API Recommendations - Adobe Marketing Cloud

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
API RecommendationsLast updated 2/22/2012

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
DescriptionParamètre
(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.
action
(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.
id
(Obligatoire) Jeton API disponible sur la page des paramètres de Recommendations.
clientKey
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.
3API Recommendations

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
DescriptionParamètre
(Obligatoire) Domaine de l'environnement Recommendations en cours d'utilisation.
recommendations.omniture.com
(Obligatoire) Identifie l'action Recommendations à exécuter. Pour créer un nom
d'algorithme personnalisé, cette valeur est toujours définie sur algorithm.upload.
action
(Obligatoire) Code client de Recommendations.
client
(Obligatoire) Jeton client affiché sur la page des paramètres de Recommendations.
clientToken
(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
algorithmName
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>
4API Recommendations

DescriptionParamètre
(Obligatoire) Domaine de l'environnement Recommendations en cours d'utilisation.
recommendations.omniture.com
(Obligatoire) Identifie l'action Recommendations à exécuter. Pour envoyer un nom
d'algorithme personnalisé, cette valeur est toujours définie sur
entity.recommendation.upload.
action
(Obligatoire) Code client de Recommendations.
client
(Obligatoire) Jeton client affiché sur la page des paramètres de Recommendations.
clientToken
(Obligatoire) Nom d'algorithme personnalisé, tel qu'il a été défini précédemment (voir
Création d'un algorithme personnalisé).
algorithmName
(Obligatoire) Définition de recommandation XML. Par exemple :
<recommendations>
<recommendation>
recommendations
<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
DescriptionParamètre
(Obligatoire) Domaine de l'environnement Recommendations en cours d'utilisation.
recommendations.omniture.com
5API Recommendations