有关此类资源的方法列表,请参阅本页面的结尾部分。
资源表示形式
表示 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) ] }, "notes": string, "scheduleStartMs": long, "scheduleEndMs": long, "parameter": [ { "type": string, "key": string, "value": string, "list": [ (Parameter) ], "map": [ (Parameter) ] } ], "fingerprint": string, "firingTriggerId": [ string ], "blockingTriggerId": [ string ], "setupTag": [ { "tagName": string, "stopOnSetupFailure": boolean } ], "teardownTag": [ { "tagName": string, "stopTeardownOnFailure": boolean } ], "parentFolderId": string, "tagFiringOption": string, "tagManagerUrl": 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 |
参数类型。有效值包括:
可接受的值包括:
|
可写入 |
parameter[].value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 | 可写入 |
parentFolderId |
string |
父文件夹 ID。 | |
path |
string |
GTM 代码的 API 相对路径。 | |
paused |
boolean |
指示此代码是否已被暂停,代码被暂停后就无法触发了。 | 可写入 |
priority |
nested object |
用户指定的代码优先级数值。代码会按优先级顺序异步触发。代码的优先级数值越大,触发顺序越靠前。代码的优先级可以是正值,也可以是负值。默认值为 0。 | 可写入 |
priority.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
priority.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
priority.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
priority.type |
string |
参数类型。有效值包括:
可接受的值包括:
|
可写入 |
priority.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“{{myVariable}}”。 | 可写入 |
scheduleEndMs |
long |
用于安排代码的结束时间戳(以毫秒为单位)。 | 可写入 |
scheduleStartMs |
long |
用于安排代码的开始时间戳(以毫秒为单位)。 | 可写入 |
setupTag[] |
list |
setup 代码列表。目前,我们仅允许有一个 setup 代码。 | |
setupTag[].stopOnSetupFailure |
boolean |
如果为 true,则当且仅当成功触发 setup 代码时才会触发主代码。如果为 false,则无论 setup 代码触发状态为何,都会触发主代码。 | |
setupTag[].tagName |
string |
setup 代码的名称。 | |
tagFiringOption |
string |
触发此代码的选项。
可接受的值包括:
|
|
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。 |