Obtenir et définir des données de terrain

L'obtention et la configuration de données de champ sur un traceur nécessitent parfois une référence à l'objet de suivi lui-même. Étant donné que les commandes ajoutées à la file d'attente de commandes ga() s'exécutent de manière asynchrone et ne renvoient pas de valeur, et que les outils de suivi sont le plus souvent créés à l'aide de la commande create, l'obtention d'une référence à un objet de suivi nécessite d'attendre l'exécution de la commande create. Vous pouvez le faire via le rappel prêt.

Le rappel "Ready" (Prêt)

Le rappel prêt est une fonction que vous pouvez ajouter à la file d'attente de commandes ga(). La fonction sera appelée dès que la bibliothèque analytics.js sera entièrement chargée et que toutes les commandes précédentes ajoutées à la file d'attente auront été exécutées.

Étant donné que toutes les commandes de la file d'attente sont exécutées dans l'ordre, l'ajout d'un rappel prêt à la file d'attente après l'ajout d'une commande create garantit que le rappel prêt est exécuté après la création du traceur. Si un traceur par défaut a été créé lors de l'appel d'un rappel prêt, il est transmis en tant que premier (et seul) argument du rappel.

Le code suivant montre comment accéder à l'objet de suivi par défaut et le consigner dans la console:

ga('create', 'UA-XXXXX-Y', 'auto');

ga(function(tracker) {
  // Logs the tracker created above to the console.
  console.log(tracker);
});

Obtenir des outils de suivi via les méthodes d'objet GA

Si vous n'utilisez pas d'outil de suivi par défaut ou si vous en avez plusieurs sur la page, vous pouvez y accéder via l'une des méthodes d'objet ga.

Une fois la bibliothèque analytics.js entièrement chargée, elle ajoute des méthodes supplémentaires à l'objet ga lui-même. Deux de ces méthodes, getByName et getAll, permettent d'accéder aux objets de suivi.

getByName

Si vous connaissez le nom du traceur auquel vous voulez accéder, vous pouvez utiliser la méthode getByName:

ga('create', 'UA-XXXXX-Y', 'auto', 'myTracker');

ga(function() {
  // Logs the "myTracker" tracker object to the console.
  console.log(ga.getByName('myTracker'));
});

getAll

Pour obtenir un tableau de tous les outils de suivi créés, utilisez la méthode getAll:

ga('create', 'UA-XXXXX-Y', 'auto', 'tracker1');
ga('create', 'UA-XXXXX-Z', 'auto', 'tracker2');

ga(function() {
  // Logs an array of all tracker objects.
  console.log(ga.getAll());
});

Obtenir des données stockées sur un coach électronique

Une fois que vous avez une référence à un objet de suivi, vous pouvez utiliser sa méthode get pour accéder à la valeur de n'importe quel champ actuellement stocké dans l'outil de suivi.

ga('create', 'UA-XXXXX-Y', 'auto');

ga(function(tracker) {
  // Logs the trackers name.
  // (Note: default trackers are given the name "t0")
  console.log(tracker.get('name'));

  // Logs the client ID for the current user.
  console.log(tracker.get('clientId'));

  // Logs the URL of the referring site (if available).
  console.log(tracker.get('referrer'));
});

Mettre à jour des données

Les objets Tracker peuvent être mis à jour à l'aide de la méthode set. La méthode set d'un traceur peut être appelée sur un objet de suivi lui-même ou en ajoutant une commande set à la file d'attente de commandes ga().

Étant donné que l'obtention d'une référence à un objet de suivi nécessite l'utilisation du rappel "ready", nous vous recommandons d'utiliser la file d'attente de commandes ga() pour mettre à jour un outil de suivi.

File d'attente de commandes ga()

La commande set peut être appelée de deux manières: en transmettant deux paramètres, un champ et sa valeur correspondante, ou en transmettant un objet de paires champ/valeur.

L'exemple suivant définit le champ page sur '/about' sur l'outil de suivi par défaut:

ga('set', 'page', '/about');

Cet exemple définit les champs page et title en même temps:

ga('set', {
  page: '/about',
  title: 'About Us'
});

Utilisation d'un traceur nommé

Si vous utilisez un outil de suivi nommé au lieu de l'outil de suivi par défaut, vous pouvez transmettre son nom dans la chaîne de commande.

L'appel suivant définit le champ page sur l'outil de suivi nommé "myTracker":

ga('myTracker.set', 'page', '/about');

Sur l'objet de suivi

Si vous avez une référence à l'objet de suivi, vous pouvez appeler directement la méthode set de ce traceur:

ga(function(tracker) {
  tracker.set('page', '/about');
});

Syntaxe des esperluettes

Les champs de l'outil de suivi sont généralement récupérés et définis à l'aide de leur nom de champ. (Consultez la documentation de référence sur les champs pour obtenir la liste complète des champs analytics.js et leur nom.)

Une autre façon d'obtenir et de définir des champs consiste à y faire référence en utilisant leur nom de paramètre du protocole de mesure correspondant.

Par exemple, les deux expressions console.log suivantes consignent le titre du document dans la console:

ga(function(tracker) {
  // Gets the title using the analytics.js field name.
  console.log(tracker.get('title'));

  // Gets the title using the measurement protocol
  // parameter name, prefixed with an ampersand.
  console.log(tracker.get('&dt'));
});

En général, la syntaxe de l'esperluette n'est pas recommandée et ne doit être utilisée que lorsque le nom de champ analytics.js d'un paramètre du protocole de mesure n'existe pas. Cela se produit occasionnellement si une nouvelle fonctionnalité est ajoutée au protocole de mesure avant d'être implémentée dans analytics.js.

Étapes suivantes

Maintenant que vous savez comment créer des outils de suivi et mettre à jour les données qui y sont stockées, la prochaine étape consiste à apprendre à envoyer ces données à Google Analytics pour traitement.