DocumentaçãoCommerceData Connection extensão para Adobe Commerce

Conectar dados do Commerce ao Adobe Experience Platform

Last update: Mon Oct 07 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Administrador

Ao instalar a extensão Data Connection, duas novas páginas de configuração aparecem no menu Sistema em Serviços no Administrador do Commerce.

  • Commerce Services Connector
  • Data Connection

Para conectar sua instância do Adobe Commerce à Adobe Experience Platform, você deve configurar ambos os conectores, começando com o conector do Commerce Services e terminando com a extensão Data Connection.

Configurar o conector de serviços do Commerce

Se você tiver instalado anteriormente um serviço do Adobe Commerce, provavelmente já terá configurado o conector de Serviços do Commerce. Caso contrário, você deve concluir as seguintes tarefas na página Conector de serviços do Commerce:

  1. Faça logon em sua conta da Commerce para recuperar as chaves de API de produção e de sandbox.
  2. Selecione um espaço de dados SaaS.
  3. Faça logon na sua conta Adobe para recuperar a ID da organização.

Após configurar o conector de Serviços da Commerce, configure a extensão Data Connection.

Configurar a extensão Data Connection

Nesta seção, você aprenderá a configurar a extensão Data Connection.

Adicionar conta de serviço e detalhes da credencial

Se você planeja coletar e enviar dados históricos de pedido ou dados de perfil do cliente, é necessário adicionar a conta de serviço e os detalhes da credencial. Além disso, se você estiver configurando a extensão Audience Activation, conclua essas etapas.

Se você estiver coletando e enviando apenas dados da loja ou do back office, pule para a seção geral.

Etapa 1: criar um projeto no Adobe Developer Console

Crie um projeto na Adobe Developer Console que autentica o Commerce para que ele possa fazer chamadas de API de Experience Platform.

Para criar o projeto, siga as etapas descritas no tutorial Autenticar e acessar APIs de Experience Platform.

À medida que você avança pelo tutorial, certifique-se de que seu projeto tenha o seguinte:

O resultado dessa etapa cria um arquivo de configuração que você usa na próxima etapa.

Etapa 2: baixar arquivo de configuração

Baixe o arquivo de configuração do espaço de trabalho. Copie e cole o conteúdo desse arquivo na página Detalhes da Conta de Serviço/Credencial do Administrador do Commerce.

  1. No Administrador do Commerce, navegue até Lojas > Configurações > Configuração > Serviços > Data Connection.

  2. Selecione o método de autorização de servidor para servidor que você implementou no menu Tipo de Autorização do Adobe Developer. O Adobe recomenda usar o OAuth. O JWT foi descontinuado. Saiba mais.

  3. (Somente JWT) Copie e cole o conteúdo do seu arquivo private.key no campo Segredo do cliente. Use o comando a seguir para copiar o conteúdo.

    code language-bash 
    cat config/private.key | pbcopy

    Consulte Autenticação de Conta de Serviço (JWT) para obter mais informações sobre o arquivo private.key.

  4. Copie o conteúdo do arquivo <workspace-name>.json no campo Detalhes da Conta/Credencial de Serviço.

    Data Connection Configuração de administração {width="700" modal="regular"}

  5. Clique em Salvar configuração.

  6. Clique no botão Test connection para verificar se a conta de serviço e as informações de credencial inseridas estão corretas.

Geral

  1. No Admin, vá para Sistema > Serviços > Data Connection.

    Data Connection Configurações {width="700" modal="regular"}

  2. Na guia Configurações em Geral, verifique a ID associada à sua conta do Adobe Experience Platform, conforme configurado no Commerce Services Connector. A ID da organização é global. Somente uma ID de organização pode ser associada por instância do Adobe Commerce.

  3. No menu suspenso Escopo, defina o contexto como Site.

  4. (Opcional) Se você já tiver um AEP Web SDK (alloy) implantado em seu site, habilite a caixa de seleção e adicione o nome de seu AEP Web SDK. Caso contrário, deixe esses campos em branco e a extensão Data Connection implantará um para você.

    note note
    NOTE
    Se você especificar seu próprio SDK da Web da AEP, a extensão Data Connection usará a ID de sequência de dados associada a esse SDK e não a ID de sequência de dados especificada nessa página (se houver).

Coleta de dados

Nesta seção, você especifica o tipo de dados que deseja coletar e enviar para a borda do Experience Platform. Há três tipos de dados:

  • Comportamental (dados do lado do cliente) são dados capturados na loja. Isso inclui informações de interações do comprador, como View Page, View Product, Add to Cart e lista de requisições (para comerciantes B2B).

  • Back office (dados do lado do servidor) são dados capturados nos servidores do Commerce. Isso inclui informações sobre o status de um pedido, como se um pedido tivesse sido feito, cancelado, reembolsado, remetido ou concluído. Também inclui dados históricos de pedido.

  • Perfil são dados relacionados às informações de perfil do seu comprador. Saiba mais.

Para garantir que sua instância do Adobe Commerce possa iniciar a coleta de dados, verifique os pré-requisitos.

Consulte o tópico de eventos para saber mais sobre loja, back office e perfil eventos.

NOTE
Todos os campos na seção Coleção de dados se aplicam ao escopo do Site ou superior.

  1. Selecione Eventos de vitrine se desejar enviar dados comportamentais de vitrine.

  2. Selecione Eventos do back office se desejar enviar informações sobre o status do pedido, como se um pedido foi feito, cancelado, reembolsado ou remetido.

    note note
    NOTE
    Se você selecionar Eventos do back office, todos os dados do back office serão enviados para a borda do Experience Platform. Se um comprador optar por recusar a coleta de dados, você deverá definir explicitamente a preferência de privacidade do comprador no Experience Platform. Isso é diferente dos eventos da loja em que o coletor já lida com o consentimento com base nas preferências do comprador. Saiba mais sobre como definir a preferência de privacidade de um comprador no Experience Platform.

  3. (Ignore esta etapa se estiver usando seu próprio SDK da Web da AEP.) Crie uma sequência de dados na Adobe Experience Platform ou selecione uma sequência de dados existente que você deseja usar para a coleção. Insira essa ID de sequência de dados no campo ID de sequência de dados.

  4. Insira a ID do conjunto de dados que você deseja que contenha seus dados do Commerce. Para localizar a ID do conjunto de dados:

    1. Abra a interface do Experience Platform e selecione Conjuntos de dados no menu de navegação esquerdo para abrir o painel Conjuntos de dados. O painel lista todos os conjuntos de dados disponíveis para sua organização. Os detalhes são exibidos para cada conjunto de dados listado, incluindo o nome, o esquema ao qual o conjunto de dados pertence e o status da execução de assimilação mais recente.
    2. Abra o conjunto de dados associado à sua sequência de dados.
    3. No painel direito, exiba os detalhes sobre o conjunto de dados. Copie a ID do conjunto de dados.

  5. Para garantir atualizações de dados de eventos de back office com base em um agendamento de acordo com um trabalho cron, você deve alterar o índice Sales Orders Feed para Update by Schedule.

    1. Na barra lateral Admin, vá para System > Tools>Index Management.

    2. Marque a caixa de seleção do indexador Sales Orders Feed.

    3. Defina Actions como Update by Schedule.

    4. Se você estiver ativando os dados de back office pela primeira vez, execute os seguintes comandos para reindexar e acionar uma ressincronização. Ressincronizações subsequentes ocorrem automaticamente desde que o trabalho cron esteja configurado corretamente.

      code language-bash 
      bin/magento index:reindex sales_order_data_exporter_v2
      code language-bash 
      bin/magento saas:resync --feed orders

Descrições dos campos

Campo
Descrição
Escopo
Site específico no qual você deseja aplicar as configurações.
ID da organização (global)
ID que pertence à organização que adquiriu o produto Adobe DX. Essa ID vincula sua instância do Adobe Commerce ao Adobe Experience Platform.
O AEP Web SDK já foi implantado no site?
Marque essa caixa de seleção se você implantou seu próprio AEP Web SDK no site
Nome do SDK da Web da AEP (global)
Se você já tiver um SDK da Web do Experience Platform implantado em seu site, especifique o nome desse SDK neste campo. Isso permite que o Coletor de Eventos da Loja e o SDK de Eventos da Loja usem o SDK da Web do Experience Platform em vez da versão implantada pela extensão Data Connection. Se você não tiver um SDK da Web do Experience Platform implantado no site, deixe esse campo em branco e a extensão Data Connection implantará um para você.
Eventos da loja
É marcado por padrão, desde que a ID da organização e a ID do fluxo de dados sejam válidas. Os eventos da loja coletam dados comportamentais anônimos dos compradores enquanto eles navegam pelo site.
Eventos de back office
Se marcado, a carga do evento conterá informações anônimas sobre o status do pedido, como se um pedido tivesse sido feito, cancelado, reembolsado ou remetido.
ID da sequência de dados (site)
ID que permite que os dados fluam do Adobe Experience Platform para outros produtos Adobe DX. Essa ID deve ser associada a um site específico em sua instância específica do Adobe Commerce. Se você especificar seu próprio SDK da Web do Experience Platform, não especifique uma ID de fluxo de dados neste campo. A extensão Data Connection usa a ID de sequência de dados associada a esse SDK e ignora qualquer ID de sequência de dados especificada nesse campo (se houver).
ID do conjunto de dados (site)
ID do conjunto de dados que contém seus dados do Commerce. Este campo é obrigatório, a menos que você tenha desmarcado as caixas de seleção Eventos da vitrine ou Eventos do back office. Além disso, se você estiver usando seu próprio SDK da Web do Experience Platform e, portanto, não tiver especificado uma ID de sequência de dados, ainda será necessário adicionar a ID do conjunto de dados associada à sequência de dados. Caso contrário, você não poderá salvar este formulário.

Após a integração, os dados da loja começam a fluir para a borda do Experience Platform. Os dados de back office levam cerca de cinco minutos para serem exibidos na borda do. As atualizações subsequentes ficam visíveis na borda com base na programação do cron.

Enviar dados de perfil do cliente

Há dois tipos de dados de perfil que você pode enviar para o Experience Platform: registros de perfil e eventos de perfil de série temporal.

Um registro de perfil contém dados que são salvos quando um comprador cria um perfil na instância do Commerce, como o nome do comprador. Quando o esquema e o conjunto de dados estão configurados corretamente, um registro de perfil é enviado para o Experience Platform e encaminhado para o serviço de gerenciamento e segmentação de perfil do Adobe: Real-Time CDP.

Os eventos de perfil de série temporal contêm dados sobre as informações de perfil do comprador, como se ele criasse, editasse ou excluísse uma conta no site. Quando os dados do evento de perfil são enviados para o Experience Platform, eles ficam em um conjunto de dados onde podem ser usados por outros produtos DX.

  1. Verifique se você forneceu a conta de serviço e os detalhes da credencial.

  2. Verifique se você tem um esquema e um conjunto de dados especificados para assimilação de dados de registro de perfil e assimilação de dados de evento de perfil de série temporal.

  3. Marque a caixa de seleção Perfis de clientes se desejar enviar dados de perfil para o Experience Platform.

  4. Insira a ID do Conjunto de Dados de Perfil.

    Os dados do registro de perfil devem usar um conjunto de dados diferente do que você está usando atualmente para dados de evento comportamentais e de back office.

  5. Se você não quiser transmitir eventos de perfil por meio da mesma ID de sequência de dados que está usando para dados comportamentais e de back office, remova a marca de seleção de Transmitir perfis de clientes por meio da mesma ID de sequência de dados e insira a ID de sequência de dados que deseja usar.

Pode levar cerca de 10 minutos para que um registro de perfil fique disponível no Real-Time CDP. Os eventos de perfil começam a ser transmitidos imediatamente.

TIP
Se você não estiver vendo os dados do perfil no Experience Platform, consulte a Commerce KnowledgeBase para obter sugestões de solução de problemas.

Descrições dos campos

Campo
Descrição
Perfis de cliente
Marque essa caixa de seleção se desejar coletar e enviar registros de perfil do cliente.
ID do conjunto de dados do perfil
Um registro de perfil deve usar um conjunto de dados diferente do usado para eventos comportamentais e de back office.
Transmitir perfis de clientes por meio da mesma ID de sequência de dados
Decida se deseja usar o mesmo fluxo de dados usado atualmente para seus eventos comportamentais e de back office ou não.
Sequência de dados para perfis de clientes
Especifique a sequência de dados específica do registro de perfil do cliente.

Enviar dados históricos do pedido

A Adobe Commerce coleta até cinco anos de dados históricos e status de pedidos. Você pode usar a extensão Data Connection para enviar esses dados históricos ao Experience Platform para enriquecer os perfis do cliente e personalizar as experiências do cliente com base nesses pedidos anteriores. Os dados são armazenados em um conjunto de dados no Experience Platform.

Embora a Commerce já colete os dados históricos do pedido, há várias etapas que você deve concluir para enviar esses dados para o Experience Platform.

Assista a este vídeo para saber mais sobre pedidos históricos e, em seguida, conclua as etapas a seguir para implementar a coleção de pedidos históricos.

https://video.tv.adobe.com/v/3424672

Configurar o serviço de sincronização de pedidos

O serviço de sincronização de ordens usa a Estrutura da Fila de Mensagens e o RabbitMQ. Após concluir essas etapas, os dados do status do pedido podem ser sincronizados com o SaaS, que é necessário antes de ser enviado para o Experience Platform.

  1. Verifique se você forneceu a conta de serviço e os detalhes da credencial.

  2. Habilitar RabbitMQ.

    note note
    NOTE
    O RabbitMQ já está configurado para o Commerce versões 2.4.7 e mais recentes, mas você deve habilitar os consumidores.

  3. Habilite os consumidores da fila de mensagens pelo trabalho cron em .magento.env.yaml usando a variável de ambiente CRON_CONSUMERS_RUNNER.

    code language-yaml 
       stage:
     deploy:
       CRON_CONSUMERS_RUNNER:
         cron_run: true
    note note
    NOTE
    Consulte a documentação de variáveis de implantação para saber mais sobre todas as opções de configuração disponíveis.

Com o serviço de sincronização de pedidos habilitado, você pode especificar o intervalo de datas do pedido histórico na página Data Connection.

Especificar intervalo de datas do histórico da ordem

Especifique o intervalo de datas para as ordens históricas que você deseja enviar para o Experience Platform.

  1. No Admin, vá para Sistema > Serviços > Data Connection.

  2. Selecione a guia Histórico de pedidos.

    Data Connection Histórico de pedidos {width="700" modal="regular"}

  3. Em Sincronização do Histórico de Pedidos, a caixa de seleção Copiar ID do Conjunto de Dados das Configurações já está habilitada. Isso garante que você esteja usando o mesmo conjunto de dados especificado na guia Configurações.

  4. Nos campos De e Até, especifique o intervalo de datas para os dados históricos de ordem que você deseja enviar. Não é possível selecionar um intervalo de datas que exceda cinco anos.

  5. Selecione Start Sync para iniciar a sincronização. Os dados históricos de pedidos são dados em lote, e não dados de vitrine e back-office que estão transmitindo dados. Os dados em lote levam cerca de 45 minutos para chegar no Experience Platform.

Descrições dos campos
Campo
Descrição
Copiar ID do conjunto de dados das configurações
Copia a ID do conjunto de dados inserida na guia Configurações.
ID do conjunto de dados (site)
ID do conjunto de dados que contém seus dados do Commerce. Este campo é obrigatório, a menos que você tenha desmarcado as caixas de seleção Eventos da vitrine ou Eventos do back office. Além disso, se você estiver usando seu próprio SDK da Web do Experience Platform e, portanto, não tiver especificado uma ID de sequência de dados, ainda será necessário adicionar a ID do conjunto de dados associada à sequência de dados. Caso contrário, você não poderá salvar este formulário.
De
Data a partir da qual você deseja começar a coletar dados do histórico do pedido.
Para
Data a partir da qual você deseja terminar a coleta de dados do histórico da ordem.
Iniciar sincronização
Inicia o processo de sincronização dos dados do histórico do pedido com a borda do Experience Platform. Esse botão será desativado se o campo Dataset ID estiver em branco ou se a ID do conjunto de dados for inválida.

Personalização de dados

Na guia Personalização de Dados, você pode exibir todos os atributos personalizados configurados em Commerce e enviados para o Experience Platform.

Data Connection Personalização de dados {width="700" modal="regular"}

IMPORTANT
Verifique se a ID da sequência de dados que você especificou na guia Coleção de Dados corresponde à ID vinculada ao esquema para assimilar atributos personalizados.

Ao criar atributos personalizados para pedidos e enviá-los ao Experience Platform, os nomes dos atributos no Commerce devem corresponder àqueles no esquema Commerce no Experience Platform. Se não corresponderem, pode ser difícil identificar as diferenças. Se houver nomes incompatíveis, a tabela Atributos de Ordem Personalizada poderá ajudar a resolver o problema.

A tabela Atributos de Ordem Personalizados fornece visibilidade sobre a configuração e o mapeamento de atributos de ordem personalizados entre o back office Commerce e o esquema Commerce no Experience Platform. Essa tabela permite exibir atributos personalizados no nível do pedido e no nível do item do pedido em diferentes origens, facilitando a identificação de atributos ausentes ou desalinhados. Ele também exibe IDs de conjunto de dados para ajudar a diferenciar entre conjuntos de dados dinâmicos e históricos, pois cada um pode ter seus próprios atributos personalizados.

Se você não vir uma marca de seleção verde ao lado de um nome de atributo personalizado na tabela, isso indica uma incompatibilidade entre os nomes de atributo nas fontes. Corrija o nome do atributo em uma origem e uma marca de seleção verde será exibida, indicando que os nomes agora correspondem.

  • Se o nome do atributo for atualizado no esquema em Experience Platform, você deverá salvar a configuração na guia Personalização de dados para acionar a alteração no esquema Experience Platform. Esta alteração será refletida na tabela Atributos da Ordem Personalizada quando você clicar no botão Refresh.
  • Se o nome do atributo for atualizado em Commerce, um evento de ordem deverá ser gerado para atualizar o nome na tabela Atributos de Ordem Personalizados. A alteração será refletida em cerca de 60 minutos.

Saiba mais sobre como configurar atributos personalizados.

Descrições dos campos

Campo
Descrição
Conjunto de dados
Exibe os conjuntos de dados que contêm os atributos personalizados. Conjuntos de dados dinâmicos e históricos podem ter seus próprios atributos personalizados.
Adobe Commerce
Exibe todos os atributos personalizados criados no back office Commerce.
Experience Platform
Exibe todos os atributos personalizados especificados no esquema Commerce no Experience Platform.
Atualizar
Recupera nomes de atributos personalizados do esquema Commerce no Experience Platform.

Confirmar se os dados do evento foram coletados

Para confirmar se os dados estão sendo coletados do seu armazenamento do Commerce, use o Adobe Experience Platform debugger para examinar seu site do Commerce. Depois de confirmar que os dados estão sendo coletados, você pode verificar se os dados do evento da loja e do back office aparecem na borda executando uma consulta que retorna dados do conjunto de dados criado.

  1. Selecione Consultas na navegação à esquerda do Experience Platform e clique em Create Query.

    Editor de consultas

  2. Quando o Editor de consultas for aberto, insira uma consulta que selecione dados do conjunto de dados.

    Criar consulta

    Por exemplo, sua consulta pode ser semelhante ao seguinte:

    code language-sql 
    SELECT * from `your_dataset_name` ORDER by TIMESTAMP DESC

  3. Após a execução da consulta, os resultados serão exibidos na guia Resultados, ao lado da guia Console. Essa exibição mostra a saída em tabela da sua query.

    Editor de consultas

Neste exemplo, você vê os dados do evento de commerce.productListAdds, commerce.productViews, web.webpagedetails.pageViews e assim por diante. Essa visualização permite verificar se os dados do Commerce chegaram à borda.

Se os resultados não forem os esperados, abra o conjunto de dados e procure qualquer importação de lotes com falha. Saiba mais sobre solução de problemas de importações em lote.

Verifique se os dados do perfil aparecem no Experience Platform

Se você não estiver vendo os dados do perfil no Experience Platform, consulte a Commerce KnowledgeBase para obter sugestões de solução de problemas.

Próximas etapas

Quando os dados do Commerce são enviados para a borda do Experience Platform, outros produtos da Adobe Experience Cloud, como o Adobe Journey Optimizer, podem usar esses dados. Por exemplo, você pode configurar o Journey Optimizer para acompanhar determinados eventos e, com base nesses dados, acionar um email para um usuário pela primeira vez ou se houver um carrinho abandonado. Saiba como estender sua plataforma do Commerce criando jornadas para clientes no Journey Optimizer.

recommendation-more-help
6bf243c8-c8c6-4074-826f-546af445e840