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

容器版本

容器的容器版本。容器版本可以视为容器配置在特定时间点的不可变副本(快照)。在使用 create 方法创建新版本时,会创建一个基于当前配置(即容器的宏、规则和代码)的版本。restore 方法会用指定版本恢复容器的配置。而 update 方法可更新版本的 namenotes 字段。要获取当前发布的版本,请使用 get 方法并为 containerVersionId 指定 published

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

资源表示形式

表示 Google 跟踪代码管理器容器的版本。

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


可接受的值包括:
  • boolean
  • integer
  • list
  • map
  • template
可写入
macro[].parameter[].value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
macro[].parentFolderId string 父文件夹 ID。
macro[].scheduleEndMs long 用于安排宏的结束时间戳(以毫秒为单位)。
macro[].scheduleStartMs long 用于安排宏的开始时间戳(以毫秒为单位)。
macro[].type string GTM 宏类型。
name string 容器版本的显示名。 可写入
notes string 有关如何在容器中应用此容器版本的用户注释。 可写入
rule[] list 该版本所在的容器中的规则。
rule[].accountId string GTM 帐号 ID。
rule[].condition[] list 构成此规则的条件的列表(这些条件之间存在隐式 AND 关系)。
rule[].condition[].parameter[] list 命名参数(即键值对)的列表,具体取决于条件的类型。注意:
  • 对于二元运算符,请添加名为 arg0arg1 的参数,分别用于指定左右操作数。
  • 此时,左操作数 (arg0) 必须是对变量的引用。
  • 对于不区分大小写的正则表达式匹配,请添加名为 ignore_case 且已设置为 true 的布尔值参数。如未指定该参数或已将其设置为任何其他值,则匹配将区分大小写。
  • 要使运算符无效,请添加名为 negate 且已设置为 true 的布尔值参数。
可写入
rule[].condition[].parameter[].key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
rule[].condition[].parameter[].list[] list 该列表参数的参数(键将被忽略)。 可写入
rule[].condition[].parameter[].map[] list 该映射参数的参数(必须提供键;且键必须具有唯一性)。 可写入
rule[].condition[].parameter[].type string 参数类型。有效值包括:
  • boolean:该值表示布尔值,以“true”或“false”表示
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括变量引用,甚至是可能返回非字符串类型的变量引用


可接受的值包括:
  • boolean
  • integer
  • list
  • map
  • template
可写入
rule[].condition[].parameter[].value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
rule[].condition[].type string 此条件的运算符类型。

可接受的值包括:
  • contains
  • cssSelector
  • endsWith
  • equals
  • greater
  • greaterOrEquals
  • less
  • lessOrEquals
  • matchRegex
  • startsWith
  • urlMatches
可写入
rule[].containerId string GTM 容器 ID。
rule[].fingerprint string GTM 规则的指纹,以存储时计算的值为准。每当修改规则时,都会重新计算此值。
rule[].name string 规则显示名。
rule[].notes string 有关如何在容器中应用此规则的用户注释。
rule[].ruleId string 唯一标识 GTM 规则的规则 ID。
tag[] list 该版本所在的容器中的代码。
trigger[] list 该版本所在的容器中的触发器。
variable[] list 该版本所在的容器中的变量。

方法

create
创建容器版本。
delete
删除容器版本。
get
获取容器版本。
list
列出 GTM 容器的所有容器版本。
publish
发布容器版本。
restore
恢复容器版本。这将覆盖该容器的当前配置,包括其变量、触发器和代码。该操作不会对目前投入使用的版本(即已发布的版本)产生任何影响。
undelete
恢复删除的容器版本。
update
更新容器版本。