Referência de métodos do objeto ga

Esta referência descreve os métodos disponíveis no objeto ga.

Resumo dos métodos

Os métodos a seguir ficam disponíveis no objeto ga depois que a biblioteca analytics.js é carregada. Como eles não são disponibilizados de imediato, você precisa invocá-los usando o ready callback da fila de comandos do ga.

Não use métodos do objeto ga fora de um readyCallback, porque talvez os métodos ainda não estejam disponíveis.

var trackers = ga.getAll();

Use métodos do objeto ga dentro de um readyCallback, porque eles certamente estarão disponíveis.

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

Métodos
create([trackingId], [cookieDomain], [name], [fieldsObject]);	Retorna: Tracker Cria uma nova instância do rastreador com os campos especificados.
getByName(name)	Retorna: Tracker Mostra a instância do rastreador com o nome especificado.
getAll()	Retorna: Array<Tracker> Mostra todas as instâncias do rastreador.
remove(name)	Retorna: undefined Remove a instância do rastreador com o nome especificado.

Detalhes do método

create

Cria uma nova instância do rastreador com os campos especificados.

Uso

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

Observação: é recomendado chamar o método create usando a fila de comandos do ga. Confira mais detalhes na referência do método "create".

Parâmetros

Consulte a referência de campos para ver a documentação referente a cada um.

Retorna

Tracker

Exemplos

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

Mostra a instância do rastreador com o nome especificado.

Uso

ga.getByName(name);

Parâmetros

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	O nome do rastreador a ser mostrado.

Retorna

Tracker

Exemplos

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

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

---

getAll

Mostra todas as instâncias do rastreador.

ga.getAll();

Retorna

Array<Tracker>

Exemplo

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

Remove a instância do rastreador com o nome especificado.

Uso

ga.remove(name);

Observação: é recomendado chamar o método remove usando a fila de comandos do ga. Consulte a referência do método "remove" para mais detalhes.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	O nome do rastreador a ser removido.

Retorna

undefined

Exemplos

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