Variable Resource – API Help Center

Resource URL

https://adapi.sizmek.com/sas/tagManagers/variables

Objects Used by This Resource

The following objects are used by this endpoint:

Variable Object

HTTP Method and URI List

HTTP METHOD	URI	DESCRIPTION
GET	/tagManagers/variables/{Id}	Retrieve a specific variable.
POST	/tagManagers/variables	Create a variable.

Method Examples and Request Parameters

Important

Important:

For PUT calls, do the following:
- For any PUT method that updates an object, make sure that you include the entire "result": object from the GET response in the request body. If there is missing information, even if it is read-only, the request might fail or override the existing fields with the new values.
- You must also change the "result": to "entities": and make the entities contents into an array. For example, here is the output from the GET request:
```
 { "result": { "type": "Advertiser", ... } }      
```
  You should make the following modifications, including your specific modifications, to the json object that you submit for the request.
```
 { "entities": [{ "type": "Advertiser", ... }] }   
```
For POST calls, do the following:
- Include the fields marked as Required, as indicated in the corresponding Object article.
- Format the JSON object as follows:
```
 { "entities": [{ "type": "Advertiser", ... }] }   
```

GET a Variable (GET)

Retrieve a specific variable.

Request Parameters

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
id	ID of the requested variable	Integer	Required

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/variables/1234567890

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the variable details. If there is no variable, the request returns an empty response.

"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
  }

Create a Variable (POST)

Create a new variable.

Request Parameters

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
Body	Request containing campaign body to create.	JSON	Required

Request Format

POST https://adapi.sizmek.com/sas/tagManagers/variables

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the new variable resource.

Resource URL

Objects Used by This Resource

HTTP Method and URI List

Method Examples and Request Parameters

Important

GET a Variable (GET)

Request Parameters

Request Format

Response Format

Create a Variable (POST)

Request Parameters

Request Format

Response Format

Comments