Trigger

import type { Trigger } from "https://googleapis.deno.dev/v1/tagmanager:v2.ts";

Represents a Google Tag Manager Trigger

interface Trigger {

accountId?: string;

autoEventFilter?: Condition[];

checkValidation?: Parameter;

containerId?: string;

continuousTimeMinMilliseconds?: Parameter;

customEventFilter?: Condition[];

eventName?: Parameter;

filter?: Condition[];

fingerprint?: string;

horizontalScrollPercentageList?: Parameter;

interval?: Parameter;

intervalSeconds?: Parameter;

limit?: Parameter;

maxTimerLengthSeconds?: Parameter;

name?: string;

notes?: string;

parameter?: Parameter[];

parentFolderId?: string;

path?: string;

selector?: Parameter;

tagManagerUrl?: string;

totalTimeMinMilliseconds?: Parameter;

triggerId?: string;

type?:

| "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";

uniqueTriggerId?: Parameter;

verticalScrollPercentageList?: Parameter;

visibilitySelector?: Parameter;

visiblePercentageMax?: Parameter;

visiblePercentageMin?: Parameter;

waitForTags?: Parameter;

waitForTagsTimeout?: Parameter;

workspaceId?: string;

}

§Properties

accountId?: string

[src]

GTM Account ID.

autoEventFilter?: Condition[]

[src]

Used in the case of auto event tracking.

checkValidation?: Parameter

[src]

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.

containerId?: string

[src]

GTM Container ID.

continuousTimeMinMilliseconds?: Parameter

[src]

A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger.

customEventFilter?: Condition[]

[src]

Used in the case of custom event, which is fired iff all Conditions are true.

eventName?: Parameter

[src]

Name of the GTM event that is fired. Only valid for Timer triggers.

filter?: Condition[]

[src]

The trigger will only fire iff all Conditions are true.

fingerprint?: string

[src]

The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.

horizontalScrollPercentageList?: Parameter

[src]

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.

interval?: Parameter

[src]

Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.

intervalSeconds?: Parameter

[src]

Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger.

limit?: Parameter

[src]

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.

maxTimerLengthSeconds?: Parameter

[src]

Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger.

name?: string

[src]

Trigger display name.

notes?: string

[src]

User notes on how to apply this trigger in the container.

parameter?: Parameter[]

[src]

Additional parameters.

parentFolderId?: string

[src]

Parent folder id.

path?: string

[src]

GTM Trigger's API relative path.

selector?: Parameter

[src]

A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger.

tagManagerUrl?: string

[src]

Auto generated link to the tag manager UI

totalTimeMinMilliseconds?: Parameter

[src]

A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger.

triggerId?: string

[src]

The Trigger ID uniquely identifies the GTM Trigger.

[src]

Defines the data layer event that causes this trigger.

uniqueTriggerId?: Parameter

[src]

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.

verticalScrollPercentageList?: Parameter

[src]

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.

visibilitySelector?: Parameter

[src]

A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger.

visiblePercentageMax?: Parameter

[src]

A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger.

visiblePercentageMin?: Parameter

[src]

A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger.

waitForTags?: Parameter

[src]

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.

waitForTagsTimeout?: Parameter

[src]

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.

workspaceId?: string

[src]

GTM Workspace ID.