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 トリガーを更新します。