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

Interface GenerateTrendingInsightsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateTrendingInsightsRequest, GenerateTrendingInsightsRequest.Builder
@Generated public interface GenerateTrendingInsightsRequestOrBuilder 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 = 6 [(.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 = 6 [(.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 = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasCountryLocation

      boolean hasCountryLocation()
       Required. The country to find trends in.
      .google.ads.googleads.v25.common.LocationInfo country_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the countryLocation field is set.

    • getCountryLocation

      LocationInfo getCountryLocation()
       Required. The country to find trends in.
      .google.ads.googleads.v25.common.LocationInfo country_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The countryLocation.

    • getCountryLocationOrBuilder

      LocationInfoOrBuilder getCountryLocationOrBuilder()
       Required. The country to find trends in.
      .google.ads.googleads.v25.common.LocationInfo country_location = 3 [(.google.api.field_behavior) = REQUIRED];

    • getSubCountryLocationsList

      List<LocationInfo> getSubCountryLocationsList()
       Optional. The sub-country geographic locations to search that apply to the
 criteria. Only supported for `search_audience` criteria.
      repeated .google.ads.googleads.v25.common.LocationInfo sub_country_locations = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getSubCountryLocations

      LocationInfo getSubCountryLocations(int index)
       Optional. The sub-country geographic locations to search that apply to the
 criteria. Only supported for `search_audience` criteria.
      repeated .google.ads.googleads.v25.common.LocationInfo sub_country_locations = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getSubCountryLocationsCount

      int getSubCountryLocationsCount()
       Optional. The sub-country geographic locations to search that apply to the
 criteria. Only supported for `search_audience` criteria.
      repeated .google.ads.googleads.v25.common.LocationInfo sub_country_locations = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getSubCountryLocationsOrBuilderList

      List<? extends LocationInfoOrBuilder> getSubCountryLocationsOrBuilderList()
       Optional. The sub-country geographic locations to search that apply to the
 criteria. Only supported for `search_audience` criteria.
      repeated .google.ads.googleads.v25.common.LocationInfo sub_country_locations = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getSubCountryLocationsOrBuilder

      LocationInfoOrBuilder getSubCountryLocationsOrBuilder(int index)
       Optional. The sub-country geographic locations to search that apply to the
 criteria. Only supported for `search_audience` criteria.
      repeated .google.ads.googleads.v25.common.LocationInfo sub_country_locations = 8 [(.google.api.field_behavior) = OPTIONAL];

    • 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 = 7 [(.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 = 7 [(.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 = 7 [(.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 = 7 [(.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 = 7 [(.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.

    • hasSearchAudience

      boolean hasSearchAudience()
       An audience to search for trending content in. Data fetched is based on
 the country or sub-country locations specified in
 [country_location][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.country_location]
 or
 [sub_country_locations][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.sub_country_locations].
      .google.ads.googleads.v25.services.SearchAudience search_audience = 4;
      Returns:
      Whether the searchAudience field is set.

    • getSearchAudience

      SearchAudience getSearchAudience()
       An audience to search for trending content in. Data fetched is based on
 the country or sub-country locations specified in
 [country_location][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.country_location]
 or
 [sub_country_locations][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.sub_country_locations].
      .google.ads.googleads.v25.services.SearchAudience search_audience = 4;
      Returns:
      The searchAudience.

    • getSearchAudienceOrBuilder

      SearchAudienceOrBuilder getSearchAudienceOrBuilder()
       An audience to search for trending content in. Data fetched is based on
 the country or sub-country locations specified in
 [country_location][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.country_location]
 or
 [sub_country_locations][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.sub_country_locations].
      .google.ads.googleads.v25.services.SearchAudience search_audience = 4;

    • hasSearchTopics

      boolean hasSearchTopics()
       Content topics to return trend information for.
      .google.ads.googleads.v25.services.SearchTopics search_topics = 5;
      Returns:
      Whether the searchTopics field is set.

    • getSearchTopics

      SearchTopics getSearchTopics()
       Content topics to return trend information for.
      .google.ads.googleads.v25.services.SearchTopics search_topics = 5;
      Returns:
      The searchTopics.

    • getSearchTopicsOrBuilder

      SearchTopicsOrBuilder getSearchTopicsOrBuilder()
       Content topics to return trend information for.
      .google.ads.googleads.v25.services.SearchTopics search_topics = 5;

    • getCriteriaCase

      GenerateTrendingInsightsRequest.CriteriaCase getCriteriaCase()