Die ga()
-Befehlswarteschlange bietet eine Schnittstelle, über die Sie fast alle Aufgaben mit der analytics.js-Bibliothek ausführen können.
Das JavaScript-Tracking-Snippet definiert die anfängliche ga()
-Befehlswarteschlangenfunktion. So kann sie verwendet werden, bevor die analytics.js-Bibliothek vollständig geladen ist. Sobald die analytics.js-Bibliothek geladen ist, werden die Elemente in der Befehlswarteschlange in der Reihenfolge ausgeführt, in der sie empfangen wurden. Sobald dies geschehen ist, werden neue Befehle, die in die Warteschlange verschoben werden, sofort ausgeführt.
Um das Tracking-Snippet so klein wie möglich zu halten, ist die ga()
-Befehlswarteschlange überlastet und akzeptiert Argumente in vielen verschiedenen Formaten. In diesem Dokument werden die verschiedenen Möglichkeiten zum Aufrufen der ga()
-Befehlswarteschlangenfunktion beschrieben.
Funktionssignatur | |
---|---|
ga(command, [...fields], [fieldsObject]) |
Wenn Sie die |
ga(readyCallback) |
Wenn Sie die Da Befehle erst ausgeführt werden, nachdem die analytics.js-Bibliothek vollständig geladen wurde, ist der häufigste Grund für das Übergeben der Befehlswarteschlange als Callback für den Zeitpunkt, zu dem die analytics.js-Bibliothek geladen wurde und bereit ist. |
Befehle zur Warteschlange hinzufügen
Wenn Sie die ga()
-Befehlswarteschlangenfunktion mit der folgenden Funktionssignatur aufrufen, werden Befehle in die Warteschlange verschoben, die nach dem Laden der Bibliothek ausgeführt werden sollen.
Nutzung
ga(command, [...fields], [fieldsObject])
Parameter
Name | Typ | Erforderlich | Beschreibung | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
command |
string |
ja |
Eine Kennung für den Befehl, der in die Warteschlange aufgenommen werden soll. Die Kennung besteht aus drei Teilen, wobei die ersten beiden optional sind: [trackerName.][pluginName:]methodName
|
|||||||||
...fields |
* |
nein | Ein oder mehrere optionale Parameter für das schnelle Angeben allgemeiner Felder. Die Anzahl der zulässigen und spezifischen Felder variiert je nach aufgerufener Befehlsmethode. | |||||||||
fieldsObject |
Object |
nein |
Ein Objekt zum Angeben aller verbleibenden Werte, die in keinem der Wenn ein Feld sowohl in einem |
In der Feldreferenz finden Sie die Dokumentation zu den einzelnen Feldern.
Beispiele
Einzelne Beispiele für Befehle finden Sie unten im Abschnitt Befehlsmethoden.
Bereit für Rückruf
Wenn Sie die ga()
-Befehlswarteschlangenfunktion aufrufen, indem Sie ihr eine Funktion übergeben, wird die Ausführung der übergebenen Funktion am nächsten Punkt in der Warteschlange geplant.
Da Befehle erst ausgeführt werden, nachdem die analytics.js-Bibliothek vollständig geladen wurde, ist der häufigste Grund für das Übergeben der Befehlswarteschlange als Callback für den Zeitpunkt, zu dem die analytics.js-Bibliothek geladen wurde und bereit ist.
Nutzung
ga(readyCallback)
Parameter
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
readyCallback |
Function |
ja |
Eine Callback-Funktion, die aufgerufen wird, wenn die Bibliothek vollständig geladen und bereit für die Interaktion ist. Die Funktion wird mit dem Standard-Tracker-Objekt als erstes Argument aufgerufen. Wenn kein Standard-Tracker erstellt wurde, ist das erste Argument Hinweis: Wenn die Callback-Funktion aufgerufen wird, können alle
|
Beispiele
// Queues a tracker object for creation. ga('create', 'UA-XXXXX-Y', 'auto'); // Once the tracker has been created, log the // client ID to the console. ga(function(tracker) { console.log(tracker.get('clientId')); });
// Queues a named tracker object for creation. ga('create', 'UA-XXXXX-Y', 'auto', 'myTracker'); // When there is no default tracker, the first // argument of the ready callback is `undefined`. ga(function(tracker) { console.log(tracker); // Logs `undefined`. });
Details zur Befehlsmethode
Im Folgenden finden Sie eine Liste aller Methoden, die an die ga()
-Befehlswarteschlange übergeben werden können (mit Ausnahme von Plug-in-Methoden).
create
Erstellt eine neue Tracker-Instanz mit den angegebenen Feldern.
Nutzung
ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);
Parameter
In der Feldreferenz finden Sie die Dokumentation zu den einzelnen Feldern.
Returns
undefined
Beispiele
// Creates a default tracker for the Property UA-XXXXX-Y // and uses automatic cookie domain configuration. ga('create', 'UA-XXXXX-Y', 'auto');
// Creates a tracker with the name "myTracker" for the Property // UA-XXXXX-Y, sets the cookieDomain to "example.com", and specifies // a transport mechanism of "beacon". ga('create', 'UA-XXXXX-Y', 'example.com', 'myTracker', { transport: 'beacon' });
send
Sendet einen Treffer an Google Analytics.
Nutzung
ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);
Es werden die Werte gesendet, die in den Parametern ...fields
und fieldsObject
angegeben und mit den derzeit auf dem Tracker gespeicherten Feldern zusammengeführt wurden.
Parameter
Welche Felder mit den ...fields
-Parametern angegeben werden können, hängt vom Treffertyp ab. In der folgenden Tabelle sind die Felder für den jeweiligen Treffertyp aufgeführt. Nicht aufgeführte Treffertypen akzeptieren keine ...fields
-Parameter, sondern nur fieldsObject
.
Treffertyp | ...fields |
---|---|
pageview |
page |
event |
eventCategory , eventAction , eventLabel , eventValue |
social |
socialNetwork , socialAction , socialTarget |
timing |
timingCategory , timingVar , timingValue , timingLabel |
In der Feldreferenz finden Sie die Dokumentation zu den einzelnen Feldern.
Returns
undefined
Beispiele
// Sends a pageview hit. ga('send', 'pageview');
// Sends an event hit for the tracker named "myTracker" with the // following category, action, and label, and sets the nonInteraction // field value to true. ga('send', 'event', 'link', 'click', 'http://example.com', { nonInteraction: true });
set
Legt ein einzelnes Feld/Wert-Paar oder eine Gruppe von Feld/Wert-Paaren in einem Tracker-Objekt fest.
Nutzung
// Sets a single field and value. ga('[trackerName.]set', fieldName, fieldValue);
// Sets a group of field/value pairs. ga('[trackerName.]set', fieldsObject);
Parameter
In der Feldreferenz finden Sie die Dokumentation zu den einzelnen Feldern.
Returns
undefined
Beispiele
// Sets the page field to "/about.html". ga('set', 'page', '/about.html');
// Sets the page field to "/about.html" and the title to "About". ga('set', { page: '/about.html', title: 'About' });
require
Erfordert ein analytics.js-Plug-in.
Nutzung
ga('[trackerName.]require', pluginName, [pluginOptions]);
Parameter
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
pluginName |
string |
ja | Der Name des erforderlichen Plug-ins. Hinweis:Wenn das Plug-in kein offizielles analytics.js-Plug-in ist, muss es an anderer Stelle auf der Seite bereitgestellt werden. |
pluginOptions |
Object |
nein | Initialisierungsobjekt, das bei der Instanziierung an den Plug-in-Konstruktor übergeben wird. |
Returns
undefined
Beispiel
// Requires the Enhanced Ecommerce plugin. ga('require', 'ec');
// Requires the Advertising Features plugin // named "myTracker" and override its default cookie name. ga('myTracker.require', 'displayfeatures', { cookieName: 'display_features_cookie' });
provide
Stellt ein analytics.js-Plug-in und seine Methoden zur Verwendung mit der ga()
-Befehlswarteschlange bereit.
ga('provide', pluginName, pluginConstuctor);
Parameter
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
pluginName |
string |
ja | Der Name des bereitgestellten Plug-ins. Der verwendete Name muss mit dem Namen übereinstimmen, der auch für alle require-Aufrufe verwendet wird. |
pluginConstuctor |
Function |
ja | Eine Konstruktorfunktion, die die gesamte Plug-in-Logik und -Methoden bereitstellt. Dieser Konstruktor wird mit dem pluginsOptions -Objekt aufgerufen, das in der Methode require angegeben ist. |
Beispiel
// Defines a plugin constructor function MyPlugin(tracker, options) { // ... } // Provides the plugin for use with the ga() command queue. ga('provide', 'myplugin', MyPlugin);
remove
Entfernt ein Tracker-Objekt.
Nutzung
ga('[trackerName.]remove');
Beispiele
// Remove the default tracker. ga('remove');
// Remove the tracker named "myTracker". ga('myTracker.remove');