REST Resource: accounts.containers.workspaces.triggers

Resource: Trigger
- JSON representation
- EventType
Methods

Resource: Trigger

Represents a Google Tag Manager Trigger

JSON representation

JSON representation
{ "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,
  "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)
    }
  ]
}

Fields
`path`	`string` GTM Trigger's API relative path.
`accountId`	`string` GTM Account ID.
`containerId`	`string` GTM Container ID.
`workspaceId`	`string` GTM Workspace ID.
`triggerId`	`string` The Trigger ID uniquely identifies the GTM Trigger.
`name`	`string` Trigger display name.
`type`	`enum (EventType)` Defines the data layer event that causes this trigger.
`customEventFilter[]`	`object (Condition)` Used in the case of custom event, which is fired iff all Conditions are true.
`filter[]`	`object (Condition)` The trigger will only fire iff all Conditions are true.
`autoEventFilter[]`	`object (Condition)` Used in the case of auto event tracking.
`waitForTags`	`object (Parameter)` Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
`checkValidation`	`object (Parameter)` Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
`waitForTagsTimeout`	`object (Parameter)` How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to `true` . Only valid for Form Submission and Link Click triggers.
`uniqueTriggerId`	`object (Parameter)` Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
`eventName`	`object (Parameter)` Name of the GTM event that is fired. Only valid for Timer triggers.
`interval`	`object (Parameter)` Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
`limit`	`object (Parameter)` Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
`fingerprint`	`string` The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
`parentFolderId`	`string` Parent folder id.
`selector`	`object (Parameter)` A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger.
`intervalSeconds`	`object (Parameter)` Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger.
`maxTimerLengthSeconds`	`object (Parameter)` Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger.
`verticalScrollPercentageList`	`object (Parameter)` List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers.
`horizontalScrollPercentageList`	`object (Parameter)` List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers.
`visibilitySelector`	`object (Parameter)` A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger.
`visiblePercentageMin`	`object (Parameter)` A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger.
`visiblePercentageMax`	`object (Parameter)` A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger.
`continuousTimeMinMilliseconds`	`object (Parameter)` A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger.
`totalTimeMinMilliseconds`	`object (Parameter)` A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger.
`tagManagerUrl`	`string` Auto generated link to the tag manager UI
`notes`	`string` User notes on how to apply this trigger in the container.
`parameter[]`	`object (Parameter)` Additional parameters.

EventType

Enums
`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`

Methods
`create`	Creates a GTM Trigger.
`delete`	Deletes a GTM Trigger.
`get`	Gets a GTM Trigger.
`list`	Lists all GTM Triggers of a Container.
`revert`	Reverts changes to a GTM Trigger in a GTM Workspace.
`update`	Updates a GTM Trigger.

REST Resource: accounts.containers.workspaces.triggers

Resource: Trigger

EventType

Methods

`create`

`delete`

`get`

`list`

`revert`

`update`