public static final class CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder extends GeneratedMessageV3.Builder<CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder> implements CreativeTemplateVariable.UrlCreativeTemplateVariableOrBuilderRepresents 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreativeTemplateVariable.UrlCreativeTemplateVariable.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
build()
public CreativeTemplateVariable.UrlCreativeTemplateVariable build()| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable |
|
buildPartial()
public CreativeTemplateVariable.UrlCreativeTemplateVariable buildPartial()| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable |
|
clear()
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder clear()| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
clearDefaultValue()
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder clearDefaultValue()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 |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
clearSampleValue()
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder clearSampleValue()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 |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
This builder for chaining. |
clearUrlType()
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder clearUrlType()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 |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
This builder for chaining. |
clone()
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder clone()| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CreativeTemplateVariable.UrlCreativeTemplateVariable other)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder mergeFrom(CreativeTemplateVariable.UrlCreativeTemplateVariable other)| Parameter | |
|---|---|
| Name | Description |
other |
CreativeTemplateVariable.UrlCreativeTemplateVariable |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
setDefaultValue(String value)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder setDefaultValue(String value)Optional. Default value to be filled in when creating creatives from the creative template.
optional string default_value = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe defaultValue to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
This builder for chaining. |
setDefaultValueBytes(ByteString value)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder setDefaultValueBytes(ByteString value)Optional. Default value to be filled in when creating creatives from the creative template.
optional string default_value = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for defaultValue to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
setSampleValue(String value)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder setSampleValue(String value)Optional. Sample value that is used when previewing the template in the UI.
optional string sample_value = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe sampleValue to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
This builder for chaining. |
setSampleValueBytes(ByteString value)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder setSampleValueBytes(ByteString value)Optional. Sample value that is used when previewing the template in the UI.
optional string sample_value = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for sampleValue to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
|
setUrlType(CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType value)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder setUrlType(CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlTypeThe urlType to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
This builder for chaining. |
setUrlTypeValue(int value)
public CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder setUrlTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for urlType to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeTemplateVariable.UrlCreativeTemplateVariable.Builder |
This builder for chaining. |