# Google Tag Gateway

# Config

## Get Google Tag Gateway configuration

`google_tag_gateway.config.get(ConfigGetParams**kwargs)  -> Config`

**get** `/zones/{zone_id}/settings/google-tag-gateway/config`

Gets the Google Tag Gateway configuration for a zone.

### Parameters

- `zone_id: str`

  Identifier.

### Returns

- `class Config: …`

  Google Tag Gateway configuration for a zone.

  - `enabled: bool`

    Enables or disables Google Tag Gateway for this zone.

  - `endpoint: str`

    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).

  - `hide_original_ip: bool`

    Hides the original client IP address from Google when enabled.

  - `measurement_id: str`

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

  - `set_up_tag: Optional[bool]`

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

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
config = client.google_tag_gateway.config.get(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(config.hide_original_ip)
```

#### Response

```json
{
  "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
  }
}
```

## Update Google Tag Gateway configuration

`google_tag_gateway.config.update(ConfigUpdateParams**kwargs)  -> Config`

**put** `/zones/{zone_id}/settings/google-tag-gateway/config`

Updates the Google Tag Gateway configuration for a zone.

### Parameters

- `zone_id: str`

  Identifier.

- `enabled: bool`

  Enables or disables Google Tag Gateway for this zone.

- `endpoint: str`

  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).

- `hide_original_ip: bool`

  Hides the original client IP address from Google when enabled.

- `measurement_id: str`

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

- `set_up_tag: Optional[bool]`

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

### Returns

- `class Config: …`

  Google Tag Gateway configuration for a zone.

  - `enabled: bool`

    Enables or disables Google Tag Gateway for this zone.

  - `endpoint: str`

    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).

  - `hide_original_ip: bool`

    Hides the original client IP address from Google when enabled.

  - `measurement_id: str`

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

  - `set_up_tag: Optional[bool]`

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

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
config = client.google_tag_gateway.config.update(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    enabled=True,
    endpoint="/metrics",
    hide_original_ip=True,
    measurement_id="GTM-P2F3N47Q",
)
print(config.hide_original_ip)
```

#### Response

```json
{
  "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
  }
}
```

## Domain Types

### Config

- `class Config: …`

  Google Tag Gateway configuration for a zone.

  - `enabled: bool`

    Enables or disables Google Tag Gateway for this zone.

  - `endpoint: str`

    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).

  - `hide_original_ip: bool`

    Hides the original client IP address from Google when enabled.

  - `measurement_id: str`

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

  - `set_up_tag: Optional[bool]`

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