Package com.google.ads.googleads.v23.services

Class GenerateAudienceDefinitionRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v23.services.GenerateAudienceDefinitionRequest
All Implemented Interfaces:
GenerateAudienceDefinitionRequestOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class GenerateAudienceDefinitionRequest extends com.google.protobuf.GeneratedMessageV3 implements GenerateAudienceDefinitionRequestOrBuilder
 Request message for
 [AudienceInsightsService.GenerateAudienceDefinition][google.ads.googleads.v23.services.AudienceInsightsService.GenerateAudienceDefinition].
Protobuf type google.ads.googleads.v23.services.GenerateAudienceDefinitionRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • AUDIENCE_DESCRIPTION_FIELD_NUMBER

      public static final int AUDIENCE_DESCRIPTION_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:

  • 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()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getCustomerId

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

    • hasAudienceDescription

      public boolean hasAudienceDescription()
       Required. Provide a text description of an audience to get AI-generated
 structured suggestions. This can take around 5 or more seconds to complete
 Supported marketing objectives are: AWARENESS, CONSIDERATION and RESEARCH.
 Supported dimensions are: AGE_RANGE, GENDER, PARENTAL_STATUS,
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST,
 CATEGORY and KNOWLEDGE_GRAPH.
      .google.ads.googleads.v23.services.InsightsAudienceDescription audience_description = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasAudienceDescription in interface GenerateAudienceDefinitionRequestOrBuilder
      Returns:
      Whether the audienceDescription field is set.

    • getAudienceDescription

      public InsightsAudienceDescription getAudienceDescription()
       Required. Provide a text description of an audience to get AI-generated
 structured suggestions. This can take around 5 or more seconds to complete
 Supported marketing objectives are: AWARENESS, CONSIDERATION and RESEARCH.
 Supported dimensions are: AGE_RANGE, GENDER, PARENTAL_STATUS,
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST,
 CATEGORY and KNOWLEDGE_GRAPH.
      .google.ads.googleads.v23.services.InsightsAudienceDescription audience_description = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceDescription in interface GenerateAudienceDefinitionRequestOrBuilder
      Returns:
      The audienceDescription.

    • getAudienceDescriptionOrBuilder

      public InsightsAudienceDescriptionOrBuilder getAudienceDescriptionOrBuilder()
       Required. Provide a text description of an audience to get AI-generated
 structured suggestions. This can take around 5 or more seconds to complete
 Supported marketing objectives are: AWARENESS, CONSIDERATION and RESEARCH.
 Supported dimensions are: AGE_RANGE, GENDER, PARENTAL_STATUS,
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST,
 CATEGORY and KNOWLEDGE_GRAPH.
      .google.ads.googleads.v23.services.InsightsAudienceDescription audience_description = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceDescriptionOrBuilder in interface GenerateAudienceDefinitionRequestOrBuilder

    • getCustomerInsightsGroup

      public String getCustomerInsightsGroup()
       Optional. The name of the customer being planned for.  This is a
 user-defined value.
      string customer_insights_group = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomerInsightsGroup in interface GenerateAudienceDefinitionRequestOrBuilder
      Returns:
      The customerInsightsGroup.

    • getCustomerInsightsGroupBytes

      public com.google.protobuf.ByteString getCustomerInsightsGroupBytes()
       Optional. The name of the customer being planned for.  This is a
 user-defined value.
      string customer_insights_group = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomerInsightsGroupBytes in interface GenerateAudienceDefinitionRequestOrBuilder
      Returns:
      The bytes for customerInsightsGroup.

    • hasInsightsApplicationInfo

      public boolean hasInsightsApplicationInfo()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasInsightsApplicationInfo in interface GenerateAudienceDefinitionRequestOrBuilder
      Returns:
      Whether the insightsApplicationInfo field is set.

    • getInsightsApplicationInfo

      public AdditionalApplicationInfo getInsightsApplicationInfo()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInsightsApplicationInfo in interface GenerateAudienceDefinitionRequestOrBuilder
      Returns:
      The insightsApplicationInfo.

    • getInsightsApplicationInfoOrBuilder

      public AdditionalApplicationInfoOrBuilder getInsightsApplicationInfoOrBuilder()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInsightsApplicationInfoOrBuilder in interface GenerateAudienceDefinitionRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<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.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 GenerateAudienceDefinitionRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GenerateAudienceDefinitionRequest.Builder newBuilder()

    • newBuilder

      public static GenerateAudienceDefinitionRequest.Builder newBuilder(GenerateAudienceDefinitionRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GenerateAudienceDefinitionRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<GenerateAudienceDefinitionRequest> 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 GenerateAudienceDefinitionRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder