Class ImageRedirectCreativeDetails.Builder (0.62.0)

public static final class ImageRedirectCreativeDetails.Builder extends GeneratedMessage.Builder<ImageRedirectCreativeDetails.Builder> implements ImageRedirectCreativeDetailsOrBuilder

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

Protobuf type google.ads.admanager.v1.ImageRedirectCreativeDetails

Static Methods

getDescriptor()

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

Methods

addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)

public ImageRedirectCreativeDetails.Builder addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)

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
values Iterable<String>

The thirdPartyImpressionTrackingUrls to add.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

addThirdPartyImpressionTrackingUrls(String value)

public ImageRedirectCreativeDetails.Builder addThirdPartyImpressionTrackingUrls(String value)

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
value String

The thirdPartyImpressionTrackingUrls to add.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

addThirdPartyImpressionTrackingUrlsBytes(ByteString value)

public ImageRedirectCreativeDetails.Builder addThirdPartyImpressionTrackingUrlsBytes(ByteString value)

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
value ByteString

The bytes of the thirdPartyImpressionTrackingUrls to add.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

build()

public ImageRedirectCreativeDetails build()
Returns
Type Description
ImageRedirectCreativeDetails

buildPartial()

public ImageRedirectCreativeDetails buildPartial()
Returns
Type Description
ImageRedirectCreativeDetails

clear()

public ImageRedirectCreativeDetails.Builder clear()
Returns
Type Description
ImageRedirectCreativeDetails.Builder
Overrides

clearAltText()

public ImageRedirectCreativeDetails.Builder clearAltText()

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
ImageRedirectCreativeDetails.Builder

This builder for chaining.

clearDestinationUrl()

public ImageRedirectCreativeDetails.Builder clearDestinationUrl()

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
ImageRedirectCreativeDetails.Builder

This builder for chaining.

clearDestinationUrlType()

public ImageRedirectCreativeDetails.Builder clearDestinationUrlType()

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
ImageRedirectCreativeDetails.Builder

This builder for chaining.

clearImageUrl()

public ImageRedirectCreativeDetails.Builder clearImageUrl()

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
ImageRedirectCreativeDetails.Builder

This builder for chaining.

clearThirdPartyImpressionTrackingUrls()

public ImageRedirectCreativeDetails.Builder clearThirdPartyImpressionTrackingUrls()

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
ImageRedirectCreativeDetails.Builder

This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ImageRedirectCreativeDetails other)

public ImageRedirectCreativeDetails.Builder mergeFrom(ImageRedirectCreativeDetails other)
Parameter
Name Description
other ImageRedirectCreativeDetails
Returns
Type Description
ImageRedirectCreativeDetails.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImageRedirectCreativeDetails.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImageRedirectCreativeDetails.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImageRedirectCreativeDetails.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImageRedirectCreativeDetails.Builder
Overrides

setAltText(String value)

public ImageRedirectCreativeDetails.Builder setAltText(String value)

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];

Parameter
Name Description
value String

The altText to set.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

setAltTextBytes(ByteString value)

public ImageRedirectCreativeDetails.Builder setAltTextBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for altText to set.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

setDestinationUrl(String value)

public ImageRedirectCreativeDetails.Builder setDestinationUrl(String value)

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];

Parameter
Name Description
value String

The destinationUrl to set.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

setDestinationUrlBytes(ByteString value)

public ImageRedirectCreativeDetails.Builder setDestinationUrlBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for destinationUrl to set.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value)

public ImageRedirectCreativeDetails.Builder setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value)

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];

Parameter
Name Description
value CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType

The destinationUrlType to set.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

setDestinationUrlTypeValue(int value)

public ImageRedirectCreativeDetails.Builder setDestinationUrlTypeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for destinationUrlType to set.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

setImageUrl(String value)

public ImageRedirectCreativeDetails.Builder setImageUrl(String value)

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];

Parameter
Name Description
value String

The imageUrl to set.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

setImageUrlBytes(ByteString value)

public ImageRedirectCreativeDetails.Builder setImageUrlBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for imageUrl to set.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.

setThirdPartyImpressionTrackingUrls(int index, String value)

public ImageRedirectCreativeDetails.Builder setThirdPartyImpressionTrackingUrls(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.

value String

The thirdPartyImpressionTrackingUrls to set.

Returns
Type Description
ImageRedirectCreativeDetails.Builder

This builder for chaining.