Schreiben von Plug-ins

Plug-ins sind Skripts, die die Funktionalität von analytics.js erweitern, um Probleme zu lösen und Nutzerinteraktionen zu messen. In diesem Leitfaden wird beschrieben, wie Sie eigene analytics.js-Plug-ins schreiben. Informationen zur Verwendung von analytics.js-Plug-ins in Ihren eigenen Implementierungen finden Sie unter Plug-ins verwenden.

Plug-in definieren

Plug-ins werden mit dem 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 bei der ga()-Befehlswarteschlange registriert.

Plug-in-Konstruktor

Hier sehen Sie das einfachste Beispiel eines analytics.js-Plug-ins:

// 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 dann korrekt funktionieren, wenn das globale ga-Objekt umbenannt wurde. Wenn Sie also ein Plug-in für die Verwendung durch Drittanbieter schreiben, sollten Sie überprüfen, ob die Variable GoogleAnalyticsObject auf einen anderen String als 'ga' festgelegt wurde. Dies wird mithilfe der folgenden providePlugin-Funktion ausgeführt:

// 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 mithilfe des new-Operators in der Konstruktorfunktion des provide-Plug-ins ein neues Objekt instanziiert. Dem Konstruktor wird das Tracker-Objekt als erstes Argument übergeben. Alle Konfigurationsoptionen werden als zweites Argument an den Befehl require übergeben.

Sehen Sie sich den folgenden require-Befehl an, der dem Google Analytics-Tag hinzugefügt wurde:

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 (beachten Sie, dass der Name des Standard-Trackers „t0“ lautet):

// localHitSender enabled for path: /log
// on tracker: t0

Plug-in-Methoden definieren

Plug-ins können ihre eigenen Methoden zur Verfügung stellen, die mithilfe der ga-Befehlswarteschlangensyntax aufgerufen werden können:

ga('[trackerName.]pluginName:methodName', ...args);

Dabei ist trackerName optional und methodName dem Namen einer Funktion im Prototyp der Plug-in-Konstruktoren. Wenn methodName im Plug-in nicht vorhanden oder das Plug-in nicht vorhanden ist, tritt ein Fehler auf.

Beispiele für Plug-in-Methodenaufrufe:

// 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 Plug-in-Methodendefinitionen:

// 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 in der Regel aus einer separaten JavaScript-Datei geladen oder mit Ihrem 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 und Plug-ins häufig auch asynchron geladen werden, ist dies in der ga()-Befehlswarteschlange möglich.

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, dass der Befehl ga('require', 'myplugin') erst drei Sekunden später ausgeführt wird, wenn der Befehl ga('provide', 'myplugin', ...) 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);

Wichtig! Die Reihenfolge der require- und provide-Befehle ist zwar nicht wichtig, sie können aber nicht vor Ausführung des JavaScript-Tracking-Snippets aufgerufen werden, da beide auf die globale ga-Befehlswarteschlangenfunktion verweisen.

Beispiele

Mit dem folgenden Beispiel-Plug-in werden benutzerdefinierte Kampagnenwerte aus der URL einer Seite erfasst und an den Tracker übergeben. Dieses Plug-in zeigt, wie ein Plug-in-Skript definiert und registriert, Plug-in-Konfigurationsparameter übergeben und Plug-in-Methoden definiert und aufgerufen werden.

// 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 wie folgt 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>

Autotrack-Plug-ins

Die autotrack-Bibliothek ist Open Source und auf GitHub verfügbar. Sie enthält mehrere analytics.js-Plug-ins, mit denen gängige Nutzerinteraktionen erfasst werden können. Weitere Informationen zur Funktionsweise von Plug-ins finden Sie im Autotrack-Quellcode.