Tags

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

資源表示法

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

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}
資源名稱 值 說明 附註
accountId string GTM 帳戶 ID。
blockingRuleId[] list 封鎖規則 ID。如果清單中的任何規則評估結果為 true，代碼就不會觸發。 可寫入
blockingTriggerId[] list 封鎖觸發條件 ID。如果清單中的任何觸發條件評估結果為 true，代碼就不會觸發。 可寫入
consentSettings nested object 代碼的同意聲明設定。 可寫入
consentSettings.consentStatus string 代碼的同意聲明狀態。如果設為 NEEDED，執行階段會檢查 consent_type 欄位指定的同意聲明類型是否已授予。

可接受的值為：
  • "needed"
  • "notNeeded"
  • "notSet"
consentSettings.consentType nested object 代碼啟用期間，如果狀態為「需要同意聲明」狀態時，系統會檢查的同意聲明類型。這個參數必須是 LIST 類型，其中每個清單項目都是 STRING 類型。
consentSettings.consentType.isWeakReference boolean 是否強烈參照參照類型參數。只會由轉換使用。 可寫入
consentSettings.consentType.key string 唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。 可寫入
consentSettings.consentType.list[] list 此清單參數的參數 (系統會忽略鍵)。 可寫入
consentSettings.consentType.map[] list 此對應參數的參數 (必須有鍵，鍵不得重複)。 可寫入
consentSettings.consentType.type string 參數類型。有效值如下：
  • boolean：這個值代表布林值，以「true」或「false」表示
  • integer：這個值代表 64 位元的帶正負號整數值，以 10 為底數
  • list：應指定參數清單
  • map：應指定參數對應
  • template：此值代表任何文字，可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照)
  • trigger_reference：這個值代表觸發條件，以觸發條件 ID 表示
  • tag_reference：這個值代表標記，以標記名稱表示


可接受的值為：
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 可寫入
consentSettings.consentType.value string 適合指定類型的參數值 (可能包含「」等變數參照。 可寫入
containerId string GTM 容器 ID。
fingerprint string 儲存時計算出的 GTM 代碼指紋。每次修改代碼時，系統都會重新計算這個值。
firingRuleId[] list 觸發規則 ID。只要列出的規則為 true，且其所有 blockingRuleIds (如有指定) 皆為 false，標記就會觸發。 可寫入
firingTriggerId[] list 觸發條件 ID。如果列出的觸發條件其中一項為 true，blockingTriggerIds (如果有的話) 全都為 false，代碼就會觸發。 可寫入
liveOnly boolean 如果設為 true，這個代碼只會在實際環境中觸發 (例如在預覽或偵錯模式下)。 可寫入
monitoringMetadata nested object 要納入事件資料中以便監控代碼的代碼中繼資料鍵/值組合的對應。附註：
  • 這個參數必須是 MAP 類型。
  • 對應中的每個參數都是 TEMPLATE 類型，但不能包含變數參照。
 可寫入
monitoringMetadata.isWeakReference boolean 是否強烈參照參照類型參數。只會由轉換使用。 可寫入
monitoringMetadata.key string 唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。 可寫入
monitoringMetadata.list[] list 此清單參數的參數 (系統會忽略鍵)。 可寫入
monitoringMetadata.map[] list 此對應參數的參數 (必須有鍵，鍵不得重複)。 可寫入
monitoringMetadata.type string 參數類型。有效值如下：
  • boolean：這個值代表布林值，以「true」或「false」表示
  • integer：這個值代表 64 位元的帶正負號整數值，以 10 為底數
  • list：應指定參數清單
  • map：應指定參數對應
  • template：此值代表任何文字，可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照)
  • trigger_reference：這個值代表觸發條件，以觸發條件 ID 表示
  • tag_reference：這個值代表標記，以標記名稱表示


可接受的值為：
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 可寫入
monitoringMetadata.value string 適合指定類型的參數值 (可能包含「」等變數參照。 可寫入
monitoringMetadataTagNameKey string 如果非空白，系統會使用指定的鍵，將標記顯示名稱納入監控中繼資料對應中。 可寫入
name string 代碼顯示名稱。 可寫入
notes string 使用者在容器中套用這個代碼的附註。 可寫入
parameter[] list 代碼的參數。 可寫入
parameter[].isWeakReference boolean 是否強烈參照參照類型參數。只會由轉換使用。 可寫入
parameter[].key string 唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。 可寫入
parameter[].list[] list 此清單參數的參數 (系統會忽略鍵)。 可寫入
parameter[].map[] list 此對應參數的參數 (必須有鍵，鍵不得重複)。 可寫入
parameter[].type string 參數類型。有效值如下：
  • boolean：這個值代表布林值，以「true」或「false」表示
  • integer：這個值代表 64 位元的帶正負號整數值，以 10 為底數
  • list：應指定參數清單
  • map：應指定參數對應
  • template：此值代表任何文字，可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照)
  • trigger_reference：這個值代表觸發條件，以觸發條件 ID 表示
  • tag_reference：這個值代表標記，以標記名稱表示


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


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

可接受的值為：
  • "oncePerEvent"
  • "oncePerLoad"
  • "tagFiringOptionUnspecified"
  • "unlimited"
tagId string 代碼 ID 是用來識別 GTM 代碼。
tagManagerUrl string 自動產生的代碼管理工具使用者介面連結
teardownTag[] list 拆解代碼清單。目前我們只允許一個。
teardownTag[].stopTeardownOnFailure boolean 如果為 true，只有在主要代碼成功觸發時，才會觸發拆解代碼。如果設為 false，則無論主要代碼觸發狀態為何，請觸發拆解代碼。
teardownTag[].tagName string 分割標記的名稱。
type string GTM 代碼類型。 可寫入
workspaceId string GTM 工作區 ID。

方法

建立
建立 GTM 代碼。
刪除
刪除 GTM 代碼。
取得
取得 GTM 代碼。
list
列出容器的所有 GTM 代碼。
revert
在 GTM 工作區中還原對 GTM 代碼的變更。
更新
更新 GTM 代碼。