Class ImageRedirectCreativeDetails (0.62.0)

public final class ImageRedirectCreativeDetails extends GeneratedMessage implements ImageRedirectCreativeDetailsOrBuilder

A Creative that loads an image asset from a specified URL.

Protobuf type google.ads.admanager.v1.ImageRedirectCreativeDetails

Inheritance

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

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_URL_FIELD_NUMBER

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

getDescriptor()

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

newBuilder()

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

newBuilder(ImageRedirectCreativeDetails prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAltText()

public String getAltText()

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

Returns
Type Description
String

The altText.

getAltTextBytes()

public ByteString getAltTextBytes()

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

Returns
Type Description
ByteString

The bytes for altText.

getDefaultInstanceForType()

public ImageRedirectCreativeDetails getDefaultInstanceForType()
Returns
Type Description
ImageRedirectCreativeDetails

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

Returns
Type Description
int

The enum numeric value on the wire for destinationUrlType.

getImageUrl()

public String getImageUrl()

Required. The URL where the actual asset resides. This field has a maximum length of 1024 characters.

optional string image_url = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The imageUrl.

getImageUrlBytes()

public ByteString getImageUrlBytes()

Required. The URL where the actual asset resides. This field has a maximum length of 1024 characters.

optional string image_url = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for imageUrl.

getParserForType()

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

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. Each string has a maximum length of 1024 characters.

repeated string third_party_impression_tracking_urls = 4 [(.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. Each string has a maximum length of 1024 characters.

repeated string third_party_impression_tracking_urls = 4 [(.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. Each string has a maximum length of 1024 characters.

repeated string third_party_impression_tracking_urls = 4 [(.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. Each string has a maximum length of 1024 characters.

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

Returns
Type Description
ProtocolStringList

A list containing the thirdPartyImpressionTrackingUrls.

hasAltText()

public boolean hasAltText()

Optional. 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 = 2 [(.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 = 5 [(.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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the destinationUrlType field is set.

hasImageUrl()

public boolean hasImageUrl()

Required. The URL where the actual asset resides. This field has a maximum length of 1024 characters.

optional string image_url = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the imageUrl 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 ImageRedirectCreativeDetails.Builder newBuilderForType()
Returns
Type Description
ImageRedirectCreativeDetails.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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