PRODUCT
Follow

Resource URL

Depending on the API user that was created for you, use one of the following URLs:

  • https://api.sizmek.com/rest/tagManagers

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

Note

Note: Confirm with your Sizmek customer success manager regarding the correct URL to use.

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.

POST

/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:

    • We recommend that for any PUT method that updates an object, 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.

    • 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.

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

Depending on the API user that was created for you, use one of the following URLs:

  • GET https://api.sizmek.com/rest/tagManagers?from=0&max-250

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

Response Format

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

Depending on the API user that was created for you, use one of the following URLs:

  • GET https://api.sizmek.com/rest/tagManagers/{id}

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

Response Format

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

Depending on the API user that was created for you, use one of the following request formats:

  • POST https://api.sizmek.com/rest/tagManagers

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

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

Depending on the API user that was created for you, use one of the following request formats:

  • PUT https://api.sizmek.com/rest/tagManagers/{id}

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

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

Depending on the API user that was created for you, use one of the following request formats:

  • DELETE https://api.sizmek.com/rest/tagManagers/{id}

  • 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 (POST)

Deletes multiple tag managers.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

IDs of tag managers to delete.

Array of long

Required

Request Format

Depending on the API user that was created for you, use one of the following URLs:

  • POST https://api.sizmek.com/rest/tagManagers/delete

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

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

dataLayer

Name of the data layer used to pass parameters.

String

Required

thirdPartyRunsOn

Response type that the Sizmek Advertising Suite server returns to the page. This response includes both 3rd party tags and other proprietary Sizmek scripts. JavaScript is the default value.

String

Required

Request Format

Depending on the API user that was created for you, use one of the following request formats:

  • GET https://api.sizmek.com/rest/tagManagers/generateTag/{id}

  • 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

Request Format

Depending on the API user that was created for you, use one of the following request formats:

  • https://api.sizmek.com/rest/tagManagers/generateNoScriptTag/{id}

  • 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 delete.

Array of long

Required

Request Format

Depending on the API user that was created for you, use one of the following request formats:

  • PUT https://api.sizmek.com/rest/tagManagers/publishConfigFile

  • 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

Depending on the API user that was created for you, use one of the following request formats:

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

  • 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

Powered by Zendesk