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.

{
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": string,
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestampMs": long,
  "containerVersionId": string
}
Property name Value Description Notes
accountId string GTM Account ID.
authorizationCode string The environment authorization code.
authorizationTimestampMs long The last update time-stamp for the authorization code.
containerId string GTM Container ID.
containerVersionId string

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 on 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
type string The type of this environment.

Acceptable values are:
  • "draft"
  • "latest"
  • "live"
  • "user"
url string Default preview page url for the environment. writable

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.
update
Updates a GTM Environment.