Triggers

For a list of methods for this resource, see the end of this page.

Resource representations

Represents a Google Tag Manager Trigger

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "triggerId": string,
  "name": string,
  "type": string,
  "customEventFilter": [
    {
      "type": string,
      "parameter": [
        {
          "type": string,
          "key": string,
          "value": string,
          "list": [
            (Parameter)
          ],
          "map": [
            (Parameter)
          ],
          "isWeakReference": boolean
        }
      ]
    }
  ],
  "filter": [
    {
      "type": string,
      "parameter": [
        {
          "type": string,
          "key": string,
          "value": string,
          "list": [
            (Parameter)
          ],
          "map": [
            (Parameter)
          ],
          "isWeakReference": boolean
        }
      ]
    }
  ],
  "autoEventFilter": [
    {
      "type": string,
      "parameter": [
        {
          "type": string,
          "key": string,
          "value": string,
          "list": [
            (Parameter)
          ],
          "map": [
            (Parameter)
          ],
          "isWeakReference": boolean
        }
      ]
    }
  ],
  "waitForTags": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "checkValidation": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "waitForTagsTimeout": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "uniqueTriggerId": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "eventName": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "interval": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "limit": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "fingerprint": string,
  "parentFolderId": string,
  "selector": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "intervalSeconds": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "maxTimerLengthSeconds": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "verticalScrollPercentageList": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "horizontalScrollPercentageList": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "visibilitySelector": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "visiblePercentageMin": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "visiblePercentageMax": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "continuousTimeMinMilliseconds": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "totalTimeMinMilliseconds": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "tagManagerUrl": string,
  "notes": string,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ]
}

Property name	Value	Description	Notes
accountId	string	GTM Account ID.
autoEventFilter[]	list	Used in the case of auto event tracking.	writable
autoEventFilter[].parameter[]	list	A list of named parameters (key/value), depending on the condition's type. Notes: For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. At this time, the left operand (arg0) must be a reference to a variable. For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.	writable
autoEventFilter[].parameter[].isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
autoEventFilter[].parameter[].key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
autoEventFilter[].parameter[].list[]	list	This list parameter's parameters (keys will be ignored).	writable
autoEventFilter[].parameter[].map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
autoEventFilter[].parameter[].type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
autoEventFilter[].parameter[].value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
autoEventFilter[].type	string	The type of operator for this condition. Acceptable values are: "conditionTypeUnspecified" "contains" "cssSelector" "endsWith" "equals" "greater" "greaterOrEquals" "less" "lessOrEquals" "matchRegex" "startsWith" "urlMatches"	writable
checkValidation	nested object	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.	writable
checkValidation.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
checkValidation.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
checkValidation.list[]	list	This list parameter's parameters (keys will be ignored).	writable
checkValidation.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
checkValidation.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
checkValidation.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
containerId	string	GTM Container ID.
continuousTimeMinMilliseconds	nested object	A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger.	writable
continuousTimeMinMilliseconds.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
continuousTimeMinMilliseconds.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
continuousTimeMinMilliseconds.list[]	list	This list parameter's parameters (keys will be ignored).	writable
continuousTimeMinMilliseconds.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
continuousTimeMinMilliseconds.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
continuousTimeMinMilliseconds.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
customEventFilter[]	list	Used in the case of custom event, which is fired iff all Conditions are true.	writable
customEventFilter[].parameter[]	list	A list of named parameters (key/value), depending on the condition's type. Notes: For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. At this time, the left operand (arg0) must be a reference to a variable. For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.	writable
customEventFilter[].parameter[].isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
customEventFilter[].parameter[].key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
customEventFilter[].parameter[].list[]	list	This list parameter's parameters (keys will be ignored).	writable
customEventFilter[].parameter[].map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
customEventFilter[].parameter[].type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
customEventFilter[].parameter[].value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
customEventFilter[].type	string	The type of operator for this condition. Acceptable values are: "conditionTypeUnspecified" "contains" "cssSelector" "endsWith" "equals" "greater" "greaterOrEquals" "less" "lessOrEquals" "matchRegex" "startsWith" "urlMatches"	writable
eventName	nested object	Name of the GTM event that is fired. Only valid for Timer triggers.	writable
eventName.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
eventName.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
eventName.list[]	list	This list parameter's parameters (keys will be ignored).	writable
eventName.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
eventName.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
eventName.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
filter[]	list	The trigger will only fire iff all Conditions are true.	writable
filter[].parameter[]	list	A list of named parameters (key/value), depending on the condition's type. Notes: For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. At this time, the left operand (arg0) must be a reference to a variable. For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.	writable
filter[].parameter[].isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
filter[].parameter[].key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
filter[].parameter[].list[]	list	This list parameter's parameters (keys will be ignored).	writable
filter[].parameter[].map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
filter[].parameter[].type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
filter[].parameter[].value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
filter[].type	string	The type of operator for this condition. Acceptable values are: "conditionTypeUnspecified" "contains" "cssSelector" "endsWith" "equals" "greater" "greaterOrEquals" "less" "lessOrEquals" "matchRegex" "startsWith" "urlMatches"	writable
fingerprint	string	The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
horizontalScrollPercentageList	nested object	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.	writable
horizontalScrollPercentageList.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
horizontalScrollPercentageList.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
horizontalScrollPercentageList.list[]	list	This list parameter's parameters (keys will be ignored).	writable
horizontalScrollPercentageList.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
horizontalScrollPercentageList.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
horizontalScrollPercentageList.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
interval	nested object	Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.	writable
interval.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
interval.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
interval.list[]	list	This list parameter's parameters (keys will be ignored).	writable
interval.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
interval.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
interval.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
intervalSeconds	nested object	Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger.	writable
intervalSeconds.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
intervalSeconds.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
intervalSeconds.list[]	list	This list parameter's parameters (keys will be ignored).	writable
intervalSeconds.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
intervalSeconds.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
intervalSeconds.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
limit	nested object	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.	writable
limit.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
limit.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
limit.list[]	list	This list parameter's parameters (keys will be ignored).	writable
limit.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
limit.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
limit.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
maxTimerLengthSeconds	nested object	Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger.	writable
maxTimerLengthSeconds.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
maxTimerLengthSeconds.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
maxTimerLengthSeconds.list[]	list	This list parameter's parameters (keys will be ignored).	writable
maxTimerLengthSeconds.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
maxTimerLengthSeconds.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
maxTimerLengthSeconds.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
name	string	Trigger display name.	writable
notes	string	User notes on how to apply this trigger in the container.	writable
parameter[]	list	Additional parameters.	writable
parameter[].isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
parameter[].key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
parameter[].list[]	list	This list parameter's parameters (keys will be ignored).	writable
parameter[].map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
parameter[].type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
parameter[].value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
parentFolderId	string	Parent folder id.
path	string	GTM Trigger's API relative path.
selector	nested object	A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger.	writable
selector.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
selector.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
selector.list[]	list	This list parameter's parameters (keys will be ignored).	writable
selector.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
selector.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
selector.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
tagManagerUrl	string	Auto generated link to the tag manager UI
totalTimeMinMilliseconds	nested object	A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger.	writable
totalTimeMinMilliseconds.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
totalTimeMinMilliseconds.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
totalTimeMinMilliseconds.list[]	list	This list parameter's parameters (keys will be ignored).	writable
totalTimeMinMilliseconds.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
totalTimeMinMilliseconds.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
totalTimeMinMilliseconds.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
triggerId	string	The Trigger ID uniquely identifies the GTM Trigger.
type	string	Defines the data layer event that causes this trigger. Acceptable values are: "always" "ampClick" "ampScroll" "ampTimer" "ampVisibility" "click" "consentInit" "customEvent" "domReady" "elementVisibility" "eventTypeUnspecified" "firebaseAppException" "firebaseAppUpdate" "firebaseCampaign" "firebaseFirstOpen" "firebaseInAppPurchase" "firebaseNotificationDismiss" "firebaseNotificationForeground" "firebaseNotificationOpen" "firebaseNotificationReceive" "firebaseOsUpdate" "firebaseSessionStart" "firebaseUserEngagement" "formSubmission" "historyChange" "init" "jsError" "linkClick" "pageview" "scrollDepth" "serverPageview" "timer" "triggerGroup" "windowLoaded" "youTubeVideo"	writable
uniqueTriggerId	nested object	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.	writable
uniqueTriggerId.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
uniqueTriggerId.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
uniqueTriggerId.list[]	list	This list parameter's parameters (keys will be ignored).	writable
uniqueTriggerId.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
uniqueTriggerId.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
uniqueTriggerId.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
verticalScrollPercentageList	nested object	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.	writable
verticalScrollPercentageList.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
verticalScrollPercentageList.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
verticalScrollPercentageList.list[]	list	This list parameter's parameters (keys will be ignored).	writable
verticalScrollPercentageList.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
verticalScrollPercentageList.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
verticalScrollPercentageList.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
visibilitySelector	nested object	A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger.	writable
visibilitySelector.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
visibilitySelector.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
visibilitySelector.list[]	list	This list parameter's parameters (keys will be ignored).	writable
visibilitySelector.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
visibilitySelector.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
visibilitySelector.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
visiblePercentageMax	nested object	A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger.	writable
visiblePercentageMax.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
visiblePercentageMax.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
visiblePercentageMax.list[]	list	This list parameter's parameters (keys will be ignored).	writable
visiblePercentageMax.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
visiblePercentageMax.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
visiblePercentageMax.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
visiblePercentageMin	nested object	A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger.	writable
visiblePercentageMin.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
visiblePercentageMin.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
visiblePercentageMin.list[]	list	This list parameter's parameters (keys will be ignored).	writable
visiblePercentageMin.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
visiblePercentageMin.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
visiblePercentageMin.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
waitForTags	nested object	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.	writable
waitForTags.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
waitForTags.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
waitForTags.list[]	list	This list parameter's parameters (keys will be ignored).	writable
waitForTags.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
waitForTags.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
waitForTags.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
waitForTagsTimeout	nested object	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.	writable
waitForTagsTimeout.isWeakReference	boolean	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
waitForTagsTimeout.key	string	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
waitForTagsTimeout.list[]	list	This list parameter's parameters (keys will be ignored).	writable
waitForTagsTimeout.map[]	list	This map parameter's parameters (must have keys; keys must be unique).	writable
waitForTagsTimeout.type	string	The parameter type. Valid values are: boolean: The value represents a boolean, represented as 'true' or 'false' integer: The value represents a 64-bit signed integer value, in base 10 list: A list of parameters should be specified map: A map of parameters should be specified template: The value represents any text; this can include variable references (even variable references that might return non-string types) trigger_reference: The value represents a trigger, represented as the trigger id tag_reference: The value represents a tag, represented as the tag name Acceptable values are: "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	writable
waitForTagsTimeout.value	string	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
workspaceId	string	GTM Workspace ID.

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.