Clients

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

資源表示法

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "clientId": string,
  "name": string,
  "type": string,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "priority": integer,
  "fingerprint": string,
  "tagManagerUrl": string,
  "parentFolderId": string,
  "notes": string
}
資源名稱 說明 附註
accountId string GTM 帳戶 ID。
clientId string 這個用戶端 ID 可用來識別 GTM 用戶端。
containerId string GTM 容器 ID。
fingerprint string 儲存時計算出的 GTM 用戶端指紋。每次修改用戶端時,系統都會重新計算這個值。
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 相對路徑。
priority integer 優先順序會決定相對觸發順序。 可寫入
tagManagerUrl string 自動產生的代碼管理工具使用者介面連結
type string 用戶端類型。 可寫入
workspaceId string GTM 工作區 ID。

方法

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