Plug-ins sind Skripts, die die Funktionalität von analytics.js erweitern, um Probleme zu beheben und die Interaktion von Nutzern zu messen. In diesem Leitfaden wird beschrieben, wie Sie eigene analytics.js-Plug-ins schreiben. Informationen zur Verwendung von analytics.js-Plug-ins in eigenen Implementierungen finden Sie unter Plug-ins verwenden.
Plug-in definieren
Plug-ins werden über den Befehl provide definiert. Dieser muss mit dem Namen des Plug-ins als erstes Argument gefolgt von der Konstruktorfunktion des Plug-ins aufgerufen werden. Wenn der Befehl provide ausgeführt wird, wird das zu verwendende Plug-in mit der ga()-Befehlswarteschlange registriert.
Plug-in-Konstruktor
Hier ein grundlegendes Beispiel für ein analytics.js-Plug-in:
// Defines the plugin constructor.
function MyPlugin() {
console.log('myplugin has been required...');
}
// Registers the plugin for use.
ga('provide', 'myplugin', MyPlugin);
Plug-ins müssen auch in Fällen korrekt funktionieren, in denen das globale ga-Objekt umbenannt wurde. Wenn Sie also ein Plug-in für die Verwendung durch Drittanbieter schreiben, sollten Sie prüfen, ob die Variable GoogleAnalyticsObject auf einen anderen String als 'ga' festgelegt wurde. Dazu wird die Funktion providePlugin verwendet:
// Provides a plugin name and constructor function to analytics.js. This
// function works even if the site has customized the ga global identifier.
function providePlugin(pluginName, pluginConstructor) {
var ga = window[window['GoogleAnalyticsObject'] || 'ga'];
if (typeof ga == 'function') {
ga('provide', pluginName, pluginConstructor);
}
}
Plug-in-Instanzen konfigurieren
Wenn die ga()-Befehlswarteschlange einen require-Befehl ausführt, wird ein neues Objekt mit dem new-Operator für die provide-Konstruktorfunktion instanziiert. Der Konstruktor wird als erstes Argument an das Tracker-Objekt übergeben und alle Konfigurationsoptionen an den Befehl require als zweites Argument.
Dem Google Analytics-Tag wurde der folgende require-Befehl hinzugefügt:
ga('create', 'UA-XXXXX-Y', 'auto');
ga('require', 'localHitSender', {path: '/log', debug: true});
ga('send', 'pageview');
Und der localHitSender-Code:
function LocalHitSender(tracker, config) {
this.path = config.path;
this.debug = config.debug;
if (this.debug) {
console.log('localHitSender enabled for path: ' + this.path);
console.log('on tracker: ' + tracker.get('name'));
}
}
providePlugin('localHitSender', LocalHitSender);
Wenn der Befehl require ausgeführt wird, wird Folgendes in der Konsole protokolliert (der Name des Standardtrackers ist "t0"):
// localHitSender enabled for path: /log
// on tracker: t0
Plug-in-Methoden definieren
Plug-ins können ihre eigenen Methoden bereitstellen, die mit der Syntax der ga-Befehlswarteschlange aufgerufen werden können:
ga('[trackerName.]pluginName:methodName', ...args);
Dabei ist trackerName optional und methodName dem Namen einer Funktion auf dem Prototyp des Plug-in-Konstruktors entspricht. Wenn methodName nicht im Plug-in oder nicht vorhanden ist, tritt ein Fehler auf.
Beispiele für Aufrufe der Plug-in-Methode:
// Execute the 'doStuff' method using the 'myplugin' plugin.
ga('create', 'UA-XXXXX-Y', 'auto');
ga('require', 'myplugin');
ga('myplugin:doStuff');
// Execute the 'setEnabled' method of the 'hitCopy' plugin on tracker 't3'.
ga('create', 'UA-XXXXX-Y', 'auto', {name: 't3'});
ga('t3.require', 'hitcopy');
ga('t3.hitcopy:setEnabled', false);
Beispiele für Definitionen von Plug-in-Methoden:
// myplugin constructor.
var MyPlugin = function(tracker) {
};
// myplugin:doStuff method definition.
MyPlugin.prototype.doStuff = function() {
alert('doStuff method called!');
};
// hitcopy plugin.
var HitCopy = function(tracker) {
};
// hitcopy:setEnabled method definition.
HitCopy.prototype.setEnabled = function(isEnabled) {
this.isEnabled = isEnabled;
}:
Plug-ins werden geladen
Plug-ins werden normalerweise aus einer separaten JavaScript-Datei geladen oder zusammen mit dem Hauptanwendungscode gebündelt.
<script async src="myplugin.js"></script>
Plug-ins müssen nicht unbedingt definiert werden, bevor sie benötigt werden. Da analytics.js asynchron geladen wird, werden Plug-ins häufig ebenfalls asynchron geladen. Dafür wurde die Befehlswarteschlange ga() erstellt.
Wenn die Befehlswarteschlange einen require-Befehl für ein Plug-in empfängt, das noch nicht bereitgestellt wurde, wird die Ausführung der verbleibenden Elemente in der Warteschlange angehalten, bis das Plug-in verfügbar ist.
Der folgende Code zeigt, wie der Befehl ga('require', 'myplugin') erst dann ausgeführt wird, wenn der Befehl ga('provide', 'myplugin', ...) drei Sekunden später ausgeführt wird.
ga('require', 'myplugin');
function MyPlugin() {
console.log('myplugin has been required...');
}
// Waits 3 second after running the `require`
// command before running the `provide` command.
setTimeout(function() {
ga('provide', 'myplugin', MyPlugin);
}, 3000);
Beispiele
Mit dem folgenden Beispiel-Plug-in werden benutzerdefinierte Kampagnenwerte aus einer URL einer Seite erfasst und an den Tracker übergeben. In diesem Plug-in wird gezeigt, wie Sie ein Plug-in-Skript definieren und registrieren, Plug-in-Konfigurationsparameter übergeben und Plug-in-Methoden definieren und aufrufen.
// campaign-loader.js
function providePlugin(pluginName, pluginConstructor) {
var ga = window[window['GoogleAnalyticsObject'] || 'ga'];
if (typeof ga == 'function') {
ga('provide', pluginName, pluginConstructor);
}
}
/**
* Constructor for the campaignLoader plugin.
*/
var CampaignLoader = function(tracker, config) {
this.tracker = tracker;
this.nameParam = config.nameParam || 'name';
this.sourceParam = config.sourceParam || 'source';
this.mediumParam = config.mediumParam || 'medium';
this.isDebug = config.debug;
};
/**
* Loads campaign fields from the URL and updates the tracker.
*/
CampaignLoader.prototype.loadCampaignFields = function() {
this.debugMessage('Loading custom campaign parameters');
var nameValue = getUrlParam(this.nameParam);
if (nameValue) {
this.tracker.set('campaignName', nameValue);
this.debugMessage('Loaded campaign name: ' + nameValue);
}
var sourceValue = getUrlParam(this.sourceParam);
if (sourceValue) {
this.tracker.set('campaignSource', sourceValue);
this.debugMessage('Loaded campaign source: ' + sourceValue);
}
var mediumValue = getUrlParam(this.mediumParam);
if (mediumValue) {
this.tracker.set('campaignMedium', mediumValue);
this.debugMessage('Loaded campaign medium: ' + mediumValue);
}
};
/**
* Enables / disables debug output.
*/
CampaignLoader.prototype.setDebug = function(enabled) {
this.isDebug = enabled;
};
/**
* Displays a debug message in the console, if debugging is enabled.
*/
CampaignLoader.prototype.debugMessage = function(message) {
if (!this.isDebug) return;
if (console) console.debug(message);
};
/**
* Utility function to extract a URL parameter value.
*/
function getUrlParam(param) {
var match = document.location.search.match('(?:\\?|&)' + param + '=([^&#]*)');
return (match && match.length == 2) ? decodeURIComponent(match[1]) : '';
}
// Register the plugin.
providePlugin('campaignLoader', CampaignLoader);
Der obige Code kann folgendermaßen in eine HTML-Seite eingefügt werden:
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-XXXXX-Y', 'auto');
ga('require', 'campaignLoader', {
debug: true,
nameParam: 'cname',
sourceParam: 'csrc',
mediumParam: 'cmed'
});
ga('campaignLoader:loadCampaignFields');
ga('send', 'pageview');
</script>
<!--Note: plugin scripts must be included after the tracking snippet. -->
<script async src="campaign-loader.js"></script>
Auto-Tracking-Plug-ins
Die Bibliothek autotrack ist Open Source und auf GitHub verfügbar. Sie enthält verschiedene analytics.js-Plug-ins, die das Tracking gängiger Nutzerinteraktionen erleichtern. Im Quellcode des Autotracks finden Sie weitere Informationen zur Funktionsweise von Plug-ins.