REST Resource: accounts.containers.environments

Ressource: Umgebung

Stellt eine Google Tag Manager-Umgebung dar. Nutzer können Umgebungen vom Typ „USER“ erstellen, löschen und aktualisieren, aber nur die Felder „enableDebug“ und „url“ von Umgebungen anderer Typen.

JSON-Darstellung
{
  "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.
}
Felder
accountId

string

GTM-Konto-ID

containerId

string

GTM-Container-ID.

environmentId

string

Die GTM-Umgebungs-ID identifiziert die GTM-Umgebung eindeutig.

type

enum (EnvironmentType)

Der Typ dieser Umgebung.

fingerprint

string

Der Fingerabdruck der GTM-Umgebung, wie er zum Zeitpunkt der Speicherung berechnet wurde. Dieser Wert wird jedes Mal neu berechnet, wenn die Umgebung geändert wird.

name

string

Der Anzeigename der Umgebung. Kann nur in Umgebungen vom Typ „USER“ festgelegt oder geändert werden.

description

string

Die Umgebungsbeschreibung. Kann nur in Umgebungen vom Typ „USER“ festgelegt oder geändert werden.

enableDebug

boolean

Ob die Debug-Funktion standardmäßig für die Umgebung aktiviert werden soll.

url

string

Standard-URL der Vorschauseite für die Umgebung.

authorizationCode

string

Der Autorisierungscode der Umgebung.

authorizationTimestampMs

string (int64 format)

Der Zeitstempel der letzten Aktualisierung des Autorisierungscodes.

containerVersionId

string

EnvironmentType

Enums
user Wird für benutzerdefinierte Umgebungen verwendet.
live Wird für die Live-Umgebung verwendet, die auf die veröffentlichte Containerversion verweist.
latest Wird für die neueste Umgebung verwendet, die auf die zuletzt erstellte Containerversion verweist.
draft Wird für die Entwurfsumgebung verwendet, die auf den einzelnen Entwurf im Container verweist.

Methoden

create

Erstellt eine GTM-Umgebung.

delete

Löscht eine GTM-Umgebung.

get

Ruft eine GTM-Umgebung ab.

list

Hier werden alle GTM-Umgebungen eines GTM-Containers aufgelistet.

update

Aktualisiert eine GTM-Umgebung.