Documentation de référence sur les files d'attente de commandes ga

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.

Remarque:Les extraits de code de suivi JavaScript permettent de renommer la fonction de file d'attente de commandes ga(). Dans ce cas, assurez-vous que tout code que vous copiez à partir de ce site fait référence au nouveau nom.

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() 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.
ga(readyCallback)	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.

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 trackerName Nom de l'outil de suivi sur lequel appeler la commande programmée. Si aucun nom d'outil de suivi n'est spécifié, la commande est appelée sur l'outil de suivi par défaut. pluginName Nom d'un plug-in analytics.js requis. Si pluginName est spécifié, methodName doit être une méthode fournie par le plug-in. methodName Nom de la méthode dont l'exécution doit être planifiée. Si vous ne spécifiez pas de nom de plug-in, cette méthode doit correspondre à l'une des méthodes de commande répertoriées ci-dessous.
...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 fields. Si un champ est défini à la fois dans un paramètre fields et dans fieldsObject, la valeur de fieldsObject sera utilisée.

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 undefined. Remarque: Lorsque la fonction de rappel est appelée, toutes les méthodes d'objet ga peuvent être utilisées.

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'
});

Important:Vous ne pouvez pas spécifier de nom d'outil de suivi dans la partie méthode de l'appel de création. Par exemple, ga('myTracker.create', 'UA-XXXXX-Y`) ne fonctionne pas.

Pour en savoir plus sur la création d'outils de suivi, consultez le guide sur la création d'outils de suivi.

---

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.

Remarque:Les valeurs spécifiées dans ...fields et fieldsObject sont envoyées avec l'appel actuel, mais ne sont pas stockées dans l'objet de suivi. Utilisez la méthode set pour mettre à jour un 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
});

Pour en savoir plus sur l'envoi d'appels, consultez le guide Envoyer des données à Google Analytics.

---

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'
});

Pour en savoir plus sur la mise à jour des outils de suivi, consultez le guide Obtenir et configurer les données de suivi.

---

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'
});

Pour en savoir plus sur l'utilisation de plug-ins analytics.js, consultez le guide Utiliser des plug-ins.

---

provide

Fournit un plug-in analytics.js et ses méthodes à utiliser avec la file d'attente de commandes ga().

ga('provide', pluginName, pluginConstuctor);

Remarque:Contrairement à la plupart des méthodes de file d'attente ga(), la méthode n'accepte pas de nom d'outil de suivi.

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);

Pour en savoir plus sur l'ajout de plug-ins analytics.js, consultez le guide sur l'écriture de plug-ins.

---

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');