Interface AspectRatioImageCreativeDetailsOrBuilder (0.62.0)

public interface AspectRatioImageCreativeDetailsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAltText()

public abstract 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 abstract 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.

getDestinationUrl()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getImageAssetsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the thirdPartyImpressionTrackingUrls.

hasAltText()

public abstract 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 abstract 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 abstract 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.