REST Resource: accounts.containers.workspaces.triggers

資源:Trigger

代表 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

觸發事件 ID 可唯一識別 GTM 觸發事件。

name

string

觸發條件顯示名稱。

type

enum (EventType)

定義觸發這個觸發條件的資料層事件。

customEventFilter[]

object (Condition)

用於自訂事件,如果所有條件都為真,就會觸發。

filter[]

object (Condition)

只有在所有條件都符合時,系統才會觸發觸發條件。

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

自動產生的代碼管理工具 UI 連結

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 觸發條件。