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

Class GenerateCreatorInsightsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v20.services.GenerateCreatorInsightsRequest
All Implemented Interfaces:
GenerateCreatorInsightsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class GenerateCreatorInsightsRequest extends com.google.protobuf.GeneratedMessageV3 implements GenerateCreatorInsightsRequestOrBuilder
 Request message for
 [ContentCreatorInsightsService.GenerateCreatorInsights][google.ads.googleads.v20.services.ContentCreatorInsightsService.GenerateCreatorInsights].
Protobuf type google.ads.googleads.v20.services.GenerateCreatorInsightsRequest
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_LOCATIONS_FIELD_NUMBER

      public static final int COUNTRY_LOCATIONS_FIELD_NUMBER
      See Also:

    • SUB_COUNTRY_LOCATIONS_FIELD_NUMBER

      public static final int SUB_COUNTRY_LOCATIONS_FIELD_NUMBER
      See Also:

    • SEARCH_ATTRIBUTES_FIELD_NUMBER

      public static final int SEARCH_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • SEARCH_BRAND_FIELD_NUMBER

      public static final int SEARCH_BRAND_FIELD_NUMBER
      See Also:

    • SEARCH_CHANNELS_FIELD_NUMBER

      public static final int SEARCH_CHANNELS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getCriteriaCase

      public GenerateCreatorInsightsRequest.CriteriaCase getCriteriaCase()
      Specified by:
      getCriteriaCase in interface GenerateCreatorInsightsRequestOrBuilder

    • getCustomerId

      public String getCustomerId()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerId in interface GenerateCreatorInsightsRequestOrBuilder
      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 GenerateCreatorInsightsRequestOrBuilder
      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 GenerateCreatorInsightsRequestOrBuilder
      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 GenerateCreatorInsightsRequestOrBuilder
      Returns:
      The bytes for customerInsightsGroup.

    • hasInsightsApplicationInfo

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

    • getInsightsApplicationInfo

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

    • getInsightsApplicationInfoOrBuilder

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

    • getCountryLocationsList

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

    • getCountryLocationsOrBuilderList

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

    • getCountryLocationsCount

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

    • getCountryLocations

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

    • getCountryLocationsOrBuilder

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

    • getSubCountryLocationsList

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

    • getSubCountryLocationsOrBuilderList

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

    • getSubCountryLocationsCount

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

    • getSubCountryLocations

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

    • getSubCountryLocationsOrBuilder

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

    • hasSearchAttributes

      public 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;
      Specified by:
      hasSearchAttributes in interface GenerateCreatorInsightsRequestOrBuilder
      Returns:
      Whether the searchAttributes field is set.

    • getSearchAttributes

      public 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;
      Specified by:
      getSearchAttributes in interface GenerateCreatorInsightsRequestOrBuilder
      Returns:
      The searchAttributes.

    • getSearchAttributesOrBuilder

      public 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;
      Specified by:
      getSearchAttributesOrBuilder in interface GenerateCreatorInsightsRequestOrBuilder

    • hasSearchBrand

      public 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;
      Specified by:
      hasSearchBrand in interface GenerateCreatorInsightsRequestOrBuilder
      Returns:
      Whether the searchBrand field is set.

    • getSearchBrand

      public 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;
      Specified by:
      getSearchBrand in interface GenerateCreatorInsightsRequestOrBuilder
      Returns:
      The searchBrand.

    • getSearchBrandOrBuilder

      public 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;
      Specified by:
      getSearchBrandOrBuilder in interface GenerateCreatorInsightsRequestOrBuilder

    • hasSearchChannels

      public 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;
      Specified by:
      hasSearchChannels in interface GenerateCreatorInsightsRequestOrBuilder
      Returns:
      Whether the searchChannels field is set.

    • getSearchChannels

      public 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;
      Specified by:
      getSearchChannels in interface GenerateCreatorInsightsRequestOrBuilder
      Returns:
      The searchChannels.

    • getSearchChannelsOrBuilder

      public 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;
      Specified by:
      getSearchChannelsOrBuilder in interface GenerateCreatorInsightsRequestOrBuilder

    • isInitialized

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

    • 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.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

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

    • 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 GenerateCreatorInsightsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GenerateCreatorInsightsRequest.Builder newBuilder()

    • newBuilder

      public static GenerateCreatorInsightsRequest.Builder newBuilder(GenerateCreatorInsightsRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected GenerateCreatorInsightsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static GenerateCreatorInsightsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<GenerateCreatorInsightsRequest> 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.GeneratedMessageV3

    • getDefaultInstanceForType

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