Documentation Guide du développeur de Target

Gestion de votre catalogue Recommendations à l’aide d’API

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

Développeur

Tout en vous assurant que vous remplissez les exigences pour utiliser l’API Recommendations, vous avez appris à générer un jeton d’accès à l’aide du flux d’authentification JWT pour utiliser les API d’administration Adobe Target sur le Adobe Developer Console.

Vous pouvez désormais utiliser les API Recommendations pour ajouter, mettre à jour ou supprimer des éléments dans votre catalogue de recommandations. Comme pour le reste des API d’administration Adobe Target, les API Recommendations nécessitent une authentification.

NOTE

Envoyez la requête IMS: JWT Generate + Auth via User Token chaque fois que vous devez actualiser votre jeton d’accès pour authentification, puisqu’il expire après 24 heures. Voir Configuration de l’authentification de l’API d’Adobepour obtenir des instructions.

JWT3ff

Avant de poursuivre, obtenez la collection Postman Recommendations.

Création et mise à jour d’éléments à l’aide de l’API Enregistrer les entités

Pour renseigner votre base de données de produits Recommendations à l’aide de l’API plutôt que d’un flux de produits CSV ou de demandes Target se déclenchant sur les pages de produits, utilisez l’ API Enregistrer les entités. Cette requête ajoute ou met à jour un élément dans un seul environnement Target. La syntaxe est la suivante :

POST https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities

Par exemple, les entités de sauvegarde peuvent être utilisées pour mettre à jour des éléments chaque fois que certains seuils sont atteints (seuils d’inventaire ou de prix, par exemple) afin de les marquer et de les empêcher d’être recommandés.

Accédez à Target > Setup > Hosts > CONTROL Environments pour obtenir l’identifiant de l’environnement cible dans lequel vous souhaitez ajouter ou mettre à jour un élément.
Vérifiez que TENANT_ID et API_KEY font référence aux variables d’environnement Postman établies précédemment. Utilisez l’image ci-dessous pour la comparaison. Si nécessaire, modifiez les en-têtes et le chemin d’accès dans votre requête d’API afin qu’ils correspondent à ceux de l’image ci-dessous.

Saisissez votre code JSON raw dans le Body. N’oubliez pas de spécifier votre ID d’environnement à l’aide de la variable environment. (Dans l’exemple ci-dessous, l’ID d’environnement est 6781.)

Vous trouverez ci-dessous un exemple JSON qui ajoute entity.id kit2001 aux valeurs d’entité associées pour un produit grille-pain dans l’environnement 6781.

code language-none

code language-none
`{ "entities": [{ "name": "Toaster Oven", "id": "kit2001", "environment": 6781, "categories": [ "housewares:appliances" ], "attributes": { "inventory": 77, "margin": 23, "message": "crashing helicopter", "pageUrl": "www.foobar.foo.com/helicopter.html", "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg", "value": 19.2 } }] }`

    {
    "entities": [{
            "name": "Toaster Oven",
            "id": "kit2001",
            "environment": 6781,
            "categories": [
                "housewares:appliances"
            ],
            "attributes": {
                "inventory": 77,
                "margin": 23,
                "message": "crashing helicopter",
                "pageUrl": "www.foobar.foo.com/helicopter.html",
                "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
               "value": 19.2
            }
        }]
    }

Cliquez sur Send. Vous devriez recevoir la réponse suivante.

L’objet JSON peut être mis à l’échelle pour envoyer plusieurs produits. Par exemple, ce code JSON spécifie deux entités.

code language-none

code language-none
{ "entities": [{ "name": "Toaster Oven", "id": "kit2001", "environment": 6781, "categories": [ "housewares:appliances" ], "attributes": { "inventory": 89, "margin": 11, "message": "Toaster Oven", "pageUrl": "www.foobar.foo.com/helicopter.html", "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg", "value": 102.5 } }, { "name": "Blender", "id": "kit2002", "environment": 6781, "categories": [ "housewares:appliances" ], "attributes": { "inventory": 36, "margin": 5, "message": "Blender", "pageUrl": "www.foobar.foo.com/helicopter.html", "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg", "value": 54.5 } } ] }

    {
        "entities": [{
                "name": "Toaster Oven",
                "id": "kit2001",
                "environment": 6781,
                "categories": [
                    "housewares:appliances"
                ],
                "attributes": {
                    "inventory": 89,
                    "margin": 11,
                    "message": "Toaster Oven",
                    "pageUrl": "www.foobar.foo.com/helicopter.html",
                    "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                    "value": 102.5
                }
            },
            {
                "name": "Blender",
                "id": "kit2002",
                "environment": 6781,
                "categories": [
                    "housewares:appliances"
                ],
                "attributes": {
                    "inventory": 36,
                    "margin": 5,
                    "message": "Blender",
                    "pageUrl": "www.foobar.foo.com/helicopter.html",
                    "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                    "value": 54.5
                }
            }
        ]
    }

Maintenant c'est ton tour ! Utilisez l’API Save Entities pour ajouter les éléments suivants à votre catalogue. Utilisez l’exemple JSON ci-dessus comme point de départ. (Vous devez étendre le fichier JSON pour inclure d’autres entités.)

Il semble que ces deux derniers éléments n'appartiennent pas à . Examinons-les à l’aide de l’API Get Entity et, si nécessaire, supprimez-les à l’aide de l’API Delete Entities.

Obtention des détails d’élément avec l’API Get Entity

Pour récupérer les détails d’un élément existant, utilisez l’ API Get Entity. La syntaxe est la suivante :

GET https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities/[entity.id]

Les détails d’entité ne peuvent être récupérés que pour une seule entité à la fois. Vous pouvez utiliser l’option Obtenir l’entité pour confirmer que des mises à jour ont été effectuées dans le catalogue comme prévu ou pour contrôler le contenu du catalogue.

Dans la requête API, spécifiez l’ID d’entité à l’aide de la variable entityId. L’exemple suivant renvoie les détails de l’entité dont entityId=kit2004.
Vérifiez que TENANT_ID et API_KEY font référence aux variables d’environnement Postman établies précédemment. Utilisez l’image ci-dessous pour la comparaison. Si nécessaire, modifiez les en-têtes et le chemin d’accès dans votre requête d’API afin qu’ils correspondent à ceux de l’image ci-dessous.

Envoyez la requête.

GetEntity3
Si vous recevez une erreur indiquant que l’entité est introuvable, comme illustré dans l’exemple ci-dessus, vérifiez que vous envoyez la demande au bon environnement Target.

note note
NOTE
Si aucun environnement n’est explicitement spécifié, Get Entity tente d’obtenir l’entité de votre environnement par défaut uniquement. Si vous souhaitez extraire de tout environnement autre que votre environnement par défaut, vous devez spécifier l’identifiant de l’environnement.

Si nécessaire, ajoutez le paramètre environmentId et renvoyez la demande.
Envoyez une autre requête Get Entity, cette fois pour inspecter l’entité dont entityId=kit2005.

Supposons que vous décidiez que ces entités doivent être supprimées de votre catalogue. Utilisons l’API Delete Entities.

Suppression d’éléments avec l’API Supprimer des entités

Pour supprimer des éléments de votre catalogue, utilisez l’API Delete Entities. La syntaxe est la suivante :

DELETE https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities?ids=[comma-delimited-entity-ids]&environment=[environmentId]

WARNING

L’API Supprimer les entités supprime les entités référencées par les identifiants que vous spécifiez. Si aucun identifiant d’entité n’est fourni, toutes les entités de l’environnement donné sont supprimées. Si aucun identifiant d’environnement n’est indiqué, les entités seront supprimées de tous les environnements. Faites attention à ceci !

Accédez à Target > Setup > Hosts > Environments pour obtenir l’ID d’environnement cible à partir duquel vous souhaitez supprimer des éléments.
Dans la requête API, spécifiez les ID d’entité des entités que vous souhaitez supprimer, en utilisant la syntaxe &ids=[comma-delimited-entity-ids] (un paramètre de requête). Lors de la suppression de plusieurs entités, séparez les identifiants à l’aide de virgules.
Indiquez l’ID d’environnement, en utilisant la syntaxe &environment=[environmentId], sinon les entités de tous les environnements seront supprimées.
Vérifiez que TENANT_ID et API_KEY font référence aux variables d’environnement Postman établies précédemment. Utilisez l’image ci-dessous pour la comparaison. Si nécessaire, modifiez les en-têtes et le chemin d’accès dans votre requête d’API afin qu’ils correspondent à ceux de l’image ci-dessous.
Envoyez la requête.
Vérifiez vos résultats à l’aide de Get Entity, qui doit maintenant indiquer que les entités supprimées sont introuvables.

Félicitations ! Vous pouvez désormais utiliser les API Recommendations pour créer, mettre à jour, supprimer et obtenir des détails sur les entités de votre catalogue. Dans la section suivante, vous apprendrez à gérer les critères personnalisés.

<!— Suivant "Gérer les critères personnalisés" > —>

recommendation-more-help

6906415f-169c-422b-89d3-7118e147c4e3