Class AspectRatioImageCreativeDetails.Builder (0.62.0)

public static final class AspectRatioImageCreativeDetails.Builder extends GeneratedMessage.Builder<AspectRatioImageCreativeDetails.Builder> implements AspectRatioImageCreativeDetailsOrBuilder

A Creative intended for mobile platforms that displays an image, whose size is defined as an aspect ratio. It can have multiple images whose dimensions conform to that aspect ratio.

Protobuf type google.ads.admanager.v1.AspectRatioImageCreativeDetails

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllImageAssets(Iterable<? extends CreativeAsset> values)

public AspectRatioImageCreativeDetails.Builder addAllImageAssets(Iterable<? extends CreativeAsset> values)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.CreativeAsset>
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)

public AspectRatioImageCreativeDetails.Builder addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)

Optional. Third party impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The thirdPartyImpressionTrackingUrls to add.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

addImageAssets(CreativeAsset value)

public AspectRatioImageCreativeDetails.Builder addImageAssets(CreativeAsset value)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CreativeAsset
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

addImageAssets(CreativeAsset.Builder builderForValue)

public AspectRatioImageCreativeDetails.Builder addImageAssets(CreativeAsset.Builder builderForValue)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue CreativeAsset.Builder
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

addImageAssets(int index, CreativeAsset value)

public AspectRatioImageCreativeDetails.Builder addImageAssets(int index, CreativeAsset value)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value CreativeAsset
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

addImageAssets(int index, CreativeAsset.Builder builderForValue)

public AspectRatioImageCreativeDetails.Builder addImageAssets(int index, CreativeAsset.Builder builderForValue)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue CreativeAsset.Builder
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

addImageAssetsBuilder()

public CreativeAsset.Builder addImageAssetsBuilder()

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreativeAsset.Builder

addImageAssetsBuilder(int index)

public CreativeAsset.Builder addImageAssetsBuilder(int index)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CreativeAsset.Builder

addThirdPartyImpressionTrackingUrls(String value)

public AspectRatioImageCreativeDetails.Builder addThirdPartyImpressionTrackingUrls(String value)

Optional. Third party impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The thirdPartyImpressionTrackingUrls to add.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

addThirdPartyImpressionTrackingUrlsBytes(ByteString value)

public AspectRatioImageCreativeDetails.Builder addThirdPartyImpressionTrackingUrlsBytes(ByteString value)

Optional. Third party impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the thirdPartyImpressionTrackingUrls to add.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

build()

public AspectRatioImageCreativeDetails build()
Returns
Type Description
AspectRatioImageCreativeDetails

buildPartial()

public AspectRatioImageCreativeDetails buildPartial()
Returns
Type Description
AspectRatioImageCreativeDetails

clear()

public AspectRatioImageCreativeDetails.Builder clear()
Returns
Type Description
AspectRatioImageCreativeDetails.Builder
Overrides

clearAltText()

public AspectRatioImageCreativeDetails.Builder clearAltText()

Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.

optional string alt_text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

clearDestinationUrl()

public AspectRatioImageCreativeDetails.Builder clearDestinationUrl()

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

optional string destination_url = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

clearDestinationUrlType()

public AspectRatioImageCreativeDetails.Builder clearDestinationUrlType()

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

clearImageAssets()

public AspectRatioImageCreativeDetails.Builder clearImageAssets()

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

clearThirdPartyImpressionTrackingUrls()

public AspectRatioImageCreativeDetails.Builder clearThirdPartyImpressionTrackingUrls()

Optional. Third party impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

getAltText()

public String getAltText()

Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.

optional string alt_text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The altText.

getAltTextBytes()

public ByteString getAltTextBytes()

Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.

optional string alt_text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for altText.

getDefaultInstanceForType()

public AspectRatioImageCreativeDetails getDefaultInstanceForType()
Returns
Type Description
AspectRatioImageCreativeDetails

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDestinationUrl()

public String getDestinationUrl()

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

optional string destination_url = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The destinationUrl.

getDestinationUrlBytes()

public ByteString getDestinationUrlBytes()

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

optional string destination_url = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for destinationUrl.

getDestinationUrlType()

public CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType getDestinationUrlType()

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType

The destinationUrlType.

getDestinationUrlTypeValue()

public int getDestinationUrlTypeValue()

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for destinationUrlType.

getImageAssets(int index)

public CreativeAsset getImageAssets(int index)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CreativeAsset

getImageAssetsBuilder(int index)

public CreativeAsset.Builder getImageAssetsBuilder(int index)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CreativeAsset.Builder

getImageAssetsBuilderList()

public List<CreativeAsset.Builder> getImageAssetsBuilderList()

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getImageAssetsCount()

public int getImageAssetsCount()

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getImageAssetsList()

public List<CreativeAsset> getImageAssetsList()

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<CreativeAsset>

getImageAssetsOrBuilder(int index)

public CreativeAssetOrBuilder getImageAssetsOrBuilder(int index)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CreativeAssetOrBuilder

getImageAssetsOrBuilderList()

public List<? extends CreativeAssetOrBuilder> getImageAssetsOrBuilderList()

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.CreativeAssetOrBuilder>

getThirdPartyImpressionTrackingUrls(int index)

public String getThirdPartyImpressionTrackingUrls(int index)

Optional. Third party impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The thirdPartyImpressionTrackingUrls at the given index.

getThirdPartyImpressionTrackingUrlsBytes(int index)

public ByteString getThirdPartyImpressionTrackingUrlsBytes(int index)

Optional. Third party impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the thirdPartyImpressionTrackingUrls at the given index.

getThirdPartyImpressionTrackingUrlsCount()

public int getThirdPartyImpressionTrackingUrlsCount()

Optional. Third party impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of thirdPartyImpressionTrackingUrls.

getThirdPartyImpressionTrackingUrlsList()

public ProtocolStringList getThirdPartyImpressionTrackingUrlsList()

Optional. Third party impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the thirdPartyImpressionTrackingUrls.

hasAltText()

public boolean hasAltText()

Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.

optional string alt_text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the altText field is set.

hasDestinationUrl()

public boolean hasDestinationUrl()

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

optional string destination_url = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the destinationUrl field is set.

hasDestinationUrlType()

public boolean hasDestinationUrlType()

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the destinationUrlType field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AspectRatioImageCreativeDetails other)

public AspectRatioImageCreativeDetails.Builder mergeFrom(AspectRatioImageCreativeDetails other)
Parameter
Name Description
other AspectRatioImageCreativeDetails
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AspectRatioImageCreativeDetails.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectRatioImageCreativeDetails.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AspectRatioImageCreativeDetails.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AspectRatioImageCreativeDetails.Builder
Overrides

removeImageAssets(int index)

public AspectRatioImageCreativeDetails.Builder removeImageAssets(int index)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

setAltText(String value)

public AspectRatioImageCreativeDetails.Builder setAltText(String value)

Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.

optional string alt_text = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The altText to set.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

setAltTextBytes(ByteString value)

public AspectRatioImageCreativeDetails.Builder setAltTextBytes(ByteString value)

Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.

optional string alt_text = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for altText to set.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

setDestinationUrl(String value)

public AspectRatioImageCreativeDetails.Builder setDestinationUrl(String value)

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

optional string destination_url = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The destinationUrl to set.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

setDestinationUrlBytes(ByteString value)

public AspectRatioImageCreativeDetails.Builder setDestinationUrlBytes(ByteString value)

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

optional string destination_url = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for destinationUrl to set.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value)

public AspectRatioImageCreativeDetails.Builder setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType

The destinationUrlType to set.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

setDestinationUrlTypeValue(int value)

public AspectRatioImageCreativeDetails.Builder setDestinationUrlTypeValue(int value)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for destinationUrlType to set.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.

setImageAssets(int index, CreativeAsset value)

public AspectRatioImageCreativeDetails.Builder setImageAssets(int index, CreativeAsset value)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value CreativeAsset
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

setImageAssets(int index, CreativeAsset.Builder builderForValue)

public AspectRatioImageCreativeDetails.Builder setImageAssets(int index, CreativeAsset.Builder builderForValue)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

repeated .google.ads.admanager.v1.CreativeAsset image_assets = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue CreativeAsset.Builder
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

setThirdPartyImpressionTrackingUrls(int index, String value)

public AspectRatioImageCreativeDetails.Builder setThirdPartyImpressionTrackingUrls(int index, String value)

Optional. Third party impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The thirdPartyImpressionTrackingUrls to set.

Returns
Type Description
AspectRatioImageCreativeDetails.Builder

This builder for chaining.