Console
    Start free

    Google Ads Ad Manager V1 Client - Class CreativeTemplateVariable (0.6.0)

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

    Represents a variable defined in a creative template.

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

    Namespace

    Google \ Ads \ AdManager \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ asset_variable
    CreativeTemplateVariable\AssetCreativeTemplateVariable

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

    ↳ list_string_variable
    CreativeTemplateVariable\ListStringCreativeTemplateVariable

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

    ↳ long_variable
    CreativeTemplateVariable\LongCreativeTemplateVariable

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

    ↳ string_variable
    CreativeTemplateVariable\StringCreativeTemplateVariable

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

    ↳ url_variable
    CreativeTemplateVariable\UrlCreativeTemplateVariable

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

    ↳ label
    string

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

    ↳ unique_display_name
    string

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

    ↳ description
    string

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

    ↳ required
    bool

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

    getAssetVariable

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

    Returns
    Type
    Description
    CreativeTemplateVariable\AssetCreativeTemplateVariable |null

    hasAssetVariable

    setAssetVariable

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

    Parameter
    Name
    Description
    var
    CreativeTemplateVariable\AssetCreativeTemplateVariable
    Returns
    Type
    Description
    $this

    getListStringVariable

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

    Returns
    Type
    Description
    CreativeTemplateVariable\ListStringCreativeTemplateVariable |null

    hasListStringVariable

    setListStringVariable

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

    Parameter
    Name
    Description
    var
    CreativeTemplateVariable\ListStringCreativeTemplateVariable
    Returns
    Type
    Description
    $this

    getLongVariable

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

    Returns
    Type
    Description
    CreativeTemplateVariable\LongCreativeTemplateVariable |null

    hasLongVariable

    setLongVariable

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

    Parameter
    Name
    Description
    var
    CreativeTemplateVariable\LongCreativeTemplateVariable
    Returns
    Type
    Description
    $this

    getStringVariable

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

    Returns
    Type
    Description
    CreativeTemplateVariable\StringCreativeTemplateVariable |null

    hasStringVariable

    setStringVariable

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

    Parameter
    Name
    Description
    var
    CreativeTemplateVariable\StringCreativeTemplateVariable
    Returns
    Type
    Description
    $this

    getUrlVariable

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

    Returns
    Type
    Description
    CreativeTemplateVariable\UrlCreativeTemplateVariable |null

    hasUrlVariable

    setUrlVariable

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

    Parameter
    Name
    Description
    var
    CreativeTemplateVariable\UrlCreativeTemplateVariable
    Returns
    Type
    Description
    $this

    getLabel

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

    Returns
    Type
    Description
    string

    hasLabel

    clearLabel

    setLabel

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getUniqueDisplayName

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

    Returns
    Type
    Description
    string

    hasUniqueDisplayName

    clearUniqueDisplayName

    setUniqueDisplayName

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

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

    Returns
    Type
    Description
    string

    hasDescription

    clearDescription

    setDescription

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRequired

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

    Returns
    Type
    Description
    bool

    hasRequired

    clearRequired

    setRequired

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

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getSubType

    Returns
    Type
    Description
    string
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: