跟踪代码管理器 API - 宏字典参考

本文档介绍了可以为 Google 跟踪代码管理器宏设置的属性。

简介

每个 Google 跟踪代码管理器都有一个用于自我识别的 type 代码。此外,大多数宏都包含参数(keytype 对),您可以在创建或更新宏时将其设置为“参数对象”的一部分。要详细了解如何使用参数对象设置这些参数,请参阅参数参考

下文列出了所有受支持的宏的详细信息。

第一方 Cookie

类型代码

k

参数

类型 备注
name template Cookie 名称。

示例

 {
   "name": "Sample 1st Party Cookie Macro",
   "type": "k",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "myCookieName"
    }
   ]
 }

自动事件变量

类型代码

aev

参数

类型 备注
varType template ELEMENT,CLASSES, ID, TARGET, TEXT, URL, HISTORY_NEW_URL_FRAGMENT, HISTORY_OLD_URL_FRAGMENT, HISTORY_NEW_STATE, HISTORY_OLD_STATE, HISTORY_CHANGE_SOURCE 中的一个。
defaultValue template 可选。

示例

  {
   "name": "Sample AutoEvent Variable",
   "type": "aev",
   "parameter": [
    {
     "type": "template",
     "key": "varType",
     "value": "CLASSES"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "MyDefault"
    }
   ]
  }

常量字符串

类型代码

c

参数

类型
value template

示例

  {
   "name": "Sample Constant String",
   "type": "c",
   "parameter": [
    {
     "type": "template",
     "key": "value",
     "value": "MyString"
    }
   ]
  }

容器版本号

类型代码

ctv

参数

示例

  {
   "name": "Sample Container Version Number",
   "type": "ctv"
  }

自定义事件

类型代码

参数

示例

  {
   "name": "Custom Event Name",
   "type": "e"
  }

自定义 JavaScript

类型代码

jsm

参数

类型
javascript template

示例

  {
   "name": "Sample Custom Javascript",
   "type": "jsm",
   "parameter": [
    {
     "type": "template",
     "key": "javascript",
     "value": "function() {\n return \"Hello World\";\n}"
    }
   ]
  }

数据层变量

类型代码

v

参数

类型 备注
name template 数据层变量名称。
defaultValue template
dataLayerVersion integer 12

示例

  {
   "name": "Sample Data Layer Variable",
   "type": "v",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "DL Variable Name"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "DEFAULT"
    },
    {
     "type": "integer",
     "key": "dataLayerVersion",
     "value": "2"
    }
   ]
  }

调试模式

类型代码

dbg

参数

示例

  {
   "name": "Sample Debug Mode Macro",
   "type": "dbg"
  }

DOM 元素

类型代码

d

参数

类型 说明
elementId template
attributeName template 可选。

示例

  {
   "name": "Sample DOM Element Macro",
   "type": "d",
   "parameter": [
    {
     "type": "template",
     "key": "elementId",
     "value": "MyElementId"
    },
    {
     "type": "template",
     "key": "attributeName",
     "value": "MyAttributeName"
    }
   ]
  }

HTTP 引荐来源网址

类型代码

f

参数

类型 备注
component template URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT 中的一个。
stripWww boolean 适用于组成部分为 HOST 的情况
queryKey tempalte 适用于组成部分为 QUERY 的情况

示例

  {
   "name": "Sample HTTP Referrer Macro",
   "type": "f",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    }
   ]
  }

JavaScript 变量

类型代码

j

参数

类型 备注
name template 全局变量名称。

示例

  {
   "name": "Sample Javascript Variable",
   "type": "j",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "MyGlobalVarName"
    }
   ]
  }

对照表

类型代码

smm

参数

类型 备注
input template 用于查询的值,应为宏引用。
map list 映射列表,每个映射都有一个 [key, value] 对。
map[].key template
map[].value template
defaultValue template 可选。

示例

  {
   "name": "Sample Lookup Table Macro",
   "type": "smm",
   "parameter": [
    {
     "type": "template",
     "key": "input",
     "value": "{{event}}"
    },
    {
     "type": "list",
     "key": "map",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "key",
         "value": "EventEqualsThis"
        },
        {
         "type": "template",
         "key": "value",
         "value": "ThenSetToThis"
        }
       ]
      }
     ]
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "MyDefaultValue"
    }
   ]
  }

随机数

类型代码

r

参数

示例

  {
   "name": "Sample Random Number Macro",
   "type": "r"
  }

网址

类型代码

u

参数

类型 备注
component template URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT 中的一个。
customUrlSource template 可选。
stripWww boolean 适用于组成部分为 HOST 的情况。
queryKey tempalte 适用于组成部分为 QUERY 的情况。

示例

  {
   "name": "Sample URL Macro",
   "type": "u",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    },
    {
     "type": "template",
     "key": "customUrlSource",
     "value": "{{element}}"
    }
   ]
  }