Documentation de référence sur les méthodes objet ga

Ce document de référence décrit les méthodes disponibles pour l'objet ga.

Récapitulatif sur la méthode

Les méthodes suivantes sont disponibles sur l'objet ga après le chargement de la bibliothèque analytics.js. Ces méthodes ne sont pas disponibles immédiatement. Vous devez donc toujours les appeler à l'aide du rappel prêt de la file d'attente de commande ga.

À éviter : utilisez les méthodes d'objet ga en dehors d'un readyCallback, car il est possible que ces méthodes ne soient pas encore disponibles.

var trackers = ga.getAll();

À faire : utilisez des méthodes d'objet ga dans un readyCallback, car leur disponibilité est garantie.

ga(function() {
  var trackers = ga.getAll();
});

Informations sur la méthode

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

Tracker

Exemples

// Creates a default tracker for the property UA-XXXXX-Y
// and uses automatic cookie domain configuration.
ga(function() {
  var tracker = 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 site speed sample rate of 10%.
ga(function() {
  var myTracker = ga.create('UA-XXXXX-Y', 'example.com', 'myTracker', {
    siteSpeedSampleRate: 10
  });
});

getByName

Récupère l'instance de suivi avec le nom spécifié.

Utilisation

ga.getByName(name);

Paramètres

Renvoie

Tracker

Exemples

// Gets the default tracker.
ga(function() {
  ga.getByName('t0');
});

// Gets the tracker with the name "myTracker".
ga(function() {
  ga.getByName('myTracker');
});

getAll

Récupère toutes les instances de l'outil de suivi.

ga.getAll();

Renvoie

Array<Tracker>

Exemple

// Logs a list of all tracker names to the console.
ga(function() {
  var trackers = ga.getAll();
  trackers.forEach(function(tracker) {
    console.log(tracker.get('name'));
  });
});

remove

Supprime l'instance de suivi avec le nom spécifié.

Utilisation

ga.remove(name);

Paramètres

Renvoie

undefined

Exemples

// Removes the default tracker.
ga(function() {
  // Note that, unlike the ga command queue's remove method,
  // this method requires passing a tracker name, even when
  // removing the default tracker.
  ga.remove('t0');
});

// Removes the tracker with the name "myTracker".
ga(function() {
  ga.remove('myTracker');
});