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 唯一标识 GTM 客户端的客户端 ID。
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 位的正负十进制整数值
  • 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。

方法

create
创建 GTM 客户端。
delete
删除 GTM 客户端。
get
获取 GTM 客户端。
list
列出 GTM 容器工作区的所有 GTM 客户端。
revert
还原对 GTM 工作区中 GTM 客户端的更改。
update
更新 GTM 客户端。