Overzicht van Admin API voor doelbeheerder

Dit artikel verstrekt een overzicht van achtergrondinformatie noodzakelijk om Adobe Target Admin API met succes te begrijpen en te gebruiken. De volgende inhoud veronderstelt u begrijpt hoe te ​ authentificatie ​ voor Adobe Target Admin API s vormen.

Voordat u begint

In alle codevoorbeelden die voor ​ worden verstrekt Admin APIs ​, vervang {tenant} met uw huurderswaarde, your-bearer-token met het toegangstoken dat u met uw JWT en your-api-key met uw API sleutel van ​ Adobe Developer Console ​ produceert. Voor meer informatie over huurders en JWTs, te zien gelieve het artikel op hoe te ​ authentificatie ​ voor Adobe Target Admin APIs vormen.

Versioning

Aan alle API's is een versie gekoppeld. Het is belangrijk om de juiste versie van de API te verstrekken u wilt gebruiken.

Als de aanvraag een payload (POST of PUT) bevat, wordt de header Content-Type van de aanvraag gebruikt om de versie op te geven.

Als de aanvraag geen payload bevat (GET, DELETE of OPTIONS), wordt de header Accept gebruikt om de versie op te geven.

Als een versie niet wordt verstrekt, zal de vraag aan V1 (application/vnd.adobe.target.v1+json) in gebreke blijven.

Foutbericht voor niet-ondersteunde functies

{
    "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 is een toepassing waarmee het eenvoudig is API-aanroepen te starten. Dit ​ Admin API van het Doel de Inzameling van Postman ​ bevat alle vraag van Admin API van het Doel die authentificatie gebruikend Activiteiten, Soorten, Aanbiedingen, Rapporten, Mboxes, en Milieu vereist

Antwoordcodes

Hier volgen de algemene responscodes voor de API's voor doelbeheer.

Activiteiten

Met een activiteit kunt u inhoud voor uw gebruikers testen of aanpassen. De activiteiten kunnen een van de volgende soorten activiteiten zijn:

Batchupdates

Meerdere Admin API's kunnen als één batchaanvraag worden uitgevoerd.

Uitvoeren Vraag in Batch

POST /{tenant}/target/batch

Stapel veelvoudige API vraag samen en voer hen in één enkele partij uit.

Met batchverwerking kunt u instructies doorgeven voor verschillende bewerkingen in één HTTP-aanvraag. U kunt ook afhankelijkheden opgeven tussen verwante bewerkingen (zoals hieronder in een sectie wordt beschreven). TNT verwerkt elk van uw onafhankelijke bewerkingen (mogelijk parallel) en verwerkt uw afhankelijke bewerkingen opeenvolgend. Wanneer alle bewerkingen zijn voltooid, wordt een geconsolideerde reactie doorgegeven en wordt de HTTP-verbinding gesloten.

De batch-API neemt een array van logische HTTP-aanvragen op die worden vertegenwoordigd door JSON-arrays. Elke aanvraag heeft een methode (die overeenkomt met de HTTP-methode GET/PUT/POST/DELETE, enz.), een relativeUrl (het gedeelte van de URL na admin/rest/), een optionele headerarray (die overeenkomt met HTTP-headers) en een optionele body (voor POST- en PUT-aanvragen). De batch-API retourneert een array met logische HTTP-reacties die worden vertegenwoordigd door JSON-arrays. Elke reactie heeft een statuscode, een optionele headerarray en een optionele body (die een JSON-gecodeerde tekenreeks is). Als u batchverzoeken wilt maken, maakt u een JSON-object dat elke afzonderlijke bewerking beschrijft die moet worden uitgevoerd. Het maximum aantal toegestane bewerkingen is 256 (van 0 tot 255).

Als u afhankelijkheden opgeeft tussen bewerkingen in de aanvraag Standaard zijn de bewerkingen die in de batch-API-aanvraag zijn opgegeven onafhankelijk. Deze kunnen in willekeurige volgorde op de server worden uitgevoerd en een fout in een bewerking heeft geen invloed op de uitvoering van andere bewerkingen.

Vaak zijn de bewerkingen in het verzoek afhankelijk. De uitvoer van een bewerking kan bijvoorbeeld worden gebruikt bij de invoer van de volgende bewerking. Bijvoorbeeld aanbieding die in operationId=0 wordt gecreeerd moet in campagnecreatie operationId=1 worden gebruikt.

Om twee batchbewerkingen aan elkaar te koppelen, geeft u in de afhankelijke bewerking de id van de vereiste bewerking op, bijvoorbeeld: "hangtOnOperationId" : 5. Ook kunnen id's van gemaakte bronnen via POST-aanvragen van batchbewerkingen worden gebruikt in afhankelijke bewerkingen, zowel in "relativeUrl" als in "body".

Machtigingen en rotatie

Voor het uitvoeren van batch-API-handelingen moet de onderliggende gebruiker ten minste ‘editor’-rechten hebben (voor elke afzonderlijke bewerking moeten aanvullende rechten worden vereist dan de gebruiker heeft, dan mislukt de afzonderlijke bewerking). De gebruikelijke vertragingsstrategieën worden toegepast op batch-API-acties alsof elke bewerking afzonderlijk is uitgevoerd.

De verwerking van de partij eindigt wanneer alle verrichtingen zijn voltooid, kon een verrichting of succesvol zijn (2xx statusCode), mislukking (4xx, 5xx statuscode) of overgeslagen omdat een gebiedsdeelverrichting is ontbroken of overgeslagen.

Objectparameters aanvragen

Voorbeeld van aanvraagobject

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

Parameters van reactieobject

Voorbeeld van reactieobject

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