Ad Managers REST-API

Allt i Aeon Ad Manager går också att göra via REST-API:t: annonser, annonsmaterial, HTML5-paket, grupper, placeringar, bokningar, förhandsvisningslänkar och statistik. En byrå eller en kodagent kan leverera en färdig kampanj utan att logga in i WordPress, och tidningen ser och styr allt i Ad Manager.

Instruktionerna steg för steg för en kodagent finns i agentbriefen (på engelska), som också ligger i startpaketet. Hur formaten byggs beskrivs i Bygga high impact-format.

Roller

Den som bara arbetar med annonser får ett WordPress-konto som når Ad Manager och inget annat. Tidningen väljer rollen när användaren läggs till.

Roll	Får
Annonsansvarig	Allt i Ad Manager, också sajtens annonsregler, ads.txt, statistikinställningarna, importen och annonser med egen kod (HTML, AdSense, Google Ad Manager)
Annonsbyrå	Annonser, HTML5-paket, grupper, placeringar, bokningar, förhandsvisningslänkar och statistik. Inte inställningarna, importen eller annonser med egen kod
Annonsrapporter	Läser statistiken

Annonser med egen kod är förbehållna tidningens egen personal, eftersom koden körs direkt på sajten. HTML5-paket körs i en låst ram, och därför får byrårollen ladda upp dem.

Inloggning

• Adress: https://<sajt>/wp-json/aeon-ad-manager/v1/.
• Inloggning: användarnamnet och ett applikationslösenord, som skapas under användarens profil i WordPress, med HTTP Basic över HTTPS.
• Lösenordet hör hemma i ett hemlighetslager, aldrig i kod, loggar eller prompter.
• Ett applikationslösenord kan dras in när som helst utan att användarens vanliga lösenord påverkas.

curl --user "$WP_USER:$WP_APP_PASSWORD" "$SITE/wp-json/aeon-ad-manager/v1/placements/map"

En leverans steg för steg

Steg	Anrop
Ladda upp affischbilder	POST /wp-json/wp/v2/media
Kontrollera HTML5-paketet	POST packages?dry_run=1, som svarar ok eller felet och inte sparar något
Ladda upp paketet	POST packages
Skapa annonsen som utkast	POST ads med "status":"draft"
Lägg till materialet	POST creatives med formatet, dess inställningar och landningssidorna
Gör materialet till annonsens	PATCH ads/<id> med active_creative_id
Förhandsvisa	POST creatives/<id>/preview-link, som ger en länk som gäller i sju dagar
Boka, efter klartecken	POST campaigns, POST flights, sedan bokningens annonser och placeringar
…eller lägg i en grupp	PUT groups/<id>/members med hela listan av annonser och vikter
Aktivera	PATCH ads/<id> med "status":"active"
Följ upp	GET placements/map, GET ads/<id>/report och annonsens publika statistiksida

Så beter sig API:t:

• Tider anges i UTC, och en sluttid räknas inte med.
• En ändring av en annons kräver dess aktuella revision. En gammal revision nekas med 409, så två personer kan inte skriva över varandra.
• Ett material ändras aldrig. En ny version är ett nytt material, och varje version behåller sin egen statistik.

Förhandsvisning i stället för testannonser

Inget testas någonsin på den publicerade sajten. Förhandsvisningslänken visar annonsen på en riktig sida på sajten:

• topscroll och skin på förstasidan, övriga format i den senaste artikeln;
• alla andra annonser på sidan utelämnade;
• inget räknas, och ett klick visar bara vart det skulle ha gått.

Tidningens personal kan också skapa förhandsvisningslänkar på annonsens sida i Ad Manager.

Felsvar

Status	Betydelse
400	Något i anropet är fel; meddelandet säger vad
401	Inloggningen misslyckades
403	Rollen får inte göra detta, eller så är förhandsvisningslänken ogiltig
404	Id:t finns inte
409	En gammal revision, eller ett försök att ändra ett material
410	Förhandsvisningslänken har gått ut

Den fullständiga referensen, med alla fält och regler, följer med tillägget. Agentbriefen täcker allt en byrå behöver.