Récupération des recommandations avec l’API de diffusion

Dernière mise à jour : 27 février 2025

Créé pour :

  • Développeur

Les API Adobe Target et Adobe Target Recommendations peuvent être utilisées pour fournir des réponses aux pages web, mais peuvent également être utilisées dans des expériences non basées sur HTML, notamment les applications, les écrans, les consoles, les e-mails, les kiosques et d’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 pour offrir des expériences personnalisées.

NOTE
Lorsque vous demandez du contenu contenant des recommandations réelles (produits ou éléments recommandés), utilisez l’API de diffusion Target.

Pour récupérer des recommandations, envoyez un appel POST de l’API de diffusion Adobe Target avec les informations contextuelles appropriées, qui peuvent inclure un identifiant utilisateur (à utiliser avec des recommandations spécifiques au profil, telles que les éléments récemment consultés de l’utilisateur), le nom de mbox approprié, les paramètres de mbox, les paramètres de profil ou d’autres attributs. La réponse inclut le paramètre entity.ids recommandé (et peut inclure d’autres données d’entité) au format JSON ou HTML, qui peut ensuite être affiché dans l’appareil.

L’API de diffusion pour Adobe Target expose toutes les fonctionnalités existantes fournies par une requête Target standard.

L’API de diffusion :

  • Permet de récupérer des expériences ou des offres pour un emplacement et une audience de manière RESTful.
  • Ne nécessite aucune authentification.
  • Uniquement les publications.
  • Ne traite pas les cookies ni les appels de redirection.
  • Ne nécessite pas ou ne reconnaît pas de « rôles utilisateur ». Il récupère simplement du contenu ou signale des événements aux serveurs Edge de Target.

Pour utiliser l’API de diffusion afin de diffuser des expériences Target (y compris des recommandations), procédez comme suit :

  1. 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).
  2. 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 vous avez défini une recommandation basée sur un formulaire pour une mbox, à quoi sert-il de faire en sorte que l’API de diffusion intervienne également pour récupérer les résultats ? Pourquoi ne pouvez-vous pas simplement laisser l’enregistrement basé sur les formulaires fournir les résultats dans l’appareil de destination…?? R : Voir le cas d’utilisation ci-dessous… c’est lorsque vous souhaitez « intercepter » les résultats en attente afin d’effectuer d’autres opérations avant d’afficher les résultats. Par exemple, des comparaisons en temps réel avec les niveaux d'inventaire. —>

Créer une recommandation à l’aide du compositeur d’expérience d’après les formulaires

Pour créer des recommandations à utiliser avec l’API de diffusion, utilisez le compositeur basé sur les formulaires.

  1. Tout d’abord, créez et enregistrez une conception basée sur JSON à utiliser dans votre recommandation. Pour obtenir un exemple JSON, ainsi que des informations générales sur la manière dont les réponses JSON peuvent être renvoyées lors de la configuration d’une activité basée sur des formulaires, consultez la documentation sur la Création de conceptions de recommandations. Dans cet exemple, la conception est nommée JSON simple.
    server-side-create-recs-json-design.png

  2. Dans Target, accédez à Activities > Create Activity > Recommendations, puis sélectionnez Form.

    server-side-create-recs.png

  3. Sélectionnez une propriété, puis cliquez sur Next.

  4. 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.
    server-side-create-recs-form.png

  5. 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

  1. Notez que le code client est obligatoire. Pour rappel, vous trouverez peut-être votre code client dans Adobe Target en accédant à Recommendations > Settings. Notez la valeur Code client dans la section Jeton API Recommendations.
    code-client.png

  2. Une fois que vous disposez de votre code client, créez votre appel API de diffusion. L’exemple ci-dessous commence par la Web Batched Mboxes Delivery API Call fournie dans la collection Postman de l’API de diffusion, qui permet d’apporter des modifications pertinentes. Par exemple :

    • les objets browser et address ont été supprimés de la Body, car ils ne sont pas nécessaires pour les cas d’utilisation non HTML

    • 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 la transmission d’une clé d’élément active à Target.

      server-side-Delivery-API-call.png
      N’oubliez pas de 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 versions plus anciennes. —> <!— Q : Ancienne image server-side-create-recs-post.png Ancien texte d’accompagnement : « Notez que cette recommandation est basée sur des produits Content Similary basés sur entity.id envoyés via mboxParameters. » —>
      code-client3

  3. Envoyez la demande. Cette opération s’exécute à l’emplacement api_charter, où s’exécute une recommandation active, définie avec votre conception JSON et qui génère une liste des entités recommandées.

  4. Recevez une réponse basée sur la conception JSON.
    server-side-create-recs-json-response2.png
    La réponse inclut l’identifiant de clé, ainsi que les identifiants d’entité des entités recommandées.

Ainsi, l’utilisation de l’API de diffusion avec Recommendations permet d’effectuer des étapes supplémentaires avant d’afficher les recommandations au visiteur sur un appareil non HTML. Par exemple, vous pouvez utiliser la réponse de l’API de diffusion pour effectuer une recherche en temps réel supplémentaire des détails des attributs de l’entité (inventaire, prix, évaluation, etc.) à partir d’un autre système (une plateforme CMS, PIM ou eCommerce, par exemple), avant d’afficher les résultats finaux.

En utilisant l’approche décrite dans ce guide, vous pouvez obtenir n’importe quelle application pour exploiter la réponse de Target et fournir des recommandations personnalisées.