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

Class GenerateImagesRequest

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

    • ADVERTISING_CHANNEL_TYPE_FIELD_NUMBER

      public static final int ADVERTISING_CHANNEL_TYPE_FIELD_NUMBER
      See Also:

    • FINAL_URL_GENERATION_FIELD_NUMBER

      public static final int FINAL_URL_GENERATION_FIELD_NUMBER
      See Also:

    • FREEFORM_GENERATION_FIELD_NUMBER

      public static final int FREEFORM_GENERATION_FIELD_NUMBER
      See Also:

    • PRODUCT_RECONTEXT_GENERATION_FIELD_NUMBER

      public static final int PRODUCT_RECONTEXT_GENERATION_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 GenerateImagesRequest.ContextCase getContextCase()
      Specified by:
      getContextCase in interface GenerateImagesRequestOrBuilder

    • getGenerationTypeCase

      public GenerateImagesRequest.GenerationTypeCase getGenerationTypeCase()
      Specified by:
      getGenerationTypeCase in interface GenerateImagesRequestOrBuilder

    • getCustomerId

      public 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];
      Specified by:
      getCustomerId in interface GenerateImagesRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public 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];
      Specified by:
      getCustomerIdBytes in interface GenerateImagesRequestOrBuilder
      Returns:
      The bytes for customerId.

    • getAssetFieldTypesList

      public 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];
      Specified by:
      getAssetFieldTypesList in interface GenerateImagesRequestOrBuilder
      Returns:
      A list containing the assetFieldTypes.

    • getAssetFieldTypesCount

      public 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];
      Specified by:
      getAssetFieldTypesCount in interface GenerateImagesRequestOrBuilder
      Returns:
      The count of assetFieldTypes.

    • getAssetFieldTypes

      public 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];
      Specified by:
      getAssetFieldTypes in interface GenerateImagesRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The assetFieldTypes at the given index.

    • getAssetFieldTypesValueList

      public 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];
      Specified by:
      getAssetFieldTypesValueList in interface GenerateImagesRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for assetFieldTypes.

    • getAssetFieldTypesValue

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

    • hasAdvertisingChannelType

      public 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];
      Specified by:
      hasAdvertisingChannelType in interface GenerateImagesRequestOrBuilder
      Returns:
      Whether the advertisingChannelType field is set.

    • getAdvertisingChannelTypeValue

      public 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];
      Specified by:
      getAdvertisingChannelTypeValue in interface GenerateImagesRequestOrBuilder
      Returns:
      The enum numeric value on the wire for advertisingChannelType.

    • getAdvertisingChannelType

      public 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];
      Specified by:
      getAdvertisingChannelType in interface GenerateImagesRequestOrBuilder
      Returns:
      The advertisingChannelType.

    • hasFinalUrlGeneration

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

    • getFinalUrlGeneration

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

    • getFinalUrlGenerationOrBuilder

      public FinalUrlImageGenerationInputOrBuilder getFinalUrlGenerationOrBuilder()
       Optional. Generate images from a final url.
      .google.ads.googleads.v22.services.FinalUrlImageGenerationInput final_url_generation = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFinalUrlGenerationOrBuilder in interface GenerateImagesRequestOrBuilder

    • hasFreeformGeneration

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

    • getFreeformGeneration

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

    • getFreeformGenerationOrBuilder

      public FreeformImageGenerationInputOrBuilder getFreeformGenerationOrBuilder()
       Optional. Generate images from a freeform prompt.
      .google.ads.googleads.v22.services.FreeformImageGenerationInput freeform_generation = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFreeformGenerationOrBuilder in interface GenerateImagesRequestOrBuilder

    • hasProductRecontextGeneration

      public 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];
      Specified by:
      hasProductRecontextGeneration in interface GenerateImagesRequestOrBuilder
      Returns:
      Whether the productRecontextGeneration field is set.

    • getProductRecontextGeneration

      public 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];
      Specified by:
      getProductRecontextGeneration in interface GenerateImagesRequestOrBuilder
      Returns:
      The productRecontextGeneration.

    • getProductRecontextGenerationOrBuilder

      public 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];
      Specified by:
      getProductRecontextGenerationOrBuilder in interface GenerateImagesRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GenerateImagesRequest.Builder newBuilder()

    • newBuilder

      public static GenerateImagesRequest.Builder newBuilder(GenerateImagesRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GenerateImagesRequest getDefaultInstance()

    • parser

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

    • getParserForType

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