REST Resource: accounts.containers.workspaces.zones

Resource: Zone

Represents a Google Tag Manager Zone's contents.

JSON representation
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "zoneId": string,
  "name": string,
  "fingerprint": string,
  "tagManagerUrl": string,
  "notes": string,
  "childContainer": [
    {
      object (ChildContainer)
    }
  ],
  "boundary": {
    object (Boundary)
  },
  "typeRestriction": {
    object (TypeRestriction)
  }
}
Fields
path

string

GTM Zone's API relative path.

accountId

string

GTM Account ID.

containerId

string

GTM Container ID.

workspaceId

string

GTM Workspace ID.

zoneId

string

The Zone ID uniquely identifies the GTM Zone.

name

string

Zone display name.

fingerprint

string

The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified.

tagManagerUrl

string

Auto generated link to the tag manager UI

notes

string

User notes on how to apply this zone in the container.

childContainer[]

object (ChildContainer)

Containers that are children of this Zone.

boundary

object (Boundary)

This Zone's boundary.

typeRestriction

object (TypeRestriction)

This Zone's type restrictions.

ChildContainer

Represents a child container of a Zone.

JSON representation
{
  "publicId": string,
  "nickname": string
}
Fields
publicId

string

The child container's public id.

nickname

string

The zone's nickname for the child container.

Boundary

Represents a Zone's boundaries.

JSON representation
{
  "condition": [
    {
      object (Condition)
    }
  ],
  "customEvaluationTriggerId": [
    string
  ]
}
Fields
condition[]

object (Condition)

The conditions that, when conjoined, make up the boundary.

customEvaluationTriggerId[]

string

Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true.

TypeRestriction

Represents a Zone's type restrictions.

JSON representation
{
  "enable": boolean,
  "whitelistedTypeId": [
    string
  ]
}
Fields
enable

boolean

True if type restrictions have been enabled for this Zone.

whitelistedTypeId[]

string

List of type public ids that have been whitelisted for use in this Zone.

Methods

create

Creates a GTM Zone.

delete

Deletes a GTM Zone.

get

Gets a GTM Zone.

list

Lists all GTM Zones of a GTM container workspace.

revert

Reverts changes to a GTM Zone in a GTM Workspace.

update

Updates a GTM Zone.