Tag Manager API - 變數字典參考資料

本文件將說明可為 Google 代碼管理工具變數設定的屬性。

簡介

每個 Google 代碼管理工具變數都有用來識別變數的 type 程式碼。此外，大多數變數都有參數 (key、type 配對)，您可以在建立或更新變數時，將其設為「參數物件」的一部分。如要進一步瞭解如何使用參數物件設定這些參數，請參閱參數參考資料。

本文件的其餘部分會列出所有支援變數的詳細資料。

第一方 Cookie

輸入代碼

k

參數

鍵	類型	附註
name	template	Cookie 名稱。

範例

 {
   "name": "Sample First Party Cookie Variable",
   "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	1 或 2。

範例

  {
   "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 Variable",
   "type": "dbg"
  }

DOM 元素

輸入代碼

d

參數

鍵	類型	附註
elementId	template
attributeName	template	選用。

範例

  {
   "name": "Sample DOM Element Variable",
   "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	template	元件 = QUERY

範例

  {
   "name": "Sample HTTP Referrer Variable",
   "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 Variable",
   "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 Variable",
   "type": "r"
  }

網址

輸入代碼

u

參數

鍵	類型	附註
component	template	只能設為 URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT。
customUrlSource	template	選用。
stripWww	boolean	元件 = HOST。
queryKey	template	元件 = QUERY。

範例

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