Documentação

Todas as páginas

Conheça os dados comuns para tagueamento em todas as páginas

🚧

Nota

Integrações que utilizam chaordic_meta considerar a documentação antiga nas versões v5-full ou v7-reduzida

Comece tagueando as propriedades comuns a todas as páginas do ecommerce. São elas page (página que está sendo visitada), salesChannel (opcional, o canal de compras atual) e user (dados do cliente que está visitando-a).

1. Tipo da página (linxMeta.page)

Campo string contendo o tipo da página sendo visitada, os possíveis valores estão especificados na tabela abaixo.

Tipo da Página linxMeta.page
Home home
Categoria ou departamento (1° nível) category
Hotsite search
Navigates category
Subcategoria subcategory
Produto product
Carrinho cart
Checkout checkout
Confirmação de compra transaction
Busca search
Busca vazia emptysearch
Landing page landing_page
Perfil do cliente userprofile
Erro 404 not_found
Outras other

2. Sales Channel (linxMeta.salesChannel) (opcional)

Indica o canal de compras (sales channel) atual do usuário. Esse campo só deve ser preenchido se a loja utilizar canais de compra, em caso de dúvida, verifique com o gerente de projetos se há necessidade de preencher esse campo.

3. Informações do cliente (linxMeta.user)

A propriedade user deve ser omitida caso o cliente esteja deslogado. Os campos devem ser declarados conforme especificação abaixo:

id:
obrigatório
String

Identificador único do cliente.

Ex: 2481632
name:
obrigatório
String

Nome completo.

Ex: Ross Geller
email:
obrigatório
String

Email válido.

Ex: [email protected]
allowMailMarketing:
obrigatório
Boolean

Informa se o cliente autoriza recebimento de campanhas de email.

true | false
remote_url:
opcional
String

URL que disponibiliza ou sobrescreve todas as informações anteriores no formato JSON. Esse campo é descrito logo abaixo.

Ex: //www.nomedosite.com/user
birthday:
opcional
String

Data de nascimento no formato YYYY-MM-DD.

Ex: 1967-10-18
gender:
opcional
String

Gênero do cliente. Utilize M para masculino e F para feminino.

M | F
tags:
opcional
String

Informações eventuais em formato linear (não hierarquizado).

Ex: vip, high_clv
extra_info:
opcional
Object

Informações eventuais em formato hierarquizado.

Ex: esp_id: 2361842
auth_token:
opcional
String

Token de autenticação para recuperar a sessão de um cliente e adicionar produtos deixados anteriormente no carrinho.

Ex: 8a9dav313b0ha492p

Exemplo do linxMeta na home

window.linxMeta = {

  /* page info */
  "page": "home",
  
  /* sales channel (apenas se utilizar sales channel) */
  "salesChannel": "5",

  /* logged user info */
  "user": {
    "id": "2481632",
    "name": "Ross Geller",
    "email": "[email protected]",
    "allowMailMarketing": true
  }

}

Informações do cliente via acesso remoto

Se preferir, utilize um serviço que disponibilize os dados de cliente de forma remota. Este método é útil caso você prefira manter a estrutura do HTML sempre igual e também para corrigir mecanismos de cache existentes em muitos ecommerces.

Para usar um serviço remoto de acesso aos dados do cliente indique apenas a propriedade remoteUrl, tendo como valor a URL onde a informação do cliente poderá ser consultada pela Chaordic. Exemplo:

O serviço consultado (em nosso exemplo: //www.nomedosite.com/user) deverá retornar os mesmos dados do objeto user no formato JSON:

Finalizado o tagueamento das informações comuns a todas as páginas, passe a adicionar os dados específicos de cada página. Que tal começar pela Home? ➝

3.1. Informações adicionais do usuário (opcional)

As informações abaixo enriquecem a base de dados de usuário, mas não são obrigatórias.

Exemplo do linxMeta com informações adicionais

window.linxMeta = {

  /* page info */
  "page": "home",
  
  /* sales channel (APENAS se utilizar sales channel) */
  "salesChannel": "5",

  /* logged user info */
  "user": {
    "id": "2481632",
    "name": "Ross Geller",
    "email": "[email protected]",
    "allowMailMarketing": true,
    "language": "pt-BR", // opcional
    "birthday": "1967-10-18", // opcional
    "gender": "M", // opctional
    "tags": ["vip", "high_clv"], // opcional
    "extraInfo": {
    	"esp_id": "2361842" // opcional
    }
  }

}

4. Gerar eventos de visualização (opcional)

Após gerar o linxMeta de cada uma das páginas, uma função precisa ser disparada para gerar o evento de visualizações de página. Para fazer isso basta chamar a seguinte função:

window.linxImpulse.createEvent('linximpulse.navigation')

O meta precisa estar totalmente preenchido para que o evento possa ser enviado corretamente. Caso o objeto esteja esperando alguma informação, o disparo desse evento também deve aguardar e disparar somente após o preenchimento do meta.

Para as páginas de search e cart uma atenção redobrada, nessas páginas ocorrem algumas atualizações que precisam ser mapeadas e enviadas no meta, são elas:

Search: Filtro, ordenação, paginação;
Cart: Adição, Remoção ou alteração na quantidade de produtos;

Quando esse cenário ocorrer, é necessário informar no meta essa alteração, principalmente no que diz respeito aos itens da busca e do carrinho. Após mapear e preencher o linxMeta, não esqueça de gerar o evento com a função descrita acima!

Nota: Quando o site possuir comportamento do tipo SPA, este passo torna-se obrigatório ser implementado!