REST Resource: accounts.containers.workspaces.variables

Ressource: Variable

Stellt eine Google Tag Manager-Variable dar.

JSON-Darstellung
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "variableId": string,
  "name": string,
  "type": string,
  "notes": string,
  "scheduleStartMs": string,
  "scheduleEndMs": string,
  "parameter": [
    {
      object (Parameter)
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    object (FormatValue)
  }
}
Felder
path

string

Relativer API-Pfad der GTM-Variable.

accountId

string

GTM-Konto-ID.

containerId

string

GTM-Container-ID.

workspaceId

string

GTM-Arbeitsbereichs-ID.

variableId

string

Die Variablen-ID identifiziert die GTM-Variable eindeutig.

name

string

Anzeigename der Variablen.

type

string

GTM-Variablentyp.

notes

string

Nutzernotizen zur Anwendung dieser Variablen im Container.

scheduleStartMs

string (int64 format)

Startzeitstempel in Millisekunden zum Planen einer Variablen.

scheduleEndMs

string (int64 format)

Endzeitstempel in Millisekunden zum Planen einer Variablen.

parameter[]

object (Parameter)

Parameter der Variablen.

enablingTriggerId[]

string

Nur für mobile Container: Eine Liste von Trigger-IDs zum Aktivieren bedingter Variablen. Die Variable wird aktiviert, wenn einer der aktivierenden Trigger „true“ ist, während alle deaktivierenden Trigger „false“ sind. Wird als ungeordnete Menge behandelt.

disablingTriggerId[]

string

Nur für mobile Container: Eine Liste von Trigger-IDs zum Deaktivieren bedingter Variablen. Die Variable wird aktiviert, wenn einer der aktivierenden Trigger „true“ ist, während alle deaktivierenden Trigger „false“ sind. Wird als ungeordnete Menge behandelt.

fingerprint

string

Der Fingerabdruck der GTM-Variable, wie er zum Zeitpunkt der Speicherung berechnet wurde. Dieser Wert wird bei jeder Änderung der Variablen neu berechnet.

parentFolderId

string

ID des übergeordneten Ordners.

tagManagerUrl

string

Automatisch generierter Link zur Tag Manager-UI

formatValue

object (FormatValue)

Option zum Konvertieren eines Variablenwerts in einen anderen Wert.

FormatValue

JSON-Darstellung
{
  "caseConversionType": enum (CaseConversionType),
  "convertToNumber": enum (DecimalSeparatorType),
  "convertNullToValue": {
    object (Parameter)
  },
  "convertUndefinedToValue": {
    object (Parameter)
  },
  "convertToBoolean": boolean,
  "convertTrueToValue": {
    object (Parameter)
  },
  "convertFalseToValue": {
    object (Parameter)
  }
}
Felder
caseConversionType

enum (CaseConversionType)

Die Option zum Konvertieren eines Variablenwerts vom Typ „String“ in Klein- oder Großbuchstaben.

convertToNumber

enum (DecimalSeparatorType)

Die Option zum Konvertieren eines Variablenwerts in eine Zahl.

convertNullToValue

object (Parameter)

Der Wert, in den konvertiert werden soll, wenn ein Variablenwert „null“ ist.

convertUndefinedToValue

object (Parameter)

Der Wert, in den konvertiert werden soll, wenn ein Variablenwert nicht definiert ist.

convertToBoolean

boolean

Die Option zum Konvertieren eines Variablenwerts in einen booleschen Wert.

convertTrueToValue

object (Parameter)

Der Wert, in den konvertiert werden soll, wenn ein Variablenwert „true“ ist.

convertFalseToValue

object (Parameter)

Der Wert, in den konvertiert werden soll, wenn ein Variablenwert „false“ ist.

CaseConversionType

Enums
none
lowercase Die Option zum Konvertieren eines Variablenwerts in Kleinbuchstaben.
uppercase Die Option zum Konvertieren eines Variablenwerts in Großbuchstaben.

DecimalSeparatorType

Enums
decimalSeparatorTypeUnspecified
period Die Option zum Konvertieren eines Variablenwerts in eine Zahl mit einem Punkt als Dezimaltrennzeichen.
comma Die Option zum Konvertieren eines Variablenwerts in eine Zahl mit einem Komma als Dezimaltrennzeichen.
automatic Die Option zum Konvertieren eines Variablenwerts in eine Zahl mit automatischer Erkennung des Dezimaltrennzeichens.

Methoden

create

Erstellt eine GTM-Variable.

delete

Löscht eine GTM-Variable.

get

Ruft eine GTM-Variable ab.

list

Listet alle GTM-Variablen eines Containers auf.

revert

Macht Änderungen an einer GTM-Variable in einem GTM-Arbeitsbereich rückgängig.

update

Aktualisiert eine GTM-Variable.