Les plug-ins sont des scripts qui améliorent le fonctionnement d'analytics.js et permettent de mesurer les interactions des utilisateurs. Les plug-ins sont généralement spécifiques à un ensemble de fonctionnalités qui peuvent ne pas être requises par tous les utilisateurs Google Analytics, comme l'ecommerce ou les mesures multidomaines. Ils ne sont donc pas inclus par défaut dans analytics.js.
Ce guide explique comment exiger et utiliser les plug-ins analytics.js.
Plug-ins requis
La commande require prend le nom d'un plug-in et l'enregistre pour l'utiliser avec la file d'attente de commandes ga(). Si le plug-in accepte des options de configuration, celles-ci peuvent être transmises en tant qu'argument final de la commande require.
Voici la signature complète de la commande require:
ga('[trackerName.]require', pluginName, [pluginOptions]);
Par exemple, voici comment le plug-in E-commerce amélioré doit être utilisé avec l'outil de suivi par défaut:
ga('require', 'ec');
Voici comment vous devez disposer du plug-in Fonctionnalités de publicité pour un outil de suivi nommé "myTracker" et transmettre une option de configuration qui remplace la valeur par défaut du nom du cookie:
ga('myTracker.require', 'displayfeatures', {
cookieName: 'display_features_cookie'
});
Charger le code du plug-in
La commande require initialise les méthodes de plug-in à utiliser avec la file d'attente de commandes ga(), mais ne charge pas le script de plug-in lui-même. Si vous utilisez un plug-in tiers ou si vous écrivez un plug-in vous-même, vous devez ajouter manuellement le code du plug-in à la page.
La méthode recommandée pour ajouter du code de plug-in à la page consiste à utiliser une balise <script> avec l'attribut async défini pour éviter qu'elle ne bloque le chargement d'autres fonctionnalités sur votre site.
Le code suivant nécessite et charge un plug-in de suivi de liens fictif:
<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>
En attente du chargement des plug-ins
Étant donné que la bibliothèque analytics.js et les plug-ins analytics.js sont chargés de manière asynchrone, il peut être difficile de savoir quand les plug-ins 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 de commandes lorsqu'elle rencontre une commande require pour un plug-in qui n'est pas encore chargé. Une fois le plug-in chargé, l'exécution de la file d'attente se poursuit normalement.
Par conséquent, il est extrêmement important de tester les plug-ins que vous utilisez pour vous assurer qu'ils se chargent et s'exécutent correctement. Si un plug-in ne se charge pas ou rencontre une erreur, il empêche l'exécution de toutes les commandes analytics.js ultérieures.
Appeler des méthodes de plug-in
Une fois le plug-in requis, ses méthodes deviennent disponibles pour une utilisation avec la file d'attente de commandes ga(). Voici la signature de la commande pour appeler les méthodes du plug-in:
ga('[trackerName.][pluginName:]methodName', ...args);
Par exemple, la méthode addProduct du plug-in Commerce électronique amélioré peut être appelée comme suit:
ga('ec:addProduct', {
'id': 'P12345',
'quantity': 1
});
Ou sur un outil de suivi nommé, en ajoutant son nom à la chaîne de commande:
ga('myTracker.ec:addProduct', {
'id': 'P12345',
'quantity': 1
});
Étapes suivantes
Si vous avez lu tous les guides de cette section, vous devriez connaître la plupart des fonctionnalités d'analytics.js. Le guide suivant explique comment déboguer vos intégrations analytics.js pour détecter plus facilement les erreurs et voir exactement ce que fait votre code.