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

Class GenerateTrendingInsightsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v25.services.GenerateTrendingInsightsRequest
All Implemented Interfaces:
GenerateTrendingInsightsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class GenerateTrendingInsightsRequest extends com.google.protobuf.GeneratedMessage implements GenerateTrendingInsightsRequestOrBuilder
 Request message for
 [ContentCreatorInsightsService.GenerateTrendingInsights][google.ads.googleads.v25.services.ContentCreatorInsightsService.GenerateTrendingInsights].
Protobuf type google.ads.googleads.v25.services.GenerateTrendingInsightsRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER

      public static final int CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER
      See Also:

    • INSIGHTS_APPLICATION_INFO_FIELD_NUMBER

      public static final int INSIGHTS_APPLICATION_INFO_FIELD_NUMBER
      See Also:

    • COUNTRY_LOCATION_FIELD_NUMBER

      public static final int COUNTRY_LOCATION_FIELD_NUMBER
      See Also:

    • SUB_COUNTRY_LOCATIONS_FIELD_NUMBER

      public static final int SUB_COUNTRY_LOCATIONS_FIELD_NUMBER
      See Also:

    • SUPPLEMENTAL_DATA_FIELD_NUMBER

      public static final int SUPPLEMENTAL_DATA_FIELD_NUMBER
      See Also:

    • SEARCH_AUDIENCE_FIELD_NUMBER

      public static final int SEARCH_AUDIENCE_FIELD_NUMBER
      See Also:

    • SEARCH_TOPICS_FIELD_NUMBER

      public static final int SEARCH_TOPICS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getCriteriaCase

      public GenerateTrendingInsightsRequest.CriteriaCase getCriteriaCase()
      Specified by:
      getCriteriaCase in interface GenerateTrendingInsightsRequestOrBuilder

    • getCustomerId

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

    • getCustomerIdBytes

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

    • getCustomerInsightsGroup

      public 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];
      Specified by:
      getCustomerInsightsGroup in interface GenerateTrendingInsightsRequestOrBuilder
      Returns:
      The customerInsightsGroup.

    • getCustomerInsightsGroupBytes

      public 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];
      Specified by:
      getCustomerInsightsGroupBytes in interface GenerateTrendingInsightsRequestOrBuilder
      Returns:
      The bytes for customerInsightsGroup.

    • hasInsightsApplicationInfo

      public 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];
      Specified by:
      hasInsightsApplicationInfo in interface GenerateTrendingInsightsRequestOrBuilder
      Returns:
      Whether the insightsApplicationInfo field is set.

    • getInsightsApplicationInfo

      public 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];
      Specified by:
      getInsightsApplicationInfo in interface GenerateTrendingInsightsRequestOrBuilder
      Returns:
      The insightsApplicationInfo.

    • getInsightsApplicationInfoOrBuilder

      public 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];
      Specified by:
      getInsightsApplicationInfoOrBuilder in interface GenerateTrendingInsightsRequestOrBuilder

    • hasCountryLocation

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

    • getCountryLocation

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

    • getCountryLocationOrBuilder

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

    • getSubCountryLocationsList

      public 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];
      Specified by:
      getSubCountryLocationsList in interface GenerateTrendingInsightsRequestOrBuilder

    • getSubCountryLocationsOrBuilderList

      public 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];
      Specified by:
      getSubCountryLocationsOrBuilderList in interface GenerateTrendingInsightsRequestOrBuilder

    • getSubCountryLocationsCount

      public 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];
      Specified by:
      getSubCountryLocationsCount in interface GenerateTrendingInsightsRequestOrBuilder

    • getSubCountryLocations

      public 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];
      Specified by:
      getSubCountryLocations in interface GenerateTrendingInsightsRequestOrBuilder

    • getSubCountryLocationsOrBuilder

      public 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];
      Specified by:
      getSubCountryLocationsOrBuilder in interface GenerateTrendingInsightsRequestOrBuilder

    • getSupplementalDataList

      public 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];
      Specified by:
      getSupplementalDataList in interface GenerateTrendingInsightsRequestOrBuilder
      Returns:
      A list containing the supplementalData.

    • getSupplementalDataCount

      public 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];
      Specified by:
      getSupplementalDataCount in interface GenerateTrendingInsightsRequestOrBuilder
      Returns:
      The count of supplementalData.

    • getSupplementalData

      public 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];
      Specified by:
      getSupplementalData in interface GenerateTrendingInsightsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The supplementalData at the given index.

    • getSupplementalDataValueList

      public 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];
      Specified by:
      getSupplementalDataValueList in interface GenerateTrendingInsightsRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for supplementalData.

    • getSupplementalDataValue

      public 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];
      Specified by:
      getSupplementalDataValue in interface GenerateTrendingInsightsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of supplementalData at the given index.

    • hasSearchAudience

      public 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;
      Specified by:
      hasSearchAudience in interface GenerateTrendingInsightsRequestOrBuilder
      Returns:
      Whether the searchAudience field is set.

    • getSearchAudience

      public 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;
      Specified by:
      getSearchAudience in interface GenerateTrendingInsightsRequestOrBuilder
      Returns:
      The searchAudience.

    • getSearchAudienceOrBuilder

      public 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;
      Specified by:
      getSearchAudienceOrBuilder in interface GenerateTrendingInsightsRequestOrBuilder

    • hasSearchTopics

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

    • getSearchTopics

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

    • getSearchTopicsOrBuilder

      public SearchTopicsOrBuilder getSearchTopicsOrBuilder()
       Content topics to return trend information for.
      .google.ads.googleads.v25.services.SearchTopics search_topics = 5;
      Specified by:
      getSearchTopicsOrBuilder in interface GenerateTrendingInsightsRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateTrendingInsightsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateTrendingInsightsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateTrendingInsightsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public GenerateTrendingInsightsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static GenerateTrendingInsightsRequest.Builder newBuilder()

    • newBuilder

      public static GenerateTrendingInsightsRequest.Builder newBuilder(GenerateTrendingInsightsRequest prototype)

    • toBuilder

      public GenerateTrendingInsightsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected GenerateTrendingInsightsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static GenerateTrendingInsightsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GenerateTrendingInsightsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<GenerateTrendingInsightsRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public GenerateTrendingInsightsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder