Referenz für GA-Befehlswarteschlangen

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.

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

[trackerName.][pluginName:]methodName

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

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.

Rückgaben

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.

In der Feldreferenz finden Sie die Dokumentation zu den einzelnen Feldern.

Rückgaben

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.

Rückgaben

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

Rückgaben

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

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');