Variable Object – API Help Center

Related Entities

Endpoints Using the Variable Object

Variable Resource

Variable Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
type	Type of entity.	String	Required	TagManagerVariable
id	ID of variable.	Long	Read-only	Auto-generated, read-only value.
version	Internal.	String	Internal
createdBy	ID of the user that created the variable.	Long	Read-only
createdByName	Name of the user that created the entity.	String	Read-only
createdByAccount	ID of the account that created the entity.	Long	Read-only
createdByAccountName	Name of the account that created the entity.	String	Read-only
createdOn	Date of creation (date epoch).	Long	Read-only
lastUpdatedBy	ID of the user that was last to update the entity.	Long	Read-only
lastUpdatedByName	Name of the user that was last to update the entity.	String	Read-only
lastUpdatedByAccount	ID of the account that was last to update the entity.	Long	Read-only
lastUpdatedByAccountName	Parent advertiser analytics settings.	String	Read-only
lastUpdateOn	Date of last update (date epoch).	Long	Read-only
name	Name of variable.	String	Required
advertiserId	ID of the advertiser to which the variable belongs.	Long	Read-only
variableType	Type of the variable.	String	Required	View values DataLayerVariable GlobalJavascriptVariable QueryStringVariable
dataType	Type of data for the variable.	String	Required	View values String Number
variableName	Name of the variable.	String	Required
defaultValue	Defines a default value if there is no value for the variable.	String	Optional
globalData	Internal.	Internal	Internal

Object JSON Example

"result": {
    "type": "TagManagerVariable",
    "id": 1083751548,
    "version": 1552312103703609300,
    "createdBy": 1073741831,
    "createdByName": "User",
    "createdByAccount": 1073741826,
    "createdByAccountName": "Account",
    "createdOn": 1552312103706,
    "lastUpdatedBy": 1073741831,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741826,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 1552312103706,
    "name": "var3",
    "advertiserId": 1083759741,
    "variableType": "DataLayerVariable",
    "dataType": "String",
    "variableName": null,
    "defaultValue": null,
    
    "globalData": null
  }

Related Entities

Endpoints Using the Variable Object

Variable Object Definition

Note

Object JSON Example

Comments