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

Interface GenerateTextRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateTextRequest, GenerateTextRequest.Builder
public interface GenerateTextRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCustomerId

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

    • getCustomerIdBytes

      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];
      Returns:
      The bytes for customerId.

    • getAssetFieldTypesList

      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];
      Returns:
      A list containing the assetFieldTypes.

    • getAssetFieldTypesCount

      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];
      Returns:
      The count of assetFieldTypes.

    • getAssetFieldTypes

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The assetFieldTypes at the given index.

    • getAssetFieldTypesValueList

      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];
      Returns:
      A list containing the enum numeric values on the wire for assetFieldTypes.

    • getAssetFieldTypesValue

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of assetFieldTypes at the given index.

    • getFinalUrl

      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];
      Returns:
      The finalUrl.

    • getFinalUrlBytes

      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];
      Returns:
      The bytes for finalUrl.

    • getFreeformPrompt

      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];
      Returns:
      The freeformPrompt.

    • getFreeformPromptBytes

      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];
      Returns:
      The bytes for freeformPrompt.

    • getKeywordsList

      List<String> getKeywordsList()
       Optional. A freeform list of keywords that are relevant,
 used to inform asset generation.
      repeated string keywords = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the keywords.

    • getKeywordsCount

      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];
      Returns:
      The count of keywords.

    • getKeywords

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The keywords at the given index.

    • getKeywordsBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the keywords at the given index.

    • hasExistingGenerationContext

      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];
      Returns:
      Whether the existingGenerationContext field is set.

    • getExistingGenerationContext

      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];
      Returns:
      The existingGenerationContext.

    • getExistingGenerationContextOrBuilder

      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];

    • hasAdvertisingChannelType

      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];
      Returns:
      Whether the advertisingChannelType field is set.

    • getAdvertisingChannelTypeValue

      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];
      Returns:
      The enum numeric value on the wire for advertisingChannelType.

    • getAdvertisingChannelType

      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];
      Returns:
      The advertisingChannelType.

    • getContextCase

      GenerateTextRequest.ContextCase getContextCase()