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：值代表以 10 為底的 64 位元帶正負號整數值
  • 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。只要列出的任一觸發條件為「是」，且該觸發條件的所有 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：值代表以 10 為底的 64 位元帶正負號整數值
  • 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：值代表以 10 為底的 64 位元帶正負號整數值
  • 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：值代表以 10 為底的 64 位元帶正負號整數值
  • 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 代碼的專屬 ID。
tagManagerUrl string 自動產生的代碼管理工具使用者介面連結
teardownTag[] list 拆解代碼清單。目前，我們只接受一個國家/地區。
teardownTag[].stopTeardownOnFailure boolean 如果設為 true，只有在主要代碼成功觸發時才觸發拆卸代碼。如果是 false，則無論主要代碼的觸發狀態為何，都會觸發移除代碼。
teardownTag[].tagName string 卸除代碼名稱。
type string GTM 代碼類型。 可寫入
workspaceId string GTM 工作區 ID。

方法

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