Criar uma camada de dados

Uma camada de dados é uma estrutura do JavaScript no site que expõe os dados coletados pela implementação do Analytics, como nomes de página, detalhes do produto e IDs do pedido. O código do site grava na camada de dados e a implementação lê a partir dela para definir variáveis do Analytics. Como sua implementação não depende do HTML da página, você pode reprojetar seu site sem interromper a coleta de dados.

Pré-requisitos

Criar um documento de design de solução: é importante que sua organização se alinhe aos requisitos de rastreamento. Esteja preparado com um documento de design de solução antes de entrar em contato com as equipes de desenvolvimento em sua organização. Os dados exigidos pelo design da solução determinam o que a camada de dados contém.

Escolha uma especificação de camada de dados specifications

A Adobe recomenda a Adobe Client Data Layer (ACDL) para implementações novas ou reestruturadas. ACDL é uma biblioteca JavaScript de código aberto que fornece ao seu site uma maneira padrão de enviar dados e eventos para uma matriz global adobeDataLayer. Tags, o Web SDK e o AppMeasurement podem ler a partir delas, e os Componentes principais do Adobe Experience Manager podem preenchê-las automaticamente.

Sua organização pode usar outras especificações, como a CEDDL (Camada de Dados Digitais da Experiência do Cliente), que armazena dados em um objeto global digitalData ou em uma especificação personalizada. O mais importante é que sua organização se alinhe a uma especificação que atenda às suas necessidades.

A tabela a seguir compara o ACDL com camadas de dados baseadas em objetos, como o CEDDL:

Camada de Dados de Clientes Adobe (adobeDataLayer)
Camada de dados baseada em objetos, como CEDDL (digitalData)
Como o código do site grava dados
Objetos de push: adobeDataLayer.push({ page: { name: "Home" } })
Define propriedades: digitalData.page.pageInfo.pageName = "Home"
Como a implementação lê um valor
adobeDataLayer.getState("page.name") ou um elemento de dados estado calculado da camada de dados da extensão de marca da Camada de Dados do Cliente Adobe
digitalData.page.pageInfo.pageName ou um elemento de dados da Variável JavaScript da extensão de tag principal
Como a implementação sabe que os dados estão prontos
O código do site envia um evento por push, como { event: "page view" }, e sua implementação o escuta. Os ouvintes também são executados para eventos que foram enviados antes de serem adicionados.
Sua implementação deve ler o objeto depois que o código do site terminar de preenchê-lo, por exemplo, usando uma regra de Chamada direta.

Exemplo de camada de dados example

A ACDL não requer uma estrutura de dados específica. Projete a estrutura em torno do documento de design da solução e documente-a para todos que gravem ou leem na camada de dados. Os exemplos neste guia usam a seguinte estrutura.

Quando uma página é carregada, o código do site envia os dados da página e um evento de exibição de página:

window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({
  event: "page view",
  page: {
    name: "Home",
    section: "Products",
    url: "https://example.com/products",
    referrer: "https://example.com/"
  }
});

Quando um visitante conclui uma compra, o código do site envia os detalhes do pedido e um evento de compra:

window.adobeDataLayer.push({
  event: "purchase",
  transaction: { id: "ABC123" },
  products: [
    { name: "Example product", category: "Example category", quantity: 1, price: 25 }
  ]
});

A ACDL mescla cada push em um único objeto chamado estado calculado, que é lido pela implementação. Os objetos de evento informam a implementação quando lê-la. Consulte Dados e o estado calculado e Eventos.

Fluxo de trabalho workflow

A implementação do Adobe Analytics usando uma camada de dados geralmente segue estas etapas:

  1. Trabalhe com a equipe de desenvolvimento do site para implementar uma camada de dados: a equipe de desenvolvimento do site é responsável principalmente por garantir que a camada de dados contenha valores corretos. Consulte esta página com a equipe de desenvolvimento do site para garantir que as expectativas estejam alinhadas entre as equipes. Consulte Instalar a Camada de Dados de Clientes Adobe.
  2. Valide sua camada de dados usando um console do navegador: abra o console de desenvolvedor do navegador, o que você pode fazer na maioria dos navegadores com a chave F12. Execute adobeDataLayer.getState() para ver o estado calculado, ou adobeDataLayer.getState("page.name") para ver um único valor. Consulte Verificar a instalação.
  3. Conectar a camada de dados ao Adobe Analytics: essa etapa varia de acordo com o método de implementação de sua organização. Consulte Conectar a camada de dados ao Adobe Analytics.

Conectar a camada de dados ao Adobe Analytics connect

A tabela a seguir mostra como cada método de implementação lê a Camada de dados de clientes Adobe:

Método de implementação
Como ler a camada de dados
Mais informações
Extensão da tag do SDK da web
Acione regras com o evento push de camada de dados da extensão de Camada de Dados do Cliente Adobe. Mapeie os valores da camada de dados para campos XDM ou para o objeto data com a ação Atualizar variável do Web SDK e envie-os com a ação Enviar evento.
Enviar dados da Camada de Dados de Clientes Adobe com a Web SDK, mapeamento do campo de objeto XDM e mapeamento do campo de objeto de dados
Biblioteca JavaScript do Web SDK
Analise eventos de camada de dados com addEventListener() e defina campos XDM ou data a partir da camada de dados ao chamar sendEvent.
Enviar dados da Camada de Dados de Clientes Adobe com a Web SDK, mapeamento do campo de objeto XDM e mapeamento do campo de objeto de dados
Extensão do Analytics
Acione regras com o evento de push de camada de dados e crie elementos de dados de estado computado da camada de dados a partir da extensão de Camada de Dados de Clientes Adobe. Atribua os elementos de dados às variáveis do Analytics na ação Definir variáveis e envie os dados com a ação Enviar sinal.
Mapear objetos de camada de dados para elementos de dados e Mapear elementos de dados para variáveis do Analytics
AppMeasurement
Leia os valores com getState() depois que o ACDL for carregado e chame s.t().
Ler a camada de dados com o AppMeasurement

Ler a camada de dados com o AppMeasurement appmeasurement

A ACDL adiciona seu método getState() à matriz adobeDataLayer quando a biblioteca é carregada. Para verificar se a biblioteca foi carregada e se o estado calculado inclui os dados mais recentes, leia os valores dentro de um ouvinte de eventos:

window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push(function(dl) {
  dl.addEventListener("page view", function(event) {
    s.pageName = dl.getState("page.name");
    s.channel = dl.getState("page.section");
    s.t();
  });
});

O ouvinte é executado uma vez para cada evento page view, incluindo eventos que foram enviados por push antes de o ouvinte ser adicionado. As páginas de variáveis neste guia, como pageName, mostram como ler valores individuais com getState(). Use esses exemplos dentro de um ouvinte como este ou no editor de código personalizado de uma regra de extensão do Analytics que um evento de push de camada de dados aciona.

Se sua implementação enviar mais de uma ocorrência por página, como em um aplicativo de página única, use clearVars() para que os valores de uma ocorrência não persistam para a próxima.

Próximas etapas

recommendation-more-help
analytics-help-implement