Package com.google.ads.googleads.v20.services

Interface GenerateCreatorInsightsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateCreatorInsightsRequest, GenerateCreatorInsightsRequest.Builder
public interface GenerateCreatorInsightsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCustomerId

      String getCustomerId()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The customerId.

    • getCustomerIdBytes

      com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for customerId.

    • getCustomerInsightsGroup

      String getCustomerInsightsGroup()
       Required. The name of the customer being planned for.  This is a
 user-defined value.
      string customer_insights_group = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The customerInsightsGroup.

    • getCustomerInsightsGroupBytes

      com.google.protobuf.ByteString getCustomerInsightsGroupBytes()
       Required. The name of the customer being planned for.  This is a
 user-defined value.
      string customer_insights_group = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for customerInsightsGroup.

    • hasInsightsApplicationInfo

      boolean hasInsightsApplicationInfo()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v20.common.AdditionalApplicationInfo insights_application_info = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the insightsApplicationInfo field is set.

    • getInsightsApplicationInfo

      AdditionalApplicationInfo getInsightsApplicationInfo()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v20.common.AdditionalApplicationInfo insights_application_info = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The insightsApplicationInfo.

    • getInsightsApplicationInfoOrBuilder

      AdditionalApplicationInfoOrBuilder getInsightsApplicationInfoOrBuilder()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v20.common.AdditionalApplicationInfo insights_application_info = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getCountryLocationsList

      List<LocationInfo> getCountryLocationsList()
       Required. The countries to search that apply to the criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo country_locations = 6 [(.google.api.field_behavior) = REQUIRED];

    • getCountryLocations

      LocationInfo getCountryLocations(int index)
       Required. The countries to search that apply to the criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo country_locations = 6 [(.google.api.field_behavior) = REQUIRED];

    • getCountryLocationsCount

      int getCountryLocationsCount()
       Required. The countries to search that apply to the criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo country_locations = 6 [(.google.api.field_behavior) = REQUIRED];

    • getCountryLocationsOrBuilderList

      List<? extends LocationInfoOrBuilder> getCountryLocationsOrBuilderList()
       Required. The countries to search that apply to the criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo country_locations = 6 [(.google.api.field_behavior) = REQUIRED];

    • getCountryLocationsOrBuilder

      LocationInfoOrBuilder getCountryLocationsOrBuilder(int index)
       Required. The countries to search that apply to the criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo country_locations = 6 [(.google.api.field_behavior) = REQUIRED];

    • getSubCountryLocationsList

      List<LocationInfo> getSubCountryLocationsList()
       The sub-country geographic locations to search that apply to the criteria.
 Only supported for [SearchAttributes] criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo sub_country_locations = 7;

    • getSubCountryLocations

      LocationInfo getSubCountryLocations(int index)
       The sub-country geographic locations to search that apply to the criteria.
 Only supported for [SearchAttributes] criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo sub_country_locations = 7;

    • getSubCountryLocationsCount

      int getSubCountryLocationsCount()
       The sub-country geographic locations to search that apply to the criteria.
 Only supported for [SearchAttributes] criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo sub_country_locations = 7;

    • getSubCountryLocationsOrBuilderList

      List<? extends LocationInfoOrBuilder> getSubCountryLocationsOrBuilderList()
       The sub-country geographic locations to search that apply to the criteria.
 Only supported for [SearchAttributes] criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo sub_country_locations = 7;

    • getSubCountryLocationsOrBuilder

      LocationInfoOrBuilder getSubCountryLocationsOrBuilder(int index)
       The sub-country geographic locations to search that apply to the criteria.
 Only supported for [SearchAttributes] criteria.
      repeated .google.ads.googleads.v20.common.LocationInfo sub_country_locations = 7;

    • hasSearchAttributes

      boolean hasSearchAttributes()
       The attributes used to identify top creators. Data fetched is based on
 the list of countries or sub-country locations specified in
 [country_locations] or [sub_country_locations].
      .google.ads.googleads.v20.services.GenerateCreatorInsightsRequest.SearchAttributes search_attributes = 3;
      Returns:
      Whether the searchAttributes field is set.

    • getSearchAttributes

      GenerateCreatorInsightsRequest.SearchAttributes getSearchAttributes()
       The attributes used to identify top creators. Data fetched is based on
 the list of countries or sub-country locations specified in
 [country_locations] or [sub_country_locations].
      .google.ads.googleads.v20.services.GenerateCreatorInsightsRequest.SearchAttributes search_attributes = 3;
      Returns:
      The searchAttributes.

    • getSearchAttributesOrBuilder

      GenerateCreatorInsightsRequest.SearchAttributesOrBuilder getSearchAttributesOrBuilder()
       The attributes used to identify top creators. Data fetched is based on
 the list of countries or sub-country locations specified in
 [country_locations] or [sub_country_locations].
      .google.ads.googleads.v20.services.GenerateCreatorInsightsRequest.SearchAttributes search_attributes = 3;

    • hasSearchBrand

      boolean hasSearchBrand()
       A brand used to search for top creators. Data fetched is based on the
 list of countries specified in [country_locations].
      .google.ads.googleads.v20.services.GenerateCreatorInsightsRequest.SearchBrand search_brand = 5;
      Returns:
      Whether the searchBrand field is set.

    • getSearchBrand

      GenerateCreatorInsightsRequest.SearchBrand getSearchBrand()
       A brand used to search for top creators. Data fetched is based on the
 list of countries specified in [country_locations].
      .google.ads.googleads.v20.services.GenerateCreatorInsightsRequest.SearchBrand search_brand = 5;
      Returns:
      The searchBrand.

    • getSearchBrandOrBuilder

      GenerateCreatorInsightsRequest.SearchBrandOrBuilder getSearchBrandOrBuilder()
       A brand used to search for top creators. Data fetched is based on the
 list of countries specified in [country_locations].
      .google.ads.googleads.v20.services.GenerateCreatorInsightsRequest.SearchBrand search_brand = 5;

    • hasSearchChannels

      boolean hasSearchChannels()
       YouTube Channel IDs for Creator Insights. Data fetched for channels is
 based on the list of countries specified in [country_locations].
      .google.ads.googleads.v20.services.GenerateCreatorInsightsRequest.YouTubeChannels search_channels = 4;
      Returns:
      Whether the searchChannels field is set.

    • getSearchChannels

      GenerateCreatorInsightsRequest.YouTubeChannels getSearchChannels()
       YouTube Channel IDs for Creator Insights. Data fetched for channels is
 based on the list of countries specified in [country_locations].
      .google.ads.googleads.v20.services.GenerateCreatorInsightsRequest.YouTubeChannels search_channels = 4;
      Returns:
      The searchChannels.

    • getSearchChannelsOrBuilder

      GenerateCreatorInsightsRequest.YouTubeChannelsOrBuilder getSearchChannelsOrBuilder()
       YouTube Channel IDs for Creator Insights. Data fetched for channels is
 based on the list of countries specified in [country_locations].
      .google.ads.googleads.v20.services.GenerateCreatorInsightsRequest.YouTubeChannels search_channels = 4;

    • getCriteriaCase

      GenerateCreatorInsightsRequest.CriteriaCase getCriteriaCase()