Class TemplateCreativeDetails.Builder (0.62.0)

public static final class TemplateCreativeDetails.Builder extends GeneratedMessage.Builder<TemplateCreativeDetails.Builder> implements TemplateCreativeDetailsOrBuilder

A Creative that is created by the specified creative template.

Protobuf type google.ads.admanager.v1.TemplateCreativeDetails

Static Methods

getDescriptor()

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

Methods

build()

public TemplateCreativeDetails build()
Returns
Type Description
TemplateCreativeDetails

buildPartial()

public TemplateCreativeDetails buildPartial()
Returns
Type Description
TemplateCreativeDetails

clear()

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

clearAmpDestinationUrl()

public TemplateCreativeDetails.Builder clearAmpDestinationUrl()

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

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

clearDestinationUrl()

public TemplateCreativeDetails.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 = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

clearDestinationUrlType()

public TemplateCreativeDetails.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 = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

clearLockedOrientation()

public TemplateCreativeDetails.Builder clearLockedOrientation()

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

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

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

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

Returns
Type Description
ByteString

The bytes for ampDestinationUrl.

getDefaultInstanceForType()

public TemplateCreativeDetails getDefaultInstanceForType()
Returns
Type Description
TemplateCreativeDetails

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

Returns
Type Description
int

The enum numeric value on the wire for lockedOrientation.

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

Returns
Type Description
boolean

Whether the lockedOrientation field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TemplateCreativeDetails other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setAmpDestinationUrl(String value)

public TemplateCreativeDetails.Builder setAmpDestinationUrl(String value)

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

Parameter
Name Description
value String

The ampDestinationUrl to set.

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

setAmpDestinationUrlBytes(ByteString value)

public TemplateCreativeDetails.Builder setAmpDestinationUrlBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for ampDestinationUrl to set.

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

setDestinationUrl(String value)

public TemplateCreativeDetails.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 = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The destinationUrl to set.

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

setDestinationUrlBytes(ByteString value)

public TemplateCreativeDetails.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 = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for destinationUrl to set.

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value)

public TemplateCreativeDetails.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 = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType

The destinationUrlType to set.

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

setDestinationUrlTypeValue(int value)

public TemplateCreativeDetails.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 = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

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

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

setLockedOrientation(CreativeLockedOrientationEnum.CreativeLockedOrientation value)

public TemplateCreativeDetails.Builder setLockedOrientation(CreativeLockedOrientationEnum.CreativeLockedOrientation value)

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

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

Parameter
Name Description
value CreativeLockedOrientationEnum.CreativeLockedOrientation

The lockedOrientation to set.

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.

setLockedOrientationValue(int value)

public TemplateCreativeDetails.Builder setLockedOrientationValue(int value)

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

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

Parameter
Name Description
value int

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

Returns
Type Description
TemplateCreativeDetails.Builder

This builder for chaining.