Récupération de Recommendations avec l’API de diffusion
Les API Adobe Target et Adobe Target Recommendations peuvent être utilisées pour envoyer des réponses aux pages web, mais aussi dans les expériences non basées sur les HTMLS, notamment les applications, écrans, consoles, emails, kiosques et autres appareils d’affichage. En d’autres termes, lorsque les bibliothèques Target et JavaScript ne peuvent pas être utilisées, l’ API de diffusion Target permet toujours d’accéder à l’ensemble des fonctionnalités de Target, afin de fournir des expériences personnalisées.
Pour récupérer les recommandations, envoyez un appel du POST de l’API de diffusion Adobe Target avec les informations contextuelles appropriées, qui peuvent inclure un ID utilisateur (à utiliser avec des recommandations spécifiques au profil telles que les éléments récemment consultés par l’utilisateur), le nom de mbox approprié, les paramètres de mbox, les paramètres de profil ou d’autres attributs. La réponse comprend les entity.ids recommandés (et peut inclure d’autres données d’entité) au format JSON ou HTML, qui peuvent ensuite être affichés sur l’appareil.
L’ API de diffusion pour Adobe Target expose toutes les fonctionnalités existantes qu’une requête Target standard fournit.
L’API de diffusion :
- Permet de récupérer des expériences ou des offres pour un emplacement et une audience d’une manière RESTful.
- Ne nécessite aucune authentification.
- Publications uniquement.
- Ne traite pas les cookies ni les appels de redirection.
- Ne nécessite ni ne reconnaît les "rôles utilisateur". Il récupère simplement du contenu ou des événements de rapports sur les serveurs Target Edge.
Pour utiliser l’API de diffusion afin de diffuser des expériences Target, y compris des recommandations, procédez comme suit :
- Créez une activité Target (A/B, XT, AP ou Recommendations) à l’aide du compositeur d’après les formulaires (et non du compositeur d’expérience visuelle).
- Utilisez l’API de diffusion pour obtenir une réponse aux requêtes générées par l’activité Target que vous venez de créer.
<!— Q : Pourquoi les DEUX étapes sont-elles nécessaires pour cela ? Si une recommandation basée sur un formulaire est définie pour une mbox, quel est l’intérêt d’avoir ÉGALEMENT l’étape API de diffusion dans pour récupérer les résultats ? Pourquoi ne pouvez-vous pas simplement faire livrer les résultats par le Rec basé sur les formulaires sur l’appareil de destination…?? R : Voir le cas d’utilisation ci-dessous… c’est quand vous voulez "intercepter" les résultats en attente afin de faire plus avant d’afficher les résultats. Des éléments comme les comparaisons en temps réel aux niveaux d’inventaire. —>
Création d’une recommandation à l’aide du compositeur d’expérience d’après les formulaires
Pour créer des recommandations qui peuvent être utilisées avec l’API de diffusion, utilisez le compositeur d’après les formulaires.
-
Tout d’abord, créez et enregistrez une conception basée sur JSON à utiliser dans votre recommandation. Pour obtenir un exemple de code JSON, ainsi que des informations d’arrière-plan sur la manière dont les réponses JSON peuvent être renvoyées lors de la configuration d’une activité basée sur un formulaire, consultez la documentation sur la création de conceptions de recommandation. Dans cet exemple, la conception est nommée Simple JSON.
-
Dans Target, accédez à Activities > Create Activity > Recommendations, puis sélectionnez Form.
-
Sélectionnez une propriété, puis cliquez sur Next.
-
Définissez l’emplacement où vous souhaitez que les utilisateurs reçoivent la réponse de la recommandation. L’exemple ci-dessous utilise un emplacement nommé api_charter. Sélectionnez votre conception basée sur JSON, créée précédemment, nommée JSON simple.
-
Enregistrez et activez la recommandation. Cela produira des résultats. Une fois les résultats prêts, vous pouvez utiliser l’API de diffusion pour les récupérer.
Utilisation de l’API de diffusion
La syntaxe de l’ API de diffusion est la suivante :
POST https://{{CLIENT_CODE}}.tt.omtrdc.net/rest/v1/delivery
-
Notez que le code client est requis. Pour rappel, votre code client se trouve dans Adobe Target en accédant à Recommendations > Settings. Notez la valeur Client Code de la section Jeton API de recommandation .
-
Une fois que vous disposez de votre code client, créez votre appel API de diffusion. L’exemple ci-dessous commence par le Web Batched Mboxes Delivery API Call fourni dans la collection Postman de l’API de diffusion, qui apporte des modifications pertinentes. Par exemple :
-
les objets browser et address ont été supprimés du Body, puisqu’ils ne sont pas nécessaires pour les cas d’utilisation non-HTMLS.
-
api_charter est répertorié comme nom d’emplacement dans cet exemple
-
entity.id est spécifié, car cette recommandation est basée sur la similarité de contenu, qui nécessite qu’une clé d’élément actif soit transmise à Target.
Pensez à configurer correctement vos paramètres de requête. Par exemple, veillez à spécifier{{CLIENT_CODE}}si nécessaire. <!— Q : Dans la syntaxe d’appel mise à jour, entity.id est répertorié en tant que profileParameter au lieu d’un mboxParameter comme dans les anciennes versions. —> <!— Q : Ancienne image
-
-
Envoyez la requête. Cette opération s’exécute par rapport à l’emplacement api_charter sur lequel une recommandation active est exécutée, défini avec votre conception JSON qui génère une liste d’entités recommandées.
-
Recevez une réponse basée sur la conception JSON.
La réponse comprend l’identifiant de clé, ainsi que les identifiants d’entité des entités recommandées.
L’utilisation de l’API de diffusion avec Recommendations vous permet ainsi d’effectuer des étapes supplémentaires avant d’afficher des recommandations au visiteur sur un périphérique non HTML. Par exemple, vous pouvez utiliser la réponse de l’API de diffusion pour effectuer une recherche supplémentaire en temps réel des détails d’attribut d’entité (inventaire, prix, évaluation, etc.) à partir d’un autre système (tel qu’une plateforme CMS, PIM ou eCommerce), avant d’afficher les résultats finaux.
En utilisant l’approche décrite dans ce guide, vous pouvez demander à n’importe quelle application d’exploiter la réponse de Target pour fournir des recommandations personnalisées.
Exemple de mises en œuvre
Les ressources suivantes fournissent des exemples de différentes mises en oeuvre non axées sur l’HTML. Gardez à l’esprit que chaque mise en oeuvre sera unique en raison du système et des périphériques impliqués.
Gestion de la configuration de Recommendations avec les API
La plupart du temps, les recommandations sont configurées dans l’interface utilisateur d’Adobe Target, puis utilisées ou accessibles via les API de Target, pour des raisons telles que celles mentionnées dans les sections ci-dessus. Cette coordination entre l’interface utilisateur et l’API est courante. Cependant, il arrive parfois que les utilisateurs souhaitent effectuer toutes les actions via les API (configuration, ainsi que l’utilisation des résultats). Bien que beaucoup moins courant, les utilisateurs peuvent absolument configurer, exécuter, et exploiter les résultats de recommandations entièrement à l’aide des API.
Nous avons appris dans une section précédente comment gérer les entités Recommendations Adobe Target et les diffuser côté serveur. De même, le Adobe Developer Console vous permet de gérer les critères, les promotions, les collections et les modèles de conception sans avoir à vous connecter à Adobe Target. Une liste complète de toutes les API Recommendations se trouve ici, mais voici un résumé à titre de référence.
Documentation de référence
Résumé et révision
Félicitations ! En suivant ce guide, vous avez appris à :