规则

容器的规则。规则运行时的计算结果为 true 或 false。它们可用于控制何时触发或阻止触发代码,以及何时启用或停用移动容器中的宏。如需了解详情,请分别参阅代码配置的触发和停用规则以及宏配置的启用和停用规则。

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

资源表示形式

用于表示 Google 跟踪代码管理器规则。

{
  "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
}
属性名称 说明 备注
accountId string GTM 帐号 ID。
condition[] list 构成此规则的条件的列表(这些条件之间存在隐式 AND 关系)。 可写入
condition[].parameter[] list 命名参数(即键值对)的列表,具体取决于条件的类型。注意:
  • 对于二元运算符,请添加名为 arg0arg1 的参数,分别用于指定左右操作数。
  • 此时,左操作数 (arg0) 必须是对宏的引用。
  • 对于不区分大小写的正则表达式匹配,请添加名为 ignore_case 且已设置为 true 的布尔值参数。如未指定该参数或已将其设置为任何其他值,则匹配将区分大小写。
  • 要使运算符无效,请添加名为 negate 的布尔值参数并将其设置为 true
可写入
condition[].parameter[].key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
condition[].parameter[].list[] list 该列表参数的参数(键将被忽略)。 可写入
condition[].parameter[].map[] list 该映射参数的参数(必须提供键,且键必须具有唯一性)。 可写入
condition[].parameter[].type string 参数类型:有效值包括:
  • boolean:该值表示布尔值,以“true”或“false”表示
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括宏引用,甚至是可能返回非字符串类型的宏引用


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

可接受的值为:
  • contains
  • cssSelector
  • endsWith
  • equals
  • greater
  • greaterOrEquals
  • less
  • lessOrEquals
  • matchRegex
  • startsWith
  • urlMatches
可写入
containerId string GTM 容器 ID。
fingerprint string GTM 规则的指纹,以存储时计算的值为准。每当修改规则时,都会重新计算此值。
name string 规则显示名。 可写入
notes string 有关如何在容器中应用此规则的用户注释。 可写入
ruleId string 唯一标识 GTM 规则的规则 ID。

方法

使用以下方法创建、修改、删除或检索规则。

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