Visão geral da Camada de dados de clientes Adobe

A Camada de Dados de Clientes Adobe (ACDL) é uma pequena biblioteca JavaScript de código aberto que oferece ao seu site uma maneira padrão de expor dados e eventos a qualquer script na página. O código do site envia dados e eventos para uma matriz JavaScript chamada adobeDataLayer. As regras de tag, o Web SDK e outros scripts leem esses dados e escutam esses eventos, independentemente de quando o script ACDL é carregado.

Este guia documenta a biblioteca ACDL. Para usar o ACDL na interface da Coleção de Dados, consulte a extensão de marca da Camada de Dados do Cliente Adobe.

Por que usar uma camada de dados why

Sem uma camada de dados, as tags geralmente arranham valores da página, como texto no DOM ou parâmetros no URL. Essas implementações são interrompidas quando o design da página é alterado e só é possível coletar o que a página exibe. Uma camada de dados separa duas responsabilidades:

  • O código do site descreve o que acontece na página, como o nome da página, o produto que um visitante visualizou ou o formulário enviado.
  • As marcas e outros scripts decidem o que fazer com essas informações, como quais dados enviar à Adobe e quando.

A ACDL adiciona os seguintes recursos a esse padrão:

  • Carregamento assíncrono. O código do site pode enviar dados antes que o script ACDL seja carregado. O ACDL processa tudo em ordem ao carregar, para que você possa carregá-lo com async ou defer sem perder dados.
  • Eventos e ouvintes. Os scripts podem acompanhar eventos nomeados ou alterações de dados, incluindo eventos que ocorreram antes da adição do ouvinte.
  • Estado calculado. A ACDL mescla cada push de dados em um único objeto que qualquer script pode ler a qualquer momento.
  • Histórico. A matriz mantém um registro dos dados e eventos que foram enviados, o que ajuda a depurar a implementação.

Como funciona how-it-works

O ACDL é construído com base em um array JavaScript simples:

  1. Sua página cria a matriz window.adobeDataLayer se ela ainda não existir.
  2. O código do site adiciona itens à matriz com push(). Um item pode ser um objeto de dados, de evento ou uma função. Antes de carregar a ACDL, esses itens aguardam no array como uma fila.
  3. Quando o script ACDL é carregado, ele adiciona métodos à matriz, como getState() e addEventListener(), e substitui push() por sua própria versão. Em seguida, ele processa cada item na fila, na ordem em que foi enviado.
  4. A partir de então, o ACDL processa cada novo item assim que é enviado. Ele mescla dados no estado computado, faz chamadas correspondentes aos ouvintes de eventos e mantém dados e objetos de eventos na matriz como histórico.
// Site code: describe what happened on the page
window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({
  page: { title: "Home", language: "en" }
});
window.adobeDataLayer.push({ event: "page view" });

// Another script: react to what happened
window.adobeDataLayer.push(function(dl) {
  dl.addEventListener("page view", function(event) {
    console.log("Page title:", dl.getState("page.title"));
  });
});

Como o ouvinte usa o all escopo padrão, ele é executado para o evento page view mesmo que esse evento tenha sido enviado primeiro.

O ACDL armazena e distribui dados na página. Ele não envia dados em nenhum lugar. Para enviar dados para a Adobe, use tags ou a SDK da Web para ler a partir da camada de dados. Consulte Enviar dados da Camada de Dados de Clientes Adobe com a Web SDK.

Como o ACDL funciona com outras ferramentas do Adobe adobe-tools

Ferramenta
Relação com a ACDL
Tags
A extensão de marca ACDL pode carregar a biblioteca, disparar regras quando dados ou eventos forem enviados por push, ler o estado calculado em elementos de dados e enviar dados ou limpar o histórico em ações de regras.
Web SDK
O Web SDK envia dados à Edge Network. Seu código ou suas regras de tag leem dados da ACDL e os transmitem para o Web SDK. Consulte Enviar dados da Camada de Dados de Clientes Adobe com a Web SDK.
Adobe Experience Manager
Os Componentes principais 2.9.0 e posteriores incluem o ACDL e podem enviar dados e eventos de componentes para ele automaticamente. Consulte Uso da Camada de Dados de Clientes Adobe com os Componentes Principais.

Formato dos dados data-format

A ACDL não requer uma estrutura de dados específica. Você pode enviar qualquer objeto simples, e o ACDL o mescla no estado calculado. Como muitos scripts e equipes dependem dos mesmos dados, considere as seguintes práticas:

  • Concorde com uma estrutura antes de gravar na camada de dados e documentá-la para todos os que enviam dados ou os leem.
  • Usar valores compatíveis com JSON, como cadeias de caracteres, números, booleanos, objetos simples e matrizes. Outros valores, como Date objetos e funções, não sobrevivem à mesclagem. Consulte Tipos de valor.
  • Considere seu destino. Se você enviar os dados para a Adobe Experience Platform, poderá estruturá-los de forma a se assemelharem ao seu esquema XDM, facilitando o mapeamento, ou manter sua própria estrutura e mapeá-la na sequência de dados com o Preparo de Dados para Coleção de Dados.

Requisitos do navegador browser-requirements

O ACDL 3.x usa a função structuredClone() do navegador e a sintaxe moderna do JavaScript. Ela requer um dos seguintes navegadores ou posterior:

  • Chrome 98
  • Edge 98
  • Firefox 94
  • Safari 15.4

O ACDL 2.x tem requisitos mais baixos de navegador. Consulte Atualizar de 2.x para 3.x para ver as diferenças entre as versões.

Versões e código-fonte source

O ACDL é de código aberto sob a licença do Apache 2.0.

Para verificar qual versão está sendo executada em uma página, leia a propriedade version no console do navegador:

adobeDataLayer.version

Próximas etapas next-steps

recommendation-more-help
experience-platform-help-collection