SSP API dokumentatsioon
Pakkumispoolse platvormi API programmaatilistele reklaamiplatvormidele
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 päringut minutis
SSP loa kohta jõustatud hinnapiirang
/online-advertisement/{PAID}📊 Kompaktne sildivorming
See lõpp-punkt tagastab kompaktse EL-i nõuetele vastava läbipaistvussildi, mis sobib kuvamiseks veebireklaamide kõrval. Töötab ainult reklaamide puhul, mille meedium = "online".
curl -X GET "https://polads.eu/api/v1/online-advertisement/ABC12" \
-H "Authorization: Bearer YOUR_SSP_TOKEN" \
-H "Accept: application/json"{
"text": "Politisk Reklame - ACME Corp - Folketingsvalg - polads.eu/ABC12",
"link": "https://polads.eu/ABC12",
"PAID": "ABC12"
}Kuva silt oma platvormil:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Päise vorming
Authorization: Bearer YOUR_SSP_TOKENToken Format
64-kohaline kuueteistkümnendjada (256-bitine entroopia)
Token Management
SSP-märke haldavad ainult süsteemiadministraatorid. Tokeni hankimiseks võtke ühendust oma administraatoriga.
Ükski pakett ei kohaldu
SSP luba antakse liidestajale, mitte avaldajale, seega ei kuulu see ühegi avaldajakonto juurde ja kontrollitavat paketti pole. Erinevalt partneri API-st ei sõltu siin miski tellimusest. Partneri luba lükatakse selles lõpp-punktis tagasi koodiga 401 ja SSP luba lükatakse samamoodi tagasi partneri lõpp-punktides.
Millal lõpp-punkt tagastab 404
Kuulutus leitakse sama nähtavusreegli järgi nagu avalikus registris. Kuulutus, mis pole veel kinnitatud, mida avaldaja pole veel heaks kiitnud, või mille avaldamise alguskuupäev on alles tulevikus, tagastab 404. Kood 404 ei tõenda seega, et PA-ID oleks vale.
Ülal olev lõpp-punkt tagastab üherealise märgiseteksti märgise jaoks, mille joonistab teie enda platvorm. Märk tagastab valmis, interaktiivse teate, mille asetate reklaami kõrvale raamina. Mõlemad kirjeldavad sama läbipaistvusteadet.
Üks URL iga versiooni kohta
Näidise juhtnupud vastavad neile parameetritele üks ühele, nii et saate valida näidislehel ja kopeerida nähtava aadressi.
# Nurgamärk, ainult märk
GET https://polads.eu/badge/{PA-ID}
# Nurgamärk koos tekstiga
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Püsivalt nähtav tähisriba
GET https://polads.eu/badge/{PA-ID}?layout=labelMida iga parameeter teeb ja mida tähendab selle ärajätmine
layout=label valib riba, ilma selleta kuvatakse nurgamärk. variant=labelled näitab suletud märgil teksti, ilma selleta jääb ainult märk. w ja h määravad ala, kus märk asub, ja otsustavad, kuidas see kitsas kohas kohandub. Kui need ära jätta, eeldab märk, et ruumi on, mis sobib tavaformaatidega.
hover=0 on näidise jaoks, mitte teie lehe jaoks
See sunnib peale hiireta vaate, et näidis saaks arvutibrauseris näidata puuteversiooni. Päris märk kontrollib seadet ise. Kui selle kinnitate, saadate vale versiooni igale külastajale, kelle seade väidab vastupidist.
Suuruse kuulaja on kohustuslik
Nurgamärk laaditakse suuruses 32 korda 32, et see kataks reklaamist võimalikult vähe, ja palub avanedes lehelt ruumi. Ilma kuulajata ei avane see üldse. Märgiseriba on vastupidavam ja kärbub ainult kitsastel laiustel.
Ainult avaldatud teate jaoks
Märk väljastatakse, kui teade on kinnitatud, avaldaja poolt heaks kiidetud ja möödunud oma alguskuupäevast. Embargo all olev või kinnitamata PA-ID vastab 404 meelega, mitte vea tõttu.
401 Volitamata
{ "error": "Invalid or revoked SSP API token." }400 Vigane päring
Kuulutus leiti, kuid selle meedium ei ole online. Vastus tagastab meediumi tegeliku väärtuse, näiteks print. Puuduv või tundmatu PA-ID tagastab selle asemel 404.
404 Ei leitud
{ "error": "Advertisement not found" }429 Rate Limit on ületatud
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}See on API versioon v1 ja iga vastus ütleb seda päises X-API-Version. Ühilduvust rikkuvad muudatused ilmuvad uuel teel, selle asemel et seda muuta. Versiooni v1 lõpp-punkti ei lülitata välja ilma Deprecation päiseta vähemalt 90 päeva varem, kooskõlas RFC 8594-ga.
Masinloetav spetsifikatsioon
Täielik OpenAPI 3.1 dokument on saadaval aadressil /api/docs. Suunake Postman, Swagger UI või kliendigeneraator otse sinna, selle asemel et seda lehte ümber kirjutada.
https://polads.eu/api/docs