Tags

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

资源表示形式

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

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}
属性名称 值 说明 备注
accountId string GTM 账号 ID。
blockingRuleId[] list 屏蔽规则 ID。如果列出的任何规则的计算结果为 true，将不触发代码。 可写入
blockingTriggerId[] list 屏蔽型触发器 ID。如果列出的任何触发器的计算结果为 true，将不触发代码。 可写入
consentSettings nested object 代码的用户意见征求设置。 可写入
consentSettings.consentStatus string 代码的同意情况。如果设置为“NEEDED”，运行时将检查是否已授予 consent_type 字段指定的用户意见征求类型。

可接受的值包括： <ph type="x-smartling-placeholder">
    </ph>
  • “needed”
  • “notNeeded”
  • “notSet”
consentSettings.consentType nested object 在代码触发期间检查的用户意见征求类型（如果处于“需要用户意见征求”状态）。此参数的类型必须为 LIST，其中每个列表项的类型为 STRING。
consentSettings.consentType.isWeakReference boolean 引用类型参数是强引用还是弱引用。仅供转换使用。 可写入
consentSettings.consentType.key string 唯一标识参数的命名键。对于顶级参数及映射值，该键属于必需项。但对于列表值，会忽略该键。 可写入
consentSettings.consentType.list[] list 该列表参数的参数（键将被忽略）。 可写入
consentSettings.consentType.map[] list 该映射参数的参数（必须提供键；且键必须具有唯一性）。 可写入
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”
 可写入
consentSettings.consentType.value string 适用于指定类型的参数的值，可以包含变量引用，如“”。 可写入
containerId string GTM 容器 ID。
fingerprint string GTM 代码的指纹，以存储时计算的值为准。每当修改代码时，都会重新计算此值。
firingRuleId[] list 触发规则 ID。如果列出的任何规则为 true 且其所有 blockingRuleIds（如果指定）均为 false，则将触发代码。 可写入
firingTriggerId[] list 触发型触发器 ID。如果列出的任何触发器为 true 且其所有 blockingTriggerIds（如果指定）均为 false，则将触发代码。 可写入
liveOnly boolean 如果设置为 true，则此代码仅在实际环境中触发，即不在预览或调试模式下触发。 可写入
monitoringMetadata nested object 要包含在事件数据中以进行代码监控的代码元数据的键值对映射。注意：
  • 此参数的类型必须为 MAP。
  • 映射中每个参数的类型均为 TEMPLATE，但不得包含变量引用。
 可写入
monitoringMetadata.isWeakReference boolean 引用类型参数是强引用还是弱引用。仅供转换使用。 可写入
monitoringMetadata.key string 唯一标识参数的命名键。对于顶级参数及映射值，该键属于必需项。但对于列表值，会忽略该键。 可写入
monitoringMetadata.list[] list 该列表参数的参数（键将被忽略）。 可写入
monitoringMetadata.map[] list 该映射参数的参数（必须提供键；且键必须具有唯一性）。 可写入
monitoringMetadata.type string 参数类型。有效值：
  • boolean：该值表示布尔值，以“true”或“false”表示
  • integer：该值表示 64 位的正负十进制整数值
  • list：应指定的参数的列表
  • map：应指定的参数的映射
  • template：该值表示任何文本；可以包括变量引用，甚至是可能返回非字符串类型的变量引用
  • trigger_reference：该值表示触发器，以触发器 ID 表示
  • tag_reference：该值表示代码，以代码名称表示


可接受的值：
  • “boolean”
  • “integer”
  • “list”
  • “map”
  • “tagReference”
  • “template”
  • “triggerReference”
  • “typeUnspecified”
 可写入
monitoringMetadata.value string 适用于指定类型的参数的值，可以包含变量引用，如“”。 可写入
monitoringMetadataTagNameKey string 如果为非空，系统会使用指定的键将代码的显示名称包含在监控元数据映射中。 可写入
name string 代码的显示名称。 可写入
notes string 有关如何在容器中应用此代码的用户注释。 可写入
parameter[] list 代码的参数。 可写入
parameter[].isWeakReference boolean 引用类型参数是强引用还是弱引用。仅供转换使用。 可写入
parameter[].key string 唯一标识参数的命名键。对于顶级参数及映射值，该键属于必需项。但对于列表值，会忽略该键。 可写入
parameter[].list[] list 该列表参数的参数（键将被忽略）。 可写入
parameter[].map[] list 该映射参数的参数（必须提供键；且键必须具有唯一性）。 可写入
parameter[].type string 参数类型。有效值：
  • boolean：该值表示布尔值，以“true”或“false”表示
  • integer：该值表示 64 位的正负十进制整数值
  • list：应指定的参数的列表
  • map：应指定的参数的映射
  • template：该值表示任何文本；可以包括变量引用，甚至是可能返回非字符串类型的变量引用
  • trigger_reference：该值表示触发器，以触发器 ID 表示
  • tag_reference：该值表示代码，以代码名称表示


可接受的值：
  • “boolean”
  • “integer”
  • “list”
  • “map”
  • “tagReference”
  • “template”
  • “triggerReference”
  • “typeUnspecified”
 可写入
parameter[].value string 适用于指定类型的参数的值，可以包含变量引用，如“”。 可写入
parentFolderId string 父文件夹 ID。
path string GTM 代码的 API 相对路径。
paused boolean 指示此代码是否已被暂停，代码被暂停后就无法触发了。 可写入
priority nested object 用户指定的代码优先级数值。代码会按优先级顺序异步触发。代码的优先级数值越大，触发顺序越靠前。代码的优先级可以是正值，也可以是负值。默认值为 0。 可写入
priority.isWeakReference boolean 引用类型参数是强引用还是弱引用。仅供转换使用。 可写入
priority.key string 唯一标识参数的命名键。对于顶级参数及映射值，该键属于必需项。但对于列表值，会忽略该键。 可写入
priority.list[] list 该列表参数的参数（键将被忽略）。 可写入
priority.map[] list 该映射参数的参数（必须提供键；且键必须具有唯一性）。 可写入
priority.type string 参数类型。有效值：
  • boolean：该值表示布尔值，以“true”或“false”表示
  • integer：该值表示 64 位的正负十进制整数值
  • list：应指定的参数的列表
  • map：应指定的参数的映射
  • template：该值表示任何文本；可以包括变量引用，甚至是可能返回非字符串类型的变量引用
  • trigger_reference：该值表示触发器，以触发器 ID 表示
  • tag_reference：该值表示代码，以代码名称表示


可接受的值：
  • “boolean”
  • “integer”
  • “list”
  • “map”
  • “tagReference”
  • “template”
  • “triggerReference”
  • “typeUnspecified”
 可写入
priority.value string 适用于指定类型的参数的值，可以包含变量引用，如“”。 可写入
scheduleEndMs long 用于安排代码的结束时间戳（以毫秒为单位）。 可写入
scheduleStartMs long 用于安排代码的开始时间戳（以毫秒为单位）。 可写入
setupTag[] list setup 代码列表。目前，我们仅允许有一个 setup 代码。
setupTag[].stopOnSetupFailure boolean 如果为 true，则当且仅当成功触发 setup 代码时才会触发主代码。如果为 false，则无论 setup 代码触发状态为何，都会触发主代码。
setupTag[].tagName string setup 代码的名称。
tagFiringOption string 触发此代码的选项。

可接受的值包括：
  • “oncePerEvent”
  • “oncePerLoad”
  • “tagFiringOptionUnspecified”
  • “unlimited”
tagId string 唯一标识 GTM 代码的代码 ID。
tagManagerUrl string 自动生成的指向跟踪代码管理器界面的链接
teardownTag[] list teardown 代码列表。目前，我们仅允许有一个 teardown 代码。
teardownTag[].stopTeardownOnFailure boolean 如果为 true，则当且仅当成功触发主代码时才会触发 teardown 代码。如果为 false，则无论主代码触发状态为何，都会触发 teardown 代码。
teardownTag[].tagName string teardown 代码的名称。
type string GTM 代码类型。 可写入
workspaceId string GTM 工作区 ID。

方法

create
创建 GTM 代码。
delete
删除 GTM 代码。
get
获取 GTM 代码。
list
列出容器的所有 GTM 代码。
revert
还原对 GTM 工作区中 GTM 代码的更改。
update
更新 GTM 代码。