Package com.google.ads.googleads.v25.services

Interface GenerateCreatorInsightsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateCreatorInsightsRequest, GenerateCreatorInsightsRequest.Builder
@Generated 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.v25.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.v25.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.v25.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.v25.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.v25.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.v25.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.v25.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.v25.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][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.SearchAttributes]
 criteria.
      repeated .google.ads.googleads.v25.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][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.SearchAttributes]
 criteria.
      repeated .google.ads.googleads.v25.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][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.SearchAttributes]
 criteria.
      repeated .google.ads.googleads.v25.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][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.SearchAttributes]
 criteria.
      repeated .google.ads.googleads.v25.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][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.SearchAttributes]
 criteria.
      repeated .google.ads.googleads.v25.common.LocationInfo sub_country_locations = 7;

    • getSupplementalDataList

      List<ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData> getSupplementalDataList()
       Optional. Optional features to include in the response. By default, only
 core insight data is returned. Including supplemental data here will
 populate additional fields in the response.
      repeated .google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData supplemental_data = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the supplementalData.

    • getSupplementalDataCount

      int getSupplementalDataCount()
       Optional. Optional features to include in the response. By default, only
 core insight data is returned. Including supplemental data here will
 populate additional fields in the response.
      repeated .google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData supplemental_data = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of supplementalData.

    • getSupplementalData

      ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData getSupplementalData(int index)
       Optional. Optional features to include in the response. By default, only
 core insight data is returned. Including supplemental data here will
 populate additional fields in the response.
      repeated .google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData supplemental_data = 10 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The supplementalData at the given index.

    • getSupplementalDataValueList

      List<Integer> getSupplementalDataValueList()
       Optional. Optional features to include in the response. By default, only
 core insight data is returned. Including supplemental data here will
 populate additional fields in the response.
      repeated .google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData supplemental_data = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the enum numeric values on the wire for supplementalData.

    • getSupplementalDataValue

      int getSupplementalDataValue(int index)
       Optional. Optional features to include in the response. By default, only
 core insight data is returned. Including supplemental data here will
 populate additional fields in the response.
      repeated .google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData supplemental_data = 10 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of supplementalData at the given index.

    • 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][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.country_locations]
 or
 [sub_country_locations][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.sub_country_locations].
      .google.ads.googleads.v25.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][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.country_locations]
 or
 [sub_country_locations][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.sub_country_locations].
      .google.ads.googleads.v25.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][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.country_locations]
 or
 [sub_country_locations][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.sub_country_locations].
      .google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.SearchAttributes search_attributes = 3;

    • 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.v25.services.GenerateCreatorInsightsRequest.country_locations].
      .google.ads.googleads.v25.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.v25.services.GenerateCreatorInsightsRequest.country_locations].
      .google.ads.googleads.v25.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.v25.services.GenerateCreatorInsightsRequest.country_locations].
      .google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.YouTubeChannels search_channels = 4;

    • hasSearchTopics

      boolean hasSearchTopics()
       Search for relevant creators who make content about the specified topics.
 Data fetched is based on the country specified in
 [country_locations][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.country_locations].
 Note: This option allows searching for one country only.
      .google.ads.googleads.v25.services.SearchTopics search_topics = 9;
      Returns:
      Whether the searchTopics field is set.

    • getSearchTopics

      SearchTopics getSearchTopics()
       Search for relevant creators who make content about the specified topics.
 Data fetched is based on the country specified in
 [country_locations][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.country_locations].
 Note: This option allows searching for one country only.
      .google.ads.googleads.v25.services.SearchTopics search_topics = 9;
      Returns:
      The searchTopics.

    • getSearchTopicsOrBuilder

      SearchTopicsOrBuilder getSearchTopicsOrBuilder()
       Search for relevant creators who make content about the specified topics.
 Data fetched is based on the country specified in
 [country_locations][google.ads.googleads.v25.services.GenerateCreatorInsightsRequest.country_locations].
 Note: This option allows searching for one country only.
      .google.ads.googleads.v25.services.SearchTopics search_topics = 9;

    • getCriteriaCase

      GenerateCreatorInsightsRequest.CriteriaCase getCriteriaCase()