Zones

For a list of methods for this resource, see the end of this page.

Resource representations

Represents a Google Tag Manager Zone's contents.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "zoneId": string,
  "name": string,
  "fingerprint": string,
  "tagManagerUrl": string,
  "notes": string,
  "childContainer": [
    {
      "publicId": string,
      "nickname": string
    }
  ],
  "boundary": {
    "condition": [
      {
        "type": string,
        "parameter": [
          {
            "type": string,
            "key": string,
            "value": string,
            "list": [
              (Parameter)
            ],
            "map": [
              (Parameter)
            ],
            "isWeakReference": boolean
          }
        ]
      }
    ],
    "customEvaluationTriggerId": [
      string
    ]
  },
  "typeRestriction": {
    "enable": boolean,
    "whitelistedTypeId": [
      string
    ]
  }
}

Property name	Value	Description	Notes
`accountId`	`string`	GTM Account ID.
`boundary`	`nested object`	This Zone's boundary.
`boundary.condition[]`	`list`	The conditions that, when conjoined, make up the boundary.
`boundary.condition[].parameter[]`	`list`	A list of named parameters (key/value), depending on the condition's type. Notes: For binary operators, include parameters named `arg0` and `arg1` for specifying the left and right operands, respectively. At this time, the left operand (`arg0`) must be a reference to a variable. For case-insensitive Regex matching, include a boolean parameter named `ignore_case` that is set to `true`. If not specified or set to any other value, the matching will be case sensitive. To negate an operator, include a boolean parameter named `negate` boolean parameter that is set to `true`.	writable
`boundary.condition[].parameter[].isWeakReference`	`boolean`	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
`boundary.condition[].parameter[].key`	`string`	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
`boundary.condition[].parameter[].list[]`	`list`	This list parameter's parameters (keys will be ignored).	writable
`boundary.condition[].parameter[].map[]`	`list`	This map parameter's parameters (must have keys; keys must be unique).	writable
`boundary.condition[].parameter[].type`	`string`	The parameter type. Valid values are: `boolean`: The value represents a boolean, represented as 'true' or 'false' `integer`: The value represents a 64-bit signed integer value, in base 10 `list`: A list of parameters should be specified `map`: A map of parameters should be specified `template`: The value represents any text; this can include variable references (even variable references that might return non-string types) `trigger_reference`: The value represents a trigger, represented as the trigger id `tag_reference`: The value represents a tag, represented as the tag name Acceptable values are: "`boolean`" "`integer`" "`list`" "`map`" "`tagReference`" "`template`" "`triggerReference`" "`typeUnspecified`"	writable
`boundary.condition[].parameter[].value`	`string`	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
`boundary.condition[].type`	`string`	The type of operator for this condition. Acceptable values are: "`conditionTypeUnspecified`" "`contains`" "`cssSelector`" "`endsWith`" "`equals`" "`greater`" "`greaterOrEquals`" "`less`" "`lessOrEquals`" "`matchRegex`" "`startsWith`" "`urlMatches`"	writable
`boundary.customEvaluationTriggerId[]`	`list`	Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true.
`childContainer[]`	`list`	Containers that are children of this Zone.
`childContainer[].nickname`	`string`	The zone's nickname for the child container.
`childContainer[].publicId`	`string`	The child container's public id.
`containerId`	`string`	GTM Container ID.
`fingerprint`	`string`	The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified.
`name`	`string`	Zone display name.
`notes`	`string`	User notes on how to apply this zone in the container.
`path`	`string`	GTM Zone's API relative path.
`tagManagerUrl`	`string`	Auto generated link to the tag manager UI
`typeRestriction`	`nested object`	This Zone's type restrictions.
`typeRestriction.enable`	`boolean`	True if type restrictions have been enabled for this Zone.
`typeRestriction.whitelistedTypeId[]`	`list`	List of type public ids that have been whitelisted for use in this Zone.
`workspaceId`	`string`	GTM Workspace ID.
`zoneId`	`string`	The Zone ID uniquely identifies the GTM 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.