Interface CreativeTemplateVariableOrBuilder (0.39.0)

public interface CreativeTemplateVariableOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssetVariable()

public abstract CreativeTemplateVariable.AssetCreativeTemplateVariable getAssetVariable()

Optional. Represents a file asset variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.AssetCreativeTemplateVariable asset_variable = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.AssetCreativeTemplateVariable

The assetVariable.

getAssetVariableOrBuilder()

public abstract CreativeTemplateVariable.AssetCreativeTemplateVariableOrBuilder getAssetVariableOrBuilder()

Optional. Represents a file asset variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.AssetCreativeTemplateVariable asset_variable = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.AssetCreativeTemplateVariableOrBuilder

getDescription()

public abstract String getDescription()

Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters.

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

Returns
Type Description
ByteString

The bytes for description.

getLabel()

public abstract String getLabel()

Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters.

optional string label = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The label.

getLabelBytes()

public abstract ByteString getLabelBytes()

Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters.

optional string label = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for label.

getListStringVariable()

public abstract CreativeTemplateVariable.ListStringCreativeTemplateVariable getListStringVariable()

Optional. Represents a list variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable list_string_variable = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariable

The listStringVariable.

getListStringVariableOrBuilder()

public abstract CreativeTemplateVariable.ListStringCreativeTemplateVariableOrBuilder getListStringVariableOrBuilder()

Optional. Represents a list variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable list_string_variable = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.ListStringCreativeTemplateVariableOrBuilder

getLongVariable()

public abstract CreativeTemplateVariable.LongCreativeTemplateVariable getLongVariable()

Optional. Represents a long variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.LongCreativeTemplateVariable long_variable = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.LongCreativeTemplateVariable

The longVariable.

getLongVariableOrBuilder()

public abstract CreativeTemplateVariable.LongCreativeTemplateVariableOrBuilder getLongVariableOrBuilder()

Optional. Represents a long variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.LongCreativeTemplateVariable long_variable = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.LongCreativeTemplateVariableOrBuilder

getRequired()

public abstract boolean getRequired()

Optional. True if this variable is required to be filled in by users when creating a creative from the creative template.

optional bool required = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The required.

getStringVariable()

public abstract CreativeTemplateVariable.StringCreativeTemplateVariable getStringVariable()

Optional. Represents a string variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.StringCreativeTemplateVariable string_variable = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.StringCreativeTemplateVariable

The stringVariable.

getStringVariableOrBuilder()

public abstract CreativeTemplateVariable.StringCreativeTemplateVariableOrBuilder getStringVariableOrBuilder()

Optional. Represents a string variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.StringCreativeTemplateVariable string_variable = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.StringCreativeTemplateVariableOrBuilder

getSubTypeCase()

public abstract CreativeTemplateVariable.SubTypeCase getSubTypeCase()
Returns
Type Description
CreativeTemplateVariable.SubTypeCase

getUniqueDisplayName()

public abstract String getUniqueDisplayName()

Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created.

optional string unique_display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uniqueDisplayName.

getUniqueDisplayNameBytes()

public abstract ByteString getUniqueDisplayNameBytes()

Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created.

optional string unique_display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uniqueDisplayName.

getUrlVariable()

public abstract CreativeTemplateVariable.UrlCreativeTemplateVariable getUrlVariable()

Optional. Represents a url variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.UrlCreativeTemplateVariable url_variable = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariable

The urlVariable.

getUrlVariableOrBuilder()

public abstract CreativeTemplateVariable.UrlCreativeTemplateVariableOrBuilder getUrlVariableOrBuilder()

Optional. Represents a url variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.UrlCreativeTemplateVariable url_variable = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTemplateVariable.UrlCreativeTemplateVariableOrBuilder

hasAssetVariable()

public abstract boolean hasAssetVariable()

Optional. Represents a file asset variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.AssetCreativeTemplateVariable asset_variable = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the assetVariable field is set.

hasDescription()

public abstract boolean hasDescription()

Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters.

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

Returns
Type Description
boolean

Whether the description field is set.

hasLabel()

public abstract boolean hasLabel()

Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters.

optional string label = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the label field is set.

hasListStringVariable()

public abstract boolean hasListStringVariable()

Optional. Represents a list variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.ListStringCreativeTemplateVariable list_string_variable = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the listStringVariable field is set.

hasLongVariable()

public abstract boolean hasLongVariable()

Optional. Represents a long variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.LongCreativeTemplateVariable long_variable = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the longVariable field is set.

hasRequired()

public abstract boolean hasRequired()

Optional. True if this variable is required to be filled in by users when creating a creative from the creative template.

optional bool required = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the required field is set.

hasStringVariable()

public abstract boolean hasStringVariable()

Optional. Represents a string variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.StringCreativeTemplateVariable string_variable = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the stringVariable field is set.

hasUniqueDisplayName()

public abstract boolean hasUniqueDisplayName()

Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created.

optional string unique_display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the uniqueDisplayName field is set.

hasUrlVariable()

public abstract boolean hasUrlVariable()

Optional. Represents a url variable defined in a creative template.

.google.ads.admanager.v1.CreativeTemplateVariable.UrlCreativeTemplateVariable url_variable = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the urlVariable field is set.