Tags

與容器相關聯的代碼。代碼通常會與一或多項觸發規則相關聯 (請參閱下方的 firingRuleId),並視需要與一或多項封鎖規則建立關聯 (請參閱下方的 blockingRuleId)。如果至少有一個觸發規則評估為 true,且完全沒有封鎖規則評估為 true,代碼就會啟動 (執行)。使用 priority 屬性 (選用),即可調整哪些代碼較常觸發。使用 dependencies 屬性可指定哪些代碼必須在這個代碼觸發之前觸發並完成。如要進一步瞭解可為 Google 代碼管理工具代碼設定的參數,請參閱代碼字典參考資料

如需本資源的方法清單,請見本頁結尾。

資源表示法

代表 Google 代碼管理工具代碼。

{
  "accountId": string,
  "containerId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  ],
  "fingerprint": string,
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "paused": boolean
}
資源名稱 說明 附註
accountId string GTM 帳戶 ID。
blockingRuleId[] list 封鎖規則 ID。如果清單中的任何規則評估結果為 true,代碼就不會觸發。 可寫入
blockingTriggerId[] list 封鎖觸發條件 ID。如果清單中的任何觸發條件評估結果為 true,代碼就不會觸發。 可寫入
containerId string GTM 容器 ID。
fingerprint string 儲存時計算出的 GTM 代碼指紋。每次修改代碼時,系統都會重新計算這個值。
firingRuleId[] list 觸發規則 ID。只要列出的規則為 true,且其所有 blockingRuleIds (如有指定) 皆為 false,標記就會觸發。 可寫入
firingTriggerId[] list 觸發條件 ID。如果列出的觸發條件其中一項為 true,blockingTriggerIds (如果有的話) 全都為 false,代碼就會觸發。 可寫入
liveOnly boolean 如果設為 true,這個代碼只會在實際環境中觸發 (例如在預覽或偵錯模式下)。 可寫入
name string 代碼顯示名稱。 可寫入
notes string 使用者在容器中套用這個代碼的附註。 可寫入
parameter[] list 代碼的參數。 可寫入
parameter[].key string 唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。 可寫入
parameter[].list[] list 此清單參數的參數 (系統會忽略鍵)。 可寫入
parameter[].map[] list 此對應參數的參數 (必須有鍵,鍵不得重複)。 可寫入
parameter[].type string 參數類型。有效值如下:
  • boolean:這個值代表布林值,以「true」或「false」表示
  • integer:這個值代表 64 位元的帶正負號整數值,以 10 為底數
  • list:應指定參數清單
  • map:應指定參數對應
  • template:此值代表任何文字,可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照)
  • trigger_reference:這個值代表觸發條件,以觸發條件 ID 表示


可接受的值為:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
可寫入
parameter[].value string 適合指定類型的參數值 (可能包含「」等變數參照。 可寫入
parentFolderId string 上層資料夾 ID。
paused boolean 如果代碼暫停,則為 True。 可寫入
priority nested object 使用者定義的代碼數字優先順序。代碼會按照優先順序以非同步方式觸發。數值較高的代碼會先觸發。標記的優先順序可以是正值或負值。預設值為 0。 可寫入
priority.key string 唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。 可寫入
priority.list[] list 此清單參數的參數 (系統會忽略鍵)。 可寫入
priority.map[] list 此對應參數的參數 (必須有鍵,鍵不得重複)。 可寫入
priority.type string 參數類型。有效值如下:
  • boolean:這個值代表布林值,以「true」或「false」表示
  • integer:這個值代表 64 位元的帶正負號整數值,以 10 為底數
  • list:應指定參數清單
  • map:應指定參數對應
  • template:此值代表任何文字,可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照)
  • trigger_reference:這個值代表觸發條件,以觸發條件 ID 表示


可接受的值為:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
可寫入
priority.value string 適合指定類型的參數值 (可能包含「」等變數參照。 可寫入
scheduleEndMs long 排定代碼的結束時間戳記 (以毫秒為單位)。 可寫入
scheduleStartMs long 排定代碼的開始時間戳記 (以毫秒為單位)。 可寫入
setupTag[] list 設定代碼清單。目前我們只允許一個。
setupTag[].stopOnSetupFailure boolean 如果為 true,只有在設定代碼成功觸發時,才會觸發主要代碼。如果設為 false,無論設定代碼觸發狀態為何,請觸發主要代碼。
setupTag[].tagName string 設定代碼的名稱。
tagFiringOption string 觸發這個代碼的選項。

可接受的值為:
  • "oncePerEvent"
  • "oncePerLoad"
  • "unlimited"
tagId string 代碼 ID 是用來識別 GTM 代碼。
teardownTag[] list 拆解代碼清單。目前我們只允許一個。
teardownTag[].stopTeardownOnFailure boolean 如果為 true,只有在主要代碼成功觸發時,才會觸發拆解代碼。如果設為 false,則無論主要代碼觸發狀態為何,請觸發拆解代碼。
teardownTag[].tagName string 分割標記的名稱。
type string GTM 代碼類型。 可寫入

方法

請使用下列方法建立、修改、刪除或擷取代碼。

建立
建立 GTM 代碼。
刪除
刪除 GTM 代碼。
取得
取得 GTM 代碼。
list
列出容器的所有 GTM 代碼。
更新
更新 GTM 代碼。