tagManager Object – API Help Center

Related Entities

Endpoints Using the tagManager Object

tagManager Resource

TagManager 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 the entity.	String	Required	TagManager
id	ID of the entity.	Long	Read-only	Auto-generated, read-only value
relationsBag	Internal.	relationsBag Object	Internal
version	Internal.	String	Internal
createdBy	ID of the user who created the entity.	Long	Read-only
createdByName	Name of the user who 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 who was the last to update the entity.	Long	Read-only
lastUpdatedByName	Name of the user who was the last to update the entity.	String	Read-only
lastUpdatedByAccount	ID of the account that was last to update the entity.	Long	Read-only
lastUpdatedByAccountName	Name of the account that was last to update the entity.	String	Read-only
lastUpdateOn	Date of the last update (date epoch).	Long	Read-only
name	Name of entity.	String	Required
advertiserId	ID of the advertiser to which the tag manager belongs.	Long	Read-only
tagManagerCode	Tag manager JavaScript code.	tagManagerCode Object	Required
rulesCount	Number of activity rules defined for the tag manager.	Integer	Read-only
conversionActivityCount	Number of conversion activities defined for the tag manager.	Integer	Read-only
retargetingActivityCount	Number of retargeting activities defined for the tag manager.	Integer	Read-only
thirdPartyActivityCount	Number of 3rd party activities defined for the tag manager.	Integer	Read-only
conversionActivityIds	Array of conversion activity IDs.	Array of long	Read-only
retargetingActivityIds	Array of retargeting activity IDs.	Array of long	Read-only
thirdPartyActivityIds	Array of 3rd party activity IDs.	Array of long	Read-only
lastPublished	Date when tag manager was published.	Date	Read-only
needPublish	Determines if the tag manager config file requires publishing.	Boolean	Read-only	If true, see Publish Tag Manager Config File.
globalData	Includes data about the advertiser, if it is a global advertiser or a local advertiser and which advertisers are global or local.	globalData Object	Optional
accessLevel	Internal.	Internal	Internal
developerScripts	Scripts that can be added to run before or after the tag manager runs.	developerScripts Object	Optional	Requires the View/Edit Tag Manager Custom Script permission.
nxtTagManagement	Flag that indicates if the activity originated in AAS.	Boolean	Read-only
allowServerToServerCalls	Enables a server to implement code to call the AAS server directly.	Boolean	Optional	Requires the Tag Manager - Allow server to server calls permission.
referralURLWithoutQueryParams	Uses criteria from a referral URL.	Boolean	Optional	When using this option, omit query string parameters in the referral URL.
tagManagerCallsIntheLast24Hours	Statistic used for analytics.	Integer	Read-only
tagManagerRuleMatchesInTheLast24Hours	Statistic used for analytics.	Integer	Read-only
tagManagerTotalCalls	Statistic used for analytics.	Integer	Read-only
tagManagerLastCall	Statistic used for analytics.	Integer	Read-only

Object JSON 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
  }
}