Busca do Recommendations com a API de entrega
As APIs do Adobe Target e do Adobe Target Recommendations podem ser usadas para fornecer respostas a páginas da Web, mas também podem ser usadas em experiências não baseadas em HTML, incluindo aplicativos, telas, consoles, emails, quiosques e outros dispositivos de exibição. Em outras palavras, quando as bibliotecas do Target e o JavaScript não podem ser usados, a API de entrega do Target ainda habilita o acesso à gama completa de funcionalidades do Target, para oferecer experiências personalizadas.
Para recuperar recomendações, envie uma chamada de POST da API de entrega do Adobe Target com as informações contextuais apropriadas, que podem incluir uma ID de usuário (para uso com recomendações específicas do perfil, como os itens visualizados recentemente pelo usuário), nome da mbox relevante, parâmetros da mbox, parâmetros do perfil ou outros atributos. A resposta incluirá entity.ids recomendado (e pode incluir outros dados de entidade) no formato JSON ou HTML, que pode então ser exibido no dispositivo.
A API de Entrega para o Adobe Target expõe todos os recursos existentes fornecidos por uma solicitação padrão do Target.
A API de entrega:
- Permite recuperar experiências ou ofertas para um local e um público-alvo de maneira RESTful.
- Não requer autenticação.
- Somente POSTs.
- Não processa cookies ou chamadas de redirecionamento.
- Não exige ou reconhece "funções de usuário". Ele simplesmente busca conteúdo ou relata eventos para os servidores do Target Edge.
Para usar a API de entrega para fornecer experiências do Target, incluindo recomendações, siga estas etapas:
- Crie uma atividade do Target (A/B, XT, AP ou Recommendations) usando o Criador baseado em formulário (não o Visual Experience Composer).
- Use a API de entrega para obter uma resposta para as solicitações geradas pela atividade do Target que você acabou de criar.
<!— P: Por que ambas as etapas são necessárias para isso? Se você tiver uma recomendação baseada em formulário definida para uma mbox, qual é o ponto/benefício de TAMBÉM ter a etapa da API de entrega na para recuperar resultados? Por que você não pode apenas ter o Rec baseado em formulário entregar os resultados no dispositivo de destino…? R: Veja o caso de uso abaixo… é quando você deseja "interceptar" os resultados pendentes para fazer mais coisas antes de exibir os resultados. Coisas como comparações em tempo real com níveis de inventário. —>
Criar uma recomendação usando o Experience Composer baseado em formulário
Para criar recomendações que podem ser usadas com a API de entrega, use o Criador baseado em formulário.
-
Primeiro, crie e salve um design baseado em JSON para usar em sua recomendação. Para obter informações de JSON de exemplo, além de informações de plano de fundo sobre como as respostas JSON podem ser retornadas ao configurar uma atividade baseada em formulário, consulte a documentação em Criação de Designs de Recomendação. Neste exemplo, o nome do design é Simple JSON.
-
No Target, navegue até Activities > Create Activity > Recommendations e selecione Form.
-
Selecione uma Propriedade e clique em Next.
-
Defina o local em que você deseja que os usuários recebam a resposta da recomendação. O exemplo abaixo usa um local denominado api_charter. Selecione seu design baseado em JSON, criado anteriormente, chamado JSON Simples.
-
Salve e ative a recomendação. Ele gerará resultados. Quando os resultados estiverem prontos, você poderá usar a API de Entrega para recuperá-los.
Usar a API de entrega
A sintaxe da API de Entrega é:
POST https://{{CLIENT_CODE}}.tt.omtrdc.net/rest/v1/delivery
-
Observe que o código de cliente é obrigatório. Lembrando que o código de cliente pode ser encontrado no Adobe Target navegando até Recommendations > Settings. Anote o valor de Código do cliente na seção Token de API do Recommendation.
-
Depois de ter o código de cliente, crie a chamada da API de entrega. O exemplo abaixo começa com a Web Batched Mboxes Delivery API Call fornecida na coleção Postman da API de entrega, fazendo modificações relevantes. Por exemplo:
-
os objetos browser e address foram removidos do Body, pois não são necessários para casos de uso que não sejam de HTML
-
api_charter está listado como o nome do local neste exemplo
-
entity.id está especificada, pois esta recomendação se baseia na Similaridade de Conteúdo, que requer que uma chave de item atual seja passada para o Target.
Lembre-se de configurar os parâmetros de consulta corretamente. Por exemplo, certifique-se de especificar{{CLIENT_CODE}}conforme necessário. <!— P: Na sintaxe de chamada atualizada, entity.id é listado como um profileParameter em vez de um mboxParameter como nas versões mais antigas. —> <!— P: Imagem antiga
-
-
Envie a solicitação. Isso é executado com base no local api_charter, que tem uma recomendação ativa em execução, definido com seu design JSON que gerará uma lista de entidades recomendadas.
-
Receba uma resposta com base no design JSON.
A resposta inclui a ID de chave, bem como as IDs de entidade das entidades recomendadas.
Usar a API de entrega com o Recommendations dessa maneira permite executar etapas adicionais antes de exibir recomendações para o visitante no dispositivo não HTML. Por exemplo, você pode obter a resposta da API de entrega para executar uma pesquisa adicional em tempo real dos detalhes do atributo da entidade (inventário, preço, classificação e assim por diante) de outro sistema (como um CMS, PIM ou plataforma de comércio eletrônico), antes de exibir os resultados finais.
Usando a abordagem descrita neste guia, você pode obter qualquer aplicativo para aproveitar a resposta do Target e fornecer recomendações personalizadas.
Exemplo de implementações
Os recursos a seguir fornecem exemplos de várias implementações não focadas em HTML. Lembre-se de que cada implementação será única, devido ao sistema e aos dispositivos envolvidos.
Gerenciamento da configuração do Recommendations com APIs
Na maioria das vezes, as recomendações são configuradas na interface do usuário do Adobe Target e, em seguida, usadas ou acessadas por meio das APIs do Target, por motivos como os mencionados nas seções acima. Essa coordenação UI-API é comum. No entanto, às vezes os usuários podem querer executar todas as ações por meio das APIs, tanto a configuração quanto o uso dos resultados. Embora seja muito menos comum, os usuários podem configurar, executar, e de forma absoluta, aproveitar os resultados das recomendações usando inteiramente as APIs.
Aprendemos em uma seção anterior a gerenciar entidades do Adobe Target Recommendations e entregá-las no lado do servidor. Da mesma forma, o Adobe Developer Console permite gerenciar critérios, promoções, coleções e modelos de design sem precisar fazer logon no Adobe Target. Uma lista completa de todas as APIs do Recommendations pode ser encontrada aqui, mas aqui está um resumo para referência.
Documentação de referência
Resumo e revisão
Parabéns! Ao concluir este guia, você aprendeu a: