Environments

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

Resource representations

Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": string,
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestamp": {
    "seconds": long,
    "nanos": integer
  },
  "containerVersionId": string,
  "workspaceId": string,
  "tagManagerUrl": string
}
Property name Value Description Notes
accountId string GTM Account ID.
authorizationCode string The environment authorization code.
authorizationTimestamp nested object The last update time-stamp for the authorization code.
authorizationTimestamp.nanos integer Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
authorizationTimestamp.seconds long Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
containerId string GTM Container ID.
containerVersionId string Represents a link to a container version.
description string The environment description. Can be set or changed only on USER type environments. writable
enableDebug boolean Whether or not to enable debug by default for the environment. writable
environmentId string GTM Environment ID uniquely identifies the GTM Environment.
fingerprint string The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
name string The environment display name. Can be set or changed only on USER type environments. writable
path string GTM Environment's API relative path.
tagManagerUrl string Auto generated link to the tag manager UI
type string The type of this environment.

Acceptable values are:
  • "latest"
  • "live"
  • "user"
  • "workspace"
url string Default preview page url for the environment. writable
workspaceId string Represents a link to a quick preview of a workspace.

Methods

create
Creates a GTM Environment.
delete
Deletes a GTM Environment.
get
Gets a GTM Environment.
list
Lists all GTM Environments of a GTM Container.
patch
Updates a GTM Environment. This method supports patch semantics.
reauthorize
Re-generates the authorization code for a GTM Environment.
update
Updates a GTM Environment.