Visão geral completa da coleta de dados

A Adobe Experience Platform coleta e transfere seus dados para outros produtos Adobe e destinos de terceiros. Para enviar dados do evento de seu aplicativo para a Rede de borda do Experience Platform, é 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 rede de borda usando os recursos de coleção de dados da Platform. Especificamente, o tutorial aborda as etapas de instalação e configuração da extensão de tag do SDK da Web da Adobe Experience Platform 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 usuário 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 SDK da Web. Para executar essas ações na interface do usuário, você deve ter acesso a pelo menos uma propriedade da Web, juntamente com o seguinte direitos de propriedade:

  • Desenvolver
  • Gerenciar extensões

Consulte o guia 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 do Adobe para obter o acesso necessário. Observe que, se você não tiver comprado o Adobe Experience Platform, o Adobe fornecerá o acesso necessário para usar o SDK sem custo adicional.

Se você já tiver acesso à Platform, deverá garantir que tenha a permissões nas seguintes categorias ativadas:

  • Modelagem de dados
  • Identidades

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

Resumo do processo

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

  1. Criar um esquema para determinar como seus dados serão estruturados ao serem enviados para a Rede de borda.
  2. Criar um fluxo de dados para configurar para quais destinos seus dados serão enviados.
  3. Instalar e configurar o SDK da Web para enviar dados para o fluxo de dados quando determinados eventos ocorrem em seu site.

Depois de enviar dados para a Rede de borda, você também pode, opcionalmente, configurar o encaminhamento de eventos se sua organização tiver uma licença para isso.

Criar um esquema schema

Experience Data Model (XDM) O é 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 pela Rede de borda 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 SDK da Web. Fora desses parâmetros, você pode definir a estrutura restante dos dados da maneira que desejar.

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

Workspace de esquemas

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

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.

Workspace de esquemas

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

Estrutura de schema

Selecione o campo raiz na árvore a ser aberto Propriedades do esquema no painel direito, onde é possível fornecer um nome e uma descrição opcional para o esquema.

Nomeie o esquema

Se quiser adicionar mais campos ao esquema, selecione Adicionar no Grupos de campos no painel esquerdo.

Adicionar grupos de campos

NOTE
Consulte o guia sobre adição de grupos de campos na documentação 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 pela Rede de borda. 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 o regras de evolução do schema 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 datastream

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

NOTE
Se quiser usar encaminhamento de eventos (supondo que sua organização esteja licenciada para a funcionalidade), você deve habilitá-la para um fluxo de dados da mesma forma que habilita os produtos Adobe. Os detalhes desse processo são abordados em uma seção posterior.

Selecionar Datastreams no painel de navegação esquerdo. Aqui, é possível selecionar um fluxo 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 visão geral dos fluxos de dados.

Instalar e configurar o SDK da Web install

Depois de criar um esquema e um fluxo de dados, a próxima etapa é instalar e configurar o SDK da Web da plataforma para começar a enviar dados para a Rede de borda.

NOTE
Esta seção usa a interface da Coleção de dados para configurar a extensão de tag do SDK da Web, 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 se você quiser 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 um etapa posterior.

O processo pode ser resumido da seguinte forma:

  1. Instalar o SDK da Web da Adobe Experience Platform em uma propriedade de tag para obter acesso às suas capacidades.
  2. Criar um elemento de dados Objeto XDM para mapear variáveis no seu site para a estrutura do esquema XDM criado anteriormente.
  3. Criar uma regra para informar ao SDK quando ele deve enviar dados para a Rede de borda.
  4. Criar e instalar uma biblioteca para implementar a regra no seu site.

Instalar o SDK em uma propriedade de tag install-sdk

Selecionar Tags na navegação à esquerda para mostrar uma lista de propriedades de tag. Você pode escolher uma propriedade existente para editar se desejar ou pode selecionar Nova propriedade em vez disso.

Propriedades

Se estiver criando uma nova propriedade, forneça um nome descritivo e defina o Platform para 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, selecione Catálogo. Encontre a lista do SDK da Web da Platform (opcionalmente, usando a barra de pesquisa para restringir resultados) e selecione Instalar.

Instalar o SDK da Web

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

Configurar o SDK da Web

No entanto, antes de instalar o SDK, é necessário selecionar uma sequência de dados para que ela saiba para onde enviar seus dados. Em Datastreams, use o menu suspenso para selecionar o fluxo de dados configurado em um etapa anterior. Depois de definir o fluxo 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 data-element

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

Na interface, selecione Elementos de dados e selecione Criar novo elemento de dados.

Criar novo elemento de dados

Na tela seguinte, selecione Adobe Experience Platform Web SDK no 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 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 acessível globalmente do lado do cliente do seu site (cartAbandonsTotal) para um campo XDM referenciando seu nome na variável Valor campo, rodeado por sinais de porcentagem (%).
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 de tags para obter mais informações.

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

Nomear e salvar 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 Rede de borda 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. A 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, selecione 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). Selecionar 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 o Núcleo e selecione a Enviar tipo de evento sob o Formulário categoria.

NOTE
Para obter mais informações sobre os diferentes tipos de evento fornecidos por extensões da Web do Adobe, incluindo como configurá-los, consulte a Referência de extensões do 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 para o acionamento da regra. No exemplo abaixo, a ID add-to-cart-form é usado para que essa regra seja acionada somente para o formulário "Adicionar ao carrinho". Selecionar Manter alterações para adicionar o evento à regra.

Configuração do evento

A página de configuração da regra será exibida novamente, mostrando que o evento foi adicionado. Você pode restringir o "Se" 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. Selecionar Adicionar em Ações para continuar.

Adicionar ação

A página de configuração da ação é exibida. Para que a regra envie dados para a Rede de borda, 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 eventType Campo XDM. Em Dados XDM, forneça o nome do tipo de dados XDM criado anteriormente (com sinais de porcentagem entre eles) ou selecione o ícone do banco de dados ( Ícone do banco de dados ) para selecioná-lo em uma lista. Esses são os dados que serão enviados para a Rede de borda.

Selecionar Manter alterações quando terminar.

Configuração de ação

Quando terminar de configurar a regra, selecione Salvar para concluir o processo.

Salvar regra

Criar e instalar uma biblioteca library

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 de 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 guia no gerenciamento de bibliotecas na documentação das tags. Ao criar a biblioteca, inclua a extensão SDK da Web da plataforma e as regras de coleção 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 a implementação usando o Adobe Experience Platform Debugger.

Configurar o encaminhamento de eventos (opcional) event-forwarding

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 para a Rede de borda, você pode configurar o encaminhamento de eventos para informar à Rede de borda onde deseja que esses dados sejam entregues.

Para usar o encaminhamento de eventos, primeiro você deve criar uma propriedade de encaminhamento de eventos. Selecionar Encaminhamento de evento na navegação à esquerda, 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.

Após a conclusão da build, a etapa final é atualizar o fluxo de dados que você configurado anteriormente e ativar o encaminhamento de eventos. Para iniciar, navegue até Datastreams e selecione o fluxo 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 do encaminhamento de eventos

Próximas etapas

Este guia forneceu uma visão geral completa e de alto nível sobre como enviar dados para a Rede de borda usando o SDK da Web da Platform. 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
1ae86b30-e55e-49c1-ab11-9d0356a5f3e1