Target Admin-API - Überblick
- Themen:
- APIs/SDKs
Erstellt für:
- Entwickler
Dieser Artikel bietet einen Überblick über Hintergrundinformationen, die zum Verständnis und zur erfolgreichen Verwendung von Adobe Target Admin API erforderlich sind. Im folgenden Inhalt wird davon ausgegangen, dass Sie verstehen, wie Authentifizierung konfigurieren für Adobe Target Admin APIs.
HINWEISVorabinformationen
Ersetzen Sie in allen Code-Beispielen für Admin-) {tenant} durch Ihren Mandantenwert, your-bearer-token durch das Zugriffstoken, das Sie mit Ihrem JWT generieren, und your-api-key durch Ihren API-Schlüssel aus der Adobe Developer Console. Weitere Informationen zu Mandanten und JWTs finden Sie im Artikel zum der Authentifizierung für das Adobe Target AdminAPIs.
Versionierung
Allen APIs ist eine Version zugeordnet. Es ist wichtig, die richtige Version der API bereitzustellen, die Sie verwenden möchten.
Wenn die Anfrage eine Payload enthält (POST oder PUT), wird die Content-Type-Kopfzeile der Anfrage verwendet, um die Version anzugeben.
Wenn die Anfrage keine Payload enthält (GET, DELETE oder OPTIONS), wird der Accept-Header verwendet, um die Version anzugeben.
Wenn keine Version bereitgestellt wird, wird für den Aufruf standardmäßig V1 (application/vnd.adobe.target.v1+json) verwendet.
HINWEISFehlermeldung für nicht unterstützte Funktionen
{
"httpStatus": 406,
"requestId": "8752b736-cf71-4d81-86c3-94be2b5ae648",
"requestTime": "2018-02-02T21:39:06.405Z",
"errors": [
{
"errorCode": "Unsupported.Feature",
"message": "Unsupported features detected"
}
]
}
Admin Postman-Sammlung
Postman ist ein Programm, mit dem API-Aufrufe einfach ausgelöst werden können. Diese Target-Admin-API-PostmanSammlung enthält alle Target-Admin-API-Aufrufe, für die eine Authentifizierung mithilfe von Aktivitäten, Audiences, Angeboten, Berichten, Mboxes und Umgebungen erforderlich ist
Antwort-Codes
Im Folgenden finden Sie die allgemeinen Antwort-Codes für die Target Admin-APIs.
Aktivitäten
Eine Aktivität ermöglicht es Ihnen, Inhalte für Ihre Benutzerinnen und Benutzer zu testen oder zu personalisieren. Aktivitäten können einen der folgenden Typen aufweisen:
Batch-Aktualisierungen
Mehrere Admin-APIs können als einzelne Batch-Anfrage ausgeführt werden.
Ausführen von Aufrufen im Batch
POST /{tenant}/target/batch
Stapeln Sie mehrere API-Aufrufe zusammen und führen Sie sie in einem Batch aus.
Durch Batching können Sie Anweisungen für mehrere Vorgänge in einer einzigen HTTP-Anfrage übergeben. Sie können auch Abhängigkeiten zwischen verwandten Vorgängen angeben (siehe folgenden Abschnitt). TNT verarbeitet jeden Ihrer unabhängigen Vorgänge (möglicherweise parallel) und verarbeitet Ihre abhängigen Vorgänge sequenziell. Sobald alle Vorgänge abgeschlossen sind, wird eine konsolidierte Antwort zurückgegeben und die HTTP-Verbindung wird geschlossen.
Die Batch-API akzeptiert ein Array von logischen HTTP-Anfragen, die als JSON-Arrays dargestellt werden. Jede Anfrage hat eine -Methode (entspricht der HTTP-Methode GET/PUT/POST/DELETE usw.), eine relativeUrl (der Teil der URL nach admin/rest/), ein optionales Header-Array (entspricht HTTP-Headern) und einen optionalen Hauptteil (für POST- und PUT-Anfragen). Die Batch-API gibt ein Array von logischen HTTP-Antworten zurück, die als JSON-Arrays dargestellt werden. Jede Antwort hat einen Status-Code, ein optionales Headers-Array und einen optionalen Hauptteil (eine JSON-codierte Zeichenfolge). Um Batch-Anfragen durchzuführen, erstellen Sie ein JSON-Objekt, das jeden einzelnen auszuführenden Vorgang beschreibt. Die Anzahl der maximal zulässigen Vorgänge ist 256 (von 0 bis 255).
Angeben von Abhängigkeiten zwischen Vorgängen in der Anfrage Standardmäßig sind die in der Batch-API-Anfrage angegebenen Vorgänge unabhängig - sie können auf dem Server in beliebiger Reihenfolge ausgeführt werden, und ein Fehler in einem Vorgang wirkt sich nicht auf die Ausführung anderer Vorgänge aus.
Häufig sind die Vorgänge in der Anfrage abhängig - beispielsweise kann die Ausgabe eines Vorgangs in der Eingabe des nächsten Vorgangs verwendet werden. Beispielsweise muss das in operationId=0 erstellte Angebot in operationId=1 der Kampagnenerstellung verwendet werden.
Um zwei Batch-Vorgänge miteinander zu verknüpfen, geben Sie im abhängigen Vorgang die ID des erforderlichen Vorgangs an, z. B.: „dependsOnOperationId“ : 5. Auch IDs von Ressourcen, die über POST-Anfragen von Batch-Vorgängen erstellt wurden, können in abhängigen Vorgängen sowohl in „relativeUrl“ als auch in „body“ verwendet werden.
Berechtigungen und Einschränkungen
Um Batch-API-Aktionen ausführen zu können, muss der zugrunde liegende Benutzer über mindestens „Editor“-Rechte verfügen (für jeden einzelnen Vorgang, falls zusätzliche Rechte erforderlich sind als der Benutzer hat, schlägt der einzelne Vorgang fehl). Übliche Drosselungsstrategien werden auf Batch-API-Aktionen so angewendet, als ob jeder Vorgang einzeln ausgeführt worden wäre.
Die Batch-Verarbeitung ist abgeschlossen, wenn alle Vorgänge abgeschlossen sind. Ein Vorgang kann entweder erfolgreich (2xx StatusCode), fehlgeschlagen (4xx, 5xx Status-Code) oder übersprungen werden, da ein Abhängigkeitsvorgang fehlgeschlagen ist oder übersprungen wurde.
Anforderungsobjektparameter
Beispielobjekt für die Anfrage
{
"operations": [
{
"operationId": 1,
"dependsOnOperationIds~": [0],
"method": "POST",
"relativeUrl": "/v1/offers",
"headers~": [
{
"name": "Content-Type",
"value": "application/json"
}
],
"body~": {
"key": "value"
}
}
]
}
Parameter des Antwortobjekts
Beispielantwortobjekt
{
"results": [
{
"operationId": 1,
"skipped~": false,
"statusCode~": 200,
"headers~": [
{
"name": "Content-Type",
"value": "application/json; charset=UTF-8"
}
],
"body~": {
"id": 5
}
}
]
}