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

代码

与容器关联的代码。通常情况下,代码会与一个或多个触发规则相关联(请参见下面的 firingRuleId),也会可选地与一个或多个屏蔽规则相关联(请参见下面的 blockingRuleId)。如果至少一个触发规则的计算结果为 true,且屏蔽规则的计算结果均不为 true 时,则触发(执行)代码。通过使用可选的 priority 属性,可调整代码的优先触发顺序;而使用 dependencies 属性,可指定必须在此代码触发前触发和完成的其他代码。如需详细了解可为 Google 跟踪代码管理器代码设置的参数,请参阅代码字典参考

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

资源表示形式

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

{
  "accountId": string,
  "containerId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  ],
  "fingerprint": string,
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "paused": boolean
}
属性名称 说明 备注
accountId string GTM 帐号 ID。
blockingRuleId[] list 屏蔽规则 ID。如果列出的任何规则的计算结果为 true,将不触发代码。 可写入
blockingTriggerId[] list 屏蔽型触发器 ID。如果列出的任何触发器的计算结果为 true,将不触发代码。 可写入
containerId string GTM 容器 ID。
fingerprint string GTM 代码的指纹,以存储时计算的值为准。每当修改代码时,都会重新计算此值。
firingRuleId[] list 触发规则 ID。如果列出的任何规则为 true 且其所有 blockingRuleIds(如果指定)均为 false,则将触发代码。 可写入
firingTriggerId[] list 触发型触发器 ID。如果列出的任何触发器为 true 且其所有 blockingTriggerIds(如果指定)均为 false,则将触发代码。 可写入
liveOnly boolean 如果设置为 true,则此代码仅在实际环境中触发,即不在预览或调试模式下触发。 可写入
name string 代码显示名。 可写入
notes string 有关如何在容器中应用此代码的用户注释。 可写入
parameter[] list 代码的参数。 可写入
parameter[].key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
parameter[].list[] list 该列表参数的参数(键将被忽略)。 可写入
parameter[].map[] list 该映射参数的参数(必须提供键,且键必须具有唯一性)。 可写入
parameter[].type string 参数类型。有效值包括:
  • boolean:值为“true”或“false”的布尔值
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括变量引用,甚至是可能返回非字符串类型的变量引用


可接受的值为:
  • boolean
  • integer
  • list
  • map
  • template
可写入
parameter[].value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
parentFolderId string 父文件夹 ID。
paused boolean 如果代码已暂停,则为 True。 可写入
priority nested object 用户指定的代码优先级数值。代码按优先级顺序异步触发。代码的优先级数值越大,触发顺序越靠前。代码的优先级可以是正值,也可以是负值。默认值为 0。 可写入
priority.key string 唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 可写入
priority.list[] list 该列表参数的参数(键将被忽略)。 可写入
priority.map[] list 该映射参数的参数(必须提供键,且键必须具有唯一性)。 可写入
priority.type string 参数类型。有效值包括:
  • boolean:值为“true”或“false”的布尔值
  • integer:该值表示 64 位的正负十进制整数值
  • list:应指定的参数的列表
  • map:应指定的参数的映射
  • template:该值表示任何文本;可以包括变量引用,甚至是可能返回非字符串类型的变量引用


可接受的值为:
  • boolean
  • integer
  • list
  • map
  • template
可写入
priority.value string 适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 可写入
scheduleEndMs long 用于安排代码的结束时间戳(以毫秒为单位)。 可写入
scheduleStartMs long 用于安排代码的开始时间戳(以毫秒为单位)。 可写入
setupTag[] list setup 代码列表。目前,我们仅支持一个列表。
setupTag[].stopOnSetupFailure boolean 如果为 true,则当且仅当成功触发 setup 代码时才会触发主代码。如果为 false,则无论 setup 代码触发与否,都会触发主代码。
setupTag[].tagName string setup 代码的名称。
tagFiringOption string 触发此代码的选项。

可接受的值为:
  • oncePerEvent
  • oncePerLoad
  • unlimited
tagId string 唯一标识 GTM 代码的代码 ID。
teardownTag[] list teardown 代码列表。目前,我们仅支持一个列表。
teardownTag[].stopTeardownOnFailure boolean 如果为 true,则当且仅当成功触发主代码时才会触发 teardown 代码。如果为 false,则无论主代码触发与否,都会触发 teardown 代码。
teardownTag[].tagName string teardown 代码的名称。
type string GTM 代码类型。 可写入

方法

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

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