Variáveis personalizadas: acompanhamento na Web (ga.js)

As variáveis personalizadas são tags de par de nome-valor que podem ser inseridas no código de acompanhamento para refinar o acompanhamento do Google Analytics. Com as variáveis personalizadas, você pode definir mais segmentos para aplicar aos seus visitantes além dos já fornecidos pelo Google Analytics. Neste documento, descrevemos as variáveis personalizadas e como configurá-las.

Visão geral

Você aproveitará ao máximo as variáveis personalizadas se entender o modelo básico de interação do visitante usado no Google Analytics. Nesse modelo, o visitante interage com seu conteúdo durante um período, e o engajamento com seu site é dividido em uma hierarquia.

O diagrama ilustra esse modelo para um único visitante ao seu site, em que cada bloco representa o número de sessões e interações do usuário específico.

Cada nível neste modelo é definido da forma a seguir:

  • Visitante: o cliente que visita o site, como o navegador ou dispositivo móvel operado por uma pessoa.
  • Sessão: o período em que o visitante fica ativo no site.
  • Página: atividade em nome do usuário que envia uma solicitação de GIF aos servidores do Google Analytics. Isso normalmente é caracterizado por uma visualização de página, mas pode incluir:
    • uma exibição de página
    • um evento (por exemplo, clicar em um botão de filme)

Cada um desses três níveis de interação define um escopo específico de engajamento do visitante. Essa distinção é importante para as variáveis personalizadas porque cada uma é restrita a um escopo específico. Por exemplo, é possível saber o número de sessões em que os visitantes removeram um item do carrinho de compras. Nesse caso específico, defina a variável personalizada no nível da sessão. Assim, toda a sessão desse visitante será sinalizada como uma em que os itens foram removidos dos carrinhos on-line.

Voltar ao início

Como usar variáveis personalizadas

Como é possível configurar diversas variáveis personalizadas para rastrear a atividade do usuário no site, é mais comum criar os próprios utilitários de JavaScript para gerenciá-las. Seu script usará o método básico para criar uma variável personalizada da seguinte maneira:

_setCustomVar(index, name, value, opt_scope)

Esse método aceita quatro parâmetros:

  • index: o slot para a variável personalizada. Obrigatório. Esse é um número com valor que pode variar de 1 a 5, incluindo esses dois valores. Uma variável personalizada precisa ser colocada em apenas um slot e não será reutilizada em slots diferentes.
  • nome: o nome da variável personalizada. Obrigatório. Essa é uma string que identifica a variável personalizada e aparece no relatório Variáveis personalizadas de nível superior dos relatórios do Google Analytics.
  • value: o valor da variável personalizada. Obrigatório. Essa é uma string pareada com um nome. É possível parear diversos valores com um nome de variável personalizada. O valor aparece na lista de tabelas da IU para um nome de variável selecionado. Normalmente, você terá dois ou mais valores para um determinado nome. Por exemplo, é possível definir um nome de variável personalizada gender e fornecer male e female como dois valores possíveis.
  • opt_scope: o escopo da variável personalizada. Opcional. Conforme descrito acima, o escopo define o nível de engajamento do usuário com o site. É um número cujos valores possíveis são 1 (no nível do visitante), 2 (nível da sessão) ou 3 (nível da página). Quando indefinido, o escopo da variável personalizada assume como padrão a interação no nível da página.

O snippet de código a seguir ilustra como definir uma variável personalizada para acompanhar as visitas em que os usuários removeram itens do carrinho de compras. Aqui, o método _setCustomVar() é chamado pouco antes de um método _trackEvent(), para que seja entregue na solicitação GIF enviada pelo método _trackEvent(). Ele usa o nome Items Removed com o valor Yes para definir essa atividade dos usuários do site. Além disso, faria sentido definir também uma variável personalizada padrão para Items Removed e No. Dessa forma, você teria uma contagem de visitas em que os itens foram removidos dos carrinhos de compras e uma contagem de visitas que não incluíram a remoção de itens.

Snippet assíncrono (recomendado)

 _gaq.push(['_setCustomVar',
      1,                   // This custom var is set to slot #1.  Required parameter.
      'Items Removed',     // The name acts as a kind of category for the user activity.  Required parameter.
      'Yes',               // This value of the custom variable.  Required parameter.
      2                    // Sets the scope to session-level.  Optional parameter.
   ]);
 _gaq.push(['_trackEvent',
      'Shopping', // category of activity
      'Item Removal', // Action
   ]);

Depois de configurar as variáveis personalizadas, você pode usar o método _deleteCustomVar(index) para removê-las.

Voltar ao início

Casos de uso de exemplo

As variáveis personalizadas podem ser implementadas de várias maneiras diferentes, dependendo do modelo do seu site e das necessidades da empresa. Os exemplos exploram diferentes casos de uso, em que cada um ilustra um nível diferente de escopo:

Variáveis personalizadas no nível da página

Use variáveis personalizadas no nível da página para definir um conjunto de atividades no nível da página pelos usuários.

Por exemplo, suponha que você gerencie o site de um jornal on-line em que os visitantes visualizam muitos artigos diferentes. Embora seja fácil determinar os artigos mais famosos, agora você também pode usar variáveis personalizadas para determinar quais seções do jornal estão em alta. Isso é feito configurando uma variável personalizada no nível da página de cada artigo, em que a seção desse artigo é definida como uma variável personalizada. Por exemplo, você pode ter seções como Estilo de vida; estilo, Opinião e Empresa. É possível definir uma variável personalizada para rastrear todos os seus artigos por seção.

Snippet assíncrono (recomendado)

_gaq.push(['_setCustomVar',
      1,                   // This custom var is set to slot #1.  Required parameter.
      'Section',           // The top-level name for your online content categories.  Required parameter.
      'Life & Style',  // Sets the value of "Section" to "Life & Style" for this particular aricle.  Required parameter.
      3                    // Sets the scope to page-level.  Optional parameter.
   ]);

Vamos continuar com este exemplo e supor que você não queira apenas marcar a seção de um artigo específico, mas também a subseção. Por exemplo, a seção Life & Style para seu jornal também pode ter várias subseções, como Culinária e bebidas, Moda e Esportes. Assim, para um determinado artigo, você pode acompanhar a seção e a subseção. Você pode criar mais uma variável personalizada para acompanhar todos os seus artigos por subseção.

Snippet assíncrono (recomendado)

_gaq.push(['_setCustomVar',
          2,                   // This custom var is set to slot #2.  Required parameter.
          'Sub-Section',       // The 2nd-level name for your online content categories.  Required parameter.
          'Fashion',           // Sets the value of "Sub-section" to "Fashion" for this particular article.  Required parameter.
          3                    // Sets the scope to page-level.  Optional parameter.
         ]);

Neste exemplo, você define duas variáveis personalizadas simultâneas no nível da página para uma única página. Em qualquer página, é possível acompanhar até cinco variáveis personalizadas, cada uma com um slot separado. Isso significa que é possível atribuir três outras variáveis personalizadas nessa mesma página. Em todos os artigos do site, é possível configurar uma matriz de variáveis personalizadas no nível da página para acompanhá-las em várias seções e subseções. Para mais informações sobre como usar corretamente as variáveis personalizadas no nível da página, consulte Diretrizes de uso abaixo.

Voltar ao início

Variáveis personalizadas no nível da sessão

Use variáveis personalizadas no nível da sessão para distinguir experiências de visitantes diferentes em cada sessão.

Por exemplo, se o site oferece aos usuários a possibilidade de fazer login, você pode usar uma variável personalizada com escopo no nível da sessão para o status de login do usuário. Dessa forma, é possível segmentar as visitas por membros registrados e visitantes anônimos.

Snippet assíncrono (recomendado)

_gaq.push(['_setCustomVar',
      1,             // This custom var is set to slot #1.  Required parameter.
      'User Type',   // The name of the custom variable.  Required parameter.
      'Member',      // Sets the value of "User Type" to "Member" or "Visitor" depending on status.  Required parameter.
       2             // Sets the scope to session-level.  Optional parameter.
   ]);

Suponha que você queira rastrear o tipo de usuário e se uma tentativa de compra ocorreu para uma determinada sessão. Se presumirmos que todas as páginas oferecem ao usuário a capacidade de fazer login, queremos reservar o slot 1 para a variável personalizada Tipo de usuário e usar outro slot para a tentativa de compra:

Snippet assíncrono (recomendado)

_gaq.push(['_setCustomVar',
      2,                   // This custom var is set to slot #2.  Required parameter.
      'Shopping Attempts', // The name of the custom variable.  Required parameter.
      'Yes',               // The value of the custom variable.  Required parameter.
                           //  (you might set this value by default to No)
      2                    // Sets the scope to session-level.  Optional parameter.
   ]);

Voltar ao início

Variáveis personalizadas no nível do visitante

Use variáveis personalizadas no nível do visitante para distinguir categorias de visitantes em várias sessões.

Por exemplo, se o site oferece conteúdo premium a assinantes pagantes, você pode definir uma variável personalizada no nível da visita para analisar quais usuários estão pagando membros, em qual nível de pagamento e quais estão usando o nível de serviço sem custo financeiro para o site. Você provavelmente configuraria essa variável personalizada como uma função única, porque o valor persistiria durante a vida útil do cookie de visitante.

Snippet assíncrono (recomendado)

_gaq.push(['_setCustomVar',
      1,                // This custom var is set to slot #1.  Required parameter.
      'Member Type',    // The name of the custom variable.  Required parameter.
      'Premium',        // The value of the custom variable.  Required parameter.
                        //  (possible values might be Free, Bronze, Gold, and Platinum)
      1                 // Sets the scope to visitor-level.  Optional parameter.
 ]); 

Diretrizes de uso

Esta seção descreve as diferenças entre os diferentes tipos de variáveis personalizadas e como usá-las corretamente:

Tipos de variáveis personalizadas

A tabela abaixo define as principais características dos diferentes tipos de variável. Lembre-se de que existem determinadas restrições quando os mesmos slots são usados por variáveis diferentes.

O comprimento total combinado dos nomes e valores de variáveis personalizadas não pode exceder 128 caracteres.

Voltar ao início

  Duração Ao compartilhar um slot com outras variáveis Número permitido
Nível da página

Uma única visualização de página, evento ou chamada de transação.

A última variável no nível da página a ser chamada em uma página é a aplicada a ela.

Para qualquer propriedade da Web (coleção de páginas), muitas variáveis únicas no nível da página podem ser definidas, e os espaços podem ser reutilizados. Limitada somente pelo número de hits em uma determinada sessão.

Em qualquer página, você pode configurar até cinco variáveis personalizadas simultâneas.

Nível da sessão

A sessão atual do visitante.

A última variável no nível da sessão chamada é a usada nessa sessão.
Exemplo: se login=false para o slot 1 no início da sessão e login=true para o slot 1 posteriormente, a sessão será definida como true para login.

Modifica qualquer variável no nível da página definida anteriormente chamada na mesma sessão.
Exemplo: se o slot 1 for usado pela primeira vez para category=sports e depois para login=true para uma sessão, category=sports não será registrado para a sessão.

Para qualquer propriedade da Web, você pode criar quantas variáveis personalizadas distintas no nível da sessão forem definidas com um limite de par de chave-valor de 128 caracteres.

Você pode configurar até cinco variáveis no nível da sessão para qualquer sessão de usuário.

Nível do visitante

A sessão atual e todas as sessões futuras durante a vida-útil do cookie do visitante.

O último valor definido para um visitante será aplicado à sessão atual e às futuras.

Para qualquer propriedade da Web, você pode criar até cinco variáveis distintas no nível do visitante.

Voltar ao início

Tome cuidado ao combinar diferentes tipos de variáveis

Geralmente, não é recomendável combinar o mesmo slot de variável personalizada com tipos diferentes, porque isso pode levar a cálculos de métricas estranhos.

Se você usar diversas variáveis personalizadas no nível da página, da sessão e do visitante para sua propriedade da Web, será necessário determinar cuidadosamente a reutilização dos slots. Se surgir uma situação no seu site em que uma variável personalizada no nível da página ou da sessão usa o mesmo espaço ao mesmo tempo, uma variável no nível da página será definida, somente a variável no nível da sessão (ou no nível da página) vai ser registrada.

Os cenários a seguir ilustram uma combinação de variáveis no nível da página, da sessão e do visitante definidas por um único usuário no mesmo navegador. Em cada exemplo, o slot é indicado pelo número entre parênteses, e S: indica o escopo da variável.

Caso 1 - A última variável de nível de sessão prevalece

Aqui, a página final reutiliza uma variável personalizada no nível da sessão no slot 1 para que tenha precedência.

Visita 1 Página 1
(1) S:nível da página
section=opinion
Página 2
(1) S: nível da sessão
login=true
Página 3
(1) S: nível da sessão
converted=true

O relatório de visitas seria:

  • Número de visitas para a seção=editorial: 0
  • Número de visitas para login=true: 0
  • Número de visitas para convertido=true: 1

Caso 2 - A variável inicial de nível de visitante prevalece

Aqui, o espaço 1 é usado primeiro por uma variável personalizada no nível do visitante na visita 1 seguida por uma variável personalizada no nível da página na visita 3. Nessa ordem, a variável no nível do visitante não substitui a variável no nível da página.

Visita 1 Página 1
(1) S:nível do visitante
gender=male
Visita 2 Página 1
(2) S:nível da sessão
converted=false
Visita 3 Página 1
(1) S:nível da página
section=opinion

O relatório de visitas seria:

  • Número de visitas para sexo=masculino: 2
  • Número de visitas para convertido=false: 1
  • Número de visitas para a seção=opinião: 1
  • Não use nomes de chave duplicados nos slots.
  • Chame a função _setCustomVar() quando ela puder ser definida antes de uma solicitação de visualização de página ou GIF de evento.
    Em alguns casos, isso não será possível, e será necessário definir outra solicitação _trackPageview() depois de definir uma variável personalizada. Normalmente, isso é necessário apenas nas situações em que o usuário aciona uma variável personalizada no nível da sessão ou da visita, em que não é possível agrupar esse método com uma chamada de visualização de página, evento ou acompanhamento de e-commerce.
  • Use uma matriz de slot para rastrear um grande número de variáveis personalizadas.
    Se você tiver requisitos complexos de acompanhamento, em que há uma combinação de variáveis no nível da página e da sessão que podem ser combinadas, crie uma matriz de slot para garantir que as variáveis no nível da sessão não sobreponham acidentalmente variáveis no nível da página.
  • Considere usar o acompanhamento de eventos para determinados aplicativos, em vez de variáveis personalizadas.
    Por exemplo, suponha que você tenha uma loja de música on-line e queira rastrear as sessões de login, de tentativa de compra e as sessões em que as músicas foram tocadas. Seria interessante usar o acompanhamento de eventos para rastrear o número de tentativas de tocar músicas em vez de usar variáveis no nível da sessão para fazer isso. Aqui, você pode usar o parâmetro de quarto valor da chamada de acompanhamento de eventos para transmitir dados da sessão a partir dos seus próprios cookies.
  • Não use variáveis no nível da sessão para rastrear o comportamento que você pode acompanhar com variáveis no nível da página.
    Por exemplo, suponha que você acompanhe o status de login e o status da tentativa de compra por sessões. Seu site oferece uma página "quot;Members' especial" que você também quer acompanhar. Como uma variável personalizada no nível da página mostra o número de visitas a essa variável específica, você já terá disponível o número de visitas que incluíram essa página pelo menos uma vez.

Voltar ao início