Jetons d'attribution

Cette page explique comment utiliser les jetons d'attribution pour améliorer les performances au fil du temps.

Les jetons d'attribution sont des ID uniques générés par Retail et renvoyés avec chaque requête de prédiction ou de recherche. Ils permettent à Retail d'associer les actions des utilisateurs et les résultats entre eux, et d'entraîner des modèles de reclassement afin d'améliorer la qualité des résultats.

L'inclusion de jetons d'attribution dans vos événements utilisateur est facultative. Si vous ne fournissez pas de jetons d'attribution, Retail se rapproche des jetons d'attribution en alignant les résultats dans la réponse de prédiction ou de recherche, et les événements utilisateur ingérés en fonction de l'ID de visiteur et des horodatages.

Fonctionnement des jetons d'attribution

Chaque réponse renvoyée par la méthode predict ou search inclut un attributionToken unique dans le corps de la réponse. Exemple :

{
  "results": [{"id": "352"}, {"id": "456"}],
  "attribution_token": "abc123"
}

Lorsque votre site Web affiche un produit basé sur un résultat de l'API Retail, vous devez renvoyer le jeton d'attribution de ce résultat lorsque l'utilisateur interagit avec un produit renvoyé (par exemple, une vue ou un clic add-to-cart). Cette boucle de rétroaction permet au secteur du commerce de fournir des informations sur l'impact de vos résultats sur votre entreprise.

Comment renvoyer le jeton d'attribution

Renvoyez le jeton d'attribution en l'incluant dans l'événement utilisateur que vous enregistrez pour toute action effectuée par l'utilisateur avec un produit associé un résultat de recommandation ou de recherche. Les actions qu'un utilisateur peut effectuer avec ce produit dépendent de la conception de votre site Web. Les actions courantes incluent l'ajout du produit à une liste de favoris, l'accès à une vue détaillée, l'ajout à un panier ou l'achat en un clic.

Pour renvoyer le jeton d'attribution, vous devez d'abord l'associer au produit tel qu'il s'affiche dans le panneau de recommandations ou dans les résultats de recherche sur votre site Web. Un moyen courant d'effectuer cette opération consiste à ajouter le jeton à toutes les URL associées aux actions pouvant être effectuées dans le panneau des recommandations ou les résultats de recherche. Exemple :

https://www.example.com/54321/?rtoken=abc123

Lorsque l'utilisateur interagit avec ce produit dans le panneau de recommandations ou les résultats de recherche (ce qui génère un événement utilisateur), le jeton d'attribution peut être analysé à partir de l'URL et inséré dans l'événement utilisateur que vous envoyez à Retail pour cette interaction.

Par exemple, supposons que vous demandiez une prédiction associée à l'affichage d'un produit pour un utilisateur. Retail affiche un ensemble d'ID de catalogue recommandés avec leurs jetons d'attribution associés.

{
  "results": [{"id": "352"}, {"id": "456"}],
  "attribution_token": "abc123"
}

Votre site Web affiche les articles recommandés dans un panneau de recommandations et inclut le jeton d'attribution renvoyé pour la prédiction avec chaque URL du panneau de recommandations. Votre site doit être configuré pour enregistrer cet événement à envoyer à Retail. Pour obtenir un exemple d'objet d'événement utilisateur, consultez Rechercher un événement utilisateur. Lorsque l'utilisateur clique sur l'un des produits d'un résultat pour afficher une vue plus détaillée, incluez le jeton d'attribution avec l'événement utilisateur que vous enregistrez pour ce clic. L'événement utilisateur doit ressembler à l'exemple suivant:

{
  "eventType" : "detail-page-view",
  "visitorId": "visitor1",
  "userInfo": {
    "userId": "user1"
   },
   "attributionToken": "abc123",
   "productDetails": [{
     "product": {
        "id": "abc"
       }
     }]
}

Lorsque l'utilisateur interagit avec un produit affiché en raison d'une recommandation ou d'un résultat de recherche, et que vous incluez le jeton d'attribution avec l'événement utilisateur correspondant à cette interaction, Retail utilise cette information pour l'évaluation.

Par exemple, supposons que l'utilisateur voit un produit inclus dans un résultat de recherche, puis qu'il utilise ce résultat pour ajouter le produit à sa liste de souhaits et pour obtenir une vue détaillée du produit. Vous devez inclure le jeton d'attribution pour les deux événements utilisateur générés à partir du résultat de recherche (add-to-cart et detail-page-view).

Supposons maintenant que le même utilisateur ajoute ce produit à son panier depuis la vue détaillée. Vous n'avez pas besoin d'inclure le jeton d'attribution avec cette action, car elle a été obtenue à partir de la vue détaillée, et non du résultat de recherche. De même, si cet utilisateur achète finalement le produit, mais pas directement depuis le résultat de recherche, le fait de renvoyer un jeton d'attribution avec l'événement d'achat ne présente aucun avantage.