Package com.google.ads.googleads.v22.services

Class GenerateTextRequest

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.v22.services.GenerateTextRequest
All Implemented Interfaces:
GenerateTextRequestOrBuilder, 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 GenerateTextRequest extends com.google.protobuf.GeneratedMessageV3 implements GenerateTextRequestOrBuilder
 Request message for
 [AssetGenerationService.GenerateText][google.ads.googleads.v22.services.AssetGenerationService.GenerateText]
Protobuf type google.ads.googleads.v22.services.GenerateTextRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • ASSET_FIELD_TYPES_FIELD_NUMBER

      public static final int ASSET_FIELD_TYPES_FIELD_NUMBER
      See Also:

    • FINAL_URL_FIELD_NUMBER

      public static final int FINAL_URL_FIELD_NUMBER
      See Also:

    • FREEFORM_PROMPT_FIELD_NUMBER

      public static final int FREEFORM_PROMPT_FIELD_NUMBER
      See Also:

    • KEYWORDS_FIELD_NUMBER

      public static final int KEYWORDS_FIELD_NUMBER
      See Also:

    • EXISTING_GENERATION_CONTEXT_FIELD_NUMBER

      public static final int EXISTING_GENERATION_CONTEXT_FIELD_NUMBER
      See Also:

    • ADVERTISING_CHANNEL_TYPE_FIELD_NUMBER

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

    • getContextCase

      public GenerateTextRequest.ContextCase getContextCase()
      Specified by:
      getContextCase in interface GenerateTextRequestOrBuilder

    • getCustomerId

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

    • getCustomerIdBytes

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

    • getAssetFieldTypesList

      public List<AssetFieldTypeEnum.AssetFieldType> getAssetFieldTypesList()
       Required. Which field types text is being generated for. Supported values
 are: HEADLINE, LONG_HEADLINE, DESCRIPTION. Required.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAssetFieldTypesList in interface GenerateTextRequestOrBuilder
      Returns:
      A list containing the assetFieldTypes.

    • getAssetFieldTypesCount

      public int getAssetFieldTypesCount()
       Required. Which field types text is being generated for. Supported values
 are: HEADLINE, LONG_HEADLINE, DESCRIPTION. Required.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAssetFieldTypesCount in interface GenerateTextRequestOrBuilder
      Returns:
      The count of assetFieldTypes.

    • getAssetFieldTypes

      public AssetFieldTypeEnum.AssetFieldType getAssetFieldTypes(int index)
       Required. Which field types text is being generated for. Supported values
 are: HEADLINE, LONG_HEADLINE, DESCRIPTION. Required.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAssetFieldTypes in interface GenerateTextRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The assetFieldTypes at the given index.

    • getAssetFieldTypesValueList

      public List<Integer> getAssetFieldTypesValueList()
       Required. Which field types text is being generated for. Supported values
 are: HEADLINE, LONG_HEADLINE, DESCRIPTION. Required.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAssetFieldTypesValueList in interface GenerateTextRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for assetFieldTypes.

    • getAssetFieldTypesValue

      public int getAssetFieldTypesValue(int index)
       Required. Which field types text is being generated for. Supported values
 are: HEADLINE, LONG_HEADLINE, DESCRIPTION. Required.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAssetFieldTypesValue in interface GenerateTextRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of assetFieldTypes at the given index.

    • getFinalUrl

      public String getFinalUrl()
       Optional. Final url to use as a source for generating assets.
 Required if existing_generation_context is not provided
 or does not have a final url associated with it.
      string final_url = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFinalUrl in interface GenerateTextRequestOrBuilder
      Returns:
      The finalUrl.

    • getFinalUrlBytes

      public com.google.protobuf.ByteString getFinalUrlBytes()
       Optional. Final url to use as a source for generating assets.
 Required if existing_generation_context is not provided
 or does not have a final url associated with it.
      string final_url = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFinalUrlBytes in interface GenerateTextRequestOrBuilder
      Returns:
      The bytes for finalUrl.

    • getFreeformPrompt

      public String getFreeformPrompt()
       Optional. A freeform description of what assets should be generated.
 The string length must be between 1 and 1500, inclusive.
      string freeform_prompt = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFreeformPrompt in interface GenerateTextRequestOrBuilder
      Returns:
      The freeformPrompt.

    • getFreeformPromptBytes

      public com.google.protobuf.ByteString getFreeformPromptBytes()
       Optional. A freeform description of what assets should be generated.
 The string length must be between 1 and 1500, inclusive.
      string freeform_prompt = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFreeformPromptBytes in interface GenerateTextRequestOrBuilder
      Returns:
      The bytes for freeformPrompt.

    • getKeywordsList

      public com.google.protobuf.ProtocolStringList getKeywordsList()
       Optional. A freeform list of keywords that are relevant,
 used to inform asset generation.
      repeated string keywords = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeywordsList in interface GenerateTextRequestOrBuilder
      Returns:
      A list containing the keywords.

    • getKeywordsCount

      public int getKeywordsCount()
       Optional. A freeform list of keywords that are relevant,
 used to inform asset generation.
      repeated string keywords = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeywordsCount in interface GenerateTextRequestOrBuilder
      Returns:
      The count of keywords.

    • getKeywords

      public String getKeywords(int index)
       Optional. A freeform list of keywords that are relevant,
 used to inform asset generation.
      repeated string keywords = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeywords in interface GenerateTextRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The keywords at the given index.

    • getKeywordsBytes

      public com.google.protobuf.ByteString getKeywordsBytes(int index)
       Optional. A freeform list of keywords that are relevant,
 used to inform asset generation.
      repeated string keywords = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeywordsBytes in interface GenerateTextRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the keywords at the given index.

    • hasExistingGenerationContext

      public boolean hasExistingGenerationContext()
       Optional. The setting for which assets are being generated, such as an
 existing AssetGroup or AdGroupAd.
      .google.ads.googleads.v22.services.AssetGenerationExistingContext existing_generation_context = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasExistingGenerationContext in interface GenerateTextRequestOrBuilder
      Returns:
      Whether the existingGenerationContext field is set.

    • getExistingGenerationContext

      public AssetGenerationExistingContext getExistingGenerationContext()
       Optional. The setting for which assets are being generated, such as an
 existing AssetGroup or AdGroupAd.
      .google.ads.googleads.v22.services.AssetGenerationExistingContext existing_generation_context = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExistingGenerationContext in interface GenerateTextRequestOrBuilder
      Returns:
      The existingGenerationContext.

    • getExistingGenerationContextOrBuilder

      public AssetGenerationExistingContextOrBuilder getExistingGenerationContextOrBuilder()
       Optional. The setting for which assets are being generated, such as an
 existing AssetGroup or AdGroupAd.
      .google.ads.googleads.v22.services.AssetGenerationExistingContext existing_generation_context = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExistingGenerationContextOrBuilder in interface GenerateTextRequestOrBuilder

    • hasAdvertisingChannelType

      public boolean hasAdvertisingChannelType()
       Optional. The advertising channel for which to generate assets. Required
 if existing_context is not provided.

 Supported channel types:
 SEARCH, PERFORMANCE_MAX, DISPLAY, and DEMAND_GEN
      .google.ads.googleads.v22.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAdvertisingChannelType in interface GenerateTextRequestOrBuilder
      Returns:
      Whether the advertisingChannelType field is set.

    • getAdvertisingChannelTypeValue

      public int getAdvertisingChannelTypeValue()
       Optional. The advertising channel for which to generate assets. Required
 if existing_context is not provided.

 Supported channel types:
 SEARCH, PERFORMANCE_MAX, DISPLAY, and DEMAND_GEN
      .google.ads.googleads.v22.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdvertisingChannelTypeValue in interface GenerateTextRequestOrBuilder
      Returns:
      The enum numeric value on the wire for advertisingChannelType.

    • getAdvertisingChannelType

      public AdvertisingChannelTypeEnum.AdvertisingChannelType getAdvertisingChannelType()
       Optional. The advertising channel for which to generate assets. Required
 if existing_context is not provided.

 Supported channel types:
 SEARCH, PERFORMANCE_MAX, DISPLAY, and DEMAND_GEN
      .google.ads.googleads.v22.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdvertisingChannelType in interface GenerateTextRequestOrBuilder
      Returns:
      The advertisingChannelType.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GenerateTextRequest.Builder newBuilder()

    • newBuilder

      public static GenerateTextRequest.Builder newBuilder(GenerateTextRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GenerateTextRequest getDefaultInstance()

    • parser

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

    • getParserForType

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