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
{
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": enum (EnvironmentType),
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestampMs": string,

  // Union field Link can be only one of the following:
  "containerVersionId": string
  // End of list of possible types for union field Link.
}
Fields
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 on for the environment.

url

string

Default preview page url for the environment.

authorizationCode

string

The environment authorization code.

authorizationTimestampMs

string (int64 format)

The last update time-stamp for the authorization code.

containerVersionId

string

EnvironmentType

Enums
user Used for user defined environments.
live Used for Live environment, which points to the live published container version.
latest Used for Latest environment, which points to the latest created container version.
draft Used for Draft environment, which points to the single draft in the container.

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.

update

Updates a GTM Environment.