REST Resource: accounts.containers.environments

Resource: Environment

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

JSON representation 
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": enum (EnvironmentType),
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestamp": string,
  "tagManagerUrl": string,

  // Union field Link can be only one of the following:
  "containerVersionId": string,
  "workspaceId": string
  // End of list of possible types for union field Link.
}
Fields
path

string

GTM Environment's API relative path.
accountId

string

GTM Account ID.
containerId

string

GTM Container ID.
environmentId

string

GTM Environment ID uniquely identifies the GTM Environment.
type

enum (EnvironmentType)

The type of this 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.
description

string

The environment description. Can be set or changed only on USER type environments.
enableDebug

boolean

Whether or not to enable debug by default for the environment.
url

string

Default preview page url for the environment.
authorizationCode

string

The environment authorization code.
authorizationTimestamp

string (Timestamp format)

The last update time-stamp for the authorization code.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
tagManagerUrl

string

Auto generated link to the tag manager UI
containerVersionId

string

Represents a link to a container version.
workspaceId

string

Represents a link to a quick preview of a workspace.

EnvironmentType

Enums
user Points to a user defined environment.
live Points to the current live container version.
latest Points to the latest container version.
workspace Automatically managed environment that points to a workspace preview or version created by 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.

reauthorize

 Re-generates the authorization code for a GTM Environment.

update

 Updates a GTM Environment.