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

Class GenerateAudienceDefinitionRequest.Builder

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

  • Method Details

    • 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.Builder<GenerateAudienceDefinitionRequest.Builder>

    • clear

      public GenerateAudienceDefinitionRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceDefinitionRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<GenerateAudienceDefinitionRequest.Builder>

    • 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

    • build

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

    • buildPartial

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

    • clone

      public GenerateAudienceDefinitionRequest.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceDefinitionRequest.Builder>

    • setField

      public GenerateAudienceDefinitionRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceDefinitionRequest.Builder>

    • clearField

      public GenerateAudienceDefinitionRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceDefinitionRequest.Builder>

    • clearOneof

      public GenerateAudienceDefinitionRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceDefinitionRequest.Builder>

    • setRepeatedField

      public GenerateAudienceDefinitionRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceDefinitionRequest.Builder>

    • addRepeatedField

      public GenerateAudienceDefinitionRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceDefinitionRequest.Builder>

    • mergeFrom

      public GenerateAudienceDefinitionRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateAudienceDefinitionRequest.Builder>

    • mergeFrom

      public GenerateAudienceDefinitionRequest.Builder mergeFrom(GenerateAudienceDefinitionRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,GenerateAudienceDefinitionRequest.Builder>

    • mergeFrom

      public GenerateAudienceDefinitionRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateAudienceDefinitionRequest.Builder>
      Throws:
      IOException

    • 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.

    • setCustomerId

      public GenerateAudienceDefinitionRequest.Builder setCustomerId(String value)
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The customerId to set.
      Returns:
      This builder for chaining.

    • clearCustomerId

      public GenerateAudienceDefinitionRequest.Builder clearCustomerId()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setCustomerIdBytes

      public GenerateAudienceDefinitionRequest.Builder setCustomerIdBytes(com.google.protobuf.ByteString value)
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for customerId to set.
      Returns:
      This builder for chaining.

    • 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.

    • setAudienceDescription

      public GenerateAudienceDefinitionRequest.Builder setAudienceDescription(InsightsAudienceDescription value)
       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];

    • setAudienceDescription

      public GenerateAudienceDefinitionRequest.Builder setAudienceDescription(InsightsAudienceDescription.Builder builderForValue)
       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];

    • mergeAudienceDescription

      public GenerateAudienceDefinitionRequest.Builder mergeAudienceDescription(InsightsAudienceDescription value)
       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];

    • clearAudienceDescription

      public GenerateAudienceDefinitionRequest.Builder clearAudienceDescription()
       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];

    • getAudienceDescriptionBuilder

      public InsightsAudienceDescription.Builder getAudienceDescriptionBuilder()
       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];

    • 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.

    • setCustomerInsightsGroup

      public GenerateAudienceDefinitionRequest.Builder setCustomerInsightsGroup(String value)
       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];
      Parameters:
      value - The customerInsightsGroup to set.
      Returns:
      This builder for chaining.

    • clearCustomerInsightsGroup

      public GenerateAudienceDefinitionRequest.Builder clearCustomerInsightsGroup()
       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];
      Returns:
      This builder for chaining.

    • setCustomerInsightsGroupBytes

      public GenerateAudienceDefinitionRequest.Builder setCustomerInsightsGroupBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for customerInsightsGroup to set.
      Returns:
      This builder for chaining.

    • 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.

    • setInsightsApplicationInfo

      public GenerateAudienceDefinitionRequest.Builder setInsightsApplicationInfo(AdditionalApplicationInfo value)
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];

    • setInsightsApplicationInfo

      public GenerateAudienceDefinitionRequest.Builder setInsightsApplicationInfo(AdditionalApplicationInfo.Builder builderForValue)
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];

    • mergeInsightsApplicationInfo

      public GenerateAudienceDefinitionRequest.Builder mergeInsightsApplicationInfo(AdditionalApplicationInfo value)
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];

    • clearInsightsApplicationInfo

      public GenerateAudienceDefinitionRequest.Builder clearInsightsApplicationInfo()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getInsightsApplicationInfoBuilder

      public AdditionalApplicationInfo.Builder getInsightsApplicationInfoBuilder()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];

    • 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

    • setUnknownFields

      public final GenerateAudienceDefinitionRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceDefinitionRequest.Builder>

    • mergeUnknownFields

      public final GenerateAudienceDefinitionRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceDefinitionRequest.Builder>