Inleiding
Adconfig.Ster - https://adconfig.ster.nl/ - is een service die aangeroepen dient te worden om de aanroep/url voor een advertentie server te ontvangen. Op basis van van programma informatie als de lengte van een video, wordt bepaald welke advertentie server, met wat voor details moet worden aangeroepen. In de nieuwste NPO Player wordt deze functionaliteit ingebouwd.
Details van het programma kunnen bepalen dat geen advertentie server aanroep wordt teruggegeven, zoals bij gevoelige content die niet van een advertentie mag worden voorzien, ZAPPE, en bij korte content.
Per streamstart dient Adconfig 1 maal aangeroepen te worden.
Werking
Roep voor het verkrijgen van de ad server aanroep, de config aan met https://adconfig.ster.nl/adurl/[identifier], waarbij [identifier] vervangen dient te worden met een voor de app of website unieke identifier, met als formaat [site]-[device].
Voor de NPO zijn de volgende identifiers beschikbaar: npo-app-desktop, npo-app-ios-smartphone, npo-app-ios-tablet, npo-app-android-smartphone, npo-app-android-tablet, npo-app-smarttv, npo-app-tvos (voor AppleTv), npo-app-chromecast.
Voor andere omroepen gelden dezelfde identifiers, waarbij 'npo-app' vervangen dient te worden door de site (lowercase, zonder streepjes). Voorbeeld: pauw-desktop, bnnvara-desktop, bnnvara-ios-smartphone, et cetera.
In de adurl/[identifier] aanroep is de variabele cust_params verplicht:
cust_params
hierin alle waardes uit onderstaande tabel 'encoded'. Als de waarde van een veld niet beschikbaar is, dient het veld meegenomen te worden met een lege string als waarde. En de 'encoding' betreft standaard encoding zoals in c# gedaan kan worden met HttpUtility.UrlEncode. Hierna zie je ipv;
'=' de waarde '%3D'
'&' de waarde '%26'
',' de waarde '%2C'
_et cetera.
',' de waarde '%2C'
Ook kan https://urldecode.org/ handig zijn. En let op 'double encoded' t.a.v. de cust_params' referrer_url en description_url
| Veld in cust_params | Omschrijving |
| programma_titel | De naam van het programma. Alleen kleine letters (geen spaties, streepjes, leestekens en speciale karakters). |
| genre | Genre, komma-gescheiden. Wanneer het gaat om een jeugd programma, dan moet de waarde jeugd in de lijst opgenomen worden (geen spaties). |
| video_duur | De totale duur van de af te spelen video, in seconden. |
| prid | Het ID van het programma. |
| srid | Het ID van de serie. |
| net | Bij jeugdprogrammering dient hier zapp (of indien van toepassing: zappe) ingevuld te worden, anders npo1, npo2 of npo3. |
| player | Keuze uit web (website players op desktop), smarttv (SMART TV applicaties), mobiel (mobiele website, dus de browsers) en app (voor mobiele apps). |
| devicetype | Device type volgens IAB OpenRTB specs 2.2: 1=Mobile/Tablet, 2=Personal Computer, 3=Connected TV, 4=Phone, 5=Tablet, 6=Connected Device, 7=Set Top Box. Zie paragraaf 5.21 van de IAB's OpenRTB API Specification. |
| os | Deze dient gevuld te worden met een kernmerk van het OS (besturingssysteem): windows, linux, osx, ios, android. Als dit uitgelezen kan worden op de client. Mits dit uitgelezen kan worden vanuit de client. |
| osversion | De versie van het OS (besturingssysteem). Mits dit uitgelezen kan worden vanuit de client. |
| playerversion | De versie van jouw applicatie/player. |
| omroep | De naam van de omroep in default formaat (kleine letters en geen koppel-streepjes). Bijvoorbeeld: npo, nos, avrotros, ntr, bnnvara, vpro, max, eo, kro, bnn, ncrv, vara, powned, wnl, tros of avro. In het geval van meerdere omroepen komma-gescheiden. |
| afleverings_titel | Titel van de aflevering. Alleen kleine letters (geen spaties, streepjes, leestekens en speciale karakters). |
| subgenre | Subgenre (evt een komma gescheiden lijst, geen spaties). |
| site | Korte en unieke naam van de site (bij web meestal: url van de website zonder https://www en .nl) van de website waar de player is geimplementeerd, als nos, npostart, dewerelddraaitdoor, wieisdemol, zapp. Bij app's korte naam van de app. |
| referrer_url | Url van pagina van stream. Veld is leeg bij apps. Als ingevuld dient op dit veld apart encoding te worden toegepast, zodat het double encoded in cust_params terechtkomt. Om foutgevoeligheid te verminderen aan einde van de cust_params. |
| description_url | Url van beschrijving van stream (meestal hetzelfde als referrer_url, en dient dan leeg te blijven). Veld is leeg bij apps. Als ingevuld dient op dit veld apart encoding te worden toegepast, zodat het double encoded in cust_params terechtkomt. Om foutgevoeligheid te verminderen aan einde van de cust_params. |
De volgende antwoorden zijn mogelijk (response formaat is JSON, met 1 variabele: adUrl die linkt naar);
Voorbeeld
Versiehistorie en wijzigingen