SSP API dokumentacija
Pasiūlos pusės platformos API programinėms reklamos platformoms
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 užklausų per minutę
Įkainio apribojimas taikomas vienam SSP prieigos raktui
/online-advertisement/{PAID}📊 Kompaktiškas etiketės formatas
Šis galutinis taškas pateikia kompaktišką, ES reikalavimus atitinkančią skaidrumo etiketę, tinkančią rodyti kartu su internetiniais skelbimais. Veikia tik skelbimams, kurių terpė = "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"
}Parodykite etiketę savo platformoje:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Antraštės formatas
Authorization: Bearer YOUR_SSP_TOKENŽetono formatas
64 simbolių šešioliktainė eilutė (256 bitų entropija)
Žetonų valdymas
SSP prieigos raktus valdo tik sistemos administratoriai. Norėdami gauti prieigos raktą, susisiekite su administratoriumi.
Joks planas netaikomas
SSP prieigos raktas išduodamas integratoriui, o ne leidėjui, todėl jis nepriklauso jokiai leidėjo paskyrai ir nėra plano, kurį reikėtų tikrinti. Skirtingai nei partnerių API, čia niekas nepriklauso nuo prenumeratos. Partnerio prieigos raktas šiame galiniame taške atmetamas su kodu 401, o SSP prieigos raktas taip pat atmetamas partnerių galiniuose taškuose.
Kada galinis taškas grąžina 404
Skelbimas randamas pagal tą pačią matomumo taisyklę kaip viešajame registre. Skelbimas, kuris dar nepatvirtintas, kurio leidėjas dar nepatvirtino, arba kurio paskelbimo pradžios data dar ateityje, grąžina 404. Todėl kodas 404 neįrodo, kad PA-ID yra klaidingas.
Pirmiau nurodytas galinis taškas grąžina vienos eilutės ženklinimo tekstą ženklinimui, kurį piešia jūsų pačių platforma. Ženklas grąžina paruoštą interaktyvų pranešimą, kurį rėmelyje padedate šalia reklamos. Abu aprašo tą patį skaidrumo pranešimą.
Po vieną URL kiekvienai versijai
Demonstracijos valdikliai atitinka šiuos parametrus vienas prie vieno, tad galite pasirinkti demonstraciniame puslapyje ir nukopijuoti matomą adresą.
# Kampo ženklas, tik ženklas
GET https://polads.eu/badge/{PA-ID}
# Kampo ženklas su užrašu
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Nuolat matoma žymėjimo juosta
GET https://polads.eu/badge/{PA-ID}?layout=labelKą daro kiekvienas parametras ir ką reiškia jį praleisti
layout=label parenka juostą, be jo rodomas kampo ženklas. variant=labelled parodo užrašą ant uždaryto ženklo, be jo lieka tik ženklas. w ir h nurodo vietą, kurioje ženklas stovi, ir nusprendžia, kaip jis prisitaiko ankštoje vietoje. Jei jų nenurodysite, ženklas laikys, kad vietos yra, o tai tinka standartiniams formatams.
hover=0 skirtas demonstracijai, ne jūsų puslapiui
Jis priverčia rodinį be užvedimo, kad demonstracija galėtų parodyti lietimo versiją kompiuterio naršyklėje. Tikrasis ženklas pats patikrina įrenginį. Jį užfiksavę, siųsite netinkamą versiją kiekvienam lankytojui, kurio įrenginys teigia kitaip.
Dydžio klausytojas yra privalomas
Kampo ženklas įkeliamas 32 iš 32 dydžio, kad kuo mažiau uždengtų reklamą, o atsidarydamas paprašo puslapio vietos. Be klausytojo jis apskritai neatsidaro. Ženklinimo juosta yra pakantesnė ir nukerpama tik esant siauriems pločiams.
Pasiekiama tik paskelbtam pranešimui
Ženklas pateikiamas, kai pranešimas patvirtintas, leidėjo pasirašytas ir praėjo jo pradžios data. Embargu apribotas ar nepatvirtintas PA-ID tyčia atsako 404, o ne dėl klaidos.
Atverkite interaktyvią demonstraciją ir nukopijuokite įterpimo kodą
401 Neteisėta
{ "error": "Invalid or revoked SSP API token." }400 Netinkama užklausa
Skelbimas rastas, bet jo medija nėra online. Atsakymas grąžina tikrąją medijos reikšmę, pavyzdžiui print. Trūkstamas ar nežinomas PA-ID vietoj to grąžina 404.
404 Nerasta
{ "error": "Advertisement not found" }429 Viršytas normos limitas
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Tai yra API versija v1, ir kiekvienas atsakymas tai nurodo antraštėje X-API-Version. Suderinamumą laužantys pakeitimai išleidžiami nauju keliu, o ne keičiant šį. Versijos v1 galinis taškas nebus išjungtas be Deprecation antraštės bent 90 dienų iš anksto, pagal RFC 8594.
Kompiuterio nuskaitoma specifikacija
Visas OpenAPI 3.1 dokumentas pateikiamas adresu /api/docs. Nukreipkite Postman, Swagger UI ar kliento generatorių tiesiai ten, o ne perrašinėkite šį puslapį.
https://polads.eu/api/docs