Variables

Am Ende dieser Seite finden Sie eine Liste der Methoden für diese Ressource.

Ressourcendarstellungen

Eine Google Tag Manager-Variable.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "variableId": string,
  "name": string,
  "type": string,
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    "caseConversionType": string,
    "convertNullToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertUndefinedToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertTrueToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertFalseToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}
Property-Name Wert Beschreibung Hinweise
accountId string Google Tag Manager-Konto-ID.
containerId string GTM-Container-ID
disablingTriggerId[] list Nur für mobile Container: Eine Liste mit Trigger-IDs zum Deaktivieren bedingter Variablen. Die Variable ist aktiviert, wenn einer der aktivierenden Trigger wahr ist, während alle deaktivierenden Trigger falsch sind. Wird als ungeordnetes Set behandelt. Bearbeitbar
enablingTriggerId[] list Nur für mobile Container: Eine Liste mit Trigger-IDs zum Aktivieren bedingter Variablen. Die Variable ist aktiviert, wenn einer der aktivierenden Trigger wahr ist, während alle deaktivierenden Trigger falsch sind. Wird als ungeordnetes Set behandelt. Bearbeitbar
fingerprint string Der Fingerabdruck der Google Tag Manager-Variable, wie er zum Speicherzeitpunkt berechnet wird. Dieser Wert wird bei jeder Änderung der Variable neu berechnet.
formatValue nested object Option zum Umwandeln eines Variablenwerts in einen anderen Wert
formatValue.caseConversionType string Option zum Konvertieren eines Variablenwerts vom Typ "String" in Kleinbuchstaben oder Großbuchstaben

Zulässige Werte sind:
  • "lowercase"
  • "none"
  • "uppercase"
formatValue.convertFalseToValue nested object Wert, der konvertiert wird, wenn ein Variablenwert falsch ist.
formatValue.convertFalseToValue.isWeakReference boolean Gibt an, ob auf einen Referenztypparameter stark oder schwach verwiesen wird. Wird nur von Transformationen verwendet. Bearbeitbar
formatValue.convertFalseToValue.key string Der benannte Schlüssel, der einen Parameter eindeutig identifiziert. Erforderlich für Parameter der obersten Ebene sowie für Zuordnungswerte. Wird für Listenwerte ignoriert. Bearbeitbar
formatValue.convertFalseToValue.list[] list Die Parameter dieses Listenparameters (Schlüssel werden ignoriert). Bearbeitbar
formatValue.convertFalseToValue.map[] list Die Parameter dieses Zuordnungsparameters (muss Schlüssel aufweisen; Schlüssel müssen eindeutig sein). Bearbeitbar
formatValue.convertFalseToValue.type string Der Parametertyp. Gültige Werte sind:
  • boolean: Der Wert steht für einen booleschen Wert, der als „wahr“ oder „falsch“ dargestellt wird.
  • integer: Der Wert stellt einen vorzeichenbehafteten 64-Bit-Ganzzahlwert in Basis 10 dar.
  • list: Es muss eine Liste mit Parametern angegeben werden
  • map: Es muss eine Zuordnung von Parametern angegeben werden.
  • template: Der Wert steht für beliebigen Text. Dieser kann Variablenverweise enthalten (auch Variablenverweise, die möglicherweise Typen zurückgeben, die keine Strings sind).
  • trigger_reference: Der Wert stellt einen Trigger dar, der als Trigger-ID dargestellt wird.
  • tag_reference: Der Wert steht für ein Tag, das als Tag-Name dargestellt wird.


Zulässige Werte sind:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
Bearbeitbar
formatValue.convertFalseToValue.value string Der Wert eines Parameters (kann Variablenverweise wie "" enthalten) je nach Typ. Bearbeitbar
formatValue.convertNullToValue nested object Wert, der konvertiert wird, wenn ein Variablenwert null ist.
formatValue.convertNullToValue.isWeakReference boolean Gibt an, ob auf einen Referenztypparameter stark oder schwach verwiesen wird. Wird nur von Transformationen verwendet. Bearbeitbar
formatValue.convertNullToValue.key string Der benannte Schlüssel, der einen Parameter eindeutig identifiziert. Erforderlich für Parameter der obersten Ebene sowie für Zuordnungswerte. Wird für Listenwerte ignoriert. Bearbeitbar
formatValue.convertNullToValue.list[] list Die Parameter dieses Listenparameters (Schlüssel werden ignoriert). Bearbeitbar
formatValue.convertNullToValue.map[] list Die Parameter dieses Zuordnungsparameters (muss Schlüssel aufweisen; Schlüssel müssen eindeutig sein). Bearbeitbar
formatValue.convertNullToValue.type string Der Parametertyp. Gültige Werte sind:
  • boolean: Der Wert steht für einen booleschen Wert, der als „wahr“ oder „falsch“ dargestellt wird.
  • integer: Der Wert stellt einen vorzeichenbehafteten 64-Bit-Ganzzahlwert in Basis 10 dar.
  • list: Es muss eine Liste mit Parametern angegeben werden
  • map: Es muss eine Zuordnung von Parametern angegeben werden.
  • template: Der Wert steht für beliebigen Text. Dieser kann Variablenverweise enthalten (auch Variablenverweise, die möglicherweise Typen zurückgeben, die keine Strings sind).
  • trigger_reference: Der Wert stellt einen Trigger dar, der als Trigger-ID dargestellt wird.
  • tag_reference: Der Wert steht für ein Tag, das als Tag-Name dargestellt wird.


Zulässige Werte sind:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
Bearbeitbar
formatValue.convertNullToValue.value string Der Wert eines Parameters (kann Variablenverweise wie "" enthalten) je nach Typ. Bearbeitbar
formatValue.convertTrueToValue nested object Wert, der konvertiert wird, wenn ein Variablenwert wahr ist.
formatValue.convertTrueToValue.isWeakReference boolean Gibt an, ob auf einen Referenztypparameter stark oder schwach verwiesen wird. Wird nur von Transformationen verwendet. Bearbeitbar
formatValue.convertTrueToValue.key string Der benannte Schlüssel, der einen Parameter eindeutig identifiziert. Erforderlich für Parameter der obersten Ebene sowie für Zuordnungswerte. Wird für Listenwerte ignoriert. Bearbeitbar
formatValue.convertTrueToValue.list[] list Die Parameter dieses Listenparameters (Schlüssel werden ignoriert). Bearbeitbar
formatValue.convertTrueToValue.map[] list Die Parameter dieses Zuordnungsparameters (muss Schlüssel aufweisen; Schlüssel müssen eindeutig sein). Bearbeitbar
formatValue.convertTrueToValue.type string Der Parametertyp. Gültige Werte sind:
  • boolean: Der Wert steht für einen booleschen Wert, der als „wahr“ oder „falsch“ dargestellt wird.
  • integer: Der Wert stellt einen vorzeichenbehafteten 64-Bit-Ganzzahlwert in Basis 10 dar.
  • list: Es muss eine Liste mit Parametern angegeben werden
  • map: Es muss eine Zuordnung von Parametern angegeben werden.
  • template: Der Wert steht für beliebigen Text. Dieser kann Variablenverweise enthalten (auch Variablenverweise, die möglicherweise Typen zurückgeben, die keine Strings sind).
  • trigger_reference: Der Wert stellt einen Trigger dar, der als Trigger-ID dargestellt wird.
  • tag_reference: Der Wert steht für ein Tag, das als Tag-Name dargestellt wird.


Zulässige Werte sind:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
Bearbeitbar
formatValue.convertTrueToValue.value string Der Wert eines Parameters (kann Variablenverweise wie "" enthalten) je nach Typ. Bearbeitbar
formatValue.convertUndefinedToValue nested object Wert, der konvertiert wird, wenn ein Variablenwert nicht definiert ist.
formatValue.convertUndefinedToValue.isWeakReference boolean Gibt an, ob auf einen Referenztypparameter stark oder schwach verwiesen wird. Wird nur von Transformationen verwendet. Bearbeitbar
formatValue.convertUndefinedToValue.key string Der benannte Schlüssel, der einen Parameter eindeutig identifiziert. Erforderlich für Parameter der obersten Ebene sowie für Zuordnungswerte. Wird für Listenwerte ignoriert. Bearbeitbar
formatValue.convertUndefinedToValue.list[] list Die Parameter dieses Listenparameters (Schlüssel werden ignoriert). Bearbeitbar
formatValue.convertUndefinedToValue.map[] list Die Parameter dieses Zuordnungsparameters (muss Schlüssel aufweisen; Schlüssel müssen eindeutig sein). Bearbeitbar
formatValue.convertUndefinedToValue.type string Der Parametertyp. Gültige Werte sind:
  • boolean: Der Wert steht für einen booleschen Wert, der als „wahr“ oder „falsch“ dargestellt wird.
  • integer: Der Wert stellt einen vorzeichenbehafteten 64-Bit-Ganzzahlwert in Basis 10 dar.
  • list: Es muss eine Liste mit Parametern angegeben werden
  • map: Es muss eine Zuordnung von Parametern angegeben werden.
  • template: Der Wert steht für beliebigen Text. Dieser kann Variablenverweise enthalten (auch Variablenverweise, die möglicherweise Typen zurückgeben, die keine Strings sind).
  • trigger_reference: Der Wert stellt einen Trigger dar, der als Trigger-ID dargestellt wird.
  • tag_reference: Der Wert steht für ein Tag, das als Tag-Name dargestellt wird.


Zulässige Werte sind:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
Bearbeitbar
formatValue.convertUndefinedToValue.value string Der Wert eines Parameters (kann Variablenverweise wie "" enthalten) je nach Typ. Bearbeitbar
name string Anzeigename der Variable. Bearbeitbar
notes string Nutzerhinweise zur Anwendung dieser Variable im Container. Bearbeitbar
parameter[] list Die Parameter der Variablen. Bearbeitbar
parameter[].isWeakReference boolean Gibt an, ob auf einen Referenztypparameter stark oder schwach verwiesen wird. Wird nur von Transformationen verwendet. Bearbeitbar
parameter[].key string Der benannte Schlüssel, der einen Parameter eindeutig identifiziert. Erforderlich für Parameter der obersten Ebene sowie für Zuordnungswerte. Wird für Listenwerte ignoriert. Bearbeitbar
parameter[].list[] list Die Parameter dieses Listenparameters (Schlüssel werden ignoriert). Bearbeitbar
parameter[].map[] list Die Parameter dieses Zuordnungsparameters (muss Schlüssel aufweisen; Schlüssel müssen eindeutig sein). Bearbeitbar
parameter[].type string Der Parametertyp. Gültige Werte sind:
  • boolean: Der Wert steht für einen booleschen Wert, der als „wahr“ oder „falsch“ dargestellt wird.
  • integer: Der Wert stellt einen vorzeichenbehafteten 64-Bit-Ganzzahlwert in Basis 10 dar.
  • list: Es muss eine Liste mit Parametern angegeben werden
  • map: Es muss eine Zuordnung von Parametern angegeben werden.
  • template: Der Wert steht für beliebigen Text. Dieser kann Variablenverweise enthalten (auch Variablenverweise, die möglicherweise Typen zurückgeben, die keine Strings sind).
  • trigger_reference: Der Wert stellt einen Trigger dar, der als Trigger-ID dargestellt wird.
  • tag_reference: Der Wert steht für ein Tag, das als Tag-Name dargestellt wird.


Zulässige Werte sind:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
Bearbeitbar
parameter[].value string Der Wert eines Parameters (kann Variablenverweise wie "" enthalten) je nach Typ. Bearbeitbar
parentFolderId string ID des übergeordneten Ordners.
path string relativer API-Pfad der GTM-Variable.
scheduleEndMs long Der Endzeitstempel in Millisekunden zum Planen einer Variablen. Bearbeitbar
scheduleStartMs long Der Startzeitstempel in Millisekunden zum Planen einer Variable. Bearbeitbar
tagManagerUrl string Automatisch generierter Link zur Tag Manager-Benutzeroberfläche
type string GTM-Variablentyp. Bearbeitbar
variableId string Mit der Variablen-ID wird die Google Tag Manager-Variable eindeutig identifiziert.
workspaceId string GTM-Arbeitsbereich-ID.

Methoden

Erstellen
eine Google Tag Manager-Variable erstellt.
delete
Eine Google Tag Manager-Variable wird gelöscht.
get
Ruft eine Google Tag Manager-Variable ab.
list
Listet alle GTM-Variablen eines Containers auf.
revert
Änderungen an einer GTM-Variablen in einem GTM-Arbeitsbereich rückgängig machen.
Aktualisieren
Aktualisiert eine Google Tag Manager-Variable.