Extensão SDK da Adobe Experience Platform Web

A extensão AEP Web SDK envia dados para a Adobe Experience Cloud a partir de propriedades da Web, por meio da Adobe Experience Platform Edge Network. A extensão Adobe Experience Platform Web SDK permite o streaming de dados na plataforma, sincronização de identidades, aceitação e coleta automática de dados de contexto.

Configurar a extensão AEP Web SDK

Esta seção fornece uma referência para as opções disponíveis ao configurar a extensão do Adobe Experience Platform Web SDK.

Se a extensão do Adobe Experience Platform Web SDK ainda não estiver instalada, abra sua propriedade, selecione Extensions > Catalog, passe o mouse sobre a extensão do Adobe Experience Platform Web SDK e selecione Install.

Para configurar a extensão, abra a guia Extensions, passe o cursor do mouse sobre a extensão e selecione Configure.

Nome da instância

A extensão AEP Web SDK suporta várias instâncias na página. Isso é usado para enviar dados para várias organizações com uma única configuração do Adobe Experience Platform Launch. O padrão Name é ativado. No entanto, é possível alterar o nome da instância para qualquer nome de objeto JavaScript válido. A extensão Adobe Experience Platform exige que cada instância tenha uma Config ID diferente e outra Organization ID diferente.

Config ID

O Config ID é o que informa à Adobe Experience Platform para onde os dados devem ser roteados e quais configurações devem ser usadas no servidor. Isso é necessário para que a extensão Adobe Experience Platform funcione. Você pode obter uma ID de configuração entrando em contato com o Atendimento ao cliente.

Organization ID

A Organization ID é a organização para a qual você deseja que os dados da Adobe sejam enviados. Na maioria das vezes, você deve usar o valor padrão preenchido automaticamente. Quando houver várias instâncias na página, preencha com o valor da segunda organização para a qual deseja enviar dados.

Edge Domain

O domínio Edge Domain é do qual a extensão Adobe Experience Platform envia e recebe dados. A extensão requer o uso de um CNAME próprio para o tráfego de produção. O domínio padrão de terceiros funciona em ambientes de desenvolvimento, mas não é adequado para ambientes de produção. As instruções sobre como configurar um CNAME primário estão listadas aqui.

Enable Errors

Por padrão, se houver um erro com a extensão, ele será registrado no console. Se quiser ocultar os erros em um ambiente de produção, desmarque a caixa de seleção Enable Errors. Os erros ainda são impressos quando a depuração está ativada no Platform Launch.

Enable Opt-in

Se Enable Opt-in estiver ativado, a extensão AEP Web SDK pode conter ocorrências até que a aceitação seja recebida. A extensão expõe uma ação para definir as preferências de aceitação.

Enable Migrate ECID

A extensão AEP Web SDK usa um novo cookie para armazenar o ECID. Essa configuração permite a compatibilidade entre o novo cookie e o cookie antigo para fins de migração. A Adobe recomenda que isso esteja ativado, a menos que você não tenha visitantes com uma ECID.

Use 3rd Party Cookies

A Adobe Experience Platform sempre armazenará um cookie no domínio primário. Esta opção permite usar um cookie de terceiros definido em demdex.net, além do cookie no domínio primário. Isso pode ser útil quando você tem usuários que se movem entre vários domínios. Isso desativará as chamadas com demdex.net.

Context

A extensão coleta informações automaticamente sobre o contexto da solicitação (por exemplo, detalhes sobre o URL e o navegador). Isso pode ser desativado ao desmarcar contextos específicos.

  • web - Detalhes sobre a página da Web, como url, referenciador etc.
  • device - Detalhes sobre o dispositivo, como a orientação da tela, a altura da tela e a largura da tela.
  • environment - Informações sobre o ambiente de computação (navegador, conexão etc.)
  • location - Informações limitadas sobre a localização do usuário

Tipos de ação

Enviar evento

Envia um evento para a Adobe Experience Platform para que ela possa coletar os dados enviados e agir de acordo com essas informações. Você deve selecionar uma instância (se tiver mais de uma). Se o evento ocorrer no início de um carregamento de página ou durante uma mudança de exibição em um aplicativo de página única, selecione Occurs at the start of a view.

Todos os dados que deseja enviar podem ser enviados no campo XDM Data. Esse deve ser um objeto JSON que esteja em conformidade com a estrutura do esquema XDM. Esse objeto pode ser criado na sua página ou por meio de um Custom Code Data Element.

Definir consentimento

Depois de receber o consentimento do usuário, isso deve ser comunicado ao SDK da Web do AEP. Para fazer isso, use o tipo de ação "Definir consentimento". Atualmente, dois tipos de padrões são suportados: "Adobe" e "IAB TCF". Se estiver usando o padrão Adobe, você pode definir o consentimento como "Entrada", "Saída" ou pode fornecê-lo usando um elemento de dados. Se estiver usando o padrão TCF IAB, forneça a versão e o valor que você deseja usar, além de informações adicionais sobre o RGPD.

Nesta ação, você também recebe um campo opcional para incluir um Mapa de identidade, de modo que as identidades possam ser sincronizadas assim que o consentimento for recebido. Isso pode ser útil quando o consentimento é configurado como "Pendente", pois a chamada de consentimento provavelmente será a primeira chamada a ser acionada.

Redefinir ID de mesclagem de Eventos

Se você deseja redefinir sua ID de mesclagem de evento na página, é possível fazer isso com esta ação. Para redefinir sua ID, é necessário selecionar a ID de mesclagem que deseja redefinir e acionar a ação conforme necessário.

Tipos de elemento de dados

ID de mesclagem de eventos

Esse elemento de dados fornece uma ID de mesclagem de evento quando usado. Nenhuma configuração é necessária para este elemento de dados. O elemento de dados fornecido permanece o mesmo até que o visitante saia da página ou até que o tipo de ação "Redefinir ID de mesclagem de Evento" seja usado.

Mapa de identidade

O elemento de dados do mapa de identidade permite criar identidades a partir de outros elementos de dados ou outros valores especificados. Todas as identidades que você criar devem estar associadas a uma namespace correspondente. Esse elemento de dados fornece uma lista suspensa que mostra todas as namespaces padrão, bem como todas as que você criou.

Objeto XDM

Todos os dados enviados para o SDK da Web da Adobe Experience Platform devem estar no formato XDM. A formatação dos dados é mais fácil com o elemento de dados do objeto XDM. Quando você abrir esse elemento de dados pela primeira vez, selecione a caixa de proteção e o schema Adobe Experience Platform corretos. Depois de selecionar seu schema, você verá a estrutura do seu schema, que pode ser facilmente preenchida.

Observe que ao abrir determinados campos do seu schema, como web.webPageDetails.URL, alguns itens são coletados automaticamente. Embora vários itens sejam coletados automaticamente, você tem a opção de substituir qualquer item, se necessário. Todos os valores podem ser preenchidos manualmente ou usando outros elementos de dados.

OBSERVAÇÃO

Basta preencher as informações que você está interessado em coletar. Tudo o que não for preenchido será omitido quando os dados forem enviados para as soluções.

Nesta página