Översikt över API för måladministratör
- Ämnen:
- APIs/SDKs
Skapat för:
- Utvecklare
Den här artikeln innehåller en översikt över bakgrundsinformation som krävs för att förstå och använda Adobe Target Admin API. Följande innehåll förutsätter att du förstår hur du konfigurerar autentisering för Adobe Target Admin APIs.
OBSERVERAInnan du börjar
I alla kodexempel som ingår för Admin-API:erna ersätter du {tenant} med ditt klientvärde, your-bearer-token med den åtkomsttoken som du genererar med din JWT och your-api-key med din API-nyckel från Adobe Developer Console. Mer information om klientorganisationer och JWT finns i artikeln om hur du konfigurerar autentisering för Adobe Target Admin API:er.
Versioner
Alla API:er har en associerad version. Det är viktigt att du tillhandahåller rätt version av det API som du vill använda.
Om begäran innehåller en nyttolast (POST eller PUT) används Content-Type-huvudet för begäran för att ange versionen.
Om begäran inte innehåller någon nyttolast (GET, DELETE eller OPTIONS) används rubriken Accept för att ange versionen.
Om ingen version anges används V1 (application/vnd.adobe.target.v1+json) som standard.
OBSERVERAFelmeddelande för funktioner som inte stöds
{
"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 Collection
Postman är ett program som gör det enkelt att utlösa API-anrop. Det här API:t för måladministratör för Postman Collection innehåller alla API-anrop för måladministratör som kräver autentisering med aktiviteter, målgrupper, erbjudanden, rapporter, kryssrutor och miljöer
Svarskoder
Här är de vanliga svarskoderna för Target Admin API:erna.
Verksamhet
Med en aktivitet kan du testa och anpassa innehåll för dina användare. Verksamheter kan vara någon av följande typer:
Batchuppdateringar
Flera administratörs-API:er kan köras som en enda gruppbegäran.
Kör gruppanrop
POST /{tenant}/target/batch
Stapla ihop flera API-anrop och kör dem i en enda batch.
Med gruppering kan du skicka instruktioner för flera åtgärder i en enda HTTP-begäran. Du kan också ange beroenden mellan relaterade åtgärder (beskrivs i ett avsnitt nedan). TNT bearbetar alla dina oberoende operationer (eventuellt parallellt) och bearbetar de beroende operationerna sekventiellt. När alla åtgärder har slutförts skickas ett konsoliderat svar tillbaka och HTTP-anslutningen stängs.
Batch-API:t innehåller en matris med logiska HTTP-begäranden som representeras av JSON-matriser - varje begäran har en metod (som motsvarar HTTP-metoden GET/PUT/POST/DELETE osv.), en relativeUrl (den del av URL:en som kommer efter admin/rest/), en valfri rubrikmatris (som motsvarar HTTP-huvuden) och ett valfritt brödtext (för POST- och PUT). Batch-API:t returnerar en array med logiska HTTP-svar representerade som JSON-arrayer - varje svar har en statuskod, en valfri rubrikarray och en valfri brödtext (som är en JSON-kodad sträng). Om du vill göra grupperade begäranden skapar du ett JSON-objekt som beskriver varje enskild åtgärd som ska utföras. Antalet tillåtna operationer är 256 (från 0 till 255).
Att ange beroenden mellan åtgärder i begäran Som standard är de åtgärder som anges i batch-API-begäran fristående. De kan köras i godtycklig ordning på servern och ett fel i en åtgärd påverkar inte körningen av andra åtgärder.
Ofta är åtgärderna i begäran beroende - utdata från en åtgärd kan till exempel användas i indata från nästa åtgärd. Erbjudandet som skapats i operationId=0 måste till exempel användas i kampanjskapandeoperationId=1.
För att länka ihop två batchåtgärder anger du ID:t för den nödvändiga åtgärden i den beroende åtgärden, till exempel: "beroendeOnOperationId" : 5. ID:n för skapade resurser via POST-begäranden från gruppåtgärder kan också användas i beroende åtgärder både i "relativeUrl" och "body".
Behörigheter och begränsning
För att kunna köra batch-API-åtgärder måste den underliggande användaren ha minst"redigeringsbehörighet" (för varje enskild åtgärd om ytterligare behörighet krävs än användaren har kommer den enskilda åtgärden att misslyckas). Vanliga begränsningsstrategier tillämpas på API-åtgärder för batch som om varje åtgärd har utförts individuellt.
Gruppbearbetningen avslutas när alla åtgärder har slutförts, en åtgärd kan antingen slutföras (2xx statusCode), misslyckas (4xx, 5xx statuskod) eller hoppas över eftersom en beroendeåtgärd har misslyckats eller har hoppats över.
Begär objektparametrar
Exempelbegärandeobjekt
{
"operations": [
{
"operationId": 1,
"dependsOnOperationIds~": [0],
"method": "POST",
"relativeUrl": "/v1/offers",
"headers~": [
{
"name": "Content-Type",
"value": "application/json"
}
],
"body~": {
"key": "value"
}
}
]
}
Parametrar för svarsobjekt
Exempelsvarsobjekt
{
"results": [
{
"operationId": 1,
"skipped~": false,
"statusCode~": 200,
"headers~": [
{
"name": "Content-Type",
"value": "application/json; charset=UTF-8"
}
],
"body~": {
"id": 5
}
}
]
}