Kong · Schema

GoogleTagManagerIntegration

Google Tag Manager integration configuration

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
enabled boolean Whether the integration is enabled
type string The type of the integration for categorization
config_data object Configuration data for the Google Tag Manager integration
View JSON Schema on GitHub

JSON Schema

kong-googletagmanagerintegration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GoogleTagManagerIntegration",
  "title": "GoogleTagManagerIntegration",
  "description": "Google Tag Manager integration configuration",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "Whether the integration is enabled",
      "type": "boolean"
    },
    "type": {
      "description": "The type of the integration for categorization",
      "type": "string",
      "enum": [
        "tracking"
      ]
    },
    "config_data": {
      "description": "Configuration data for the Google Tag Manager integration",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "The Google Tag Manager container ID",
          "type": "string",
          "example": "GTM-XXXXXX",
          "maxLength": 20,
          "minLength": 5,
          "pattern": "^GTM-[A-Za-z0-9]+$",
          "x-validation-message": "must be a valid GTM container ID (format: GTM-XXXXXX)"
        },
        "l": {
          "description": "Optional dataLayer variable name",
          "type": "string",
          "example": "myNewName",
          "maxLength": 100,
          "nullable": true
        },
        "preview": {
          "description": "Preview environment name",
          "type": "string",
          "example": "preview",
          "maxLength": 100,
          "nullable": true
        },
        "cookies_win": {
          "description": "Forces GTM cookies to take precedence when true",
          "type": "boolean",
          "nullable": true
        },
        "debug": {
          "description": "Enables debug mode when true",
          "type": "boolean",
          "nullable": true
        },
        "npa": {
          "description": "No Personal Advertising - disables advertising features when true",
          "type": "boolean",
          "nullable": true
        },
        "data_layer": {
          "description": "Custom dataLayer name (alternative to \"l\" property)",
          "type": "string",
          "example": "myNewName",
          "maxLength": 100,
          "nullable": true
        },
        "env_name": {
          "description": "Environment name for environment-specific container",
          "type": "string",
          "example": "production",
          "maxLength": 100,
          "nullable": true
        },
        "auth_referrer_policy": {
          "description": "Referrer policy for analytics requests",
          "type": "string",
          "example": "no-referrer",
          "maxLength": 100,
          "nullable": true
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "additionalProperties": false,
  "nullable": true,
  "required": [
    "enabled",
    "type",
    "config_data"
  ]
}