Documentação Experience Platform Coleção de dados

Visão geral completa da coleta de dados

Última atualização: 4 de abril de 2025

Tópicos:
IDs De Compra

Criado para:

Desenvolvedor

A Adobe Experience Platform coleta e transfere seus dados para outros produtos da Adobe e destinos de terceiros. Para enviar dados do evento de seu aplicativo para o Experience Platform Edge Network, é importante entender essas tecnologias principais e como configurá-las para fornecer seus dados aos destinos de que você precisa, quando você precisar.

Este guia fornece um tutorial de alto nível sobre como enviar um evento pela Edge Network usando os recursos de coleta de dados da Experience Platform. Especificamente, o tutorial aborda as etapas de instalação e configuração da extensão de tag do Adobe Experience Platform Web SDK na interface da Coleção de dados (antiga Adobe Experience Platform Launch).

NOTE

Você também pode optar por instalar e configurar o SDK manualmente se não quiser usar tags, mas as etapas subjacentes ainda devem ser concluídas conforme descrito abaixo.

Todas as etapas que envolvem a interface da Coleção de dados também podem ser executadas na interface do Experience Platform.

Pré-requisitos

Este tutorial usa a interface da Coleção de dados para criar um esquema, configurar um fluxo de dados e instalar o Web SDK. Para executar essas ações na interface do usuário, você deve ter acesso a pelo menos uma propriedade da Web, juntamente com os direitos de propriedade a seguir:

Desenvolver
Gerenciar extensões

Consulte o manual sobre gerenciamento de permissões para coleta de dados para saber como conceder acesso a propriedades e direitos de propriedade.

Para usar os vários produtos de Coleção de dados mencionados neste guia, você também deve ter acesso aos fluxos de dados e a capacidade de criar e gerenciar esquemas. Se precisar de acesso a qualquer um desses recursos, entre em contato com a equipe de conta da Adobe para obter o acesso necessário. Observe que, se você não tiver comprado o Adobe Experience Platform, a Adobe fornecerá o acesso necessário para usar o SDK sem custo adicional.

Se você já tiver acesso ao Experience Platform, deverá garantir que todas as permissões nas seguintes categorias estejam habilitadas:

Modelagem de dados
Identidades

Consulte a visão geral da interface do controle de acesso para saber como conceder permissões para recursos do Experience Platform aos usuários.

Resumo do processo

O processo de configuração da coleta de dados para seu site pode ser resumido da seguinte maneira:

Crie um esquema para determinar como seus dados serão estruturados ao serem enviados para a Edge Network.
Crie uma sequência de dados para configurar para quais destinos você deseja que seus dados sejam enviados.
Instale e configure o Web SDK para enviar dados para a sequência de dados quando determinados eventos ocorrerem no site.

Depois de enviar dados para a Edge Network, você também poderá configurar o encaminhamento de eventos, se sua organização tiver uma licença para isso.

Criar um esquema

O Experience Data Model (XDM) é uma especificação de código aberto que fornece estruturas e definições comuns para dados na forma de esquemas. Em outras palavras, o XDM é uma maneira de estruturar e formatar seus dados de uma maneira que pode ser acionada pelo Edge Network e outros aplicativos da Adobe Experience Cloud.

A primeira etapa na configuração das operações de coleta de dados é criar um esquema XDM para representar seus dados. Em uma etapa posterior deste tutorial, você mapeará os dados que deseja enviar para a estrutura deste esquema.

NOTE

Os esquemas XDM são muito personalizáveis. Em vez de serem excessivamente prescritivas, as etapas descritas abaixo se concentram especificamente nos requisitos de esquema do Web SDK. Fora desses parâmetros, você pode definir a estrutura restante dos dados da maneira que desejar.

Na interface, selecione Esquemas na navegação à esquerda. Aqui, você pode ver uma lista de esquemas criados anteriormente que pertencem à sua organização. Para continuar, selecione Criar esquema e XDM ExperienceEvent no menu suspenso.

Espaço de trabalho de esquemas

Uma caixa de diálogo é exibida solicitando que você comece a adicionar grupos de campos ao esquema. Para enviar eventos usando o Web SDK, é necessário adicionar o grupo de campos AEP Web SDK ExperienceEvent Mixin. Este grupo de campos contém definições para atributos de dados que são coletados automaticamente pela biblioteca do Web SDK.

Use a barra de pesquisa para restringir a lista e ajudar a encontrar este grupo de campos mais facilmente. Depois de encontrá-lo, selecione-o na lista antes de selecionar Adicionar grupos de campos.

Espaço de trabalho de esquemas

A tela Esquema é exibida, mostrando uma estrutura de árvore do esquema XDM, incluindo os campos fornecidos pelo grupo de campos do Web SDK.

Estrutura de schema

Selecione o campo raiz na árvore para abrir as Propriedades do esquema no painel direito, onde você pode fornecer um nome e uma descrição opcional para o esquema.

Nomear o esquema

Para adicionar mais campos ao esquema, selecione Adicionar na seção Grupos de campos no painel esquerdo.

Adicionar grupos de campos

NOTE

Consulte o manual sobre adição de grupos de campos na documentação do XDM para obter etapas detalhadas sobre como pesquisar por diferentes grupos de campos para atender aos seus casos de uso.

A prática recomendada é adicionar campos somente para dados que você planeja enviar por meio da Edge Network. Depois de adicionar campos a um esquema e salvá-lo, somente alterações aditivas poderão ser feitas no esquema após isso. Consulte a seção sobre as regras de evolução do esquema para obter mais informações.

Depois de adicionar os campos necessários, selecione Salvar para salvar o esquema.

Salvar o esquema

Criar um fluxo de dados

Uma sequência de dados é uma configuração que informa à Edge Network para onde você deseja que seus dados sejam enviados. Especificamente, um fluxo de dados especifica para quais produtos da Experience Cloud você deseja enviar os dados e como você deseja que os dados sejam manipulados e armazenados em cada produto.

NOTE

Se você quiser usar o encaminhamento de eventos (supondo que sua organização esteja licenciada para a funcionalidade), será necessário habilitá-lo para uma sequência de dados da mesma forma que habilita os produtos da Adobe. Detalhes sobre este processo são abordados em uma seção posterior.

Selecione Datastreams na navegação à esquerda. Aqui, você pode selecionar uma sequência de dados existente na lista para editar, ou criar uma nova configuração selecionando Nova sequência de dados.

Datastreams

Os requisitos de configuração para uma sequência de dados dependem dos produtos e recursos para os quais você está enviando dados. Para obter informações detalhadas sobre as opções de configuração de cada produto, consulte a visão geral dos fluxos de dados.

Instalar e configurar o Web SDK

Depois de criar um esquema e um fluxo de dados, a próxima etapa é instalar e configurar o Experience Platform Web SDK para começar a enviar dados para a Edge Network.

NOTE

Esta seção usa a interface da Coleção de dados para configurar a extensão de tag do Web SDK, mas você também pode instalá-la e configurá-la usando código bruto. Consulte os seguintes guias para obter mais informações:

Observe também que mesmo que você deseje usar apenas o encaminhamento de eventos, ainda será necessário instalar e configurar o SDK conforme descrito antes de configurar o encaminhamento de eventos em uma etapa posterior.

O processo pode ser resumido da seguinte forma:

Instale o Adobe Experience Platform Web SDK em uma propriedade de marca para obter acesso a seus recursos.
Crie um elemento de dados Objeto XDM para mapear variáveis no seu site para a estrutura do esquema XDM criado anteriormente.
Crie uma regra para informar à SDK quando ela deve enviar dados para a Edge Network.
Crie e instale uma biblioteca para implementar a regra no seu site.

Instalar a SDK em uma propriedade de tag

Selecione Tags na navegação à esquerda para mostrar uma lista de propriedades de tags. Você pode escolher uma propriedade existente para editar, se desejar, ou pode selecionar Nova propriedade.

Propriedades

Se estiver criando uma nova propriedade, forneça um nome descritivo e defina a Plataforma como Web. Forneça o domínio completo para a propriedade da Web e selecione Salvar.

Criar propriedade

A página de visão geral da propriedade é exibida. Aqui, selecione Extensões na navegação à esquerda e Catálogo. Localize a listagem do Experience Platform Web SDK (opcionalmente, use a barra de pesquisa para restringir os resultados) e selecione Instalar.

Instalar o Web SDK

A página de configuração da SDK é exibida. A maioria dos valores obrigatórios é preenchida automaticamente com padrões que você pode alterar se desejar.

Configurar o Web SDK

No entanto, antes de instalar o SDK, você deve selecionar um fluxo de dados para que ele saiba para onde enviar seus dados. Em Datastreams, use o menu suspenso para selecionar a sequência de dados configurada em uma etapa anterior. Depois de definir a sequência de dados, selecione Salvar para concluir a instalação do SDK na propriedade.

Definir sequência de dados e salvar

Criar um elemento de dados XDM

Para que o SDK envie dados para o Edge Network, esses dados devem ser mapeados para o esquema XDM criado em uma etapa anterior. Esse mapeamento é realizado por meio do uso de um elemento de dados.

Na interface, selecione Elementos de Dados e Criar Novo Elemento de Dados.

Criar novo elemento de dados

Na próxima tela, selecione Adobe Experience Platform Web SDK na lista suspensa Extensão e selecione objeto XDM para o tipo de elemento de dados.

Tipo de objeto XDM

A caixa de diálogo de configuração é exibida para o tipo de objeto XDM. A caixa de diálogo seleciona automaticamente a sandbox da Experience Platform e, aqui, é possível ver todos os esquemas criados nessa sandbox. Selecione na lista o esquema XDM criado anteriormente.

Tipo de objeto XDM

A estrutura do schema é exibida. Todos os campos com um asterisco (*) indicam campos que serão preenchidos automaticamente quando os eventos forem acionados. Para todos os outros campos, é possível explorar a estrutura do esquema e preencher o restante dos dados.

Mapear dados para campos XDM

NOTE

A captura de tela acima demonstra como mapear uma variável globalmente acessível do lado do cliente do seu site (cartAbandonsTotal) para um campo XDM, referenciando seu nome no campo Valor, com sinais de porcentagem (%) de ambos os lados.

Você também pode usar outros elementos de dados criados anteriormente para preencher esses campos. Consulte a referência em elementos de dados na documentação das tags para obter mais informações.

Após concluir o mapeamento dos dados para o esquema, forneça um nome para o elemento de dados antes de selecionar Salvar.

Nomeie e salve o elemento de dados

Criar uma regra

Depois de salvar o elemento de dados, a próxima etapa é criar uma regra que o enviará para a Edge Network sempre que um determinado evento ocorrer em seu site (como quando um cliente adiciona um produto ao carrinho).

Você pode configurar regras para praticamente qualquer evento que possa ocorrer em seu site. Como exemplo, esta seção mostra como criar uma regra que será acionada quando um cliente enviar um formulário. O HTML a seguir representa uma página da Web simples com um formulário "Adicionar ao carrinho", que será o assunto da regra:

<!DOCTYPE html>
<html>
<body>

  <form id="add-to-cart-form">
    <label for="item">Product:</label><br>
    <input type="text" id="item" name="item"><br>
    <label for="amount">Amount:</label><br>
    <input type="number" id="amount" name="amount" value="1"><br><br>
    <input type="submit" value="Add to Cart">
  </form>

</body>
</html>

Na interface da Coleção de dados, selecione Regras na navegação à esquerda e Criar nova regra.

Regras

Na próxima tela, forneça um nome para a regra. A partir daqui, a próxima etapa é determinar o evento para a regra (em outras palavras, quando a regra será acionada). Selecione Adicionar em Eventos.

Regra de nome

A página de configuração do evento é exibida. Para configurar um evento, primeiro selecione o tipo de evento. Os tipos de evento são fornecidos por extensões. Para configurar um evento "envio de formulário", por exemplo, selecione a extensão Core e selecione o tipo de evento Enviar na categoria Formulário.

NOTE

Para obter mais informações sobre os diferentes tipos de eventos fornecidos pelas extensões da Web do Adobe, incluindo como configurá-los, consulte a referência das extensões da Adobe na documentação das tags.

O evento de envio de formulário permite usar um seletor de CSS para fazer referência a um elemento específico no qual a regra será acionada. No exemplo abaixo, a ID add-to-cart-form é usada para que essa regra seja acionada somente para o formulário "Adicionar ao carrinho". Selecione Manter alterações para adicionar o evento à regra.

Configuração de evento

A página de configuração da regra será exibida novamente, mostrando que o evento foi adicionado. Você pode restringir o "If" adicionando outras condições à regra.

Caso contrário, a próxima etapa é adicionar uma ação para a regra a ser executada ao ser acionada. Selecione Adicionar em Ações para continuar.

Adicionar ação

A página de configuração da ação é exibida. Para obter a regra para enviar dados à Edge Network, selecione Adobe Experience Platform Web SDK para a extensão e Enviar evento para o tipo de ação.

Tipo de ação

A tela é atualizada para mostrar opções adicionais para configurar a ação enviar evento. Em Tipo, você pode fornecer um valor de tipo personalizado para preencher o campo XDM eventType. Em Dados XDM, forneça o nome do tipo de dados XDM criado anteriormente (cercado por sinais de porcentagem) ou selecione o ícone do banco de dados ( ) para selecioná-lo em uma lista. Esses são os dados que serão enviados para a Edge Network.

Selecione Manter alterações quando terminar.

Configuração de ação

Depois de concluir a configuração da regra, selecione Salvar para concluir o processo.

Salvar regra

Criar e instalar uma biblioteca

Depois que a regra for configurada, você estará pronto para adicioná-la a uma biblioteca de tags, criar essa biblioteca em um ambiente e instalar essa build no site.

NOTE

Se você ainda não tiver configurado um ambiente na interface da Coleção de dados, é necessário fazer isso antes de criar um build. Consulte a seção sobre configuração de um ambiente para uma propriedade da Web na documentação das tags para obter mais informações.

Para saber como criar uma biblioteca, adicionar extensões e regras à biblioteca e criar essa biblioteca em um ambiente, consulte o manual sobre gerenciamento de bibliotecas na documentação de tags. Ao criar a biblioteca, inclua a extensão Experience Platform Web SDK e as regras de coleta de dados criadas anteriormente.

Depois de criar a biblioteca e a build for atribuída a um ambiente, você pode instalar esse ambiente no lado do cliente do site. Consulte a seção sobre instalação de ambientes para obter mais informações.

Depois de instalar o ambiente em seu site, você pode testar sua implementação usando o Adobe Experience Platform Debugger.

Configurar o encaminhamento de eventos (opcional)

NOTE

O encaminhamento de eventos só está disponível para organizações que tenham sido licenciadas para ele.

Depois de configurar o SDK para enviar dados ao Edge Network, você pode configurar o encaminhamento de eventos para informar ao Edge Network onde deseja que esses dados sejam entregues.

Para usar o encaminhamento de eventos, primeiro você deve criar uma propriedade de encaminhamento de eventos. Selecione Encaminhamento de eventos na navegação à esquerda e selecione Nova propriedade. Forneça um nome para a propriedade antes de selecionar Salvar.

Depois de criar uma propriedade de encaminhamento de eventos, a próxima etapa é criar uma regra que determine para onde os dados devem ser enviados. As regras para propriedades de encaminhamento de eventos são construídas de forma muito semelhante às propriedades de tags, com a exceção de que nenhum evento pode ser especificado (já que o encaminhamento de eventos lida apenas com eventos que recebe diretamente da sequência de dados). Para a ação da regra, é possível usar uma das extensões de encaminhamento de eventos disponíveis ou usar um código personalizado para entregar o evento.

Regra de encaminhamento de eventos

Semelhante a antes, após configurar a regra, é necessário adicioná-la a uma biblioteca e criar essa biblioteca em um ambiente.

Depois que a compilação for concluída, a etapa final é atualizar a sequência de dados que você configurou anteriormente e habilitar o encaminhamento de eventos. Para iniciar, navegue até Datastreams e selecione a sequência de dados em questão na lista. Aqui, ative a opção para encaminhamento de eventos e forneça os nomes da propriedade e do ambiente que você acabou de configurar.

Sequência de dados de encaminhamento de eventos

Próximas etapas

Este guia fornece uma visão geral completa de alto nível sobre como enviar dados para a Edge Network usando o Experience Platform Web SDK. Consulte a documentação vinculada a este guia para obter mais informações sobre os vários componentes e serviços envolvidos.

recommendation-more-help