Submit a request
 
PRODUCT
Privacy Policy |  AAS Advertising Policy | Terms of Use
Cookie Preference
✖

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Please note that on October 1, 2024, the ability to create new campaigns, placements, and tag managers will be disabled.

Follow
Last Update:
  viewable by end users
  editable by agents

Resource URL

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

Objects Used by This Resource

The following objects are used by this endpoint:

HTTP Method and URI List

HTTP METHOD

URI

DESCRIPTION

GET

/tagManagers

Retrieves all tag managers by advertiser ID.

GET

/tagManagers/{id}

Retrieves a tag manager by ID.

POST

/tagManagers

Creates a new tag manager.

PUT

/tagManagers/{id}

Updates an existing tag manager.

DELETE

/tagManagers/{id}

Deletes one tag manager.

DELETE

/tagManagers/delete

Deletes one or more tag managers.

GET

/tagmanagers/generateTag/{id}

Generates JavaScript code for a tag manager.

GET

/tagManagers/generateNoScriptTag/{id}

Generates NoScript code for a tag manager.

PUT

/tagManagers/publishConfigFile/{id}

Publishes the tag manager config file.

GET

/tagManagers/getTagManagersByEntity

Finds tag managers by entity ID.

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 all Tag Managers (GET)

Retrieves multiple Tag Managers. Can be filtered according to query parameters.

Request Query Parameters

Name

Description

Type

Required

Notes

from

Starting index by which to fetch new tag managers for paging purposes.

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of tag managers to fetch for each page.

Long

Required

q

Filtering options for the request (see here).

String

Optional

Example of query string: q={"1":{"CREATEDBYNAME":["MonicaSmith"]},"2":{"ADVERTISERNAME":["autoads"]}}

Note

Note: The date is according to the Unix epoch timestamp.

View values

NAME

DESCRIPTION

TYPE

NAME

Name of tag manager.

String

ID

ID of tag manager.

Long

ADVERTISER

ID of the advertiser to which the tag manager belongs.

Long

ACCOUNT

ID of the account to which the tag manager belongs.

Long

CREATEDBY

ID of the user that created the tag manager.

Long

UPDATEDBY

ID of the user that was last to update the tag manager.

Long

CREATEDON

Date tag manager was created.

Long

UPDATEDON

Date of last update (Date epoch).

Long

order

Sort order ASC or DESC, required if sort field name is specified (see here).

String

Optional

Note

Note: Required if a sort field name is specified.

By default, the API response is ascending.

sort

Sort by field name (see here).

String

Optional

advertiserID

Advertiser ID from which to retrieve tag manager.

Long

Optional

enrichWithEntitiesCounts

Determines whether to enrich tag manager with related entities' counts.

Boolean

Optional

Specify true if counts are required; otherwise, counts will be zero and performance is improved.

Request Format

GET https://adapi.sizmek.com/sas/tagManagers?from=0&max=250

Response Format

Example
{
  "result": [{
    "type": "TagManager",
    "id": 1083761655,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 1073744288,
          "name": "AccountDemo0",
          "internal": false
        },
        "advertiser": {
          "id": 1083762304,
          "name": "adv3333"
        },
        "brand": null,
        "campaign": null,
        "site": null
      },
      "children": {
        "advertisers": {
          "count": 0
        },
        "brands": {
          "count": 0
        },
        "campaigns": {
          "count": 0
        },
        "users": {
          "count": 0
        }
      },
      "creativeAccountContact": false
    },
    "version": 1561623586382610400,
    "createdBy": 1073741831,
    "createdByName": "User",
    "createdByAccount": 1073741826,
    "createdByAccountName": "Account",
    "createdOn": 1561623586375,
    "lastUpdatedBy": 1073741831,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741826,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 1561623586375,
    "name": "tag manager",
    "advertiserId": 1083762304,
    "tagManagerCode": {
      "type": "TagManagerCode",
      "protocol": "HTTPS",
      "thirdPartyRunsOn": "js",
      "loadingMethod": "Asynchronous",
      "removeCodeComments": false,
      "codeGenerationMode": "Partial",
      "dataLayerObjectName": "SizmekDataLayer"
    },
    "rulesCount": 0,
    "conversionActivityCount": 0,
    "retargetingActivityCount": 0,
    "thirdPartyActivityCount": 0,
    "conversionActivityIds": [],
    "retargetingActivityIds": [],
    "thirdPartyActivityIds": [],
    "lastPublished": null,
    "needPublish": true,
    "globalData": {
      "type": "GlobalData",
      "status": "Global",
      "global": {
        "type": "GlobalEntityData",
        "allowUserAccessToLocalAdvertisers": false,
        "localAdvertisers": [
          {
            "type": "AdvertiserIdName",
            "id": 1073747395,
            "name": "!!!eidanAdvertiser11072017",
            "accountId": 1073746545,
            "accountName": "Testing Account",
            "hasGlobalTagManagerPermissionAccess": true
          }
        ]
      },
      "local": null
    },
    "accessLevel": "Full",
    "developerScripts": {
      "type": "DeveloperScripts",
      "preScriptEnable": true,
      "preScript": "<script type='text/javascript'>ff</script>",
      "postScriptEnable": true,
      "postScript": "<script type='text/javascript'>fff</script>"
    },
    "nxtTagManagement": true,
    "allowServerToServerCalls": true,
    "referralUrlWithoutQueryParams": true,
    "tagManagerCallsInTheLast24Hours": null,
    "tagManagerRuleMatchesInTheLast24Hours": null,
    "tagManagerTotalCalls": null,
    "tagManagerLastCall": null
  }
}
]
}

Note

Note: Returns tag managers filtered by data ownership, all tag managers under the specific advertiser with sufficient data ownership rights, or an empty response.

GET a Tag Manager (GET)

Retrieves a tag manager by ID.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of tag manager to fetch.

Long

Required

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/{id}

Response Format

Example
{
  "result": {
    "type": "TagManager",
    "id": 1083761655,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 1073744288,
          "name": "AccountDemo0",
          "internal": false
        },
        "advertiser": {
          "id": 1083762304,
          "name": "adv3333"
        },
        "brand": null,
        "campaign": null,
        "site": null
      },
      "children": {
        "advertisers": {
          "count": 0
        },
        "brands": {
          "count": 0
        },
        "campaigns": {
          "count": 0
        },
        "users": {
          "count": 0
        }
      },
      "creativeAccountContact": false
    },
    "version": 1561623586382610400,
    "createdBy": 1073741831,
    "createdByName": "User",
    "createdByAccount": 1073741826,
    "createdByAccountName": "Account",
    "createdOn": 1561623586375,
    "lastUpdatedBy": 1073741831,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741826,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 1561623586375,
    "name": "tag manager",
    "advertiserId": 1083762304,
    "tagManagerCode": {
      "type": "TagManagerCode",
      "protocol": "HTTPS",
      "thirdPartyRunsOn": "js",
      "loadingMethod": "Asynchronous",
      "removeCodeComments": false,
      "codeGenerationMode": "Partial",
      "dataLayerObjectName": "SizmekDataLayer"
    },
    "rulesCount": 0,
    "conversionActivityCount": 0,
    "retargetingActivityCount": 0,
    "thirdPartyActivityCount": 0,
    "conversionActivityIds": [],
    "retargetingActivityIds": [],
    "thirdPartyActivityIds": [],
    "lastPublished": null,
    "needPublish": true,
    "globalData": {
      "type": "GlobalData",
      "status": "Global",
      "global": {
        "type": "GlobalEntityData",
        "allowUserAccessToLocalAdvertisers": false,
        "localAdvertisers": [
          {
            "type": "AdvertiserIdName",
            "id": 1073747395,
            "name": "Name",
            "accountId": 1073746545,
            "accountName": Testing Account",
            "hasGlobalTagManagerPermissionAccess": true
          }
        ]
      },
      "local": null
    },
    "accessLevel": "Full",
    "developerScripts": {
      "type": "DeveloperScripts",
      "preScriptEnable": true,
      "preScript": "<script type='text/javascript'>ff</script>",
      "postScriptEnable": true,
      "postScript": "<script type='text/javascript'>fff</script>"
    },
    "nxtTagManagement": true,
    "allowServerToServerCalls": true,
    "referralUrlWithoutQueryParams": true,
    "tagManagerCallsInTheLast24Hours": null,
    "tagManagerRuleMatchesInTheLast24Hours": null,
    "tagManagerTotalCalls": null,
    "tagManagerLastCall": null
  }
}

Create a Tag Manager (POST)

Create a Tag Manager.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing tag manager body to create.

JSON

Required

Request Format

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

Example
{
  "entities": [
    {
      "type": "TagManager",
      "name": "TestTM2",
      "advertiserId": "1083762304",
      "tagManagerCode": {
        "type": "TagManagerCode",
        "protocol": "HTTPS",
        "dataLayerObjectName": "SizmekDataLayer",
        "thirdPartyRunsOn": "js"
      },
      "accessLevel": "Full",
      "referralUrlWithoutQueryParams": false,
      "developerScripts": {
        "type": "DeveloperScripts",
        "preScriptEnable": false,
        "postScriptEnable": false,
        "preScript": null,
        "postScript": null
      },
      "advertiserName": "adv3333"
    }
  ]
}

Response Format

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

Update a Tag Manager (PUT)

Updates an existing tag manager.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of the tag manager.

Long

Required

Body

Request containing tag manager body to update.

JSON

Required

Request Format

PUT https://adapi.sizmek.com/sas/tagManagers/{id}

Example
{
 "entities": [
   {
    "type": "TagManager",
    "id": 1083761655,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 1073744288,
          "name": "AccountDemo0",
          "internal": false
        },
        "advertiser": {
          "id": 1083762304,
          "name": "adv3333"
        },
        "brand": null,
        "campaign": null,
        "site": null
      },
      "children": {
        "advertisers": {
          "count": 0
        },
        "brands": {
          "count": 0
        },
        "campaigns": {
          "count": 0
        },
        "users": {
          "count": 0
        }
      },
      "creativeAccountContact": false
    },
    "version": 1561623586382610400,
    "createdBy": 1073741831,
    "createdByName": "User",
    "createdByAccount": 1073741826,
    "createdByAccountName": "Account",
    "createdOn": 1561623586375,
    "lastUpdatedBy": 1073741831,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741826,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 1561623586375,
    "name": "tag manager",
    "advertiserId": 1083762304,
    "tagManagerCode": {
      "type": "TagManagerCode",
      "protocol": "HTTPS",
      "thirdPartyRunsOn": "js",
      "loadingMethod": "Asynchronous",
      "removeCodeComments": false,
      "codeGenerationMode": "Partial",
      "dataLayerObjectName": "SizmekDataLayer"
    },
    "rulesCount": 0,
    "conversionActivityCount": 0,
    "retargetingActivityCount": 0,
    "thirdPartyActivityCount": 0,
    "conversionActivityIds": [],
    "retargetingActivityIds": [],
    "thirdPartyActivityIds": [],
    "lastPublished": null,
    "needPublish": true,
    "globalData": {
      "type": "GlobalData",
      "status": "Global",
      "global": {
        "type": "GlobalEntityData",
        "allowUserAccessToLocalAdvertisers": false,
        "localAdvertisers": [
          {
            "type": "AdvertiserIdName",
            "id": 1073747395,
            "name": "Name",
            "accountId": 1073746545,
            "accountName": "Testing Account",
            "hasGlobalTagManagerPermissionAccess": true
          }
        ]
      },
      "local": null
    },
    "accessLevel": "Full",
    "developerScripts": {
      "type": "DeveloperScripts",
      "preScriptEnable": true,
      "preScript": "<script type='text/javascript'>ff</script>",
      "postScriptEnable": true,
      "postScript": "<script type='text/javascript'>fff</script>"
    },
    "nxtTagManagement": true,
    "allowServerToServerCalls": true,
    "referralUrlWithoutQueryParams": true,
    "tagManagerCallsInTheLast24Hours": null,
    "tagManagerRuleMatchesInTheLast24Hours": null,
    "tagManagerTotalCalls": null,
    "tagManagerLastCall": null
  }
 ]
}

Delete a Tag Manger (DELETE)

Deletes a single tag manager.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of tag manager to delete.

Long

Required

Request Format

DELETE https://adapi.sizmek.com/sas/tagManagers/{id}

Response Format

A successful request returns the HTTP 200 OK status code; the requested tag manager is deleted.

Delete Multiple Tag Managers (DELETE)

Deletes multiple tag managers.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

IDs of tag managers to delete.

Array of long

Required

Request Format

DELETE https://adapi.sizmek.com/sas/tagManagers/delete

Example
{  
   "entities":[  
      1073748333,
      1083745645
   ]
}

Response Format

A successful request returns the HTTP 200 OK status code; the requested tag managers are deleted.

Generate JavaScript Code for a Tag Manager (GET)

Generates JavaScript code for a tag manager.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of the tag manager.

Long

Required

protocol

Protocol of the tag. HTTPS is the default value.

String

Required
View protocol values

  • HTTP

  • HTTPS

dataLayer

Name of the data layer used to pass parameters.

String

Required

thirdPartyRunsOn

Response type that the Amazon Ad Server (AAS) server returns to the page. This response includes both 3rd party tags and other proprietary AAS scripts. JavaScript is the default value.

String

Required
View thirdPartyRunsOn values

  • js

  • iFrame

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/generateTag/{id}

Response Format

Sample JavaScript code with specified settings.

Generate NoScript Code for a Tag Manager (GET)

Generates NoScript code for a tag manager.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

protocol

Protocol of the tag. HTTPS is the default value.

String

Required
View protocol values

  • HTTP

  • HTTPS

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/generateNoScriptTag/{id}

Response Format

Sample JavaScript code with specified settings.

Publish Tag Manager Config File (PUT)

Publishes the tag manager config file.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

IDs of tag managers to publish.

Array of long

Required

Request Format

Request URL: PUT https://adapi.sizmek.com/sas/tagManagers/publishConfigFile?tagmanagerId={id}

Body URL: PUT https://adapi.sizmek.com/sas/tagManagers/publishConfigFile

Response Format

A successful request returns the HTTP 200 OK status code; the requested tag manager is published.

Find Tag Managers by Entity ID (GET)

Retrieves tag managers by ID of an entity.

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/getTagManagersByEntity?entityId=1083753345&entityType=TagManagerVariable&from=0&max=250&order=asc&sort=name

Response Format

A successful request returns the HTTP 200 OK status code with a list of tag managers that include the entity.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments