Présentation de l'API Adobe Target Admin | Cible Adobe (2023)

Cet article fournit un aperçu des informations générales nécessaires pour comprendre et utiliser avec succès les API Adobe Target Admin. Le contenu suivant suppose que vous comprenez commentconfigurer l'authentificationpour les API Adobe Target Admin.

Avant que tu commences

Dans tous les exemples de code fournis pour leAPI d'administration, remplacez {locataire} par votre valeur de locataire,jeton-de-votre-porteuravec le jeton d'accès que vous générez avec votre JWT etvotre-clé-apiavec votre clé API depuis leConsole de développement Adobe. Pour plus d'informations sur les locataires et les JWT, veuillez consulter l'article sur la façon deconfigurer l'authentificationpour les API Adobe Target Admin.

Gestion des versions

Toutes les API ont une version associée. Il est important de fournir la bonne version de l'API que vous souhaitez utiliser.

Si la requête contient une charge utile (POST ou PUT), leType de contenul'en-tête de la requête est utilisé pour spécifier la version.

Si la requête ne contient pas de charge utile (GET, DELETE ou OPTIONS), leAccepterheader est utilisé pour spécifier la version.

Si aucune version n'est fournie, l'appel sera par défaut V1 (application/vnd.adobe.target.v1+json).

Message d'erreur pour les fonctionnalités non prises en charge

{ "httpStatus": 406, "requestId": "8752b736-cf71-4d81-86c3-94be2b5ae648", "requestTime": "2018-02-02T21:39:06.405Z", "errors": [ { "errorCode": "Unsupported.Feature", "message": "Fonctionnalités non prises en charge détectées" } ]}

Collecte du facteur administratif

Postman est une application qui facilite le déclenchement des appels API. CeCollection Postman de l'API d'administration ciblecontient tous les appels de l'API Target Admin qui nécessitent une authentification à l'aide d'Activités, d'Audiences, d'Offres, de Rapports, de Mbox et d'Environnements

Codes de réponse

Voici les codes de réponse courants pour les API d'administration cible.

Activités

Une activité vous permet de tester ou de personnaliser du contenu pour vos utilisateurs. Les activités peuvent être de l'un des types suivants :

• UN B
• Ciblage d'expérience (XT)
• Recommandations
• Personnalisation automatisée
• Test multivarié (MVT)

Mises à jour par lots

Plusieurs API d'administration peuvent être exécutées en une seule requête par lot.

Exécuter des appels par lots

POST /{locataire}/cible/lot

Empilez plusieurs appels d'API et exécutez-les en un seul lot.

Le traitement par lots vous permet de transmettre des instructions pour plusieurs opérations dans une seule requête HTTP. Vous pouvez également spécifier des dépendances entre des opérations liées (décrites dans une section ci-dessous). TNT traitera chacune de vos opérations indépendantes (éventuellement en parallèle) et traitera séquentiellement vos opérations dépendantes. Une fois toutes les opérations terminées, une réponse consolidée sera renvoyée et la connexion HTTP sera fermée.

L'API batch prend en charge un tableau de requêtes HTTP logiques représentées sous forme de tableaux JSON - chaque requête a une méthode (correspondant à la méthode HTTP GET/PUT/POST/DELETE etc.), une relativeUrl (la partie de l'URL après admin/rest/ ), un tableau d'en-têtes facultatif (correspondant aux en-têtes HTTP) et un corps facultatif (pour les requêtes POST et PUT). L'API Batch renvoie un tableau de réponses HTTP logiques représentées sous forme de tableaux JSON - chaque réponse a un code d'état, un tableau d'en-têtes facultatif et un corps facultatif (qui est une chaîne encodée JSON). Pour effectuer des requêtes par lots, créez un objet JSON qui décrit chaque opération individuelle à effectuer. Le nombre maximum d'opérations autorisées est de 256 (de 0 à 255).

Spécification des dépendances entre les opérations dans la requête Par défaut, les opérations spécifiées dans la requête API batch sont indépendantes - elles peuvent être exécutées dans un ordre arbitraire sur le serveur et une erreur dans une opération n'affecte pas l'exécution des autres opérations.

Souvent, les opérations dans la demande sont dépendantes - par exemple, la sortie d'une opération peut être utilisée dans l'entrée de l'opération suivante. Par exemple, l'offre créée dans operationId=0 doit être utilisée dans la création de la campagne operationId=1.

Afin de lier deux opérations par lots, spécifiez dans l'opération dépendante l'identifiant de l'opération requise, par exemple : "dependsOnOperationId" : 5. Les identifiants des ressources créées via les requêtes POST des opérations par lots peuvent également être utilisés dans les opérations dépendantes à la fois dans " et le corps".

Autorisations et limitation

Afin d'exécuter des actions d'API par lots, l'utilisateur sous-jacent doit avoir au moins des droits "d'éditeur" (pour chaque opération individuelle, si des droits supplémentaires sont requis par rapport à l'utilisateur, l'opération individuelle échouera). Les stratégies de limitation habituelles sont appliquées aux actions d'API par lots comme si chaque opération avait été effectuée individuellement.

Le traitement par lots se termine lorsque toutes les opérations sont terminées, une opération peut soit réussir (code d'état 2xx), échouer (code d'état 4xx, 5xx) ou être ignorée car une opération de dépendance a échoué ou a été ignorée.

Paramètres d'objet de requête

Exemple d'objet de requête

{ "operations": [ { "operationId": 1, "dependsOnOperationIds~": [0], "method": "POST", "relativeUrl": "/v1/offers", "headers~": [ { "nom ": "Content-Type", "value": "application/json" } ], "body~": { "key": "value" } } ]}

Paramètres de l'objet de réponse

Exemple d'objet de réponse

{ "results": [ { "operationId": 1, "skipped~": false, "statusCode~": 200, "headers~": [ { "name": "Content-Type", "value": "application /json; charset=UTF-8" } ], "body~": { "id": 5 } } ]}