Referência de métodos do objeto ga

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

Resumo do método

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

Não use métodos do objeto ga fora de um readyCallback, pois é possível que os métodos ainda não estejam disponíveis.

var trackers = ga.getAll();

Use métodos do objeto ga dentro de um readyCallback, pois 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]);

Parâmetros

Consulte a referência de campo para ver a documentação de campo individual.

Retorna

Rastreador

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 transport mechanism of "beacon".
ga(function() {
  var myTracker = ga.create('UA-XXXXX-Y', 'example.com', 'myTracker', {
    transport: 'beacon'
  });
});

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

Rastreador

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

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