Tag Manager API – Variablenwörterbuch-Referenz

In diesem Dokument werden die Eigenschaften beschrieben, die für Google Tag Manager-Variablen festgelegt werden können.

Einführung

Jede Google Tag Manager-Variable hat einen type-Code, um sie zu identifizieren. Darüber hinaus haben die meisten Variablen Parameter (key- und type-Paare), die Sie als Teil eines „Parameterobjekts“ festlegen können, wenn Sie eine Variable erstellen oder aktualisieren. Weitere Informationen zum Festlegen dieser Parameter mithilfe eines Parameterobjekts finden Sie in der Parameterreferenz.

Im weiteren Verlauf dieses Dokuments werden die Details aller unterstützten Variablen aufgeführt.

Eigenes Cookie

Code eingeben

k

Parameter

Schlüssel Typ Hinweise
name template Name des Cookies.

Beispiel

 {
   "name": "Sample First Party Cookie Variable",
   "type": "k",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "myCookieName"
    }
   ]
 }

Variable für automatisches Ereignis

Code eingeben

aev

Parameter

Schlüssel Typ Hinweise
varType template Mögliche Werte: ELEMENT,CLASSES, ID, TARGET, TEXT, URL, HISTORY_NEW_URL_FRAGMENT, HISTORY_OLD_URL_FRAGMENT, HISTORY_NEW_STATE, HISTORY_OLD_STATE, HISTORY_CHANGE_SOURCE.
defaultValue template Optional.

Beispiel

  {
   "name": "Sample AutoEvent Variable",
   "type": "aev",
   "parameter": [
    {
     "type": "template",
     "key": "varType",
     "value": "CLASSES"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "MyDefault"
    }
   ]
  }

Konstantenstring

Code eingeben

c

Parameter

Schlüssel Typ
value template

Beispiel

  {
   "name": "Sample Constant String",
   "type": "c",
   "parameter": [
    {
     "type": "template",
     "key": "value",
     "value": "MyString"
    }
   ]
  }

Containerversionsnummer

Code eingeben

ctv

Parameter

Beispiel

  {
   "name": "Sample Container Version Number",
   "type": "ctv"
  }

Benutzerdefiniertes Ereignis

Code eingeben

Parameter

Beispiel

  {
   "name": "Custom Event Name",
   "type": "e"
  }

Benutzerdefiniertes JavaScript

Code eingeben

jsm

Parameter

Schlüssel Typ
javascript template

Beispiel

  {
   "name": "Sample Custom Javascript",
   "type": "jsm",
   "parameter": [
    {
     "type": "template",
     "key": "javascript",
     "value": "function() {\n return \"Hello World\";\n}"
    }
   ]
  }

Datenschichtvariable

Code eingeben

v

Parameter

Schlüssel Typ Hinweise
name template Name der Datenschichtvariablen
defaultValue template
dataLayerVersion integer 1 oder 2.

Beispiel

  {
   "name": "Sample Data Layer Variable",
   "type": "v",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "DL Variable Name"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "DEFAULT"
    },
    {
     "type": "integer",
     "key": "dataLayerVersion",
     "value": "2"
    }
   ]
  }

Debug-Modus

Code eingeben

dbg

Parameter

Beispiel

  {
   "name": "Sample Debug Mode Variable",
   "type": "dbg"
  }

DOM-Element

Code eingeben

d

Parameter

Schlüssel Typ Hinweise
elementId template
attributeName template Optional.

Beispiel

  {
   "name": "Sample DOM Element Variable",
   "type": "d",
   "parameter": [
    {
     "type": "template",
     "key": "elementId",
     "value": "MyElementId"
    },
    {
     "type": "template",
     "key": "attributeName",
     "value": "MyAttributeName"
    }
   ]
  }

HTTP-Referrer-URL

Code eingeben

f

Parameter

Schlüssel Typ Hinweise
component template Eine der folgenden Möglichkeiten: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
stripWww boolean Für Komponente = HOST
queryKey template Für Komponente = QUERY

Beispiel

  {
   "name": "Sample HTTP Referrer Variable",
   "type": "f",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    }
   ]
  }

JavaScript-Variable

Code eingeben

j

Parameter

Schlüssel Typ Hinweise
name template Name der globalen Variablen.

Beispiel

  {
   "name": "Sample Javascript Variable",
   "type": "j",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "MyGlobalVarName"
    }
   ]
  }

Suchtabelle

Code eingeben

smm

Parameter

Schlüssel Typ Hinweise
input template Wert, der für die Suche verwendet wird, sollte ein Variablenbezug sein.
map list Eine Liste von Karten mit jeweils einem [key, value]-Paar.
map[].key template
map[].value template
defaultValue template Optional.

Beispiel

  {
   "name": "Sample Lookup Table Variable",
   "type": "smm",
   "parameter": [
    {
     "type": "template",
     "key": "input",
     "value": "{{event}}"
    },
    {
     "type": "list",
     "key": "map",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "key",
         "value": "EventEqualsThis"
        },
        {
         "type": "template",
         "key": "value",
         "value": "ThenSetToThis"
        }
       ]
      }
     ]
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "MyDefaultValue"
    }
   ]
  }

Zufallszahl

Code eingeben

r

Parameter

Beispiel

  {
   "name": "Sample Random Number Variable",
   "type": "r"
  }

URL

Code eingeben

u

Parameter

Schlüssel Typ Hinweise
component template Eine der folgenden Möglichkeiten: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
customUrlSource template Optional.
stripWww boolean Für Komponente = HOST.
queryKey template Für Komponente = QUERY.

Beispiel

  {
   "name": "Sample URL Variable",
   "type": "u",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    },
    {
     "type": "template",
     "key": "customUrlSource",
     "value": "{{element}}"
    }
   ]
  }