Variables

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

资源表示形式

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

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "variableId": string,
  "name": string,
  "type": string,
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    "caseConversionType": string,
    "convertNullToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertUndefinedToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertTrueToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertFalseToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}
属性名称 值 说明 备注
accountId string GTM 账号 ID。
containerId string GTM 容器 ID。
disablingTriggerId[] list 仅适用于移动容器：用于停用条件变量的触发器 ID 列表；如果某个启用触发器为 true，且所有停用触发器为 false，则会启用相应变量。处理时，会将其视为无序集。 可写入
enablingTriggerId[] list 仅适用于移动容器：用于启用条件变量的触发器 ID 列表；如果某个启用触发器为 true，且所有停用触发器为 false，则会启用相应变量。处理时，会将其视为无序集。 可写入
fingerprint string GTM 变量的指纹，以存储时计算的值为准。每当修改变量时，都会重新计算此值。
formatValue nested object 将变量值转换为其他值的选项。
formatValue.caseConversionType string 将字符串类型的变量值转换为小写或大写格式的选项。

可接受的值：
  • “lowercase”
  • “none”
  • “uppercase”
formatValue.convertFalseToValue nested object 要在变量值为 false 时进行转换的值。
formatValue.convertFalseToValue.isWeakReference boolean 引用类型参数是强引用还是弱引用。仅供转换使用。 可写入
formatValue.convertFalseToValue.key string 唯一标识参数的命名键。对于顶级参数及映射值，该键属于必需项。但对于列表值，会忽略该键。 可写入
formatValue.convertFalseToValue.list[] list 该列表参数的参数（键将被忽略）。 可写入
formatValue.convertFalseToValue.map[] list 该映射参数的参数（必须提供键；且键必须具有唯一性）。 可写入
formatValue.convertFalseToValue.type string 参数类型。有效值：
  • boolean：该值表示布尔值，以“true”或“false”表示
  • integer：该值表示 64 位的正负十进制整数值
  • list：应指定的参数的列表
  • map：应指定的参数的映射
  • template：该值表示任何文本；可以包括变量引用，甚至是可能返回非字符串类型的变量引用
  • trigger_reference：该值表示触发器，以触发器 ID 表示
  • tag_reference：该值表示代码，以代码名称表示


可接受的值：
  • “boolean”
  • “integer”
  • “list”
  • “map”
  • “tagReference”
  • “template”
  • “triggerReference”
  • “typeUnspecified”
 可写入
formatValue.convertFalseToValue.value string 适用于指定类型的参数的值，可以包含变量引用，如“”。 可写入
formatValue.convertNullToValue nested object 要在变量值为 null 时进行转换的值。
formatValue.convertNullToValue.isWeakReference boolean 引用类型参数是强引用还是弱引用。仅供转换使用。 可写入
formatValue.convertNullToValue.key string 唯一标识参数的命名键。对于顶级参数及映射值，该键属于必需项。但对于列表值，会忽略该键。 可写入
formatValue.convertNullToValue.list[] list 该列表参数的参数（键将被忽略）。 可写入
formatValue.convertNullToValue.map[] list 该映射参数的参数（必须提供键；且键必须具有唯一性）。 可写入
formatValue.convertNullToValue.type string 参数类型。有效值：
  • boolean：该值表示布尔值，以“true”或“false”表示
  • integer：该值表示 64 位的正负十进制整数值
  • list：应指定的参数的列表
  • map：应指定的参数的映射
  • template：该值表示任何文本；可以包括变量引用，甚至是可能返回非字符串类型的变量引用
  • trigger_reference：该值表示触发器，以触发器 ID 表示
  • tag_reference：该值表示代码，以代码名称表示


可接受的值：
  • “boolean”
  • “integer”
  • “list”
  • “map”
  • “tagReference”
  • “template”
  • “triggerReference”
  • “typeUnspecified”
 可写入
formatValue.convertNullToValue.value string 适用于指定类型的参数的值，可以包含变量引用，如“”。 可写入
formatValue.convertTrueToValue nested object 要在变量值为 true 时进行转换的值。
formatValue.convertTrueToValue.isWeakReference boolean 引用类型参数是强引用还是弱引用。仅供转换使用。 可写入
formatValue.convertTrueToValue.key string 唯一标识参数的命名键。对于顶级参数及映射值，该键属于必需项。但对于列表值，会忽略该键。 可写入
formatValue.convertTrueToValue.list[] list 该列表参数的参数（键将被忽略）。 可写入
formatValue.convertTrueToValue.map[] list 该映射参数的参数（必须提供键；且键必须具有唯一性）。 可写入
formatValue.convertTrueToValue.type string 参数类型。有效值：
  • boolean：该值表示布尔值，以“true”或“false”表示
  • integer：该值表示 64 位的正负十进制整数值
  • list：应指定的参数的列表
  • map：应指定的参数的映射
  • template：该值表示任何文本；可以包括变量引用，甚至是可能返回非字符串类型的变量引用
  • trigger_reference：该值表示触发器，以触发器 ID 表示
  • tag_reference：该值表示代码，以代码名称表示


可接受的值：
  • “boolean”
  • “integer”
  • “list”
  • “map”
  • “tagReference”
  • “template”
  • “triggerReference”
  • “typeUnspecified”
 可写入
formatValue.convertTrueToValue.value string 适用于指定类型的参数的值，可以包含变量引用，如“”。 可写入
formatValue.convertUndefinedToValue nested object 要在变量值未定义时进行转换的值。
formatValue.convertUndefinedToValue.isWeakReference boolean 引用类型参数是强引用还是弱引用。仅供转换使用。 可写入
formatValue.convertUndefinedToValue.key string 唯一标识参数的命名键。对于顶级参数及映射值，该键属于必需项。但对于列表值，会忽略该键。 可写入
formatValue.convertUndefinedToValue.list[] list 该列表参数的参数（键将被忽略）。 可写入
formatValue.convertUndefinedToValue.map[] list 该映射参数的参数（必须提供键；且键必须具有唯一性）。 可写入
formatValue.convertUndefinedToValue.type string 参数类型。有效值：
  • boolean：该值表示布尔值，以“true”或“false”表示
  • integer：该值表示 64 位的正负十进制整数值
  • list：应指定的参数的列表
  • map：应指定的参数的映射
  • template：该值表示任何文本；可以包括变量引用，甚至是可能返回非字符串类型的变量引用
  • trigger_reference：该值表示触发器，以触发器 ID 表示
  • tag_reference：该值表示代码，以代码名称表示


可接受的值：
  • “boolean”
  • “integer”
  • “list”
  • “map”
  • “tagReference”
  • “template”
  • “triggerReference”
  • “typeUnspecified”
 可写入
formatValue.convertUndefinedToValue.value string 适用于指定类型的参数的值，可以包含变量引用，如“”。 可写入
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 相对路径。
scheduleEndMs long 用于安排变量的结束时间戳（以毫秒为单位）。 可写入
scheduleStartMs long 用于安排变量的开始时间戳（以毫秒为单位）。 可写入
tagManagerUrl string 自动生成的指向跟踪代码管理器界面的链接
type string GTM 变量类型。 可写入
variableId string 唯一标识 GTM 变量的变量 ID。
workspaceId string GTM 工作区 ID。

方法

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