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 ( |
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.
tagManagerUrl
string
Auto generated link to the tag manager UI
Link
. The version ID, workspace id or none. May contain other IDs in the future. Can be set or changed only on USER type environments. Link
can be only one of the following: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 |
|
---|---|
|
Creates a GTM Environment. |
|
Deletes a GTM Environment. |
|
Gets a GTM Environment. |
|
Lists all GTM Environments of a GTM Container. |
|
Re-generates the authorization code for a GTM Environment. |
|
Updates a GTM Environment. |