Panoramica API dell’amministratore di Target
- Argomenti:
- APIs/SDKs
Creato per:
- Sviluppatore
Questo articolo fornisce una panoramica delle informazioni di base necessarie per comprendere e utilizzare Adobe Target Admin API correttamente. Il contenuto seguente presuppone che tu sappia come configurare l'autenticazione per Adobe Target Admin API.
NOTAPrima di iniziare
In tutti gli esempi di codice forniti per le API amministratore, sostituisci {tenant} con il valore tenant, your-bearer-token con il token di accesso generato con il tuo JWT e your-api-key con la tua chiave API di Adobe Developer Console. Per ulteriori informazioni su tenant e JWT, consulta l'articolo su come configurare l'autenticazione, ad Adobe Target API amministratore.
Controllo delle versioni
A tutte le API è associata una versione. È importante fornire la versione corretta dell’API che desideri utilizzare.
Se la richiesta contiene un payload (POST o PUT), l'intestazione Content-Type della richiesta viene utilizzata per specificare la versione.
Se la richiesta non contiene un payload (GET, DELETE o OPTIONS), per specificare la versione viene utilizzata l'intestazione Accept.
Se non viene fornita una versione, la chiamata sarà predefinita V1 (application/vnd.adobe.target.v1+json).
NOTAMessaggio di errore per funzioni non supportate
{
"httpStatus": 406,
"requestId": "8752b736-cf71-4d81-86c3-94be2b5ae648",
"requestTime": "2018-02-02T21:39:06.405Z",
"errors": [
{
"errorCode": "Unsupported.Feature",
"message": "Unsupported features detected"
}
]
}
Raccolta Postman amministrazione
Postman è un’applicazione che semplifica l’attivazione delle chiamate API. Questa raccolta Postman API amministratore di Target contiene tutte le chiamate API amministratore di Target che richiedono l'autenticazione tramite attività, tipi di pubblico, offerte, report, mbox e ambienti
Codici di risposta
Di seguito sono riportati i codici di risposta comuni per le API di amministrazione di Target.
Attività
Un’attività ti consente di testare o personalizzare il contenuto per i tuoi utenti. Le attività possono essere di uno dei seguenti tipi:
Aggiornamenti in blocco
È possibile eseguire più API amministratore come una singola richiesta batch.
Esegui chiamate in batch
POST /{tenant}/target/batch
Sovrapponi più chiamate API ed eseguili in un singolo batch.
Il batch consente di trasmettere istruzioni per diverse operazioni in una singola richiesta HTTP. Puoi anche specificare le dipendenze tra operazioni correlate (descritte in una sezione seguente). TNT elaborerà ciascuna delle operazioni indipendenti (possibilmente in parallelo) ed elaborerà le operazioni dipendenti in sequenza. Una volta completate tutte le operazioni, verrà restituita una risposta consolidata e la connessione HTTP verrà chiusa.
L’API batch accetta un array di richieste HTTP logiche rappresentate come array JSON: ogni richiesta ha un metodo (corrispondente al metodo HTTP GET/PUT/POST/DELETE, ecc.), un relativeUrl (la parte dell’URL dopo admin/rest/), un array di intestazioni facoltativo (corrispondente alle intestazioni HTTP) e un corpo facoltativo (per le richieste POST e PUT). L’API Batch restituisce un array di risposte HTTP logiche rappresentate come array JSON: ogni risposta ha un codice di stato, un array di intestazioni facoltativo e un corpo facoltativo (che è una stringa codificata JSON). Per creare richieste in batch, crea un oggetto JSON che descrive ogni singola operazione da eseguire. Il numero massimo di operazioni consentite è 256 (da 0 a 255).
Specifica delle dipendenze tra le operazioni nella richiesta Per impostazione predefinita, le operazioni specificate nella richiesta API batch sono indipendenti: possono essere eseguite in ordine arbitrario sul server e un errore in un’operazione non influisce sull’esecuzione di altre operazioni.
Spesso, le operazioni nella richiesta dipendono - ad esempio, l’output di un’operazione può essere utilizzato nell’input dell’operazione successiva. Ad esempio, l’offerta creata in operationId=0 deve essere utilizzata nella creazione della campagna operationId=1.
Per collegare insieme due operazioni batch, specifica nell’operazione dipendente l’ID dell’operazione richiesta, ad esempio: "dependentOnOperationId" : 5. Inoltre, gli ID delle risorse create tramite richieste POST di operazioni batch possono essere utilizzati nelle operazioni dipendenti sia in "relativeUrl" che in "body".
Autorizzazioni e limitazione
Per eseguire azioni API in batch, l’utente sottostante deve disporre almeno dei diritti di "editor" (per ogni singola operazione nel caso in cui siano necessari diritti aggiuntivi rispetto all’utente, la singola operazione non riuscirà). Le comuni strategie di limitazione vengono applicate alle azioni API batch come se ogni operazione fosse stata eseguita singolarmente.
L'elaborazione batch termina quando tutte le operazioni sono state completate, un'operazione potrebbe essere riuscita (codice stato 2xx), non riuscita (codice stato 4xx, 5xx) o ignorata perché un'operazione di dipendenza non è riuscita o è stata ignorata.
Parametri oggetto di richiesta
Oggetto di richiesta di esempio
{
"operations": [
{
"operationId": 1,
"dependsOnOperationIds~": [0],
"method": "POST",
"relativeUrl": "/v1/offers",
"headers~": [
{
"name": "Content-Type",
"value": "application/json"
}
],
"body~": {
"key": "value"
}
}
]
}
Parametri oggetto di risposta
Oggetto risposta di esempio
{
"results": [
{
"operationId": 1,
"skipped~": false,
"statusCode~": 200,
"headers~": [
{
"name": "Content-Type",
"value": "application/json; charset=UTF-8"
}
],
"body~": {
"id": 5
}
}
]
}