Update Google Tag Gateway configuration

client.googleTagGateway.config.update(, ?): Config { enabled, endpoint, hideOriginalIp, 2 more }

PUT/zones/{zone_id}/settings/google-tag-gateway/config

Updates the Google Tag Gateway configuration for a zone.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Zone Settings Write

ParametersExpand Collapse

params: ConfigUpdateParams { zone_id, enabled, endpoint, 3 more }

zone_id: string

Path param: Identifier.

maxLength32

enabled: boolean

Body param: Enables or disables Google Tag Gateway for this zone.

endpoint: string

Body param: Specifies the endpoint path for proxying Google Tag Manager requests. Use an absolute path starting with ’/’, with no nested paths and alphanumeric characters only (e.g. /metrics).

hideOriginalIp: boolean

Body param: Hides the original client IP address from Google when enabled.

measurementId: string

Body param: Specify the Google Tag Manager container or measurement ID (e.g. GTM-XXXXXXX or G-XXXXXXXXXX).

setUpTag?: boolean | null

Body param: Set up the associated Google Tag on the zone automatically when enabled.

ReturnsExpand Collapse

Config { enabled, endpoint, hideOriginalIp, 2 more }

Google Tag Gateway configuration for a zone.

enabled: boolean

Enables or disables Google Tag Gateway for this zone.

endpoint: string

Specifies the endpoint path for proxying Google Tag Manager requests. Use an absolute path starting with ’/’, with no nested paths and alphanumeric characters only (e.g. /metrics).

hideOriginalIp: boolean

Hides the original client IP address from Google when enabled.

measurementId: string

Specify the Google Tag Manager container or measurement ID (e.g. GTM-XXXXXXX or G-XXXXXXXXXX).

setUpTag?: boolean | null

Set up the associated Google Tag on the zone automatically when enabled.

Update Google Tag Gateway configuration

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const config = await client.googleTagGateway.config.update({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
  enabled: true,
  endpoint: '/metrics',
  hideOriginalIp: true,
  measurementId: 'GTM-P2F3N47Q',
});

console.log(config.hideOriginalIp);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "enabled": true,
    "endpoint": "/metrics",
    "hideOriginalIp": true,
    "measurementId": "GTM-P2F3N47Q",
    "setUpTag": true
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "enabled": true,
    "endpoint": "/metrics",
    "hideOriginalIp": true,
    "measurementId": "GTM-P2F3N47Q",
    "setUpTag": true
  }
}