注意:此开发者网站正在向 developers.google.com/tag-platform 迁移,2021 年 9 月 30 日起系统会将您重定向到新的网址

变量:update

需要授权

更新 GTM 变量。 立即试用

请求

HTTP 请求

PUT https://www.googleapis.com/tagmanager/v2/path

参数

参数名称 说明
路径参数
path string GTM 变量的 API 相对路径。示例:accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id}
可选查询参数
fingerprint string 此指纹(如果提供)必须与所存储的变量的指纹匹配。

授权

此请求需要获得下列范围的授权(详细了解身份验证和授权)。

范围
https://www.googleapis.com/auth/tagmanager.edit.containers

请求正文

在请求正文中,提供具有以下属性的 Variables 资源

属性名称 说明 备注
必需属性
formatValue.convertFalseToValue.type string 参数类型。有效值包括:
  • boolean:该值表示布尔值,以“true”或“false”表示
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括变量引用,甚至是可能返回非字符串类型的变量引用
  • trigger_reference:该值表示触发器,以触发器 ID 表示


可接受的值包括:
  • boolean
  • integer
  • list
  • map
  • template
  • triggerReference
  • typeUnspecified
可写入
formatValue.convertNullToValue.type string 参数类型。有效值包括:
  • boolean:该值表示布尔值,以“true”或“false”表示
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括变量引用,甚至是可能返回非字符串类型的变量引用
  • trigger_reference:该值表示触发器,以触发器 ID 表示


可接受的值包括:
  • boolean
  • integer
  • list
  • map
  • template
  • triggerReference
  • typeUnspecified
可写入
formatValue.convertTrueToValue.type string 参数类型。有效值包括:
  • boolean:该值表示布尔值,以“true”或“false”表示
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括变量引用,甚至是可能返回非字符串类型的变量引用
  • trigger_reference:该值表示触发器,以触发器 ID 表示


可接受的值包括:
  • boolean
  • integer
  • list
  • map
  • template
  • triggerReference
  • typeUnspecified
可写入
formatValue.convertUndefinedToValue.type string 参数类型。有效值包括:
  • boolean:该值表示布尔值,以“true”或“false”表示
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括变量引用,甚至是可能返回非字符串类型的变量引用
  • trigger_reference:该值表示触发器,以触发器 ID 表示


可接受的值包括:
  • boolean
  • integer
  • list
  • map
  • template
  • triggerReference
  • typeUnspecified
可写入
name string 变量显示名。 可写入
parameter[].type string 参数类型。有效值包括:
  • boolean:该值表示布尔值,以“true”或“false”表示
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括变量引用,甚至是可能返回非字符串类型的变量引用
  • trigger_reference:该值表示触发器,以触发器 ID 表示


可接受的值包括:
  • boolean
  • integer
  • list
  • map
  • template
  • triggerReference
  • typeUnspecified
可写入
type string GTM 变量类型。 可写入
可选属性
disablingTriggerId[] list 仅适用于移动容器:用于停用条件变量的触发器 ID 列表;如果某个启用触发器为 true,且所有停用触发器为 false,则会启用相应变量。处理时,会将其视为无序集。 可写入
enablingTriggerId[] list 仅适用于移动容器:用于启用条件变量的触发器 ID 列表;如果某个启用触发器为 true,且所有停用触发器为 false,则会启用相应变量。处理时,会将其视为无序集。 可写入
formatValue.convertFalseToValue.key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
formatValue.convertFalseToValue.list[] list 该列表参数的参数(键将被忽略)。 可写入
formatValue.convertFalseToValue.map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写入
formatValue.convertFalseToValue.value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
formatValue.convertNullToValue.key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
formatValue.convertNullToValue.list[] list 该列表参数的参数(键将被忽略)。 可写入
formatValue.convertNullToValue.map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写入
formatValue.convertNullToValue.value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
formatValue.convertTrueToValue.key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
formatValue.convertTrueToValue.list[] list 该列表参数的参数(键将被忽略)。 可写入
formatValue.convertTrueToValue.map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写入
formatValue.convertTrueToValue.value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
formatValue.convertUndefinedToValue.key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
formatValue.convertUndefinedToValue.list[] list 该列表参数的参数(键将被忽略)。 可写入
formatValue.convertUndefinedToValue.map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写入
formatValue.convertUndefinedToValue.value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
notes string 有关如何在容器中应用此变量的用户注释。 可写入
parameter[] list 变量的参数。 可写入
parameter[].key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
parameter[].list[] list 该列表参数的参数(键将被忽略)。 可写入
parameter[].map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写入
parameter[].value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
scheduleEndMs long 用于安排变量的结束时间戳(以毫秒为单位)。 可写入
scheduleStartMs long 用于安排变量的开始时间戳(以毫秒为单位)。 可写入

响应

如果成功,此方法将在响应正文中返回 Variables 资源

试用一下!

请使用下面的 API Explorer 针对实际数据调用此方法,并查看响应。