Macros

容器的巨集。巨集代表在執行階段中評估的值。您可以在設定規則和代碼時參照巨集。如要進一步瞭解可供 Google 代碼管理工具巨集設定的屬性,請參閱巨集字典參考資料。如要瞭解使用者如何設定及使用巨集,請參閱 Google 代碼管理工具說明中心的巨集

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

資源表示法

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

{
  "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
}
資源名稱 說明 附註
accountId string GTM 帳戶 ID。
containerId string GTM 容器 ID。
disablingRuleId[] list 僅適用於行動容器:列出停用條件巨集的規則 ID 清單;如果其中一項啟用規則為 true,而所有停用規則為 False,系統就會啟用該巨集。視為未排序的集合。 可寫入
enablingRuleId[] list 僅適用於行動容器:用於啟用條件巨集的規則 ID 清單;如果其中一項啟用規則為 true,而所有停用規則為 False,此巨集就會啟用。視為未排序的集合。 可寫入
fingerprint string 儲存時計算出的 GTM 巨集指紋。每次修改巨集時,系統都會重新計算這個值。
macroId string 巨集 ID 可用來識別 GTM 巨集。
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:這個值代表任何文字,可能包括巨集參照 (甚至是可能會傳回非字串類型的巨集參照)


可接受的值為:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
可寫入
parameter[].value string 符合指定類型的參數值 (可能包含「」等巨集參照)。 可寫入
parentFolderId string 上層資料夾 ID。
scheduleEndMs long 排定巨集的結束時間戳記 (以毫秒為單位)。 可寫入
scheduleStartMs long 排定巨集的開始時間戳記 (以毫秒為單位)。 可寫入
type string GTM 巨集類型。 可寫入

方法

您可以使用下列方法建立、修改、刪除或擷取巨集。

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