Tags: update

更新 GTM 代码。立即试用

请求

HTTP 请求

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

参数

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

授权

此请求需要获得以下范围的授权:

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

如需了解详情,请参阅身份验证和授权页面。

请求正文

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

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


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


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


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


可接受的值:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
可写
type string GTM 代码类型。 可写
可选属性
blockingRuleId[] list 屏蔽规则 ID。如果列出的任何规则的计算结果为 true,将不触发代码。 可写
blockingTriggerId[] list 屏蔽型触发器 ID。如果列出的任何触发器的计算结果为 true,将不触发代码。 可写
consentSettings nested object 代码的用户意见征求设置。 可写
consentSettings.consentType.key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写
consentSettings.consentType.list[] list 该列表参数的参数(键将被忽略)。 可写
consentSettings.consentType.map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写
consentSettings.consentType.value string 适用于指定类型的参数的值,可以包含变量引用,如“”。 可写
firingRuleId[] list 触发规则 ID。如果列出的任何规则为 true 且其所有 blockingRuleIds(如果指定)均为 false,则将触发代码。 可写
firingTriggerId[] list 触发型触发器 ID。如果列出的任何触发器为 true 且其所有 blockingTriggerIds(如果指定)均为 false,则将触发代码。 可写
liveOnly boolean 如果设置为 true,则此代码仅在实际环境中触发,即不在预览或调试模式下触发。 可写
monitoringMetadata nested object 要包含在事件数据中以进行代码监控的代码元数据的键值对映射。注意:
  • 此参数的类型必须为 MAP
  • 映射中每个参数的类型均为 TEMPLATE,但不得包含变量引用。
可写
monitoringMetadata.key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写
monitoringMetadata.list[] list 该列表参数的参数(键将被忽略)。 可写
monitoringMetadata.map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写
monitoringMetadata.value string 适用于指定类型的参数的值,可以包含变量引用,如“”。 可写
monitoringMetadataTagNameKey string 如果为非空,系统会使用指定的键将代码的显示名称包含在监控元数据映射中。 可写
notes string 有关如何在容器中应用此代码的用户注释。 可写
parameter[] list 代码的参数。 可写
parameter[].key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写
parameter[].list[] list 该列表参数的参数(键将被忽略)。 可写
parameter[].map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写
parameter[].value string 适用于指定类型的参数的值,可以包含变量引用,如“”。 可写
paused boolean 指示此代码是否已被暂停,代码被暂停后就无法触发了。 可写
priority nested object 用户指定的代码优先级数值。代码会按优先级顺序异步触发。代码的优先级数值越大,触发顺序越靠前。代码的优先级可以是正值,也可以是负值。默认值为 0。 可写
priority.key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写
priority.list[] list 该列表参数的参数(键将被忽略)。 可写
priority.map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写
priority.value string 适用于指定类型的参数的值,可以包含变量引用,如“”。 可写
scheduleEndMs long 用于安排代码的结束时间戳(以毫秒为单位)。 可写
scheduleStartMs long 用于安排代码的开始时间戳(以毫秒为单位)。 可写

响应

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

试试看!

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