Les plugins sont des scripts qui améliorent les fonctionnalités de analytics.js pour aider à mesurer l’interaction des utilisateurs. Les plugins sont généralement spécifiques à un ensemble de fonctionnalités qui ne sont pas forcément requises par tous les utilisateurs de Google Analytics, comme le commerce électronique ou la mesure interdomaines, et ne sont donc pas inclus par défaut dans analytics.js.
Ce guide explique comment requérir et utiliser les plugins analytics.js.
Requérir des plugins
La commande require prend le nom d’un plugin et l’enregistre pour l’utiliser avec la ga() file d’attente des commandes. Si le plugin accepte des options de configuration, ces options peuvent être transmises comme argument final à la commande require.
Voici la signature complète de la commande require:
ga('require', pluginName, );Par exemple, voici comment vous exigerez le plugin Enhanced Ecommerce à utiliser avec le tracker par défaut :
ga('require', 'ec');Et voici comment vous exigeriez le plugin Advertising Features pour un tracker nommé « myTracker » et passeriez une option de configuration qui remplace la valeur par défaut du nom du cookie :
ga('myTracker.require', 'displayfeatures', { cookieName: 'display_features_cookie'});Chargement du code du plugin
La commande require initialise les méthodes du plugin à utiliser avec la file d’attente de la commande ga(), mais elle ne charge pas le script du plugin lui-même. Si vous utilisez un plugin tiers, ou si vous écrivez un plugin vous-même, vous devrez ajouter manuellement le code du plugin à la page.
La méthode recommandée pour ajouter le code du plugin à la page est via une balise <script> avec l’attribut async défini pour s’assurer qu’il ne bloque pas le chargement d’autres fonctionnalités sur votre site.
Le code suivant requiert et charge à la fois un hypothétique plugin de suivi des liens:
<script>ga('create', 'UA-XXXXX-Y', 'auto');ga('require', 'linkTracker');ga('send', 'pageview');</script><!--Note: plugin scripts must be included after the tracking snippet. --><script async src="/path/to/link-tracker-plugin.js"></script>Attente du chargement des plugins
Parce que la bibliothèque analytics.js et les plugins analytics.js sont chargés de manière asynchrone, il peut être difficile de savoir quand les plugins sont entièrement chargés et prêts à être utilisés.
La bibliothèque analytics.js résout ce problème en interrompant l’exécution de la file d’attente des commandes lorsqu’elle rencontre une require commande pour un plugin qui n’est pas encore chargé. Une fois le plugin chargé, l’exécution de la file d’attente se poursuit normalement.
En conséquence, il est extrêmement important que vous testiez les plugins que vous utilisez pour vous assurer qu’ils se chargent et s’exécutent correctement. Si un plugin ne parvient pas à se charger ou présente une erreur, il empêchera toutes les commandes analytics.js suivantes de s’exécuter.
Appeler les méthodes du plugin
Après avoir demandé un plugin, ses méthodes deviennent disponibles pour être utilisées avec la ga() file d’attente des commandes. Voici la signature de commande pour appeler les méthodes du plugin :
ga('methodName', ...args);Par exemple, la méthode addProduct du plugin Enhanced Ecommerce peut être appelée comme suit :
ga('ec:addProduct', { 'id': 'P12345', 'quantity': 1});Ou sur un tracker nommé en ajoutant le nom du tracker à la chaîne de commande :
ga('myTracker.ec:addProduct', { 'id': 'P12345', 'quantity': 1});Si vous avez lu tous les guides de cette section, vous devriez connaître la plupart des fonctionnalités d’analytics.js. Le prochain guide explique comment déboguer vos implémentations analytics.js afin de détecter plus facilement les erreurs et de voir exactement ce que fait votre code.