API Recommendations - Adobe Marketing Cloud
publicité
Adobe© Digital Marketing Suite API Recommendations Contents API Recommendations............................................................................................3 API Téléchargement................................................................................................................3 API Algorithme personnalisé...................................................................................................4 Création d'un algorithme personnalisé.......................................................................................................4 Chargement de données de l'algorithme personnalisé..............................................................................4 Suppression d'un algorithme personnalisé................................................................................................5 API Gestion des entités...........................................................................................................6 Suppression d'entités individuelles............................................................................................................6 Suppression du catalogue d'entités...........................................................................................................7 Last updated 2/22/2012 API Recommendations API Recommendations 3 API Recommendations L'API Recommendations vous permet d'accéder, par programmation, aux données Recommendations et de personnaliser votre environnement Recommendations. Note: Test&Target prend uniquement en charge l'interface REST. L'interface SOAP n'est pas prise en charge. API Téléchargement L'API Téléchargement vous permet de télécharger des informations Recommendations dans un fichier .csv (valeurs séparées par des virgules), de sorte que vous puissiez les consulter hors ligne dans une feuille de calcul ou à l'aide d'un éditeur de texte. Note: L'API Téléchargement de Recommendations utilise une interface REST. Le fichier .csv comprend la liste de toutes les recommandations pour chaque clé de produit. Veuillez tenir compte des points suivants lors de l'utilisation de l'API Téléchargement de Recommendations : • Chaque téléchargement de Recommendations envoie l'ensemble des données Recommendations, et pas seulement les modifications (Deltas) apportées depuis le dernier téléchargement. • Le serveur d'algorithmes met à jour les recommandations toutes les deux à six heures. Les changements sont appliqués immédiatement aux résultats de téléchargement. • L'API Téléchargement est toujours disponible, sauf pendant les fenêtres de maintenance périodiques ; ces opérations sont planifiées tous les jeudis à partir de 20h00 (heure du Pacifique). Pour utiliser l'API Téléchargement de Recommendations, il vous suffit de créer l'URL de téléchargement. Par exemple : http://recommendations.omniture.com/rest?action=downloadRecommendations&id=43&clientKey=24be79b2-d631-4207-a435-c6d5dd11059a Paramètre action id Description (Obligatoire) Identifie le type d'action Recommendations à exécuter. Pour télécharger des données Recommendations, cette valeur est toujours définie sur downloadRecommendations. (Obligatoire) Identifiant Recommendations, visible en accédant à l'URL indiquée sur la page d'édition de l'API Recommendations (id=XXX). N'utilisez PAS la valeur groupId dans l'URL. clientKey (Obligatoire) Jeton API disponible sur la page des paramètres de Recommendations. Note: Les paramètres et valeurs sont sensibles à la casse. Si vous indiquez un id ou clientKey non valide, l'API Téléchargement renvoie une erreur : Client key or recommendation id invalid. API Recommendations 4 API Algorithme personnalisé L'API Algorithme personnalisé vous permet de créer un ou plusieurs algorithmes personnalisés et de fournir la liste des articles recommandés à afficher pour une clé spécifique. Note: L'API Téléchargement de Recommendations utilise une interface REST. La création d'algorithmes personnalisés s'adresse uniquement aux utilisateurs chevronnés. Pour utiliser l'API Algorithme personnalisé, vous devez accomplir les tâches ci-dessous dans l'ordre indiqué ; elles ne doivent toutefois pas être effectuées en même temps. Après avoir créé le nom de l'algorithme, vous pourrez charger des données chaque fois que nécessaire (par exemple, dans une planification pour que les informations soient toujours à jour), sans devoir recréer le nom de l'algorithme personnalisé. Création d'un algorithme personnalisé Avant de créer un algorithme personnalisé, vous devez créer son nom. Par exemple : https://recommendations.omniture.com/rest?action=algorithm.upload&client=clientCode&clientToken=51dafdf4-f825-4581-a7c0-8ce9db31bd31&algorithmName=myCustomAlgorithm Paramètre recommendations.omniture.com action client clientToken algorithmName Description (Obligatoire) Domaine de l'environnement Recommendations en cours d'utilisation. (Obligatoire) Identifie l'action Recommendations à exécuter. Pour créer un nom d'algorithme personnalisé, cette valeur est toujours définie sur algorithm.upload. (Obligatoire) Code client de Recommendations. (Obligatoire) Jeton client affiché sur la page des paramètres de Recommendations. (Obligatoire) Nom utilisé pour identifier l'algorithme personnalisé dans la liste déroulante de sélection des algorithmes lors de la création ou de la modification d'une recommandation. Utilisez ce nom lors du chargement des données de recommandation (voir Chargement de données de l'algorithme personnalisé). Le paramètre algorithmName peut contenir, au maximum, 250 caractères. Note: Les paramètres et valeurs sont sensibles à la casse. Le nouveau nom apparaît immédiatement sous la forme d'un type d'algorithme dans Recommendations. Chargement de données de l'algorithme personnalisé Après avoir créé un nom d'algorithme personnalisé (voir Création d'un algorithme personnalisé), chargez la liste des articles recommandés à afficher pour un élément de clé spécifique lors de l'utilisation de cet algorithme. Par exemple : https://recommendations.omniture.com=entity.recommendation.upload&client=<recommendations><recommendation><key>1</key><entityId>2</entityId><entityId>3</entityId><entityId>4</entityId></recommendation></recommendations> API Recommendations Paramètre recommendations.omniture.com action client clientToken algorithmName recommendations 5 Description (Obligatoire) Domaine de l'environnement Recommendations en cours d'utilisation. (Obligatoire) Identifie l'action Recommendations à exécuter. Pour envoyer un nom d'algorithme personnalisé, cette valeur est toujours définie sur entity.recommendation.upload. (Obligatoire) Code client de Recommendations. (Obligatoire) Jeton client affiché sur la page des paramètres de Recommendations. (Obligatoire) Nom d'algorithme personnalisé, tel qu'il a été défini précédemment (voir Création d'un algorithme personnalisé). (Obligatoire) Définition de recommandation XML. Par exemple : <recommendations> <recommendation> <key>1</key> <entityId>4</entityId> <entityId>2</entityId> <entityId>3</entityId> </recommendation> <recommendation> <key>2</key> <entityId>5</entityId> <entityId>3</entityId> <entityId>6</entityId> </recommendation> ... </recommendations> Le code XML doit inclure une balise <recommendation> distincte pour chaque clé, spécifiée par la balise <key>. Chaque balise <entityId> comprend un article recommandé pour la clé spécifiée. Note: Les paramètres et valeurs sont sensibles à la casse. Suppression d'un algorithme personnalisé L'API Algorithme personnalisé vous permet également de supprimer un algorithme personnalisé. Par exemple : https://recommendations.omniture.com/rest?action=algorithm.delete&client=clientCode&clientToken=51dafdf4-f825-4581-a7c0-8ce9db31bd31&algorithmName=myCustomAlgorithm Paramètre recommendations.omniture.com Description (Obligatoire) Domaine de l'environnement Recommendations en cours d'utilisation. API Recommendations 6 Paramètre Description action (Obligatoire) Identifie l'action Recommendations à exécuter. Pour supprimer un nom d'algorithme personnalisé, cette valeur est toujours définie sur algorithm.delete. client (Obligatoire) Code client de Recommendations. clientToken (Obligatoire) Jeton client affiché sur la page des paramètres de Recommendations. algorithmName (Obligatoire) Nom utilisé pour identifier l'algorithme personnalisé dans la liste déroulante de sélection des algorithmes lors de la création ou de la modification d'une recommandation. Note: Les paramètres et valeurs sont sensibles à la casse. API Gestion des entités L'API Gestion des entités vous permet de gérer le catalogue des entités Recommendations. Veuillez tenir compte des points suivants lors de l'utilisation de l'API Gestion des entités : • Aucun mécanisme d'annulation n'est disponible pour ces API. • Une fois la mémoire cache de Recommendations mise à jour, les entités supprimées ne sont plus disponibles dans aucune recommandation. • L'API Recommendations peut "réapprendre" les entités supprimées par le biais d'une requête mbox productPage ou d'un transfert de produit au format CSV. • Les valeurs et paramètres d'URL sont sensibles à la casse. L'API Gestion des entités vous permet d'effectuer les opérations suivantes : • Suppression d'entités individuelles • Suppression du catalogue d'entités Suppression d'entités individuelles L'API Gestion d'entités vous permet de supprimer toutes les informations relatives à une ou plusieurs entités. Par exemple : https://recommendations.omniture.com/rest?action=entity.delete&client=CLIENT_CODE&clientToken=76bde9de-74f7-434b-ad1a-6d2d4c1b42d9&entityIds=ENTITY_ID1,ENTITY_ID2 Paramètre action Description (Obligatoire) Identifie le type d'action Recommendations à exécuter. Pour supprimer une entité, cette valeur est toujours définie sur entity.delete. API Recommendations Paramètre client clientToken entityIds 7 Description (Obligatoire) Identifiant Recommendations, visible en accédant à l'URL indiquée sur la page d'édition de l'API Recommendations (id=XXX). N'utilisez PAS la valeur groupId dans l'URL. (Obligatoire) Jeton client visible sur la page des paramètres de Recommendations. (Obligatoire) Liste d'identifiants d'entités (séparés par des virgules) que vous souhaitez supprimer du catalogue d'entités. Note: Les paramètres et valeurs sont sensibles à la casse. Suppression du catalogue d'entités L'API Gestion des entités vous permet de supprimer l'intégralité du catalogue d'entités, y compris l'ensemble des entrées et des attributs, en une seule opération. Cela se révèle particulièrement utile en cas de modification du catalogue de produits (après Noël, par exemple) ou si des données de test ont été envoyées au cours de la phase de test ou de développement. Par exemple : https://recommendations.omniture.com/rest?action=entity.deleteAll&client=CLIENT_CODE&clientToken=76bde9de-74f7-434b-ad1a-6d2d4c1b42d9 Paramètre action client clientToken Description (Obligatoire) Identifie le type d'action Recommendations à exécuter. Pour supprimer une entité, cette valeur est toujours définie sur entity.delete. (Obligatoire) Identifiant Recommendations, visible en accédant à l'URL indiquée sur la page d'édition de l'API Recommendations (id=XXX). N'utilisez PAS la valeur groupId dans l'URL. (Obligatoire) Jeton client visible sur la page des paramètres de Recommendations. Note: Les paramètres et valeurs sont sensibles à la casse.
