Google Tag Manager · Schema

Trigger

Represents a Google Tag Manager Trigger. A trigger defines conditions under which tags should fire, such as page views, clicks, form submissions, or custom events.

AnalyticsConversion TrackingMarketingTag ManagementTracking

Properties

Name Type Description
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 string Defines the data layer event that causes this trigger.
customEventFilter array Used in the case of custom event, which is fired if and only if all Conditions are true.
filter array The trigger will only fire if and only if all Conditions are true.
autoEventFilter array Used in the case of auto event tracking for filtering events.
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.
tagManagerUrl string Auto-generated link to the tag manager UI.
notes string User notes on how to apply this trigger in the container.
parameter array Additional parameters for the trigger.
View JSON Schema on GitHub

JSON Schema

google-tag-manager-v2-trigger-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Trigger",
  "type": "object",
  "description": "Represents a Google Tag Manager Trigger. A trigger defines conditions under which tags should fire, such as page views, clicks, form submissions, or custom events.",
  "properties": {
    "path": {
      "type": "string",
      "description": "GTM Trigger's API relative path."
    },
    "accountId": {
      "type": "string",
      "description": "GTM Account ID."
    },
    "containerId": {
      "type": "string",
      "description": "GTM Container ID."
    },
    "workspaceId": {
      "type": "string",
      "description": "GTM Workspace ID."
    },
    "triggerId": {
      "type": "string",
      "description": "The Trigger ID uniquely identifies the GTM Trigger."
    },
    "name": {
      "type": "string",
      "description": "Trigger display name."
    },
    "type": {
      "type": "string",
      "description": "Defines the data layer event that causes this trigger."
    },
    "customEventFilter": {
      "type": "array",
      "description": "Used in the case of custom event, which is fired if and only if all Conditions are true."
    },
    "filter": {
      "type": "array",
      "description": "The trigger will only fire if and only if all Conditions are true."
    },
    "autoEventFilter": {
      "type": "array",
      "description": "Used in the case of auto event tracking for filtering events."
    },
    "fingerprint": {
      "type": "string",
      "description": "The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified."
    },
    "parentFolderId": {
      "type": "string",
      "description": "Parent folder ID."
    },
    "tagManagerUrl": {
      "type": "string",
      "description": "Auto-generated link to the tag manager UI."
    },
    "notes": {
      "type": "string",
      "description": "User notes on how to apply this trigger in the container."
    },
    "parameter": {
      "type": "array",
      "description": "Additional parameters for the trigger."
    }
  }
}