A seguir estão as informações necessárias para implementar as APIs do Experience e começar a executar campanhas. É vital que você garanta uma implementação completa e correta antes de começar a executar campanhas de produção. Este guia presume que você esteja usando nosso DYID para se referir ao usuário que visita o website ou aplicativo. Se estiver planejando uma implementação exclusivamente por API com IDs de usuário gerados do seu lado, pule para esta seção.
Antes de começar:
- Se estiver planejando implementar o script da Dynamic Yield em seu website e ainda não tiver feito isso, faça-o primeiro e depois volte para este guia.
-
Certifique-se de que seu feed de produtos esteja funcionando perfeitamente.
Um feed de produtos é um arquivo que contém seu catálogo de produtos (todos os seus produtos, com metadados de produtos). Ele alimenta a personalização baseada em afinidades, recomendações de produtos, mensagens de prova social e muito mais.
Você pode criar e sincronizar seu feed de produtos no console do Experience OS ou usar APIs.
Passo 1: gere chaves de API
Crie chaves de API para o seu aplicativo.
Se quiser chamar a API diretamente do seu lado do cliente, use uma chave de API do lado do cliente ou, alternativamente, faça com que seu lado do servidor atue como um proxy para o cliente, de modo que produza todos os relatórios em nome dos clientes. Essa última opção envolve mais trabalho, mas na verdade é bem popular: funciona bem com a centralização dos relatórios das ações dos usuários para múltiplos sistemas downstream e com a ocultação de detalhes de implementação e chaves do cliente.
Passo 2: faça uma chamada Choose para obter variações de campanha
Todas as suas campanhas devem ter um nome de seletor de API que você usará em sua chamada da API Choose para obter a variação desejada.
A resposta incluirá os dados de produtos necessários para campanhas de recomendação ou variações para campanhas de código personalizado. Além disso, a Dynamic Yield enviará os atributos DecisionID ou SlotID (para campanhas de código personalizado ou de recomendações, respectivamente) que você, por sua vez, vai nos reportar na chamada da API Engagement se o usuário clicar em uma campanha.
Fazer chamadas Choose de forma assíncrona
Após a renderização inicial da página, você também pode solicitar de forma assíncrona qualquer campanha que possa ser exibida após a renderização da página (em particular, para elementos visuais abaixo da dobra). Nessas chamadas Choose, certifique-se de definir "options": { "isImplicitPageview": false } no corpo da solicitação.
Passo 3: adicione IDs de usuário e sessão às suas solicitações de API
Isso é feito através dos cookies da Dynamic Yield. Adicione cookies como dyid, _dyid_server, e dyjsession à sua chamada de API, de forma que a Dynamic Yield possa reconhecer o usuário.
Os cookies são escritos pela Dynamic Yield quando os scripts são carregados. Se você estiver enviando uma solicitação Choose para uma página em que os scripts não estejam em execução, e o usuário não tiver IDs de usuário e de sessão existentes provenientes de páginas anteriores, você deve nos enviar valores vazios para que geremos novos IDs de usuário e de sessão, que serão enviados de volta.
Observe que, se tiver habilitado o modo de consentimento ativo de cookies, você deve incluir o parâmetro active_consent_accepted. Para mais informações, consulte modo de consentimento ativo de cookies para gerenciamento de privacidade de dados do usuário.
Saiba mais sobre cookies da Dynamic Yield e como implementá-los.
Passo 4: relate eventos
Relate qualquer ação significativa realizada pelo usuário em seu website ou aplicativo. Isso normalmente inclui operações de carrinho e compra no comércio eletrônico, iniciar e enviar candidaturas em instituições financeiras, visualizações de vídeo no mundo das mídias e qualquer outro evento personalizado conforme suas necessidades. Use essas informações posteriormente para segmentação comportamental, relatórios e muito mais. Observe que, se você relatar somente eventos a partir do seu lado do servidor, será mais fácil evitar "ruído" gerado por robôs e afins.
Saiba mais sobre relatar eventos.
Passo 5: rastreie e relate o engajamento do usuário com variações
Como parte da execução de campanhas por API na página, você deve armazenar os identificadores únicos retornados na resposta da chamada Choose. Isso geralmente é feito no lado do cliente. Quando o usuário clicar em uma variação ou em um produto específico recomendado, você precisará passar esses identificadores de volta para nós.
- Para um clique em uma variação de código personalizado, ele seria o decisionId (e também o variationIds apenas no caso de campanhas de múltiplas variações, como controles deslizantes).
- No caso de um clique num item recomendado, seria o slotId.
Na web, é comum armazená-los como atributos de dados no elemento DOM que esteja renderizando a variação, por exemplo, <div id= ... data-dy-decision-id="d512ae8f">.
Configure listeners on-click em todas as variações renderizadas e relate os cliques para a Dynamic Yield usando os identificadores únicos fornecidos. Esse passo quase sempre é iniciado do lado do cliente, mas pode ser passado por proxy a partir do seu lado do servidor para nossa API para evitar lógica (ou chaves) demais nos clientes.
Saiba mais sobre relatar o engajamento dos usuários.
Implementação exclusivamente por API
Identificadores de usuário e sessão
Com a implementação exclusivamente por API, você precisa decidir quais identificadores de usuário e sessão usar. Esses identificadores já existem em seu aplicativo e podem ser reutilizados? Qual é o tempo de vida deles, e eles correspondem às suas expectativas?
Se não tiver certeza, veja nossas melhores práticas. O código de exemplo para gerenciar esses IDs também está disponível no tutorial da Petshop.
Relatar visualizações de página
No modo exclusivamente por API, você precisa relatar uma nova visualização de página para todas as páginas do seu website. Para latência mínima, isso geralmente é feito junto com a busca das variações da campanha por API escolhidas para a respectiva página, em um trajeto de ida e volta ao nosso terminal da API Choose.
Integre uma chamada Choose em todos os tipos de página em seu aplicativo com o contexto de página adequado, mesmo sem fazer referência a uma campanha neste momento.
Ativar o suporte de prévia
Embora não seja tecnicamente necessário, recomendamos fortemente que você também adicione o código para dar suporte à prévia de conteúdo direto a partir do console do Experience OS.