Google Ads Ad Manager V1 Client - Class UrlCreativeTemplateVariable (0.5.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class UrlCreativeTemplateVariable.

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.

Generated from protobuf message google.ads.admanager.v1.CreativeTemplateVariable.UrlCreativeTemplateVariable

Namespace

Google \ Ads \ AdManager \ V1 \ CreativeTemplateVariable

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ default_value string

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

↳ sample_value string

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

↳ url_type int

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

getDefaultValue

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

Returns
Type Description
string

hasDefaultValue

clearDefaultValue

setDefaultValue

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSampleValue

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

Returns
Type Description
string

hasSampleValue

clearSampleValue

setSampleValue

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

Parameter
Name Description
var string
Returns
Type Description
$this

getUrlType

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

Returns
Type Description
int

hasUrlType

clearUrlType

setUrlType

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

Parameter
Name Description
var int
Returns
Type Description
$this