La file d'attente de commandes ga()
fournit une interface qui vous permet de réaliser presque toutes les opérations à réaliser avec la bibliothèque analytics.js.
L'extrait de suivi JavaScript définit la fonction initiale de la file d'attente de commandes ga()
. Vous pouvez donc l'utiliser avant même le chargement complet de la bibliothèque analytics.js. Dès que la bibliothèque analytics.js est chargée, les éléments de la file d'attente de commandes sont exécutés dans l'ordre de leur réception. Une fois cette opération effectuée, les nouvelles commandes ajoutées à la file d'attente sont immédiatement exécutées.
Afin de limiter au maximum la taille de l'extrait de suivi, la file d'attente de commandes ga()
est surchargée et accepte les arguments dans de nombreux formats différents. Ce document détaille les différentes manières d'appeler la fonction de file d'attente de commandes ga()
.
Signature de la fonction | |
---|---|
ga(command, [...fields], [fieldsObject]) |
Si vous appelez la fonction de file d'attente de commandes |
ga(readyCallback) |
Appeler la fonction de file d'attente de commandes Étant donné que les commandes ne sont exécutées qu'une fois la bibliothèque analytics.js entièrement chargée, la raison la plus courante pour transmettre une fonction à la file d'attente de commandes est de servir de rappel lorsque la bibliothèque analytics.js est chargée et prête. |
Ajouter des commandes à la file d'attente
Si vous appelez la fonction de file d'attente de commandes ga()
avec la signature de fonction suivante, les commandes seront envoyées à la file d'attente, dont l'exécution sera programmée une fois la bibliothèque chargée.
Utilisation
ga(command, [...fields], [fieldsObject])
Paramètres
Nom | Type | Obligatoire | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
command |
string |
oui |
Identifiant représentant la commande à ajouter à la file d'attente. L'identifiant se compose de trois parties (les deux premières étant facultatives): [trackerName.][pluginName:]methodName
|
|||||||||
...fields |
* |
no | Un ou plusieurs paramètres pratiques facultatifs permettant de spécifier rapidement des champs courants. Le nombre de champs spécifiques autorisés varie en fonction de la méthode de commande appelée. | |||||||||
fieldsObject |
Object |
no |
Objet permettant de spécifier les valeurs restantes non spécifiées dans aucun des paramètres Si un champ est défini à la fois dans un paramètre |
Consultez la documentation de référence sur les champs pour en savoir plus sur chaque champ.
Exemples
Consultez la section Méthodes de commande ci-dessous pour obtenir des exemples de commandes spécifiques.
Rappel disponible
Appeler la fonction de file d'attente de commandes ga()
en lui transmettant une fonction programmera l'exécution de la fonction transmise au point suivant de la file d'attente.
Étant donné que les commandes ne sont exécutées qu'une fois la bibliothèque analytics.js entièrement chargée, la raison la plus courante pour transmettre une fonction à la file d'attente de commandes est de servir de rappel lorsque la bibliothèque analytics.js est chargée et prête.
Utilisation
ga(readyCallback)
Paramètres
Nom | Type | Obligatoire | Description |
---|---|---|---|
readyCallback |
Function |
oui |
Fonction de rappel à appeler lorsque la bibliothèque est entièrement chargée et prête à être utilisée. La fonction est appelée avec l'objet de suivi par défaut comme premier argument. Si aucun outil de suivi par défaut n'a été créé, le premier argument est Remarque: Lorsque la fonction de rappel est appelée, toutes les méthodes d'objet
|
Exemples
// 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`. });
Détails des méthodes de commande
Vous trouverez ci-dessous la liste de toutes les méthodes pouvant être transmises à la file d'attente de commandes ga()
(à l'exception des méthodes de plug-in).
create
Crée une instance de traceur avec les champs spécifiés.
Utilisation
ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);
Paramètres
Consultez la documentation de référence sur les champs pour en savoir plus sur chaque champ.
Renvoie
undefined
Exemples
// 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
Envoie un appel à Google Analytics.
Utilisation
ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);
Les champs envoyés sont les valeurs spécifiées dans les paramètres ...fields
et fieldsObject
, fusionnées avec les champs actuellement stockés dans l'outil de suivi.
Paramètres
Les champs pouvant être spécifiés par les paramètres ...fields
varient en fonction du type d'appel. Le tableau suivant liste les champs correspondant à chaque type d'appel. Les types d'appels non répertoriés n'acceptent pas les paramètres ...fields
, mais uniquement fieldsObject
.
Type d'appel | ...fields |
---|---|
pageview |
page |
event |
eventCategory , eventAction , eventLabel , eventValue |
social |
socialNetwork , socialAction et socialTarget |
timing |
timingCategory , timingVar , timingValue , timingLabel |
Consultez la documentation de référence sur les champs pour en savoir plus sur chaque champ.
Renvoie
undefined
Exemples
// 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
Définit une seule paire champ/valeur ou un groupe de paires champ/valeur sur un objet Tracker.
Utilisation
// Sets a single field and value. ga('[trackerName.]set', fieldName, fieldValue);
// Sets a group of field/value pairs. ga('[trackerName.]set', fieldsObject);
Paramètres
Consultez la documentation de référence sur les champs pour en savoir plus sur chaque champ.
Renvoie
undefined
Exemples
// 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
Nécessite un plug-in analytics.js.
Utilisation
ga('[trackerName.]require', pluginName, [pluginOptions]);
Paramètres
Nom | Type | Obligatoire | Description |
---|---|---|---|
pluginName |
string |
oui | Nom du plug-in requis. Remarque:Si le plug-in n'est pas un plug-in analytics.js officiel, il doit être fourni ailleurs sur la page. |
pluginOptions |
Object |
no | Objet d'initialisation qui est transmis au constructeur du plug-in lors de l'instanciation. |
Renvoie
undefined
Exemple
// 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
Fournit un plug-in analytics.js et ses méthodes à utiliser avec la file d'attente de commandes ga()
.
ga('provide', pluginName, pluginConstuctor);
Paramètres
Nom | Type | Obligatoire | Description |
---|---|---|---|
pluginName |
string |
oui | Nom du plug-in fourni. Le nom utilisé doit être le même que celui utilisé par tous les appels require. |
pluginConstuctor |
Function |
oui | Une fonction constructeur fournit l'ensemble de la logique et des méthodes du plug-in. Ce constructeur sera appelé avec l'objet pluginsOptions spécifié dans la méthode require. |
Exemple
// Defines a plugin constructor function MyPlugin(tracker, options) { // ... } // Provides the plugin for use with the ga() command queue. ga('provide', 'myplugin', MyPlugin);
remove
Supprime un objet de suivi.
Utilisation
ga('[trackerName.]remove');
Exemples
// Remove the default tracker. ga('remove');
// Remove the tracker named "myTracker". ga('myTracker.remove');