Interface ImageCreativeDetailsOrBuilder (0.62.0)

public interface ImageCreativeDetailsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAltText()

public abstract String getAltText()

Alternative text to be rendered along with the creative used mainly for accessibility. This field has a maximum length of 500 characters.

optional string alt_text = 1;

Returns
Type Description
String

The altText.

getAltTextBytes()

public abstract ByteString getAltTextBytes()

Alternative text to be rendered along with the creative used mainly for accessibility. This field has a maximum length of 500 characters.

optional string alt_text = 1;

Returns
Type Description
ByteString

The bytes for altText.

getAmpDestinationUrl()

public abstract String getAmpDestinationUrl()

Optional. The AMP destination URL for this creative. This must be a valid URL, including the http:// or https:// scheme.

optional string amp_destination_url = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The ampDestinationUrl.

getAmpDestinationUrlBytes()

public abstract ByteString getAmpDestinationUrlBytes()

Optional. The AMP destination URL for this creative. This must be a valid URL, including the http:// or https:// scheme.

optional string amp_destination_url = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for ampDestinationUrl.

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 = 8 [(.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 = 8 [(.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 = 9 [(.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 = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for destinationUrlType.

getLockedOrientation()

public abstract CreativeLockedOrientationEnum.CreativeLockedOrientation getLockedOrientation()

Optional. A locked orientation for this creative to be displayed in.

optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeLockedOrientationEnum.CreativeLockedOrientation

The lockedOrientation.

getLockedOrientationValue()

public abstract int getLockedOrientationValue()

Optional. A locked orientation for this creative to be displayed in.

optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for lockedOrientation.

getOverrideSize()

public abstract boolean getOverrideSize()

Optional. Allows the creative size to differ from the actual image asset size.

optional bool override_size = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The overrideSize.

getPrimaryImageAsset()

public abstract CreativeAsset getPrimaryImageAsset()

The primary image asset associated with this creative. This attribute is required.

.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6;

Returns
Type Description
CreativeAsset

The primaryImageAsset.

getPrimaryImageAssetOrBuilder()

public abstract CreativeAssetOrBuilder getPrimaryImageAssetOrBuilder()

The primary image asset associated with this creative. This attribute is required.

.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6;

Returns
Type Description
CreativeAssetOrBuilder

getSecondaryImageAssets(int index)

public abstract CreativeAsset getSecondaryImageAssets(int index)

Secondary image assets associated with this creative. This attribute is optional.

Secondary image assets can be used to store different resolution versions of the primary asset for use on non-standard density screens.

repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;

Parameter
Name Description
index int
Returns
Type Description
CreativeAsset

getSecondaryImageAssetsCount()

public abstract int getSecondaryImageAssetsCount()

Secondary image assets associated with this creative. This attribute is optional.

Secondary image assets can be used to store different resolution versions of the primary asset for use on non-standard density screens.

repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;

Returns
Type Description
int

getSecondaryImageAssetsList()

public abstract List<CreativeAsset> getSecondaryImageAssetsList()

Secondary image assets associated with this creative. This attribute is optional.

Secondary image assets can be used to store different resolution versions of the primary asset for use on non-standard density screens.

repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;

Returns
Type Description
List<CreativeAsset>

getSecondaryImageAssetsOrBuilder(int index)

public abstract CreativeAssetOrBuilder getSecondaryImageAssetsOrBuilder(int index)

Secondary image assets associated with this creative. This attribute is optional.

Secondary image assets can be used to store different resolution versions of the primary asset for use on non-standard density screens.

repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;

Parameter
Name Description
index int
Returns
Type Description
CreativeAssetOrBuilder

getSecondaryImageAssetsOrBuilderList()

public abstract List<? extends CreativeAssetOrBuilder> getSecondaryImageAssetsOrBuilderList()

Secondary image assets associated with this creative. This attribute is optional.

Secondary image assets can be used to store different resolution versions of the primary asset for use on non-standard density screens.

repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;

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

getThirdPartyImpressionTrackingUrls(int index)

public abstract String getThirdPartyImpressionTrackingUrls(int index)

Optional. Impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 3 [(.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. Impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 3 [(.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. Impression tracking URLs to ping when this creative is displayed.

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

Returns
Type Description
int

The count of thirdPartyImpressionTrackingUrls.

getThirdPartyImpressionTrackingUrlsList()

public abstract List<String> getThirdPartyImpressionTrackingUrlsList()

Optional. Impression tracking URLs to ping when this creative is displayed.

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

Returns
Type Description
List<String>

A list containing the thirdPartyImpressionTrackingUrls.

hasAltText()

public abstract boolean hasAltText()

Alternative text to be rendered along with the creative used mainly for accessibility. This field has a maximum length of 500 characters.

optional string alt_text = 1;

Returns
Type Description
boolean

Whether the altText field is set.

hasAmpDestinationUrl()

public abstract boolean hasAmpDestinationUrl()

Optional. The AMP destination URL for this creative. This must be a valid URL, including the http:// or https:// scheme.

optional string amp_destination_url = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ampDestinationUrl 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 = 8 [(.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 = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the destinationUrlType field is set.

hasLockedOrientation()

public abstract boolean hasLockedOrientation()

Optional. A locked orientation for this creative to be displayed in.

optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the lockedOrientation field is set.

hasOverrideSize()

public abstract boolean hasOverrideSize()

Optional. Allows the creative size to differ from the actual image asset size.

optional bool override_size = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the overrideSize field is set.

hasPrimaryImageAsset()

public abstract boolean hasPrimaryImageAsset()

The primary image asset associated with this creative. This attribute is required.

.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6;

Returns
Type Description
boolean

Whether the primaryImageAsset field is set.