Tag Manager API - Tag Dictionary Reference

This document describes the parameters that can be set for Google Tag Manager tags.

Introduction

Each Google Tag Manager Tag has a type code to identify the tag. In addition, most tags have parameters (key, type pairs) that you can set as part of a "parameter object" when you create or update a tag. To learn more about how to set these parameters using a parameter object see the Parameter Reference.

The remainder of this document lists the details of all supported tags for Web and Mobile.

Web Tags

Custom HTML Tag

Type code

html

Parameters
Key Type
html template
convertJsValuesToExpressions boolean
usePostscribe boolean
Example
{
  "liveOnly": false,
  "name": "Sample Custom HTML",
  "parameter": [
    {
      "key": "html",
      "type": "template",
      "value": "<script>alert('hello world')</script>"
    },
    {
      "key": "convertJsValuesToExpressions",
      "type": "boolean",
      "value": "true"
    },
    {
      "key": "usePostscribe",
      "type": "boolean",
      "value": "false"
    }
  ],
  "type": "html"
}

Custom Image Tag

Type code

img

Parameters
Key Type
useCacheBuster boolean
url template
cacheBusterQueryParam template
Example
{
  "liveOnly": false,
  "name": "Sample Custom Image Tag",
  "parameter": [
    {
      "key": "useCacheBuster",
      "type": "boolean",
      "value": "true"
    },
    {
      "key": "url",
      "type": "template",
      "value": "//{{a}}"
    },
    {
      "key": "cacheBusterQueryParam",
      "type": "template",
      "value": "gtmcb"
    }
  ],
  "type": "img"
}

Event Listeners

Link Click Listener

Type code

lcl

Parameters
Key Type Notes
checkValidation boolean
waitForTags boolean
waitForTagsTimeout template Number of milliseconds.
Specify when waitForTags=true.
Example
{
   "name": "Sample Link Click Listener",
   "liveOnly": false,
   "parameter": [
    {
     "type": "boolean",
     "key": "waitForTags",
     "value": "true"
    },
    {
     "type": "boolean",
     "key": "checkValidation",
     "value": "true"
    },
    {
     "type": "template",
     "key": "waitForTagsTimeout",
     "value": "2000"
    }
   ],
   "type": "lcl",
  }

Form Submit Listener

Type code

fsl

Parameters
Key Type Notes
waitForTags boolean
checkValidation boolean
waitForTagsTimeout template Number of milliseconds.
Specify when waitForTags=true.
Example
{
  "liveOnly": false,
  "name": "Sample Form Submit Listener",
  "parameter": [
    {
      "key": "waitForTags",
      "type": "boolean",
      "value": "false"
    },
    {
      "key": "checkValidation",
      "type": "boolean",
      "value": "false"
    }
  ],
  "type": "fsl"
}

Click Listener

Type code

cl

Parameters

N/A

Example
{
  "liveOnly": false,
  "name": "Sample Click Listener",
  "type": "cl"
}

Timer Listener

Type code

tl

Parameters
Key Type Notes
eventName template
interval template Number of milliseconds
limit template Maximum number of times to fire
Example
{
  "liveOnly": false,
  "name": "Sample Timer Listener",
  "parameter": [
    {
      "key": "eventName",
      "type": "template",
      "value": "gtm.timer"
    },
    {
      "key": "interval",
      "type": "template",
      "value": "{{a}}"
    },
    {
      "key": "limit",
      "type": "template",
      "value": "5"
    }
  ],
  "type": "tl"
}

JavaScript Error Listener

Type code

jel

Parameters

N/A

Example
{
  "liveOnly": false,
  "name": "Sample JavaScript Error Listener",
  "type": "jel"
}

History Listener

Type code

hl

Parameters

N/A

Example
{
  "liveOnly": false,
  "name": "Sample History Listener",
  "type": "hl"
}

Display Ad Tracking

Floodlight Counter

Type code

flc

Parameters
Key Type Notes
ordinalType template One of STANDARD, UNIQUE, SESSION
advertiserId template
groupTag template
activityTag template
useImageTag boolean
customVariable list [key, value] pairs
userVariable template The tag's u= variable.
transactionVariable template The tag's tran= variable.
sessionId template Specify if ordinalType is SESSION.
Example
{
  "liveOnly": false,
  "name": "Sample Floodlight Counter",
  "parameter": [
    {
      "key": "ordinalType",
      "type": "template",
      "value": "STANDARD"
    },
    {
      "key": "advertiserId",
      "type": "template",
      "value": "{{a}}"
    },
    {
      "key": "groupTag",
      "type": "template",
      "value": "{{b}}"
    },
    {
      "key": "activityTag",
      "type": "template",
      "value": "{{c}}"
    },
    {
      "key": "useImageTag",
      "type": "boolean",
      "value": "false"
    },
    {
      "key": "customVariable",
      "type": "list"
 "list": [
     {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "key",
         "value": "u2"
        },
        {
         "type": "template",
         "key": "value",
         "value": "u2_custom_var"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "key",
         "value": "u1"
        },
        {
         "type": "template",
         "key": "value",
         "value": "u1_custom_var"
        }
     ]
    },
    {
      "key": "userVariable",
      "type": "template",
      "value": ""
    },
    {
      "key": "transactionVariable",
      "type": "template",
      "value": ""
    },
    {
     "type": "template",
     "key": "sessionId",
     "value": "MySessionId"
    }
  ],
  "type": "flc"
}

Floodlight Sales

Type code

fls

Parameters
Key Type Notes
countingMethod template One of TRANSACTIONS, ITEM_SOLD
advertiserId template
groupTag template
activityTag template
revenue template
orderId template
useImageTag boolean
customVariable map A list of maps, each with a single [key, value] pair.
userVariable template The tag's u= variable.
transactionVariable template The tag's tran= variable.
quantity template Specify if countingMethod is ITEM_SOLD
Example
{
   "name": "Sample Floodlight Sales Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "countingMethod",
     "value": "TRANSACTIONS"
    },
    {
     "type": "template",
     "key": "advertiserId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "groupTag",
     "value": "{{b}}"
    },
    {
     "type": "template",
     "key": "activityTag",
     "value": "{{c}}"
    },
    {
     "type": "template",
     "key": "revenue",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "orderId",
     "value": "{{b}}"
    },
    {
     "type": "boolean",
     "key": "useImageTag",
     "value": "false"
    },
    {
     "type": "map",
     "key": "customVariable",
     "map": [
      {
       "type": "template",
       "key": "u2",
       "value": "u2_custom_var"
      },
      {
       "type": "template",
       "key": "u1",
       "value": "u1_custom_var"
      }
     ]
    },
    {
     "type": "template",
     "key": "userVariable",
     "value": "u_var"
    },
    {
     "type": "template",
     "key": "transactionVariable",
     "value": "tran_var"
    }
   ],
   "type": "fls"
  }

Mediaplex - IFRAME MCT Tag

Type code

mpm

Parameters
Key Type Notes
placementId template
roiName template
pageName template
uniqueUserId template Optional.
Example
{
   "name": "Sample Mediaplex IFRAME MCT Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "placementId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "roiName",
     "value": "1"
    },
    {
     "type": "template",
     "key": "pageName",
     "value": "{{a}}"
    }
   ],
   "type": "mpm"
  }

Mediaplex - Standard IMG ROI Tag

Type code

mpr

Parameters
Key Type Notes
placementId template
roiName template
uniqueUserId template Optional.
Example
{
   "name": "Sample Mediaplex Standard IMG ROI Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "placementId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "roiName",
     "value": "1"
    },
    {
     "type": "template",
     "key": "uniqueUserId",
     "value": "MyUniqueId"
    }
   ],
   "type": "mpr"
  }

Turn Conversion Tracking

Type code

tc

Parameters
Key Type Notes
customerId template Data Contract ID
orderId template Optional.
orderValue template Optional.
optOut template Optional.
Example
{
   "name": "Sample Turn Conversion Tracking",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "customerId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "orderId",
     "value": "MyOrderId"
    },
    {
     "type": "template",
     "key": "orderValue",
     "value": "MyOrderValue"
    },
    {
     "type": "template",
     "key": "optOut",
     "value": "MyOptOut"
    }
   ],
   "type": "tc"
  }

Remarketing

AdRoll Smart Pixel

Type code

asp

Parameters
Key Type Notes
customerId template adroll_adv_id
pixelId template adroll_pix_id
conversionValueInDollars template Optional.
customData map Optional. A list of maps, each with a single [key, value] pair.
segmentName template Optional.
Example
{
   "name": "Sample AdRoll Smart Pixel",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "customerId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "pixelId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "conversionValueInDollars",
     "value": "conversionValue"
    },
    {
     "type": "map",
     "key": "customData",
     "map": [
      {
       "type": "template",
       "key": "key2",
       "value": "World"
      },
      {
       "type": "template",
       "key": "key1",
       "value": "Hello"
      }
     ]
    },
    {
     "type": "template",
     "key": "segmentName",
     "value": "SegmentName"
    }
   ],
   "type": "asp"
  }

Google Ads Remarketing

Type code

sp

Parameters
Key Type Notes
googleConversionId template
googleConversionLabel template Optional.
customParamsFormat template One of DATA_LAYER, USER_SPECIFIED
dataLayerVariable template For customParamsFormat = DATA_LAYER
googleCustomParams list For customParamsFormat = USER_SPECIFIED
googleScreenName template Optional.
Example

Where customParamFormat = DATA_LAYER:

{
   "name": "Sample Google Ads Remarketing",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "googleConversionId",
     "value": "{{c}}"
    },
    {
     "type": "template",
     "key": "googleConversionLabel",
     "value": "MyLabel"
    },
    {
     "type": "template",
     "key": "customParamsFormat",
     "value": "DATA_LAYER"
    },
    {
     "type": "template",
     "key": "dataLayerVariable",
     "value": "{{e}}"
    }
   ],
   "type": "sp"
  }

Where customParamFormat = USER_SPECIFIED:

{
   "name": "Sample Google Ads Remarketing",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "googleConversionId",
     "value": "{{c}}"
    },
    {
     "type": "template",
     "key": "googleConversionLabel",
     "value": "MyLabel"
    },
    {
     "type": "template",
     "key": "customParamsFormat",
     "value": "USER_SPECIFIED"
    },
    {
     "type": "list",
     "key": "googleCustomParams",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "key",
         "value": "key2"
        },
        {
         "type": "template",
         "key": "value",
         "value": "World"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "key",
         "value": "key1"
        },
        {
         "type": "template",
         "key": "value",
         "value": "Hello"
        }
       ]
      }
     ]
    }
   ],
   "type": "sp"
  }

Turn Data Collection

Type code

tdc

Parameters
Key Type Notes
customerId template
categoryId template Optional.
keyword template Optional.
dataProviderId template Optional.
optOut template Optional.
Example
{
   "name": "Sample Turn Data Collection Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "customerId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "categoryId",
     "value": "myCategoryId"
    },
    {
     "type": "template",
     "key": "keyword",
     "value": "myKeyword"
    },
    {
     "type": "template",
     "key": "dataProviderId",
     "value": "myDataProviderId"
    },
    {
     "type": "template",
     "key": "optOut",
     "value": "myOptOut"
    }
   ],
   "type": "tdc"
  }

See Google Ads Conversion Tracking under Mobile Tags

Marin Software

Type code

ms

Parameters
Key Type Notes
type template One of TRACK_PAGEVIEW, TRACK_TRANSACTION
clientId template
anonymizeIp boolean Optional.
conversionType template For type = TRACK_TRANSACTION.
useDataLayer boolean For type = TRACK_TRANSACTION
orderId template For useDataLayer = false
product template For useDataLayer = false
price template For useDataLayer = false
category template For useDataLayer = false
quantity template For useDataLayer = false
currencyCode template For useDataLayer = false
Example

Where type=TRACK_PAGEVIEW:

{
   "name": "Sample Marin Software Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "type",
     "value": "TRACK_PAGEVIEW"
    },
    {
     "type": "template",
     "key": "clientId",
     "value": "Client ID"
    },
    {
     "type": "boolean",
     "key": "anonymizeIp",
     "value": "false"
    }
   ],
   "type": "ms"
  }

Where type = TRACK_TRANSACTION and useDataLayer = true:

{
   "name": "Sample Marin Software Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "type",
     "value": "TRACK_TRANSACTION"
    },
    {
     "type": "template",
     "key": "clientId",
     "value": "Client ID"
    },
    {
     "type": "template",
     "key": "conversionType",
     "value": "myConversionType"
    },
    {
     "type": "boolean",
     "key": "anonymizeIp",
     "value": "false"
    },
    {
     "type": "boolean",
     "key": "useDataLayer",
     "value": "true"
    }
   ],
   "type": "ms"
  }

Where type = TRACK_TRANSACTION and useDataLayer = false:

{
   "name": "Sample Marin Software Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "type",
     "value": "TRACK_TRANSACTION"
    },
    {
     "type": "template",
     "key": "clientId",
     "value": "Client ID"
    },
    {
     "type": "template",
     "key": "conversionType",
     "value": "myConversionType"
    },
    {
     "type": "boolean",
     "key": "anonymizeIp",
     "value": "false"
    },
    {
     "type": "template",
     "key": "orderId",
     "value": "myOrderId"
    },
    {
     "type": "template",
     "key": "product",
     "value": "myProduct"
    },
    {
     "type": "template",
     "key": "price",
     "value": "myPrice"
    },
    {
     "type": "template",
     "key": "category",
     "value": "myCategory"
    },
    {
     "type": "template",
     "key": "quantity",
     "value": "myQuantity"
    },
    {
     "type": "template",
     "key": "currencyCode",
     "value": "myCurrencyCode"
    },
    {
     "type": "boolean",
     "key": "useDataLayer",
     "value": "false"
    }
   ],
   "type": "ms"
  }

Audience

AdAdvisor

Type code

_ta

Parameters
Key Type
subscriberId template
Example
  {
   "name": "Sample AdAdvisor Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "subscriberId",
     "value": "{{a}}"
    }
   ],
   "type": "_ta",
  }

Bizo Insight

Type code

bzi

Parameters
Example
 {
   "name": "Sample Bizo Insight Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "id",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "title",
     "value": "myTitle"
    },
    {
     "type": "template",
     "key": "domain",
     "value": "myDomain"
    },
    {
     "type": "template",
     "key": "company",
     "value": "myCompany"
    },
    {
     "type": "template",
     "key": "location",
     "value": "myLocation"
    },
    {
     "type": "template",
     "key": "employeeRange",
     "value": "myEmployeeRange"
    },
    {
     "type": "template",
     "key": "standardIndustrialClassification",
     "value": "mySICS"
    },
    {
     "type": "template",
     "key": "email",
     "value": "myEmail"
    }
   ],
   "type": "bzi"
  }

Dstillery Universal Pixel

Type code

m6d

Parameters
Key Type Notes
id template
title template Optional.
domain template Optional.
company template Optional.
location template Optional.
employeeRange template Optional.
standardIndustrialClassification template Optional.
email template Optional.
Key Type Notes
pixelId template
pixelCheckValue template
orderId template Optional.
revenue template Optional.
namespaceId template
namespaceCheckValue template
namespaceCode template
Example
  {
   "name": "Sample Dstillery Pixel Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "pixelId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "pixelCheckValue",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "orderId",
     "value": "myOrderId"
    },
    {
     "type": "template",
     "key": "revenue",
     "value": "myRevenue"
    },
    {
     "type": "template",
     "key": "namespaceId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "namespaceCheckValue",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "namespaceCode",
     "value": "{{a}}"
    }
   ],
   "type": "m6d"
  }

VisualDNA Conversion Tag

Type code

vdc

Parameters
Key Type Notes
apiAccountKey template
conversionId template
identitySyncPlatformCode template Optional.
Example
  {
   "name": "Sample Visual DNA Conversion Tag",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "apiAccountKey",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "conversionId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "identitySyncPlatformCode",
     "value": "mySyncPlatformCode"
    }
   ],
   "type": "vdc"
  }

Analytics

Universal Analytics

Type code

ua

Parameters
Key Type Notes
trackingId template
type template One of: TRACK_PAGEVIEW, TRACK_EVENT, TRACK_TRANSACTION, TRACK_SOCIAL, TRACK_TIMING, DECORATE_LINK, DECORATE_FORM.
contentGroup list Optional. List of maps, each with an index key and a group key.
dimension list Optional. List of maps, each with an index key and a dimension key.
metric list Optional. List of maps, each with an index key and a metric key.
functionName template Optional.
fieldsToSet map Optional. Each parameter in the list is a map; each map parameter should have two sub-parameters: one with key fieldName and one with key value. The following fields are now only accessible using fieldsToSet: anonymizeIp, sessionControl, referrer, page, title (formerly named documentTitle), cookieName, cookieDomain, sampleRate, cookieExpires (formerly named cookieExpiration), cookiePath, forceSSL (formerly named forceSsl), allowLinker.
doubleClick boolean Optional.
trackerName template Optional. trackerName can be specified when setTrackerName == true.
useDebugVersion boolean Optional.
autoLinkDomains template Optional. This field can be specified for TRACK_PAGEVIEW.
linkId template Optional. Enable enhanced link attribution.
decorateFormsAutoLink boolean Optional. This field can be specified for TRACK_PAGEVIEW.
setTrackerName boolean Optional.
useHashAutoLink boolean Optional.
enableEcommerce boolean Optional.
useEcommerceDataLayer boolean Optional. This can only be specified for eventType=TRACK_EVENT and/or TRACK_PAGEVIEW.
ecommerceMacroData template Optional. This can only be specified for eventType=TRACK_EVENT and/or TRACK_PAGEVIEW and when useEcommerceDataLayer=false.
eventCategory template For eventType=TRACK_EVENT
eventAction template For eventType=TRACK_EVENT
eventLabel template For eventType=TRACK_EVENT
eventValue template For eventType=TRACK_EVENT
nonInteraction template For eventType=TRACK_EVENT
socialNetwork template For eventType=TRACK_SOCIAL
socialAction template For eventType=TRACK_SOCIAL
socialActionTarget template For eventType=TRACK_SOCIAL
timingVar template For eventType=TRACK_TIMING
timingCategory template For eventType=TRACK_TIMING
timingLabel template For eventType=TRACK_TIMING
timingValue template For eventType=TRACK_TIMING
useHashDecorateLink boolean For eventType=DECORATE_LINK
useHashDecorateForm boolean For eventType=DECORATE_FORM
Example

Where trackType=TRACK_PAGEVIEW:

 {
   "name": "Sample Universal Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "trackingId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_PAGEVIEW"
    },
    {
     "type": "list",
     "key": "contentGroup",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "index",
         "value": "1"
        },
        {
         "type": "template",
         "key": "group",
         "value": "myContentGroup"
        }
       ]
      }
     ]
    },
    {
     "type": "list",
     "key": "dimension",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "index",
         "value": "1"
        },
        {
         "type": "template",
         "key": "dimension",
         "value": "myCustomDimension"
        }
       ]
      }
     ]
    },
    {
     "type": "list",
     "key": "metric",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "index",
         "value": "1"
        },
        {
         "type": "template",
         "key": "metric",
         "value": "myCustomMetric"
        }
       ]
      }
     ]
    },
    {
     "type": "list",
     "key": "fieldsToSet",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "myFieldName"
        },
        {
         "type": "template",
         "key": "value",
         "value": "myFieldValue"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "anonymizeIp"
        },
        {
         "type": "template",
         "key": "value",
         "value": "true"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "allowLinker"
        },
        {
         "type": "template",
         "key": "value",
         "value": "true"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "sessionControl"
        },
        {
         "type": "template",
         "key": "value",
         "value": "mySessionControl"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "referrer"
        },
        {
         "type": "template",
         "key": "value",
         "value": "myDocReferrer"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "page"
        },
        {
         "type": "template",
         "key": "value",
         "value": "myDocPath"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "title"
        },
        {
         "type": "template",
         "key": "value",
         "value": "myDocTitle"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "sampleRate"
        },
        {
         "type": "template",
         "key": "value",
         "value": "mySampleRate"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "cookieName"
        },
        {
         "type": "template",
         "key": "value",
         "value": "myCookieName"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "cookieDomain"
        },
        {
         "type": "template",
         "key": "value",
         "value": "myCookieDomain"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "cookiePath"
        },
        {
         "type": "template",
         "key": "value",
         "value": "myCookiePath"
        }
       ]
      },
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "fieldName",
         "value": "cookieExpires"
        },
        {
         "type": "template",
         "key": "value",
         "value": "myCookieExpirationInSeconds"
        }
       ]
      }
     ]
    },
    {
     "type": "template",
     "key": "trackerName",
     "value": "myCustomTrackerName"
    },
    {
     "type": "boolean",
     "key": "useDebugVersion",
     "value": "false"
    },
    {
     "type": "template",
     "key": "autoLinkDomains",
     "value": "myAutoLinkDomain"
    },
    {
     "type": "boolean",
     "key": "linkId",
     "value": "false"
    },
    {
     "type": "boolean",
     "key": "decorateFormsAutoLink",
     "value": "false"
    },
    {
     "type": "boolean",
     "key": "setTrackerName",
     "value": "true"
    },
    {
     "type": "boolean",
     "key": "useHashAutoLink",
     "value": "false"
    },
    {
     "type": "boolean",
     "key": "enableEcommerce",
     "value": "false"
    }
   ],
   "type": "ua"
  }

Where trackType=TRACK_EVENT:

 {
   "name": "Sample Universal Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "trackingId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_EVENT"
    },
    {
     "type": "template",
     "key": "eventCategory",
     "value": "myCategory"
    },
    {
     "type": "template",
     "key": "eventAction",
     "value": "myAction"
    },
    {
     "type": "template",
     "key": "eventLabel",
     "value": "myLabel"
    },
    {
     "type": "template",
     "key": "eventValue",
     "value": "myValue"
    },
   "type": "ua"
   }

Where trackType=TRACK_TRANSACTION:

  {
   "name": "Sample Universal Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "trackingId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_TRANSACTION"
    }
   ],
   "type": "ua"
  }

Where trackType=TRACK_SOCIAL:

 {
   "name": "Sample Universal Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "trackingId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_SOCIAL"
    },
    {
     "type": "template",
     "key": "socialNetwork",
     "value": "myNetwork"
    },
    {
     "type": "template",
     "key": "socialAction",
     "value": "myAction"
    },
    {
     "type": "template",
     "key": "socialActionTarget",
     "value": "myActionTarget"
    }
   ],
   "type": "ua"
  }

Where trackType=TRACK_TIMING:

 {
   "name": "Sample Universal Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "trackingId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_TIMING"
    },
    {
     "type": "template",
     "key": "timingVar",
     "value": "myVar"
    },
    {
     "type": "template",
     "key": "timingCategory",
     "value": "myCategory"
    },
    {
     "type": "template",
     "key": "timingLabel",
     "value": "myLabel"
    },
    {
     "type": "template",
     "key": "timingValue",
     "value": "myValue"
    }
   ],
   "type": "ua"
  }

Where trackType=DECORATE_LINK:

 {
   "name": "Sample Universal Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "trackingId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "DECORATE_LINK"
    },
    {
     "type": "boolean",
     "key": "useHashDecorateLink",
     "value": "false"
    }
   ],
   "type": "ua"
  }

Where trackType=DECORATE_FORM:

  {
   "name": "Sample Universal Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "trackingId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "DECORATE_FORM"
    },
    {
     "type": "boolean",
     "key": "useHashDecorateForm",
     "value": "false"
    }
   ],
   "type": "ua"
  }

Classic Google Analytics

Type code

ga

Parameters
Key Type Notes
webPropertyId template
type template One of: TRACK_PAGEVIEW, TRACK_EVENT, LINK, LINK_BY_POST, TRACK_TRANSACTION, TRACK_SOCIAL, TRACK_TIMING, DECORATE_LINK, DECORATE_FORM
siteSpeedSampleRate template Should evaluate to a numeric percentage value (0..100).
cookiePath template
page template
domainName template
allowLinker boolean
sampleRate integer Range of 0 to 100
campaignCookieTimeout template Should evaluate to numeric value representing timeout in milliseconds.
allowAnchor boolean
sessionCookieTimeout template Should evaluate to numeric value representing timeout in milliseconds.
doubleClick boolean
hitCallback template
ignoredRef list List of referrers to ignore.
ignoredRef[].value template Name of referrer
customVar list List of maps. One map per custom variable.
customVar[].slot integer
customVar[].name template
customVar[].value template
customVar[].scope integer 1 for Hit scope, 2for Session scope, and 3 for User scope.
organic list
organic[].searchEngine template
organic[].queryParamName template
organic[].prepend boolean
ignoredOrganic list List of keywords to ignore.
ignoredOrganic[].value template Keywords to ignore.
title template
campaignSourceOverride template
campaignMediumOverride template
campaignTermOverride template
campaignContentOverride template
campaignNameOverride template
anonymizeIp boolean
linkId boolean Optional. Enable enhanced link attribution.
contentGroup list List of maps.
contentGroup[].index template Must evaluate to integer.
contentGroup[].group template Group name.
campContentKey template
campMediumKey template
campNameKey template
campNoKey template
campSourceKey template
campTermKey template
campaignTrack boolean
clientInfo template
detectFlash template
detectTitle template
localGifPath template
sendHitstToGoogle template
referrerOverride template
visitorCookieTimeout template Number of milliseconds.
trackerName template
cookiePathCopy list List of cookie paths.
cookiePathCopy[].value template Cookie path.
useDebugVersion boolean
forceSsl boolean
setTrackerName boolean
eventCategory template For trackType=TRACK_EVENT
eventAction template For trackType=TRACK_EVENT
eventLabel template For trackType=TRACK_EVENT
eventValue template For trackType=TRACK_EVENT
nonInteraction boolean For trackType=TRACK_EVENT
targetUrl template For trackType=LINK
useHashLink boolean For trackType=LINK
formObject template For trackType=LINK_BY_POST
useHashLinkByPost boolean For trackType=LINK_BY_POST
currencyCode template Optional. For trackType=TRACK_TRANSACTION
socialUseDataLayer boolean Optional. For trackType=TRACK_SOCIAL
socialNetwork template For trackType=TRACK_SOCIAL and socialUseDataLayer=false
socialAction template For trackType=TRACK_SOCIAL and socialUseDataLayer=false
socialPagePath template Optional. For trackType=TRACK_SOCIAL
socialTarget template For trackType=TRACK_SOCIAL and socialUseDataLayer=false
timingCategory template For trackType=TRACK_TIMING
timingVariable template For trackType=TRACK_TIMING
timingTime template For trackType=TRACK_TIMING
timingLabel template For trackType=TRACK_TIMING
timingSampleRate template For trackType=TRACK_TIMING
useHashDecorateLink boolean For trackType=DECORATE_LINK
useHashDecorateForm boolean For trackType=DECORATE_FORM
Example

Where trackType=TRACK_PAGEVIEW:

 {
   "name": "Sample Classic Google Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "webPropertyId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "siteSpeedSampleRate",
     "value": "{{sampleRatePercent}}"
    },
    {
     "type": "template",
     "key": "cookiePath",
     "value": "myCookiePath"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_PAGEVIEW"
    },
    {
     "type": "template",
     "key": "page",
     "value": "myVirtualPagePath"
    },
    {
     "type": "template",
     "key": "domainName",
     "value": "myDomainName"
    },
    {
     "type": "boolean",
     "key": "allowLinker",
     "value": "true"
    },
    {
     "type": "integer",
     "key": "sampleRate",
     "value": "10"
    },
    {
     "type": "template",
     "key": "campaignCookieTimeout",
     "value": "{{timeoutInMilli}}"
    },
    {
     "type": "boolean",
     "key": "allowAnchor",
     "value": "true"
    },
    {
     "type": "template",
     "key": "sessionCookieTimeout",
     "value": "{{timeoutInMilli}}"
    },
    {
     "type": "boolean",
     "key": "doubleClick",
     "value": "true"
    },
    {
     "type": "list",
     "key": "ignoredRef",
     "list": [
      {
       "type": "template",
       "value": "referrer1Ignore"
      },
      {
       "type": "template",
       "value": "referrer2Ignore"
      }
     ]
    },
    {
     "type": "list",
     "key": "customVar",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "integer",
         "key": "slot",
         "value": "1"
        },
        {
         "type": "template",
         "key": "name",
         "value": "myCustomVar"
        },
        {
         "type": "template",
         "key": "value",
         "value": "myCustomVarValue"
        },
        {
         "type": "integer",
         "key": "scope",
         "value": "3"
        }
       ]
      }
     ]
    },
    {
     "type": "list",
     "key": "organic",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "searchEngine",
         "value": "myOrganicSearchEngine"
        },
        {
         "type": "template",
         "key": "queryParamName",
         "value": "mySearchQueryParamName"
        },
        {
         "type": "boolean",
         "key": "prepend",
         "value": "true"
        }
       ]
      }
     ]
    },
    {
     "type": "list",
     "key": "ignoredOrganic",
     "list": [
      {
       "type": "template",
       "value": "keyword1Ignore"
      },
      {
       "type": "template",
       "value": "keyword2Ignore"
      }
     ]
    },
    {
     "type": "template",
     "key": "title",
     "value": "myPageTitle"
    },
    {
     "type": "template",
     "key": "campaignSourceOverride",
     "value": "mySourceOverride"
    },
    {
     "type": "template",
     "key": "campaignMediumOverride",
     "value": "myMediumOverride"
    },
    {
     "type": "template",
     "key": "campaignTermOverride",
     "value": "myTermOverride"
    },
    {
     "type": "template",
     "key": "campaignContentOverride",
     "value": "myContentOverride"
    },
    {
     "type": "template",
     "key": "campaignNameOverride",
     "value": "myNameOverride"
    },
    {
     "type": "boolean",
     "key": "anonymizeIp",
     "value": "true"
    },
    {
     "type": "boolean",
     "key": "linkId",
     "value": "false"
    },
    {
     "type": "list",
     "key": "contentGroup",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "index",
         "value": "1"
        },
        {
         "type": "template",
         "key": "group",
         "value": "myContentGroup1"
        }
       ]
      }
     ]
    },
    {
     "type": "template",
     "key": "campContentKey",
     "value": "myContentKey"
    },
    {
     "type": "template",
     "key": "campMediumKey",
     "value": "myMediumKey"
    },
    {
     "type": "template",
     "key": "campNameKey",
     "value": "myNameKey"
    },
    {
     "type": "template",
     "key": "campNoKey",
     "value": "myNoOverrideKey"
    },
    {
     "type": "template",
     "key": "campSourceKey",
     "value": "mySourceKey"
    },
    {
     "type": "template",
     "key": "campTermKey",
     "value": "myTermKey"
    },
    {
     "type": "boolean",
     "key": "campaignTrack",
     "value": "true"
    },
    {
     "type": "boolean",
     "key": "clientInfo",
     "value": "true"
    },
    {
     "type": "boolean",
     "key": "detectFlash",
     "value": "true"
    },
    {
     "type": "boolean",
     "key": "detectTitle",
     "value": "true"
    },
    {
     "type": "template",
     "key": "localGifPath",
     "value": "myLocalGIFPath"
    },
    {
     "type": "boolean",
     "key": "sendHitsToGoogle",
     "value": "true"
    },
    {
     "type": "template",
     "key": "referrerOverride",
     "value": "myReferrerOverride"
    },
    {
     "type": "template",
     "key": "visitorCookieTimeout",
     "value": "{{timeoutInMilli}}"
    },
    {
     "type": "template",
     "key": "trackerName",
     "value": "myTrackerName"
    },
    {
     "type": "list",
     "key": "cookiePathCopy",
     "list": [
      {
       "type": "template",
       "value": "/path/to/cookies1"
      },
      {
       "type": "template",
       "value": "/path/to/cookies2"
      }
     ]
    },
    {
     "type": "boolean",
     "key": "useDebugVersion",
     "value": "false"
    },
    {
     "type": "boolean",
     "key": "forceSsl",
     "value": "false"
    },
    {
     "type": "boolean",
     "key": "setTrackerName",
     "value": "true"
    }
   ],
   "type": "ga"
  }

Where trackType=TRACK_EVENT:

 {
   "name": "Sample Classic Google Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "webPropertyId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_EVENT"
    },
    {
     "type": "template",
     "key": "eventCategory",
     "value": "myCategory"
    },
    {
     "type": "template",
     "key": "eventAction",
     "value": "myAction"
    },
    {
     "type": "template",
     "key": "eventLabel",
     "value": "myLabel"
    },
    {
     "type": "template",
     "key": "eventValue",
     "value": "myValue"
    },
    {
     "type": "boolean",
     "key": "nonInteraction",
     "value": "false"
    }
   ],
   "type": "ga"
  }

Where trackType=LINK:

 {
   "name": "Sample Classic Google Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "webPropertyId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "LINK"
    },
    {
     "type": "template",
     "key": "targetUrl",
     "value": "TargetURL"
    },
    {
     "type": "boolean",
     "key": "useHashLink",
     "value": "false"
    }
   ],
   "type": "ga"
  }

Where trackType=LINK_BY_POST:

 {
   "name": "Sample Classic Google Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "webPropertyId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "LINK_BY_POST"
    },
    {
     "type": "template",
     "key": "formObject",
     "value": "{{a}}"
    },
    {
     "type": "boolean",
     "key": "useHashLinkByPost",
     "value": "false"
    }
   ],
   "type": "ga"
  }

Where trackType=TRACK_TRANSACTION:

 {
   "name": "Sample Classic Google Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "webPropertyId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_TRANSACTION"
    },
    {
     "type": "template",
     "key": "currencyCode",
     "value": "{{a}}"
    }
   ]
   "type": "ga"
  }

Where trackType=TRACK_SOCIAL:

 {
   "name": "Sample Classic Google Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "webPropertyId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_SOCIAL"
    },
    {
     "type": "template",
     "key": "socialNetwork",
     "value": "mySocialNetwork"
    },
    {
     "type": "template",
     "key": "socialAction",
     "value": "mySocialAction"
    },
    {
     "type": "template",
     "key": "socialTarget",
     "value": "myTarget"
    },
    {
     "type": "template",
     "key": "socialPagePath",
     "value": "myPagePaht"
    }
   ],
   "type": "ga"
  }

Where trackType=TRACK_TIMING:

 {
   "name": "Sample Classic Google Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "webPropertyId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "TRACK_TIMING"
    },
    {
     "type": "template",
     "key": "timingCategory",
     "value": "myCategory"
    },
    {
     "type": "template",
     "key": "timingVariable",
     "value": "myVariable"
    },
    {
     "type": "template",
     "key": "timingTime",
     "value": "myTime"
    },
    {
     "type": "template",
     "key": "timingLabel",
     "value": "myLabel"
    },
    {
     "type": "template",
     "key": "timingSampleRate",
     "value": "{{sampleRatePercent}}"
    }
   ],
   "type": "ga"
  }

Where trackType=DECORATE_LINK:

 {
   "name": "Sample Classic Google Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "webPropertyId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "DECORATE_LINK"
    },
    {
     "type": "boolean",
     "key": "useHashDecorateLink",
     "value": "false"
    }
   ],
   "type": "ga"
  }

Where trackType=DECORATE_FORM:

 {
   "name": "Sample Classic Google Analytics",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "webPropertyId",
     "value": "UA-00000-123"
    },
    {
     "type": "template",
     "key": "trackType",
     "value": "DECORATE_LINK"
    },
    {
     "type": "boolean",
     "key": "useHashDecorateForm",
     "value": "false"
    }
   ],
   "type": "ga"
  }

ClickTale Standard

Type code

cts

Parameters
Key Type
projectId template
sampleRate template
partition template
Example
 {
   "name": "Sample ClickTale Standard Tracking",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "projectId",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "sampleRate",
     "value": "{{a}}"
    },
    {
     "type": "template",
     "key": "partition",
     "value": "{{a}}"
    }
   ],
   "type": "cts"
  }

comScore Unified Digital Measurement

Type code

csm

Parameters
Key Type
clientId template
Example
 {
   "name": "Sample comScore Unified Digital Measurement",
   "liveOnly": false,
   "parameter": [
    {
     "type": "template",
     "key": "clientId",
     "value": "{{a}}"
    }
   ],
   "type": "csm"
  }

Mobile Tags

Google Ads Conversion Tracking

Type code

awct

Parameters
Key Type
googleConversionId template
googleConversionLabel template
googleConversionValue template
Example
{
  "liveOnly": false,
  "name": "Google Ads Conversion Tracking",
  "parameter": [
    {
      "key": "googleConversionId",
      "type": "template",
      "value": "{{a}}"
    },
    {
      "key": "googleConversionLabel",
      "type": "template",
      "value": "{{a}}"
    },
    {
      "key": "googleConversionValue",
      "type": "template",
      "value": "{{a}}"
    }
  ],
  "tagId": "1",
  "type": "awct"
}

Google Ads Remarketing

Type code

sp

Parameters
Key Type Notes
googleConversionId template
googleConversionLabel template
customParamsFormat template One of: DATA_LAYER, USER_SPECIFIED
googleScreenName template Optional.
dataLayerVariable template For customParamsFormat=DATA_LAYER; should refer to a data layer variable macro.
googleCustomParams list A list of maps, each with a single [key, value] entry. For customParamsFormat=USER_SPECIFIED.
googleCustomParams[].key template
googleCustomParams[].value template
Example

Where customParamsFormat=USER_SPECIFIED:

{
  "accountId": "103020",
  "containerId": "666282",
  "firingRuleId": [
    "1"
  ],
  "liveOnly": false,
  "name": "Google Ads Remarketing",
  "parameter": [
    {
      "key": "conversionId",
      "type": "template",
      "value": "cvid"
    },
    {
      "key": "conversionLabel",
      "type": "template",
      "value": "cvl"
    },
    {
      "key": "customParamsFormat",
      "type": "template",
      "value": "USER_SPECIFIED"
    },
    {
      "key": "customParams",
      "list": [
        {
          "map": [
            {
              "key": "key",
              "type": "template",
              "value": "cpk1"
            },
            {
              "key": "value",
              "type": "template",
              "value": "cpv1"
            }
          ],
          "type": "map"
        }
      ],
      "type": "list"
    }
  ],
  "tagId": "2",
  "type": "sp"
}

Where customParamsFormat=DATA_LAYER:

{
  "accountId": "103020",
  "containerId": "666282",
  "firingRuleId": [
    "1"
  ],
  "liveOnly": false,
  "name": "Google Ads Remarketing DataLayer",
  "parameter": [
    {
      "key": "conversionId",
      "type": "template",
      "value": "cvid"
    },
    {
      "key": "conversionLabel",
      "type": "template",
      "value": "cvl"
    },
    {
      "key": "customParamsFormat",
      "type": "template",
      "value": "DATA_LAYER"
    },
    {
      "key": "dataLayerVariable",
      "type": "template",
      "value": "{{dlv}}"
    }
  ],
  "tagId": "3",
  "type": "sp"
}

Floodlight Counter

Type code

flc

Parameters
Key Type Notes
ordinalType template One of STANDARD, UNIQUE, SESSION
advertiserId template
groupTag template
activityTag template
customVariable list [key, value] pairs
userVariable template The tag's u= variable.
transactionVariable template The tag's tran= variable.
sessionId template Specify if ordinalType is SESSION.
useImageTag boolean
unrepeatable boolean Optional.
Example

Where ordinalType=STANDARD:

{
  "accountId": "103020",
  "containerId": "666282",
  "firingRuleId": [
    "1"
  ],
  "liveOnly": false,
  "name": "Floodlight Counter",
  "parameter": [
    {
      "key": "ordinalType",
      "type": "template",
      "value": "STANDARD"
    },
    {
      "key": "advertiserId",
      "type": "template",
      "value": "42"
    },
    {
      "key": "groupTag",
      "type": "template",
      "value": "gts"
    },
    {
      "key": "activityTag",
      "type": "template",
      "value": "ats"
    },
    {
      "key": "useImageTag",
      "type": "boolean",
      "value": "false"
    },
    {
      "key": "customVariable",
      "list": [
        {
          "map": [
            {
              "key": "key",
              "type": "template",
              "value": "u3"
            },
            {
              "key": "value",
              "type": "template",
              "value": "bar"
            }
          ],
          "type": "map"
        },
        {
          "map": [
            {
              "key": "key",
              "type": "template",
              "value": "u1"
            },
            {
              "key": "value",
              "type": "template",
              "value": "foo"
            }
          ],
          "type": "map"
        }
      ],
      "type": "list"
    },
    {
      "key": "userVariable",
      "type": "template",
      "value": "u"
    },
    {
      "key": "transactionVariable",
      "type": "template",
      "value": "tran"
    }
  ],
  "tagId": "4",
  "type": "flc"
}

Where ordinalType=SESSION:

{
  "accountId": "103020",
  "containerId": "666282",
  "firingRuleId": [
    "1"
  ],
  "liveOnly": false,
  "name": "Floodlight Counter Per Session",
  "parameter": [
    {
      "key": "ordinalType",
      "type": "template",
      "value": "SESSION"
    },
    {
      "key": "advertiserId",
      "type": "template",
      "value": "42"
    },
    {
      "key": "groupTag",
      "type": "template",
      "value": "gts"
    },
    {
      "key": "activityTag",
      "type": "template",
      "value": "ats"
    },
    {
      "key": "sessionId",
      "type": "template",
      "value": "session-id"
    },
    {
      "key": "useImageTag",
      "type": "boolean",
      "value": "false"
    },
    {
      "key": "customVariable",
      "type": "list"
    },
    {
      "key": "userVariable",
      "type": "template",
      "value": "u"
    },
    {
      "key": "transactionVariable",
      "type": "template",
      "value": "tran"
    }
  ],
  "tagId": "5",
  "type": "flc"
}

Floodlight Sales

Type code

fls

Parameters
Key Type Notes
countingMethod template One of TRANSACTIONS, ITEM_SOLD
advertiserId template
groupTag template
activityTag template
revenue template
orderId template Specify if countingMethod is ITEM_SOLD
customVariable map A list of maps, each with a single [key, value] pair. Map item keys are u1 to u20; map item type is template.
userVariable template The tag's u= variable.
transactionVariable template The tag's tran= variable.
quantity template Specify if countingMethod is ITEM_SOLD.
useImageTag boolean
unrepeatable boolean Optional.
Example

Where countingMethod=TRANSACTIONS:

{
  "accountId": "103020",
  "containerId": "666282",
  "firingRuleId": [
    "1"
  ],
  "liveOnly": false,
  "name": "Floodlight Sales",
  "parameter": [
    {
      "key": "countingMethod",
      "type": "template",
      "value": "TRANSACTIONS"
    },
    {
      "key": "advertiserId",
      "type": "template",
      "value": "42"
    },
    {
      "key": "groupTag",
      "type": "template",
      "value": "gts"
    },
    {
      "key": "activityTag",
      "type": "template",
      "value": "ats"
    },
    {
      "key": "revenue",
      "type": "template",
      "value": "{{revenue}}"
    },
    {
      "key": "orderId",
      "type": "template",
      "value": "oid"
    },
    {
      "key": "useImageTag",
      "type": "boolean",
      "value": "false"
    },
    {
      "key": "customVariable",
      "map": [
        {
          "key": "u1",
          "type": "template",
          "value": "jio"
        }
      ],
      "type": "map"
    },
    {
      "key": "userVariable",
      "type": "template",
      "value": "u"
    },
    {
      "key": "transactionVariable",
      "type": "template",
      "value": "tran"
    }
  ],
  "tagId": "6",
  "type": "fls"
}

Where countingMethod=ITEM_SOLD:

{
  "accountId": "103020",
  "containerId": "666282",
  "firingRuleId": [
    "1"
  ],
  "liveOnly": false,
  "name": "Floodlight Sales Item Sold",
  "parameter": [
    {
      "key": "countingMethod",
      "type": "template",
      "value": "ITEM_SOLD"
    },
    {
      "key": "advertiserId",
      "type": "template",
      "value": "42"
    },
    {
      "key": "groupTag",
      "type": "template",
      "value": "gts"
    },
    {
      "key": "activityTag",
      "type": "template",
      "value": "ats"
    },
    {
      "key": "quantity",
      "type": "template",
      "value": "1"
    },
    {
      "key": "revenue",
      "type": "template",
      "value": "{{revenue}}"
    },
    {
      "key": "orderId",
      "type": "template",
      "value": "oid"
    },
    {
      "key": "useImageTag",
      "type": "boolean",
      "value": "false"
    },
    {
      "key": "customVariable",
      "map": [
        {
          "key": "u1",
          "type": "template",
          "value": "ji"
        }
      ],
      "type": "map"
    },
    {
      "key": "userVariable",
      "type": "template",
      "value": "u"
    },
    {
      "key": "transactionVariable",
      "type": "template",
      "value": "tran"
    }
  ],
  "tagId": "7",
  "type": "fls"
}

Function Call

Type code

_fc

Parameters
Key Type Notes
functionName template
functionArgument map A list of maps, each with a single [key, value] pair.
Example
{
  "accountId": "103020",
  "containerId": "666282",
  "firingRuleId": [
    "1"
  ],
  "liveOnly": false,
  "name": "Function Call",
  "parameter": [
    {
      "key": "functionName",
      "type": "template",
      "value": "fn"
    },
    {
      "key": "functionArgument",
      "map": [
        {
          "key": "argkey1",
          "type": "template",
          "value": "argval1"
        }
      ],
      "type": "map"
    }
  ],
  "tagId": "8",
  "type": "_fc"
}

Universal Analytics

Type code

ua

Parameters
Key Type Notes
trackingId template
type template One of: TRACK_APPVIEW, TRACK_EVENT, TRACK_SOCIAL, TRACK_TIMING, TRACK_EXCEPTION.
contentGroup list Each parameter in the list is a map; each map parameter should have two sub-parameters: one with key index and one with key group.
dimension list Each parameter in the list is a map; each map parameter should have two sub-parameters: one with key index and one with key dimension.
metric list Each parameter in the list is a map; each map parameter should have two sub-parameters: one with key index and one with key metric.
fieldsToSet list Optional. Each parameter in the list is a map; each map parameter should have two sub-parameters: one with key fieldName and one with key value. The following fields are now only accessible using fieldsToSet: anonymizeIp, sessionControl, appName, appVersion, screenName (formerly named contentDescription), sampleRate.
nonInteraction boolean or template For trackType=TRACK_EVENT
eventCategory template For trackType=TRACK_EVENT
eventAction template For trackType=TRACK_EVENT
eventLabel template For trackType=TRACK_EVENT
eventValue template For trackType=TRACK_EVENT
socialNetwork template For trackType=TRACK_SOCIAL
socialAction template For trackType=TRACK_SOCIAL
socialActionTarget template For trackType=TRACK_SOCIAL
timingVar template For trackType=TRACK_TIMING
timingCategory template For trackType=TRACK_TIMING
timingLabel template For trackType=TRACK_TIMING
timingValue template For trackType=TRACK_TIMING
exceptionDescription template For trackType=TRACK_EXCEPTION
exceptionFatal boolean or template For eventType=TRACK_EXCEPTION. If type is template, value should refer to a macro that evaluates to boolean.
Example

Where trackType=TRACK_APPVIEW:

{
  "accountId": "103020",
  "containerId": "666282",
  "liveOnly": false,
  "name": "Universal Analytics App View",
  "parameter": [
    {
      "key": "trackingId",
      "type": "template",
      "value": "UA-123-1"
    },
    {
      "key": "trackType",
      "type": "template",
      "value": "TRACK_APPVIEW"
    },
    {
      "key": "contentGroup",
      "list": [
        {
          "map": [
            {
              "key": "index",
              "type": "template",
              "value": "0"
            },
            {
              "key": "group",
              "type": "template",
              "value": "cg0"
            }
          ],
          "type": "map"
        }
      ],
      "type": "list"
    },
    {
      "key": "dimension",
      "list": [
        {
          "map": [
            {
              "key": "index",
              "type": "template",
              "value": "0"
            },
            {
              "key": "dimension",
              "type": "template",
              "value": "dim0"
            }
          ],
          "type": "map"
        }
      ],
      "type": "list"
    },
    {
      "key": "metric",
      "list": [
        {
          "map": [
            {
              "key": "index",
              "type": "template",
              "value": "0"
            },
            {
              "key": "metric",
              "type": "template",
              "value": "cm0"
            }
          ],
          "type": "map"
        }
      ],
      "type": "list"
    },
    {
      "key": "fieldsToSet",
      "list": [
        {
          "map": [
            {
              "key": "fieldName",
              "type": "template",
              "value": "fn0"
            },
            {
              "key": "value",
              "type": "template",
              "value": "fv0"
            }
          ],
          "type": "map"
        },
        {
          "map": [
            {
             "type": "template",
             "key": "fieldName",
             "value": "anonymizeIp"
            },
            {
             "type": "template",
             "key": "value",
             "value": "true"
            }
          ],
          "type": "map"
        },
        {
          "map": [
            {
             "type": "template",
             "key": "fieldName",
             "value": "appName"
            },
            {
             "type": "template",
             "key": "value",
             "value": "myApp"
            }
          ],
          "type": "map"
        },
        {
          "map": [
            {
             "type": "template",
             "key": "fieldName",
             "value": "sessionControl"
            },
            {
             "type": "template",
             "key": "value",
             "value": "mySessionControl"
            }
          ],
          "type": "map"
        }
      ],
      "type": "list"
    }
  ],
  "tagId": "9",
  "type": "ua"
}

Where trackType=TRACK_EVENT:

{
  "accountId": "103020",
  "containerId": "666282",
  "liveOnly": false,
  "name": "Universal Analytics Event",
  "parameter": [
    {
      "key": "trackingId",
      "type": "template",
      "value": "UA-123-1"
    },
    {
      "key": "trackType",
      "type": "template",
      "value": "TRACK_EVENT"
    },
    {
      "key": "nonInteraction",
      "type": "boolean",
      "value": "true"
    },
    {
      "key": "contentGroup",
      "type": "list"
    },
    {
      "key": "dimension",
      "type": "list"
    },
    {
      "key": "metric",
      "type": "list"
    },
    {
      "key": "fieldsToSet",
      "type": "list"
    },
    {
      "key": "eventCategory",
      "type": "template",
      "value": "cat"
    },
    {
      "key": "eventAction",
      "type": "template",
      "value": "act"
    },
    {
      "key": "eventLabel",
      "type": "template",
      "value": "label"
    },
    {
      "key": "eventValue",
      "type": "template",
      "value": "value"
    }
  ],
  "tagId": "10",
  "type": "ua"
}

Where trackType=TRACK_SOCIAL:

{
  "accountId": "103020",
  "containerId": "666282",
  "liveOnly": false,
  "name": "Universal Analytics Social",
  "parameter": [
    {
      "key": "trackingId",
      "type": "template",
      "value": "UA-123-1"
    },
    {
      "key": "trackType",
      "type": "template",
      "value": "TRACK_SOCIAL"
    },
    {
      "key": "contentGroup",
      "type": "list"
    },
    {
      "key": "dimension",
      "type": "list"
    },
    {
      "key": "metric",
      "type": "list"
    },
    {
      "key": "fieldsToSet",
      "type": "list"
    },
    {
      "key": "socialNetwork",
      "type": "template",
      "value": "network"
    },
    {
      "key": "socialAction",
      "type": "template",
      "value": "action"
    },
    {
      "key": "socialActionTarget",
      "type": "template",
      "value": "action-target"
    }
  ],
  "tagId": "11",
  "type": "ua"
}

Where trackType=TRACK_TIMING:

{
  "accountId": "103020",
  "containerId": "666282",
  "liveOnly": false,
  "name": "Universal Analytics Timing",
  "parameter": [
    {
      "key": "trackingId",
      "type": "template",
      "value": "UA-123-1"
    },
    {
      "key": "trackType",
      "type": "template",
      "value": "TRACK_TIMING"
    },
    {
      "key": "contentGroup",
      "type": "list"
    },
    {
      "key": "dimension",
      "type": "list"
    },
    {
      "key": "metric",
      "type": "list"
    },
    {
      "key": "fieldsToSet",
      "type": "list"
    },
    {
      "key": "timingVar",
      "type": "template",
      "value": "var"
    },
    {
      "key": "timingCategory",
      "type": "template",
      "value": "cat"
    },
    {
      "key": "timingLabel",
      "type": "template",
      "value": "label"
    },
    {
      "key": "timingValue",
      "type": "template",
      "value": "value"
    }
  ],
  "tagId": "12",
  "type": "ua"
}

Where trackType=TRACK_EXCEPTION:

{
  "accountId": "103020",
  "containerId": "666282",
  "liveOnly": false,
  "name": "Universal Analytics Exception",
  "parameter": [
    {
      "key": "trackingId",
      "type": "template",
      "value": "UA-123-1"
    },
    {
      "key": "trackType",
      "type": "template",
      "value": "TRACK_EXCEPTION"
    },
    {
      "key": "contentGroup",
      "type": "list"
    },
    {
      "key": "dimension",
      "type": "list"
    },
    {
      "key": "metric",
      "type": "list"
    },
    {
      "key": "fieldsToSet",
      "type": "list"
    },
    {
      "key": "exceptionDescription",
      "type": "template",
      "value": "description"
    },
    {
      "key": "exceptionFatal",
      "type": "boolean",
      "value": "true"
    }
  ],
  "tagId": "13",
  "type": "ua"
}

Custom Image Tag

Type code

img

Parameters
Key Type Notes
useCacheBuster boolean Macros not allowed.
url template
cacheBusterQueryParam template
Example
{
  "accountId": "103020",
  "containerId": "666282",
  "firingRuleId": [
    "1"
  ],
  "liveOnly": false,
  "name": "Custom Image Tag",
  "parameter": [
    {
      "key": "useCacheBuster",
      "type": "boolean",
      "value": "true"
    },
    {
      "key": "url",
      "type": "template",
      "value": "http://www.example.com"
    },
    {
      "key": "cacheBusterQueryParam",
      "type": "template",
      "value": "gtmcb"
    }
  ],
  "tagId": "14",
  "type": "img"
}