用于创建 GTM 触发器。立即试用。
请求
HTTP 请求
POST https://www.googleapis.com/tagmanager/v2/+parent/triggers
参数
参数名称 | 值 | 说明 |
---|---|---|
路径参数 | ||
parent |
string |
GTM 工作区的 API 相对路径。示例:accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} |
授权
此请求需要获得以下范围的授权:
范围 |
---|
https://www.googleapis.com/auth/tagmanager.edit.containers |
如需了解详情,请参阅身份验证和授权页面。
请求正文
在请求正文中,提供具有以下属性的 Triggers 资源:
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
必需属性 | |||
autoEventFilter[].parameter[] |
list |
命名参数(即键值对)的列表,具体取决于条件的类型。注意:
|
可写入 |
autoEventFilter[].parameter[].type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
autoEventFilter[].type |
string |
此条件的运算符类型。
可接受的值:
|
可写入 |
checkValidation.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
continuousTimeMinMilliseconds.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
customEventFilter[].parameter[] |
list |
命名参数(即键值对)的列表,具体取决于条件的类型。注意:
|
可写入 |
customEventFilter[].parameter[].type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
customEventFilter[].type |
string |
此条件的运算符类型。
可接受的值:
|
可写入 |
eventName.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
filter[].parameter[] |
list |
命名参数(即键值对)的列表,具体取决于条件的类型。注意:
|
可写入 |
filter[].parameter[].type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
filter[].type |
string |
此条件的运算符类型。
可接受的值:
|
可写入 |
horizontalScrollPercentageList.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
interval.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
intervalSeconds.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
limit.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
maxTimerLengthSeconds.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
name |
string |
触发器显示名称。 | 可写入 |
parameter[].type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
selector.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
totalTimeMinMilliseconds.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
type |
string |
定义触发此触发器的数据层事件。
可接受的值:
|
可写入 |
uniqueTriggerId.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
verticalScrollPercentageList.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
visibilitySelector.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
visiblePercentageMax.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
visiblePercentageMin.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
waitForTags.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
waitForTagsTimeout.type |
string |
参数类型。有效值:
可接受的值:
|
可写入 |
可选属性 | |||
autoEventFilter[] |
list |
用于自动事件跟踪情形。 | 可写入 |
autoEventFilter[].parameter[].key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
autoEventFilter[].parameter[].list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
autoEventFilter[].parameter[].map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
autoEventFilter[].parameter[].value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
checkValidation |
nested object |
旨在确定我们是否应仅在其他事件处理脚本(例如,因为验证)没有取消表单提交或链接点击事件的情况下触发代码。仅对表单提交和链接点击触发器有效。 | 可写入 |
checkValidation.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
checkValidation.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
checkValidation.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
checkValidation.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
continuousTimeMinMilliseconds |
nested object |
可见性触发器的连续可见时间下限(以毫秒为单位)。仅对 AMP 可见性触发器有效。 | 可写入 |
continuousTimeMinMilliseconds.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
continuousTimeMinMilliseconds.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
continuousTimeMinMilliseconds.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
continuousTimeMinMilliseconds.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
customEventFilter[] |
list |
用于所有条件为 true 而触发的自定义事件情形。 | 可写入 |
customEventFilter[].parameter[].key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
customEventFilter[].parameter[].list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
customEventFilter[].parameter[].map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
customEventFilter[].parameter[].value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
eventName |
nested object |
触发的 GTM 事件的名称。仅对计时器触发器有效。 | 可写入 |
eventName.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
eventName.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
eventName.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
eventName.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
filter[] |
list |
此触发器仅在所有条件均为 true 时触发。 | 可写入 |
filter[].parameter[].key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
filter[].parameter[].list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
filter[].parameter[].map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
filter[].parameter[].value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
horizontalScrollPercentageList |
nested object |
滚动触发器的整数百分比值列表。该触发器会在视图水平滚动所达到的每个百分比上触发。仅对 AMP 滚动触发器有效。 | 可写入 |
horizontalScrollPercentageList.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
horizontalScrollPercentageList.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
horizontalScrollPercentageList.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
horizontalScrollPercentageList.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
interval |
nested object |
触发周期性计时器事件的时间间隔(以毫秒为单位)。仅对计时器触发器有效。 | 可写入 |
interval.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
interval.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
interval.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
interval.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
intervalSeconds |
nested object |
触发计时器事件的时间间隔(以秒为单位)。仅对 AMP 计时器触发器有效。 | 可写入 |
intervalSeconds.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
intervalSeconds.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
intervalSeconds.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
intervalSeconds.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
limit |
nested object |
此计时器触发器会触发的 GTM 事件数量限制。如果未设置限制,则在用户离开页面之前,我们将持续触发 GTM 事件。仅对计时器触发器有效。 | 可写入 |
limit.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
limit.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
limit.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
limit.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
maxTimerLengthSeconds |
nested object |
触发计时器事件的时间上限(以秒为单位)。仅对 AMP 计时器触发器有效。 | 可写入 |
maxTimerLengthSeconds.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
maxTimerLengthSeconds.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
maxTimerLengthSeconds.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
maxTimerLengthSeconds.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
notes |
string |
有关如何在容器中应用此触发器的用户注释。 | 可写入 |
parameter[] |
list |
其他参数。 | 可写入 |
parameter[].key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
parameter[].list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
parameter[].map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
parameter[].value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
selector |
nested object |
点击触发器的 CSS 选择器(即“a”、“button”等)。仅对 AMP 点击触发器有效。 | 可写入 |
selector.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
selector.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
selector.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
selector.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
totalTimeMinMilliseconds |
nested object |
可见性触发器的总可见时间下限(以毫秒为单位)。仅对 AMP 可见性触发器有效。 | 可写入 |
totalTimeMinMilliseconds.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
totalTimeMinMilliseconds.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
totalTimeMinMilliseconds.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
totalTimeMinMilliseconds.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
uniqueTriggerId |
nested object |
自动生成此属性的触发器(表单提交、链接点击或计时器监听器)的全局唯一 ID(如果有)。对于根据触发器 ID 执行过滤操作的触发器,使用此属性可让其触发不兼容的自动事件。系统会在输出生成期间填充此值,因为触发器隐含的代码在此之前并不存在。仅对表单提交、链接点击和计时器触发器有效。 | 可写入 |
uniqueTriggerId.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
uniqueTriggerId.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
uniqueTriggerId.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
uniqueTriggerId.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
verticalScrollPercentageList |
nested object |
滚动触发器的整数百分比值列表。该触发器会在视图垂直滚动所达到的每个百分比上触发。仅对 AMP 滚动触发器有效。 | 可写入 |
verticalScrollPercentageList.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
verticalScrollPercentageList.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
verticalScrollPercentageList.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
verticalScrollPercentageList.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
visibilitySelector |
nested object |
可见性触发器的 CSS 选择器(即“#id”)。仅对 AMP 可见性触发器有效。 | 可写入 |
visibilitySelector.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
visibilitySelector.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
visibilitySelector.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
visibilitySelector.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
visiblePercentageMax |
nested object |
可见性触发器的可见性百分比上限。仅对 AMP 可见性触发器有效。 | 可写入 |
visiblePercentageMax.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
visiblePercentageMax.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
visiblePercentageMax.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
visiblePercentageMax.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
visiblePercentageMin |
nested object |
可见性触发器的可见性百分比下限。仅对 AMP 可见性触发器有效。 | 可写入 |
visiblePercentageMin.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
visiblePercentageMin.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
visiblePercentageMin.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
visiblePercentageMin.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
waitForTags |
nested object |
我们是否应通过“先阻止后模拟”的默认操作处理方式,延迟提交表单或打开链接,直到触发所有代码。仅对表单提交和链接点击触发器有效。 | 可写入 |
waitForTags.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
waitForTags.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
waitForTags.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
waitForTags.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
waitForTagsTimeout |
nested object |
当上述“waits_for_tags”的计算结果为 true 时,要等待多长时间才能触发代码(以毫秒为单位)。仅对表单提交和链接点击触发器有效。 |
可写入 |
waitForTagsTimeout.key |
string |
唯一标识参数的命名键。对于顶级参数及映射值,该键属于必需项。但对于列表值,会忽略该键。 | 可写入 |
waitForTagsTimeout.list[] |
list |
该列表参数的参数(键将被忽略)。 | 可写入 |
waitForTagsTimeout.map[] |
list |
该映射参数的参数(必须提供键;且键必须具有唯一性)。 | 可写入 |
waitForTagsTimeout.value |
string |
适用于指定类型的参数的值,可以包含变量引用,如“”。 | 可写入 |
响应
如果成功,此方法将在响应正文中返回 Triggers 资源。
试试看!
使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。