Class ImageCreativeDetails (0.62.0)

public final class ImageCreativeDetails extends GeneratedMessage implements ImageCreativeDetailsOrBuilder

A Creative that displays an image.

Protobuf type google.ads.admanager.v1.ImageCreativeDetails

Static Fields

ALT_TEXT_FIELD_NUMBER

public static final int ALT_TEXT_FIELD_NUMBER
Field Value
Type Description
int

AMP_DESTINATION_URL_FIELD_NUMBER

public static final int AMP_DESTINATION_URL_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_URL_FIELD_NUMBER

public static final int DESTINATION_URL_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_URL_TYPE_FIELD_NUMBER

public static final int DESTINATION_URL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LOCKED_ORIENTATION_FIELD_NUMBER

public static final int LOCKED_ORIENTATION_FIELD_NUMBER
Field Value
Type Description
int

OVERRIDE_SIZE_FIELD_NUMBER

public static final int OVERRIDE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PRIMARY_IMAGE_ASSET_FIELD_NUMBER

public static final int PRIMARY_IMAGE_ASSET_FIELD_NUMBER
Field Value
Type Description
int

SECONDARY_IMAGE_ASSETS_FIELD_NUMBER

public static final int SECONDARY_IMAGE_ASSETS_FIELD_NUMBER
Field Value
Type Description
int

THIRD_PARTY_IMPRESSION_TRACKING_URLS_FIELD_NUMBER

public static final int THIRD_PARTY_IMPRESSION_TRACKING_URLS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImageCreativeDetails getDefaultInstance()
Returns
Type Description
ImageCreativeDetails

getDescriptor()

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

newBuilder()

public static ImageCreativeDetails.Builder newBuilder()
Returns
Type Description
ImageCreativeDetails.Builder

newBuilder(ImageCreativeDetails prototype)

public static ImageCreativeDetails.Builder newBuilder(ImageCreativeDetails prototype)
Parameter
Name Description
prototype ImageCreativeDetails
Returns
Type Description
ImageCreativeDetails.Builder

parseDelimitedFrom(InputStream input)

public static ImageCreativeDetails parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImageCreativeDetails parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ImageCreativeDetails parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImageCreativeDetails parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImageCreativeDetails parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImageCreativeDetails parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImageCreativeDetails parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImageCreativeDetails parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ImageCreativeDetails parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImageCreativeDetails parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ImageCreativeDetails parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImageCreativeDetails parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImageCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ImageCreativeDetails> parser()
Returns
Type Description
Parser<ImageCreativeDetails>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAltText()

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

getDefaultInstanceForType()

public ImageCreativeDetails getDefaultInstanceForType()
Returns
Type Description
ImageCreativeDetails

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

Returns
Type Description
int

The enum numeric value on the wire for destinationUrlType.

getLockedOrientation()

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

getParserForType()

public Parser<ImageCreativeDetails> getParserForType()
Returns
Type Description
Parser<ImageCreativeDetails>
Overrides

getPrimaryImageAsset()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getThirdPartyImpressionTrackingUrls(int index)

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

A list containing the thirdPartyImpressionTrackingUrls.

hasAltText()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ImageCreativeDetails.Builder newBuilderForType()
Returns
Type Description
ImageCreativeDetails.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ImageCreativeDetails.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ImageCreativeDetails.Builder
Overrides

toBuilder()

public ImageCreativeDetails.Builder toBuilder()
Returns
Type Description
ImageCreativeDetails.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException