Referenz zur ga-Befehlswarteschlange

Die ga()-Befehlswarteschlange bietet eine Schnittstelle für fast alles, was Sie mit der analytics.js-Bibliothek tun müssen.

Das JavaScript-Tracking-Snippet definiert die anfängliche ga()-Befehlswarteschlangenfunktion und kann daher verwendet werden, bevor die analytics.js-Bibliothek vollständig geladen ist. Sobald die analytics.js-Bibliothek geladen wurde, werden die Elemente in der Befehlswarteschlange in der Reihenfolge ausgeführt, in der sie empfangen wurden. Danach werden neue in die Warteschlange verschobene Befehle sofort ausgeführt.

Um das Tracking-Snippet so klein wie möglich zu halten, wird die Befehlswarteschlange ga() überlastet, um Argumente in vielen verschiedenen Formaten zu akzeptieren. In diesem Dokument werden alle verschiedenen Möglichkeiten der ga()-Befehlswarteschlange beschrieben, die aufgerufen werden können.

Funktionssignatur
ga(command, [...fields], [fieldsObject])

Wenn Sie die Funktion ga() mit der folgenden Funktionssignatur aufrufen, werden die Befehle in die Warteschlange gestellt, damit sie ausgeführt werden können, sobald die Bibliothek geladen wurde.

ga(readyCallback)

Wenn Sie die ga()-Befehlswarteschlangenfunktion durch Übergeben einer Funktion aufrufen, wird die übergebene Funktion für die Ausführung 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 die Übergabe einer Befehlswarteschlange ein Callback, wenn die analytics.js-Bibliothek geladen und bereit ist.

Befehle zur Warteschlange hinzufügen

Wenn Sie die Funktion ga() mit der folgenden Funktionssignatur aufrufen, werden die Befehle in die Warteschlange gestellt, damit sie ausgeführt werden können, sobald die Bibliothek geladen wurde.

Nutzung

ga(command, [...fields], [fieldsObject])

Parameter

Name Typ Required Beschreibung
command string ja

Eine Kennung für den Befehl, der der Warteschlange hinzugefügt werden soll. Die Kennung besteht aus drei Teilen (die ersten beiden sind optional):

[trackerName.][pluginName:]methodName
trackerName Der Name des Trackers, für den der geplante Befehl aufgerufen wird. Wenn kein Tracker-Name angegeben ist, wird der Befehl für den Standard-Tracker aufgerufen.
pluginName Der Name eines analytics.js-Plug-ins, das erforderlich ist. Wenn pluginName angegeben ist, muss methodName eine vom Plug-in bereitgestellte Methode sein.
methodName Der Name der Methode, deren Ausführung geplant werden soll. Wenn kein Plug-in-Name angegeben wird, muss diese Methode eine der unten aufgeführten Befehlsmethoden sein.
...fields * Nein Ein oder mehrere optionale Convenience-Parameter zum schnellen Angeben häufig verwendeter Felder. Die Anzahl der zulässigen Felder und die spezifischen Felder variieren je nach aufgerufener Befehlsmethode.
fieldsObject Object Nein

Ein Objekt zum Angeben verbleibender Werte, die in keinem der fields-Parameter angegeben sind.

Wenn ein Feld sowohl in einem fields-Parameter als auch in einem fieldsObject festgelegt ist, wird der Wert in fieldsObject verwendet.

In der Feldreferenz finden Sie die Dokumentation für einzelne Felder.

Beispiele

Beispiele für einzelne Befehle finden Sie unten im Abschnitt Befehlsmethoden.

Bereiter Callback

Wenn Sie die ga()-Befehlswarteschlangenfunktion durch Übergeben einer Funktion aufrufen, wird die übergebene Funktion für die Ausführung 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 die Übergabe einer Befehlswarteschlange ein Callback, wenn die analytics.js-Bibliothek geladen und bereit ist.

Nutzung

ga(readyCallback)

Parameter

Name Typ Required Beschreibung
readyCallback Function ja

Eine Callback-Funktion, die aufgerufen werden soll, wenn die Bibliothek vollständig geladen ist und mit ihr interagiert werden kann. Die Funktion wird mit dem Standard-Tracker-Objekt als erstes Argument aufgerufen. Wenn kein Standard-Tracker erstellt wurde, ist das erste Argument undefined.

Hinweis: Wenn die Callback-Funktion aufgerufen wird, stehen alle ga-Objektmethoden zur Verfügung.

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 weitergegeben werden können (ausgenommen 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 für einzelne Felder.

Gibt Folgendes zurück:

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

Ein Treffer wird an Google Analytics gesendet.

Nutzung

ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);

Die gesendeten Felder sind die in den ...fields-Parametern und fieldsObject angegebenen Werte, die mit den derzeit im Tracker gespeicherten Feldern zusammengeführt werden.

Parameter

Welche Felder durch die ...fields-Parameter festgelegt werden können, hängt vom Treffertyp ab. In der folgenden Tabelle sind die Felder für die einzelnen Treffertypen aufgeführt. Für nicht aufgeführte Treffertypen sind keine ...fields-Parameter zulässig, 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 für einzelne Felder.

Gibt Folgendes zurück:

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 und ein Wertpaar oder eine Gruppe von Feld/Wert-Paaren für ein 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 für einzelne Felder.

Gibt Folgendes zurück:

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

Ein analytics.js-Plug-in ist erforderlich.

Nutzung

ga('[trackerName.]require', pluginName, [pluginOptions]);

Parameter

Name Typ Required 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

Gibt Folgendes zurück:

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 für die Verwendung mit der Befehlswarteschlange ga() bereit.

ga('provide', pluginName, pluginConstuctor);

Parameter

Name Typ Required Beschreibung
pluginName string ja Der Name des bereitgestellten Plug-ins. Der verwendete Name muss mit dem Namen übereinstimmen, der bei allen required-Aufrufen verwendet wird.
pluginConstuctor Function ja Eine Konstruktorfunktion stellt alle Plug-in-Logiken und -Methoden bereit. 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');