REST Resource: accounts.containers.workspaces.triggers

资源:触发器

表示 Google 跟踪代码管理器触发器

JSON 表示法
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "triggerId": string,
  "name": string,
  "type": enum (EventType),
  "customEventFilter": [
    {
      object (Condition)
    }
  ],
  "filter": [
    {
      object (Condition)
    }
  ],
  "autoEventFilter": [
    {
      object (Condition)
    }
  ],
  "waitForTags": {
    object (Parameter)
  },
  "checkValidation": {
    object (Parameter)
  },
  "waitForTagsTimeout": {
    object (Parameter)
  },
  "uniqueTriggerId": {
    object (Parameter)
  },
  "eventName": {
    object (Parameter)
  },
  "interval": {
    object (Parameter)
  },
  "limit": {
    object (Parameter)
  },
  "fingerprint": string,
  "parentFolderId": string,
  "selector": {
    object (Parameter)
  },
  "intervalSeconds": {
    object (Parameter)
  },
  "maxTimerLengthSeconds": {
    object (Parameter)
  },
  "verticalScrollPercentageList": {
    object (Parameter)
  },
  "horizontalScrollPercentageList": {
    object (Parameter)
  },
  "visibilitySelector": {
    object (Parameter)
  },
  "visiblePercentageMin": {
    object (Parameter)
  },
  "visiblePercentageMax": {
    object (Parameter)
  },
  "continuousTimeMinMilliseconds": {
    object (Parameter)
  },
  "totalTimeMinMilliseconds": {
    object (Parameter)
  },
  "tagManagerUrl": string,
  "notes": string,
  "parameter": [
    {
      object (Parameter)
    }
  ]
}
字段
path

string

GTM 触发器的 API 相对路径。

accountId

string

GTM 账号 ID。

containerId

string

GTM 容器 ID。

workspaceId

string

GTM 工作区 ID。

triggerId

string

唯一标识 GTM 触发器的触发器 ID。

name

string

触发器显示名称。

type

enum (EventType)

定义触发此触发器的数据层事件。

customEventFilter[]

object (Condition)

用于所有条件为 true 而触发的自定义事件情形。

filter[]

object (Condition)

此触发器仅在所有条件均为 true 时触发。

autoEventFilter[]

object (Condition)

用于自动事件跟踪情形。

waitForTags

object (Parameter)

我们是否应通过“先阻止后模拟”的默认操作处理方式,延迟提交表单或打开链接,直到触发所有代码。仅对表单提交和链接点击触发器有效。

checkValidation

object (Parameter)

旨在确定我们是否应仅在其他事件处理脚本(例如,因为验证)没有取消表单提交或链接点击事件的情况下触发代码。仅对表单提交和链接点击触发器有效。

waitForTagsTimeout

object (Parameter)

当上述“waits_for_tags”的计算结果为

true

仅对表单提交和链接点击触发器有效。

uniqueTriggerId

object (Parameter)

自动生成此属性的触发器(表单提交、链接点击或计时器监听器)的全局唯一 ID(如果有)。对于根据触发器 ID 执行过滤操作的触发器,使用此属性可让其触发不兼容的自动事件。系统会在输出生成期间填充此值,因为触发器隐含的代码在此之前并不存在。仅对表单提交、链接点击和计时器触发器有效。

eventName

object (Parameter)

触发的 GTM 事件的名称。仅对计时器触发器有效。

interval

object (Parameter)

触发周期性计时器事件的时间间隔(以毫秒为单位)。仅对计时器触发器有效。

limit

object (Parameter)

此计时器触发器会触发的 GTM 事件数量限制。如果未设置限制,则在用户离开页面之前,我们将持续触发 GTM 事件。仅对计时器触发器有效。

fingerprint

string

GTM 触发器的指纹,以存储时计算的值为准。每当修改触发器时,都会重新计算此值。

parentFolderId

string

父文件夹 ID。

selector

object (Parameter)

点击触发器的 CSS 选择器(即“a”、“button”等)。仅对 AMP 点击触发器有效。

intervalSeconds

object (Parameter)

触发计时器事件的时间间隔(以秒为单位)。仅对 AMP 计时器触发器有效。

maxTimerLengthSeconds

object (Parameter)

触发计时器事件的时间上限(以秒为单位)。仅对 AMP 计时器触发器有效。

verticalScrollPercentageList

object (Parameter)

滚动触发器的整数百分比值列表。该触发器会在视图垂直滚动所达到的每个百分比上触发。仅对 AMP 滚动触发器有效。

horizontalScrollPercentageList

object (Parameter)

滚动触发器的整数百分比值列表。该触发器会在视图水平滚动所达到的每个百分比上触发。仅对 AMP 滚动触发器有效。

visibilitySelector

object (Parameter)

可见性触发器的 CSS 选择器(即“#id”)。仅对 AMP 可见性触发器有效。

visiblePercentageMin

object (Parameter)

可见性触发器的可见性百分比下限。仅对 AMP 可见性触发器有效。

visiblePercentageMax

object (Parameter)

可见性触发器的可见性百分比上限。仅对 AMP 可见性触发器有效。

continuousTimeMinMilliseconds

object (Parameter)

可见性触发器的连续可见时间下限(以毫秒为单位)。仅对 AMP 可见性触发器有效。

totalTimeMinMilliseconds

object (Parameter)

可见性触发器的总可见时间下限(以毫秒为单位)。仅对 AMP 可见性触发器有效。

tagManagerUrl

string

自动生成的指向跟踪代码管理器界面的链接

notes

string

有关如何在容器中应用此触发器的用户注释。

parameter[]

object (Parameter)

其他参数。

EventType

枚举
eventTypeUnspecified
pageview
domReady
windowLoaded
customEvent
triggerGroup
init
consentInit
serverPageview
always
firebaseAppException
firebaseAppUpdate
firebaseCampaign
firebaseFirstOpen
firebaseInAppPurchase
firebaseNotificationDismiss
firebaseNotificationForeground
firebaseNotificationOpen
firebaseNotificationReceive
firebaseOsUpdate
firebaseSessionStart
firebaseUserEngagement
formSubmission
click
linkClick
jsError
historyChange
timer
ampClick
ampTimer
ampScroll
ampVisibility
youTubeVideo
scrollDepth
elementVisibility

方法

create

创建 GTM 触发器。

delete

删除 GTM 触发器。

get

获取 GTM 触发器。

list

列出容器的所有 GTM 触发器。

revert

还原 GTM 工作区中 GTM 触发器的更改。

update

更新 GTM 触发器。