Referencia de métodos del objeto ga

En esta referencia se describen los métodos disponibles en el objeto ga.

Resumen de métodos

Los siguientes métodos están disponibles en el objeto ga después de que se cargue la biblioteca analytics.js. Debido a que estos métodos no están disponibles de forma inmediata, siempre debes invocarlos con la función ready callback de la cola de comandos ga.

No utilices los métodos del objeto ga fuera de readyCallback, ya que es posible que todavía no estén disponibles.

var trackers = ga.getAll();

Utiliza los métodos del objeto ga en readyCallback, ya que tienes la garantía de que estarán disponibles.

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

Métodos
create([trackingId], [cookieDomain], [name], [fieldsObject]);	Devuelve: Tracker Crea una instancia de objeto de seguimiento con los campos especificados.
getByName(name)	Devuelve: Tracker Obtiene la instancia de objeto de seguimiento con el nombre especificado.
getAll()	Devuelve: Array<Tracker> Obtiene todas las instancias de objeto de seguimiento.
remove(name)	Devuelve: undefined Quita la instancia de objeto de seguimiento con el nombre especificado.

Detalles de método

create

Crea una instancia de objeto de seguimiento con los campos especificados.

Uso

ga.create([trackingId], [cookieDomain], [name], [fieldsObject]);

Nota: Se recomienda llamar al método create mediante la cola de comandos ga. Consulta la referencia del método create para obtener más información.

Parámetros

En la referencia de campos puedes consultar la documentación de cada campo.

Devuelve

Tracker

Ejemplos

// 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

Obtiene la instancia de objeto de seguimiento con el nombre especificado.

Uso

ga.getByName(name);

Parámetros

Nombre	Tipo	Obligatorio	Descripción
name	string	Sí	Nombre del objeto de seguimiento que se obtendrá.

Devuelve

Tracker

Ejemplos

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

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

---

getAll

Obtiene todas las instancias de objeto de seguimiento.

ga.getAll();

Devuelve

Array<Tracker>

Ejemplo

// 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

Quita la instancia de objeto de seguimiento que tiene el nombre especificado.

Uso

ga.remove(name);

Nota: Se recomienda llamar al método remove mediante la cola de comandos ga. Consulta la referencia del método remove para obtener más información.

Parámetros

Nombre	Tipo	Obligatorio	Descripción
name	string	Sí	Nombre del objeto de seguimiento que se eliminará.

Devuelve

undefined

Ejemplos

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