变量

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

表示 Google 跟踪代码管理器变量。

{
  "accountId": string,
  "containerId": string,
  "variableId": string,
  "name": string,
  "type": string,
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string
}
属性名称 说明 备注
accountId string GTM 帐号 ID。
containerId string GTM 容器 ID。
disablingTriggerId[] list 仅适用于移动容器:用于停用条件变量的触发器 ID 列表;如果某个启用触发器为 true,且所有停用触发器为 false,则会启用相应变量。处理时,会将其视为无序集。 可写入
enablingTriggerId[] list 仅适用于移动容器:用于启用条件变量的触发器 ID 列表;如果某个启用触发器为 true,且所有停用触发器为 false,则会启用相应变量。处理时,会将其视为无序集。 可写入
fingerprint string GTM 变量的指纹,以存储时计算的值为准。每当修改变量时,都会重新计算此值。
name string 变量显示名。 可写入
notes string 有关如何在容器中应用此变量的用户注释。 可写入
parameter[] list 变量的参数。 可写入
parameter[].key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
parameter[].list[] list 该列表参数的参数(键将被忽略)。 可写入
parameter[].map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写入
parameter[].type string 参数类型。有效值包括:
  • boolean:该值表示布尔值,以“true”或“false”表示
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括变量引用,甚至是可能返回非字符串类型的变量引用


可接受的值包括:
  • boolean
  • integer
  • list
  • map
  • template
可写入
parameter[].value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
parentFolderId string 父文件夹 ID。
scheduleEndMs long 用于安排变量的结束时间戳(以毫秒为单位)。 可写入
scheduleStartMs long 用于安排变量的开始时间戳(以毫秒为单位)。 可写入
type string GTM 变量类型。 可写入
variableId string 唯一标识 GTM 变量的变量 ID。

方法

create
创建 GTM 变量。
delete
删除 GTM 变量。
get
获取 GTM 变量。
list
列出容器的所有 GTM 变量。
update
更新 GTM 变量。