Transmissão de parâmetros de usuário

Importante

Trabalhar com a API JavaScript exige conhecimentos de HTML e JavaScript. Se você não conhece essas linguagens, entre em contato com o desenvolvedor ou webmaster do seu site.

A maior parte dos dados de sessão é coletada automaticamente pela tag Yandex Metrica. Você pode complementá-los com dados próprios, transmitindo para isso parâmetros de sessão. No entanto, você talvez ache que as informações sobre os usuários em si são mais úteis que as estatísticas de sessão.

O Yandex Metrica permite que você envie dados personalizados, referidos como parâmetros de usuário. Para parâmetros de usuário, recomendamos a transmissão de características do usuário que não mudem de sessão para sessão e que não contenham dados pessoais, como o nome do usuário. Para mais informações sobre a diferença entre parâmetros de sessão e parâmetros de usuário, consulte Processamento e armazenamento de dados.

Caso queira que os parâmetros que você informou se reflitam nos relatórios, o Yandex Metrica deve vinculá-los aos usuários. Para isso, são usadas as seguintes IDs especiais: ID de cliente e ID de usuário. Os parâmetros são vinculados às sessões dos usuários que tiverem visitado o site nos 90 dias que precederam o envio dos dados para o Yandex Metrica.

Observação

Quando você transmite parâmetros de usuário especificando a ID de cliente e a ID de usuário, o número total de usuários nos relatórios do Yandex Metrica pode divergir do número de IDs informadas, devido à forma como a ID de usuário é vinculada à ID de cliente.

Os relatórios serão atualizados com as novas informações dentro de algumas horas. Para visualizar estatísticas, use o relatório Parâmetros de usuário. Você também pode usar esses dados para criar segmentos para listas de retargeting no Yandex Direct ou Yandex Audience (veja o exemplo).

Observação

Os parâmetros enviados para o Yandex Metrica são armazenados por dois anos, contados a partir do último upload. Ao fim do período de armazenamento, o relatório deixa de exibir os dados.

Quando transmitir a ID de cliente

Recomendamos usar a ID de cliente nos dados transmitidos caso não precise obter suas próprias IDs no relatório.

Quando transmitir a ID de usuário

Recomendamos usar a ID de usuário se, por exemplo, seu site já tiver um sistema de ID de usuários e você precise obter um relatório que utilize essas IDs.

Há várias maneiras possíveis de enviar parâmetros de usuário para o Yandex Metrica:

Informar dados durante uma sessão no site

Este método é útil quando o relatório está sendo gerado com base em dados recebidos enquanto o usuário está visualizando o site.

Os parâmetros de usuário são transmitidos para o Yandex Metrica através da API JavaScript. As informações enviadas usando esse método não podem ser deletadas do Yandex Metrica.

Para transmitir os parâmetros em qualquer outro momento, use o método userParams. Para transmitir parâmetros durante a inicialização da tag, especifique dados no parâmetro userParams. As informações são transmitidas como objeto JavaScript e processadas da seguinte forma.

O valor do campo é processado da seguinte forma, a depender do seu tipo:

  • objeto — Cria um novo ramo de árvore para cada chave de objeto e invoca o algoritmo recursivamente para cada valor.

  • string — Conta o número de vezes que cada valor da string ocorre.

  • número — Calcula o valor total e o médio de todos os números.

  • true, false ou null — Calcula o número de vezes que cada valor ocorre.

Os dados só serão vinculados à ID de cliente se o método userParams tiver sido convocado durante a sessão do usuário. Para obter estatísticas mais completas, aguarde até que um volume maior de dados tenha sido transmitido para o Yandex Metrica.

Exemplo

Vamos considerar uma loja online que possui dois tipos de clientes: “normais” e “VIP”. Os dados de status dos clientes estão armazenados no banco de dados do próprio site. Após logarem no site, os usuários passam a ver seus nomes de usuário em todas as páginas ao invés do link Fazer login. Se o usuário tiver status especial, isto será mostrado ao lado do nome: Maria/VIP. Junto com o status, você também pode transmitir a ID de usuário que está armazenada no seu banco de dados.

Para enviar dados para o Yandex Metrica, adicione código a todas as páginas do site que irão convocar o método userParams.

Para enviar dados sobre usuários com status especial, o código ficará assim:

ym(XXXXXX, 'userParams', {
    vip_status: true,
    child: 1,
    child_age: 13,
    UserID: 12345
});
ym(XXXXXX, 'init', {
    clickmap: true,
    webvisor: true,
    userParams: {
        vip_status: true,
        child: 1,
        child_age: 13,
        UserID: 12345
    }
});

Se informações sobre um usuário "normal" estiverem sendo transmitidas, o código ficará assim:

ym(XXXXXX, 'userParams', {
    vip_status: false,
    child: 1,
    child_age: 13,
    UserID: 12345
});
ym(XXXXXX, 'init', {
    clickmap: true,
    webvisor: true,
    userParams: {
        vip_status: false,
        child: 1,
        child_age: 13,
        UserID: 12345
    }
});

onde XXXXXX é o número do seu contador.

Se um cliente regular receber status VIP, o método userParams enviará os novos dados para o Yandex Metrica da próxima vez que ele logar no seu site. Esse novo status se aplicará a todo o histórico de sessões desse usuário, como se o cliente sempre tivesse sido VIP.

Transmissão de dados por arquivo CSV, a qualquer momento

Com este método, o Yandex Metrica recebe os dados coletados tanto durante a sessão no site quanto após o usuário sair do site.

Especificação para o formato CSV

Descrição do formato CSV

Nome do campo

Descrição

Exemplo

ID de cliente | ID de usuário

ID do usuário do site

P12345

chave

ID de usuário. No máximo, 1.000 por usuário

idade | client.age

valor

Valor da ID de usuário

40

Para enviar uma estrutura hierárquica de parâmetros, use o símbolo "." (ponto). Por exemplo, para transmitir diversos valores do campo key, especifique cliente.demografia.idade.

Número máximo de caracteres nos campos mostrados nos relatórios do Yandex Metrica:

  • chave — 255;
  • valor — 50.

Para passar informações com um parâmetro:

  1. Obtenha a ID de cliente usando o método getClientID.
  2. Gere um arquivo CSV especificando a ID de cliente (ClientID) e envie na interface do Yandex Metrica.
  1. Envie sua ID de usuário usando o método setUserID.
  2. Gere um arquivo CSV especificando a ID de usuário (UserID) e envie na interface do Yandex Metrica.

Trabalhando com um arquivo

A interface do Yandex Metrica permite fazer o upload de dados ou deletá-los. Você pode gerenciar o arquivo em Configurações (encontre a aba Fazer upload de dados e escolha Parâmetros de usuário).

Para enviar ao Yandex Metrica um arquivo CSV gerado:

  1. Clique em Fazer upload de dados.
  2. Na janela que aparece, selecione o tipo de arquivo, conforme o tipo de ID que você deseje transmitir (ID de usuário ou ID de cliente).
  3. Selecione o arquivo no seu computador e, se necessário, adicione comentários ao upload.
  4. Clique em Fazer upload de dados.

Exemplo de arquivo CSV para upload de dados

Para remover do serviço dados carregados anteriormente, ou partes deles, prepare um arquivo CSV. O arquivo deve conter apenas o campo key com os dados que você deseja remover. Em seguida, siga estas etapas:

  1. Clique em Deletar dados.

  2. Na janela que aparece, selecione o tipo de arquivo ao qual você deseja aplicar as alterações, conforme a ID (ID de usuário ou ID de cliente).

  3. Selecione o arquivo no seu computador e, se necessário, adicione comentários ao upload.

  4. Clique em Fazer upload de dados.

Exemplo de arquivo CSV para deleção de dados

Leva algum tempo para o serviço processar o arquivo. Encerrado o processamento, as informações enviadas estarão disponíveis no relatório Parâmetros de usuário. Você também pode usar esses dados para criar segmentos para listas de retargeting no Yandex Direct ou Yandex Audience (veja o exemplo).

Fale conosco

Escrever um e-mail

Observe, por gentileza, que nossa equipe de suporte jamais iniciará uma chamada com você. Se alguém ligar para você e se apresentar como a equipe de suporte do Yandex Metrica, não siga as instruções dessa pessoa.


ID exclusiva de usuário do site criada automaticamente pelo Yandex Metrica.

A ID de usuário definida pelo dono do site (por exemplo, quando o usuário do site faz login numa conta pessoal).

A ID de usuário definida pelo dono do site (por exemplo, quando o usuário do site faz login numa conta pessoal).

ID exclusiva de usuário do site criada automaticamente pelo Yandex Metrica.