Class CreativeTemplateVariable.UrlCreativeTemplateVariable (0.39.0)

public static final class CreativeTemplateVariable.UrlCreativeTemplateVariable extends GeneratedMessageV3 implements CreativeTemplateVariable.UrlCreativeTemplateVariableOrBuilder

Represents a url variable defined in a creative template.

Use [UrlCreativeTemplateVariableValue][] to specify the value for this variable when creating a [TemplateCreative][] from a CreativeTemplate.

Protobuf type google.ads.admanager.v1.CreativeTemplateVariable.UrlCreativeTemplateVariable

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CreativeTemplateVariable.UrlCreativeTemplateVariable

Static Fields

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_VALUE_FIELD_NUMBER

public static final int SAMPLE_VALUE_FIELD_NUMBER
Field Value
Type Description
int

URL_TYPE_FIELD_NUMBER

public static final int URL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreativeTemplateVariable.UrlCreativeTemplateVariable getDefaultInstance()
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable

getDescriptor()

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

newBuilder()

public static CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder newBuilder()
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder

newBuilder(CreativeTemplateVariable.UrlCreativeTemplateVariable prototype)

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

parseDelimitedFrom(InputStream input)

public static CreativeTemplateVariable.UrlCreativeTemplateVariable parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static CreativeTemplateVariable.UrlCreativeTemplateVariable parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static CreativeTemplateVariable.UrlCreativeTemplateVariable parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static CreativeTemplateVariable.UrlCreativeTemplateVariable parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static CreativeTemplateVariable.UrlCreativeTemplateVariable parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<CreativeTemplateVariable.UrlCreativeTemplateVariable> parser()
Returns
Type Description
Parser<UrlCreativeTemplateVariable>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreativeTemplateVariable.UrlCreativeTemplateVariable getDefaultInstanceForType()
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable

getDefaultValue()

public String getDefaultValue()

Optional. Default value to be filled in when creating creatives from the creative template.

optional string default_value = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The defaultValue.

getDefaultValueBytes()

public ByteString getDefaultValueBytes()

Optional. Default value to be filled in when creating creatives from the creative template.

optional string default_value = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for defaultValue.

getParserForType()

public Parser<CreativeTemplateVariable.UrlCreativeTemplateVariable> getParserForType()
Returns
Type Description
Parser<UrlCreativeTemplateVariable>
Overrides

getSampleValue()

public String getSampleValue()

Optional. Sample value that is used when previewing the template in the UI.

optional string sample_value = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sampleValue.

getSampleValueBytes()

public ByteString getSampleValueBytes()

Optional. Sample value that is used when previewing the template in the UI.

optional string sample_value = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sampleValue.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUrlType()

public CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType getUrlType()

Optional. The type of URL that this variable represents. Different types of URLs may be handled differently at rendering time.

optional .google.ads.admanager.v1.CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType url_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType

The urlType.

getUrlTypeValue()

public int getUrlTypeValue()

Optional. The type of URL that this variable represents. Different types of URLs may be handled differently at rendering time.

optional .google.ads.admanager.v1.CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType url_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for urlType.

hasDefaultValue()

public boolean hasDefaultValue()

Optional. Default value to be filled in when creating creatives from the creative template.

optional string default_value = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the defaultValue field is set.

hasSampleValue()

public boolean hasSampleValue()

Optional. Sample value that is used when previewing the template in the UI.

optional string sample_value = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sampleValue field is set.

hasUrlType()

public boolean hasUrlType()

Optional. The type of URL that this variable represents. Different types of URLs may be handled differently at rendering time.

optional .google.ads.admanager.v1.CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType url_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the urlType field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder newBuilderForType()
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder toBuilder()
Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder

writeTo(CodedOutputStream output)

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