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 
{
  "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.
}
Felder
path

string

Relativer API-Pfad der GTM-Umgebung.
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.
authorizationTimestamp

string (Timestamp format)

Der Zeitstempel der letzten Aktualisierung des Autorisierungscodes.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
tagManagerUrl

string

Automatisch generierter Link zur Tag Manager-Benutzeroberfläche
containerVersionId

string

Stellt einen Link zu einer Containerversion dar.
workspaceId

string

Stellt einen Link zu einer schnellen Vorschau eines Arbeitsbereichs dar.

EnvironmentType

Enums
user Verweist auf eine benutzerdefinierte Umgebung.
live Verweist auf die aktuelle Live-Containerversion.
latest Verweist auf die neueste Containerversion.
workspace Automatisch verwaltete Umgebung, die auf eine Arbeitsbereichsvorschau oder -version verweist, die von einem Arbeitsbereich erstellt wurde.

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.

reauthorize

 Generiert den Autorisierungscode für eine GTM-Umgebung noch einmal.

update

 Aktualisiert eine GTM-Umgebung.