Class AspectRatioImageCreativeDetails (0.62.0)

public final class AspectRatioImageCreativeDetails extends GeneratedMessage 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > AspectRatioImageCreativeDetails

Static Fields

ALT_TEXT_FIELD_NUMBER

public static final int ALT_TEXT_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

IMAGE_ASSETS_FIELD_NUMBER

public static final int 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 AspectRatioImageCreativeDetails getDefaultInstance()
Returns
Type Description
AspectRatioImageCreativeDetails

getDescriptor()

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

newBuilder()

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

newBuilder(AspectRatioImageCreativeDetails prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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

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

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>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 AspectRatioImageCreativeDetails.Builder newBuilderForType()
Returns
Type Description
AspectRatioImageCreativeDetails.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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