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

Interface GenerateImagesRequestOrBuilder

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

  • Method Details

    • getCustomerId

      String getCustomerId()
       Required. The ID of the customer for whom the images are being generated.
 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 for whom the images are being generated.
 Required.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for customerId.

    • getAssetFieldTypesList

      List<AssetFieldTypeEnum.AssetFieldType> getAssetFieldTypesList()
       Optional. Output field types for generated images. Supported values are
 MARKETING_IMAGE, SQUARE_MARKETING_IMAGE, PORTRAIT_MARKETING_IMAGE, and
 TALL_PORTRAIT_MARKETING_IMAGE. All specified field types must be
 compatible with the `advertising_channel_type` or
 `existing_generation_context` (whichever is set). If no field types are
 provided, images will be generated for all compatible field types.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the assetFieldTypes.

    • getAssetFieldTypesCount

      int getAssetFieldTypesCount()
       Optional. Output field types for generated images. Supported values are
 MARKETING_IMAGE, SQUARE_MARKETING_IMAGE, PORTRAIT_MARKETING_IMAGE, and
 TALL_PORTRAIT_MARKETING_IMAGE. All specified field types must be
 compatible with the `advertising_channel_type` or
 `existing_generation_context` (whichever is set). If no field types are
 provided, images will be generated for all compatible field types.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of assetFieldTypes.

    • getAssetFieldTypes

      AssetFieldTypeEnum.AssetFieldType getAssetFieldTypes(int index)
       Optional. Output field types for generated images. Supported values are
 MARKETING_IMAGE, SQUARE_MARKETING_IMAGE, PORTRAIT_MARKETING_IMAGE, and
 TALL_PORTRAIT_MARKETING_IMAGE. All specified field types must be
 compatible with the `advertising_channel_type` or
 `existing_generation_context` (whichever is set). If no field types are
 provided, images will be generated for all compatible field types.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The assetFieldTypes at the given index.

    • getAssetFieldTypesValueList

      List<Integer> getAssetFieldTypesValueList()
       Optional. Output field types for generated images. Supported values are
 MARKETING_IMAGE, SQUARE_MARKETING_IMAGE, PORTRAIT_MARKETING_IMAGE, and
 TALL_PORTRAIT_MARKETING_IMAGE. All specified field types must be
 compatible with the `advertising_channel_type` or
 `existing_generation_context` (whichever is set). If no field types are
 provided, images will be generated for all compatible field types.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the enum numeric values on the wire for assetFieldTypes.

    • getAssetFieldTypesValue

      int getAssetFieldTypesValue(int index)
       Optional. Output field types for generated images. Supported values are
 MARKETING_IMAGE, SQUARE_MARKETING_IMAGE, PORTRAIT_MARKETING_IMAGE, and
 TALL_PORTRAIT_MARKETING_IMAGE. All specified field types must be
 compatible with the `advertising_channel_type` or
 `existing_generation_context` (whichever is set). If no field types are
 provided, images will be generated for all compatible field types.
      repeated .google.ads.googleads.v22.enums.AssetFieldTypeEnum.AssetFieldType asset_field_types = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of assetFieldTypes at the given index.

    • hasAdvertisingChannelType

      boolean hasAdvertisingChannelType()
       Optional. The advertising channel type for which the images are being
 generated. This field is required if `existing_generation_context` is not
 provided. Supported channel types include SEARCH, PERFORMANCE_MAX,
 DISPLAY, and DEMAND_GEN.
      .google.ads.googleads.v22.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the advertisingChannelType field is set.

    • getAdvertisingChannelTypeValue

      int getAdvertisingChannelTypeValue()
       Optional. The advertising channel type for which the images are being
 generated. This field is required if `existing_generation_context` is not
 provided. Supported channel types include SEARCH, PERFORMANCE_MAX,
 DISPLAY, and DEMAND_GEN.
      .google.ads.googleads.v22.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for advertisingChannelType.

    • getAdvertisingChannelType

      AdvertisingChannelTypeEnum.AdvertisingChannelType getAdvertisingChannelType()
       Optional. The advertising channel type for which the images are being
 generated. This field is required if `existing_generation_context` is not
 provided. Supported channel types include SEARCH, PERFORMANCE_MAX,
 DISPLAY, and DEMAND_GEN.
      .google.ads.googleads.v22.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The advertisingChannelType.

    • hasFinalUrlGeneration

      boolean hasFinalUrlGeneration()
       Optional. Generate images from a final url.
      .google.ads.googleads.v22.services.FinalUrlImageGenerationInput final_url_generation = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the finalUrlGeneration field is set.

    • getFinalUrlGeneration

      FinalUrlImageGenerationInput getFinalUrlGeneration()
       Optional. Generate images from a final url.
      .google.ads.googleads.v22.services.FinalUrlImageGenerationInput final_url_generation = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The finalUrlGeneration.

    • getFinalUrlGenerationOrBuilder

      FinalUrlImageGenerationInputOrBuilder getFinalUrlGenerationOrBuilder()
       Optional. Generate images from a final url.
      .google.ads.googleads.v22.services.FinalUrlImageGenerationInput final_url_generation = 5 [(.google.api.field_behavior) = OPTIONAL];

    • hasFreeformGeneration

      boolean hasFreeformGeneration()
       Optional. Generate images from a freeform prompt.
      .google.ads.googleads.v22.services.FreeformImageGenerationInput freeform_generation = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the freeformGeneration field is set.

    • getFreeformGeneration

      FreeformImageGenerationInput getFreeformGeneration()
       Optional. Generate images from a freeform prompt.
      .google.ads.googleads.v22.services.FreeformImageGenerationInput freeform_generation = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The freeformGeneration.

    • getFreeformGenerationOrBuilder

      FreeformImageGenerationInputOrBuilder getFreeformGenerationOrBuilder()
       Optional. Generate images from a freeform prompt.
      .google.ads.googleads.v22.services.FreeformImageGenerationInput freeform_generation = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasProductRecontextGeneration

      boolean hasProductRecontextGeneration()
       Optional. Generate new images by recontextualizing existing product
 images.
      .google.ads.googleads.v22.services.ProductRecontextGenerationImageInput product_recontext_generation = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the productRecontextGeneration field is set.

    • getProductRecontextGeneration

      ProductRecontextGenerationImageInput getProductRecontextGeneration()
       Optional. Generate new images by recontextualizing existing product
 images.
      .google.ads.googleads.v22.services.ProductRecontextGenerationImageInput product_recontext_generation = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The productRecontextGeneration.

    • getProductRecontextGenerationOrBuilder

      ProductRecontextGenerationImageInputOrBuilder getProductRecontextGenerationOrBuilder()
       Optional. Generate new images by recontextualizing existing product
 images.
      .google.ads.googleads.v22.services.ProductRecontextGenerationImageInput product_recontext_generation = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getContextCase

      GenerateImagesRequest.ContextCase getContextCase()

    • getGenerationTypeCase

      GenerateImagesRequest.GenerationTypeCase getGenerationTypeCase()