Código de acompanhamento: configuração básica

Esta referência descreve os métodos usados para personalizar métodos os aspectos dos relatórios do Google Analytics.

Métodos básicos ga.js

Detalhes do método

_deleteCustomVar()

_deleteCustomVar(index)

Este método exclui a variável atribuída ao índice fornecido (caso haja um). Por exemplo, você pode definir uma variável personalizada no nível do visitante e depois decidir que não quer mais usar essa variável no nível do visitante.

Snippet assíncrono (recomendado)

_gaq.push(['_deleteCustomVar', 1]);

parâmetros

Int   index O índice da variável personalizada a ser excluída.


_getName()

_getName()

Mostra o nome atribuído ao acompanhamento quando foi criado.

Snippet assíncrono (recomendado)

_gaq.push(function() {
  var pageTracker = _gat._getTrackerByName(); // Gets the default tracker.
  var trackerName = pageTracker._getName();
});

retorna.

String O nome do tracker.


_getAccount()

_getAccount()

Retorna o ID do Google Analytics referente a esse objeto do rastreador. Se você estiver acompanhando páginas em seu site em várias contas, poderá usar esse método para determinar a conta associada a um determinado objeto de acompanhamento.

Snippet assíncrono (recomendado)

_gaq.push(function() {
  var pageTracker = _gat._getTrackerByName(); // Gets the default tracker.
  var accountId = pageTracker._getAccount();
});

retorna.

String ID da conta com que esse objeto de acompanhamento é instanciado.


_getVersion()

_getVersion()

Mostra o número de versão do GATC (Google Analytics Tracking Code, código de acompanhamento do Google Analytics).

Snippet assíncrono (recomendado)

_gaq.push(function() {
  var pageTracker = _gat._getTrackerByName(); // Gets the default tracker.
  var version = pageTracker._getVersion();
});

retorna.

Número da versão do GATC: String.


_getVisitorCustomVar()

_getVisitorCustomVar(index)

Retorna o valor da variável personalizada no nível do visitante atribuído ao índice especificado.

Snippet assíncrono (recomendado)

_gaq.push(function() {
  var pageTracker = _gat._getTrackerByName(); // Gets the default tracker.
  var visitorCustomVar1Value = pageTracker._getVisitorCustomVar(1);
});

parâmetros

Int   index O índice da variável personalizada no nível do visitante.

retorna.

String: o valor da variável personalizada no nível do visitante. Mostrará um valor indefinido caso não seja possível recuperar a variável do índice especificado.


_initData() (link em inglês)

_initData()Descontinuado. Agora, initData() é executado automaticamente no código de acompanhamento da ga.js.

Inicializa ou reinicializa o objeto GATC.

var pageTracker = _gat._getTracker("UA-12345-1");
pageTracker._trackPageview();

_setAccount()

_setAccount(accountId)

Usado exclusivamente no acompanhamento assíncrono. Define o ID da propriedade da Web do objeto de acompanhamento.

_gaq.push(['_setAccount', 'UA-XXXXX-X']);

parâmetros

String accountID: o ID completo da propriedade da Web (por exemplo, UA-65432-1) para o objeto de acompanhamento.


_setCookiePersistent()

_setCookiePersistence(milliseconds)

Esse método não foi aprovado. Use _setVisitorCookieTimeout(cookieTimeoutMillis).

Define a expiração de cookies de visitante do Google Analytics (em milissegundos). Por padrão, o cookie do visitante é definido para expirar em dois anos. Se preferir, você pode mudar a data de validade do cookie de visitante usando esse método. Por exemplo, para definir a validade do cookie de visitante como sete dias, use o seguinte código:

pageTracker._setCookiePersistence(604800000); 

parameters

Number   milliseconds Novo prazo de validade do cookie de visitante.


_setCustomVar()

_setCustomVar(index, name, value, opt_scope)

Define uma variável personalizada com o nome, o valor e o escopo definidos para a variável. Há um limite de 128 bytes de caracteres para os atributos name e value combinados.

Snippet assíncrono (recomendado)

_gaq.push(['_setCustomVar', 1, 'Section', 'Life & Style', 3]);

retorna.

Boolean Esse método retornará true se a variável personalizada tiver sido definida e false se não tiver sido (por exemplo, se o comprimento da string de nome/valor exceder 128 bytes ou se você usar um espaço incorreto).

parâmetros

Int      index       Obrigatório. O espaço usado para a variável personalizada. Os valores possíveis são 1-5, inclusive.

String   name        Obrigatório. O nome da variável personalizada.

String   value       Obrigatório. O valor da variável personalizada.

Int      opt_scope   Opcional. O escopo usado para variável personalizada. Os valores possíveis são 1 para o nível de visitante, 2 para o nível de sessão e 3 para o nível de página.


_setSampleRate()

_setSampleRate(newRate)

Define a nova taxa de amostragem. Se seu website for particularmente grande e estiver sujeito a picos de tráfego intensos, defina a taxa de amostragem para assegurar o acompanhamento ininterrupto do relatório. A amostragem no Google Analytics é realizada de maneira uniforme para todos os visitantes únicos, de modo a manter a integridade das tendências e dos relatórios mesmo com a amostragem ativada, pois os visitantes únicos permanecem incluídos ou excluídos da amostra conforme definido no início da amostragem.

Você só precisa especificar esse método ao mesmo tempo que _setAccount() é chamado, normalmente uma vez por página ou aplicativo, em que o código de acompanhamento é inicializado. Tenha em mente que o valor da taxa de amostragem especificada permanecerá em vigor enquanto o objeto de acompanhamento persistir.

Snippet assíncrono (recomendado)

_gaq.push(['_setSampleRate', '2.5']);

parâmetros

String newRate Nova taxa de amostragem a ser definida. Forneça uma string numérica entre 0 e 100 (preciso de duas casas decimais).


_setSessionTimeout().

_setSessionTimeout(newTimeout)

Esse método não foi aprovado. Use _setSessionCookieTimeout(cookieTimeoutMillis).

Define o novo tempo limite da sessão em segundos. Por padrão, o tempo limite da sessão é definido como 30 minutos (1.800 segundos). O tempo limite da sessão é usado para calcular as visitas (consulte Como uma sessão é definida no Google Analytics). Se você quiser mudar a definição de uma "sessão" para suas necessidades específicas, transmita o número de segundos para definir um novo valor. Isso afetará os relatórios de visitas em cada seção em que o número de visitas é calculado e em que as visitas são usadas para calcular outros valores. Por exemplo, o número de visitas geralmente aumentará se você reduzir o tempo limite da sessão e diminuirá se o tempo limite da sessão for reduzido.

parameters

String newTimeout Novo tempo limite da sessão a ser definido em segundos.


_setSessionCookieTimeout()

_setSessionCookieTimeout(cookieTimeoutMillis)

Define o novo tempo limite do cookie da sessão em milissegundos. Por padrão, o tempo limite da sessão é de trinta minutos. O tempo limite da sessão é usado para registrar visitas, já que uma visita é encerrada após trinta minutos de inatividade do navegador ou após o navegador ser fechado. Caso deseje alterar a definição de uma "sessão" para que atenda a suas necessidades específicas, informe o número de milissegundos para definir um novo valor. Isso afetará os Relatórios de visitas de todas as seções onde o número de visitas é calculado e onde as visitas são usadas no cálculo de outros valores. Por exemplo, o número de visitas aumentará se você reduzir o tempo limite da sessão, e diminuirá se você aumentar esse tempo limite. Você pode alterar o limite de validade para zero a fim de indicar que o cookie deve ser excluído quando o navegador for fechado.

Snippet assíncrono (recomendado)

_gaq.push(['_setSessionCookieTimeout', 1800000]);


parâmetros

Number cookieTimeoutMillis Tempo limite da nova sessão em milissegundos ou zero para excluir o cookie quando o navegador for fechado.


_setSiteSpeedSampleRate()

_setSiteSpeedSampleRate(sampleRate)

Define um novo tamanho de conjunto de amostra para a coleta de dados de velocidade do site. Por padrão, uma amostra fixa de 1% dos visitantes do site compõem o pool de dados que origina as métricas da velocidade do site. Se você tem um número relativamente pequeno de visitantes diários no site, como 100.000 ou menos, ajuste a amostragem para uma taxa maior. Isso fornecerá mais granularidade para o tempo de carregamento da página e outras métricas de velocidade do site. Consulte Velocidade do site na Central de Ajuda para ver detalhes sobre os relatórios de velocidade do site.

O método _setSiteSpeedSampleRate() precisa ser chamado antes de _trackPageview() para ser eficaz.

O Google Analytics restringe os hits de coleta de velocidade do site de uma única propriedade a 1% dos usuários ou 10 mil hits por dia para garantir uma distribuição equitativa dos recursos do sistema relacionados a esse recurso.

Observação: recomendamos que os sites com mais de 1 milhão de hits por dia mantenham a seleção de exemplo como a taxa padrão de 1%. Ajustar o tamanho da amostra para um número maior não aumentará o tamanho da amostra.

Snippet assíncrono (recomendado)

_gaq.push(['_setSiteSpeedSampleRate', 5]);
_gaq.push(['_trackPageview']);

parâmetros

Number sampleRate Valor entre 0 e 100 para definir a porcentagem de visitantes do seu site que será analisada para fins de velocidade do site. Por exemplo, o valor 5 define a amostra de coleta de velocidade do site como 5%.


_setVisitorCookieTimeout()

_setVisitorCookieTimeout(cookieTimeoutMillis)

Define a expiração de cookies de visitante do Google Analytics (em milissegundos). Por padrão, o cookie do visitante está definido para expirar em dois anos. Se preferir, você pode mudar a data de validade do cookie do visitante usando esse método. É possível alterar o tempo limite de expiração para 0, indicando que esse cookie precisa ser excluído quando o navegador é fechado.

Snippet assíncrono (recomendado)

_gaq.push(['_setVisitorCookieTimeout', 63072000000]);

parâmetros

Number cookieTimeoutMillis Novo prazo de validade do cookie de visitante em milissegundos ou zero para excluir o cookie quando o navegador for fechado.


_setVar()

_setVar(newVal)

Esse método não foi aprovado. Em vez disso, use _setCustomVar().

Configura ou define um segmento de visitante personalizado com a string fornecida. Você pode usar esse valor para realizar segmentação adicional de usuário em seu website. Por exemplo, você pode ter uma página de login ou um formulário que aciona um valor com base na entrada de um visitante, como uma preferência escolhida pelo visitante ou uma opção de privacidade. Em seguida, essa variável é atualizada no cookie desse visitante. Quando implementado no seu site, e os dados forem coletados por meio desse método, o segmento recém-definido aparecerá nos relatórios Definidos pelo usuário da seção "Visitantes" dos relatórios do Google Analytics. Além disso, você pode acessar o segmento Valor definido pelo usuário no relatório "Detalhes do conteúdo" para ver qual porcentagem de visitantes de uma página pertence a um segmento específico definido por você.

parameters

String newVal Novo valor definido pelo usuário.


_trackPageLoadTime() (link em inglês)

_trackPageLoadTime()

Esse método foi descontinuado porque os relatórios de velocidade do site são ativados automaticamente para todos os usuários. Use _setSiteSpeedSampleRate() para ajustar a taxa de amostragem dos relatórios de velocidade do site.

Ativa os relatórios de velocidade do site para esta página. Insira esse método para cada página do site sobre a qual você quer gerar relatórios de velocidade. Para mais informações sobre os relatórios de velocidade do site no Google Analytics, consulte o artigo Velocidade do site na Central de Ajuda.

Como verificar as alterações

Se houver dados aparecendo nos relatórios, isso significa que a configuração está correta. Se você não vir dados após 24 horas, verifique sua personalização para ver se não cometeu erros. Consulte Solução de problemas do código de acompanhamento para ver uma lista de erros comuns do código de acompanhamento. Este guia de solução de problemas também contém etapas básicas de depuração e mais informações sobre depuração.

Ativar o acompanhamento de velocidade para seu site resulta em uma solicitação extra feita para os servidores do Google Analytics, diferente da solicitação GIF de acompanhamento de página feita para as visualizações de página. Para minimizar o impacto na latência geral do site, essa solicitação é enviada somente em uma amostragem de visualizações de página para seu site. Por essa razão, nem sempre será possível ver a solicitação GIF de velocidade do site ao tentar depurar esse recurso no Firebug ou em outras ferramentas. Isso é normal e esperado.

Snippet assíncrono (recomendado)

_gaq.push(['_setAccount', 'UA-12345-1']);
_gaq.push(['_trackPageview']);
_gaq.push(['_trackPageLoadTime']);

_trackPageview()

_trackPageview(opt_pagePath)

Lógica principal do GATC. Se as funcionalidades do vinculador estiverem ativadas, ela tentará extrair valores de cookie do URL. Caso contrário, ele tenta extrair valores de cookies de document.cookie. Ele também atualiza ou cria cookies conforme necessário e, em seguida, os grava novamente no objeto do documento. Coleta todas as métricas apropriadas para enviar ao front-end do UCFE (front-end do coletor do Urchin).

Snippet assíncrono (recomendado)

_gaq.push(['_setAccount', 'UA-12345-1']);
_gaq.push(['_trackPageview', '/home/landingPage']);

parâmetros

String opt_pagePath Parâmetro opcional que indica o caminho da página para acompanhar métricas. Ao usar essa opção, use uma barra inicial (/) para indicar o caminho da página.