Container Versions

容器的容器版本。容器版本可視為容器設定在特定時間點的不可變更副本 (快照)。使用 create 方法建立新版本時,系統會根據目前設定 (即容器的巨集、規則和標記) 建立版本。restore 方法會使用指定的版本還原容器設定。update 方法可讓您更新版本的 namenotes 欄位。如要擷取目前發布的版本,請使用 get 方法,並為 containerVersionId 指定 published

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

資源表示法

代表 Google 代碼管理工具容器版本。

{
  "accountId": string,
  "containerId": string,
  "containerVersionId": string,
  "name": string,
  "deleted": boolean,
  "notes": string,
  "container": accounts.containers Resource,
  "macro": [
    {
      "accountId": string,
      "containerId": string,
      "macroId": string,
      "name": string,
      "type": string,
      "notes": string,
      "scheduleStartMs": long,
      "scheduleEndMs": long,
      "parameter": [
        {
          "type": string,
          "key": string,
          "value": string,
          "list": [
            (Parameter)
          ],
          "map": [
            (Parameter)
          ]
        }
      ],
      "enablingRuleId": [
        string
      ],
      "disablingRuleId": [
        string
      ],
      "fingerprint": string,
      "parentFolderId": string
    }
  ],
  "rule": [
    {
      "accountId": string,
      "containerId": string,
      "ruleId": string,
      "name": string,
      "notes": string,
      "condition": [
        {
          "type": string,
          "parameter": [
            {
              "type": string,
              "key": string,
              "value": string,
              "list": [
                (Parameter)
              ],
              "map": [
                (Parameter)
              ]
            }
          ]
        }
      ],
      "fingerprint": string
    }
  ],
  "tag": [
    accounts.containers.tags Resource
  ],
  "trigger": [
    accounts.containers.triggers Resource
  ],
  "variable": [
    accounts.containers.variables Resource
  ],
  "folder": [
    accounts.containers.folders Resource
  ],
  "fingerprint": string
}
資源名稱 說明 附註
accountId string GTM 帳戶 ID。
container nested object 取得這個版本的來源容器。
containerId string GTM 容器 ID。
containerVersionId string containerVersionId 是用來識別 GTM 容器版本的專屬識別碼。
deleted boolean 如果值為 true,表示這個容器版本已遭刪除。
fingerprint string 儲存時計算出的 GTM 容器版本指紋。每當容器版本修改時,系統都會重新計算這個值。
folder[] list 容器中取自這個版本的資料夾。
macro[] list 產生這個版本來源的容器中的巨集。
macro[].accountId string GTM 帳戶 ID。
macro[].containerId string GTM 容器 ID。
macro[].disablingRuleId[] list 僅適用於行動容器:列出停用條件巨集的規則 ID 清單;如果其中一項啟用規則為 true,而所有停用規則為 False,系統就會啟用該巨集。視為未排序的集合。
macro[].enablingRuleId[] list 僅適用於行動容器:用於啟用條件巨集的規則 ID 清單;如果其中一項啟用規則為 true,而所有停用規則為 False,此巨集就會啟用。視為未排序的集合。
macro[].fingerprint string 儲存時計算出的 GTM 巨集指紋。每次修改巨集時,系統都會重新計算這個值。
macro[].macroId string 巨集 ID 可用來識別 GTM 巨集。
macro[].name string 巨集顯示名稱。
macro[].notes string 使用者如何在容器中套用這個巨集。
macro[].parameter[] list 巨集的參數。
macro[].parameter[].key string 唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。 可寫入
macro[].parameter[].list[] list 此清單參數的參數 (系統會忽略鍵)。 可寫入
macro[].parameter[].map[] list 此對應參數的參數 (必須有鍵,鍵不得重複)。 可寫入
macro[].parameter[].type string 參數類型。有效值如下:
  • boolean:這個值代表布林值,以「true」或「false」表示
  • integer:這個值代表 64 位元的帶正負號整數值,以 10 為底數
  • list:應指定參數清單
  • map:應指定參數對應
  • template:此值代表任何文字,可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照)
  • trigger_reference:這個值代表觸發條件,以觸發條件 ID 表示


可接受的值為:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
可寫入
macro[].parameter[].value string 適合指定類型的參數值 (可能包含「」等變數參照。 可寫入
macro[].parentFolderId string 上層資料夾 ID。
macro[].scheduleEndMs long 排定巨集的結束時間戳記 (以毫秒為單位)。
macro[].scheduleStartMs long 排定巨集的開始時間戳記 (以毫秒為單位)。
macro[].type string GTM 巨集類型。
name string 容器版本顯示名稱。 可寫入
notes string 使用者說明如何在容器中套用這個容器版本。 可寫入
rule[] list 版本取自容器中的規則。
rule[].accountId string GTM 帳戶 ID。
rule[].condition[] list 組成這項規則的條件清單 (兩者之間隱含 AND)。
rule[].condition[].parameter[] list 根據條件類型而定的已命名參數 (鍵/值) 清單。附註:
  • 針對二進位運算子,請加入名為 arg0arg1 的參數,分別指定左右運算元。
  • 目前,左運算元 (arg0) 必須是變數的參照。
  • 對於不區分大小寫的規則運算式比對,請加入名為 ignore_case 的布林值參數,並設為 true。如未指定或設為任何其他值,比對會區分大小寫。
  • 如要否定運算子,請加入名為 negate 布林參數的布林值參數,並設為 true
可寫入
rule[].condition[].parameter[].key string 唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。 可寫入
rule[].condition[].parameter[].list[] list 此清單參數的參數 (系統會忽略鍵)。 可寫入
rule[].condition[].parameter[].map[] list 此對應參數的參數 (必須有鍵,鍵不得重複)。 可寫入
rule[].condition[].parameter[].type string 參數類型。有效值如下:
  • boolean:這個值代表布林值,以「true」或「false」表示
  • integer:這個值代表 64 位元的帶正負號整數值,以 10 為底數
  • list:應指定參數清單
  • map:應指定參數對應
  • template:此值代表任何文字,可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照)
  • trigger_reference:這個值代表觸發條件,以觸發條件 ID 表示


可接受的值為:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
可寫入
rule[].condition[].parameter[].value string 適合指定類型的參數值 (可能包含「」等變數參照。 可寫入
rule[].condition[].type string 此條件的運算子類型。

可接受的值為:
  • "contains"
  • "cssSelector"
  • "endsWith"
  • "equals"
  • "greater"
  • "greaterOrEquals"
  • "less"
  • "lessOrEquals"
  • "matchRegex"
  • "startsWith"
  • "urlMatches"
可寫入
rule[].containerId string GTM 容器 ID。
rule[].fingerprint string 儲存時計算出的 GTM 規則指紋。每當規則修改時,系統都會重新計算這個值。
rule[].name string 規則顯示名稱。
rule[].notes string 使用者說明如何在容器中套用這項規則。
rule[].ruleId string 規則 ID 可用來識別 Google 代碼管理工具規則。
tag[] list 版本取自容器中的代碼。
trigger[] list 容器中,這個版本擷取來源的觸發條件。
variable[] list 版本中使用的來源容器變數。

方法

建立
建立容器版本。
刪除
刪除容器版本。
取得
取得容器版本。
list
列出 GTM 容器的所有容器版本。
publish
發布容器版本。
還原
還原容器版本。這項操作會覆寫容器目前的設定 (包括容器的變數、觸發條件和代碼)。這項作業不會對提供的版本 (即已發布的版本) 產生任何影響。
undelete
取消刪除容器版本。
更新
更新容器版本。