SSP-sovellusliittymän dokumentaatio
Tarjontapuolen alustan API ohjelmallisille mainosalustoille
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 pyyntöä minuutissa
SSP-tunnusta kohti pakotettu hintarajoitus
/online-advertisement/{PAID}📊 Kompakti etikettimuoto
Tämä päätepiste palauttaa kompaktin, EU-yhteensopivan läpinäkyvyystarran, joka sopii näytettäväksi verkkomainosten yhteydessä. Toimii vain mainoksissa, joissa media = "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"
}Näytä tunniste alustallasi:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Otsikkomuoto
Authorization: Bearer YOUR_SSP_TOKENToken-muoto
64-merkkinen heksadesimaalimerkkijono (256-bittinen entropia)
Tokenin hallinta
SSP-tunnuksia hallinnoivat vain järjestelmänvalvojat. Ota yhteyttä järjestelmänvalvojaan saadaksesi tunnus.
Mikään tilaus ei koske tätä
SSP-tunniste myönnetään integroijalle eikä julkaisijalle, joten se ei kuulu mihinkään julkaisijatiliin eikä tarkistettavaa tilausta ole. Toisin kuin kumppanirajapinnassa, täällä mikään ei riipu tilauksesta. Kumppanitunniste hylätään tässä päätepisteessä koodilla 401, ja SSP-tunniste hylätään samoin kumppanipäätepisteissä.
Milloin päätepiste palauttaa 404
Ilmoitus haetaan samalla näkyvyyssäännöllä kuin julkisessa rekisterissä. Ilmoitus, jota ei ole vielä vahvistettu, jota julkaisija ei ole vielä hyväksynyt, tai jonka julkaisun alkamispäivä on vielä tulevaisuudessa, palauttaa 404. Koodi 404 ei siis ole todiste siitä, että PA-ID olisi väärä.
Yllä oleva päätepiste palauttaa yksirivisen merkintätekstin merkintää varten, jonka oma alustasi piirtää. Merkki palauttaa valmiin, vuorovaikutteisen ilmoituksen, jonka sijoitat mainoksen viereen kehyksenä. Molemmat kuvaavat samaa avoimuusilmoitusta.
Yksi URL-osoite versiota kohden
Esittelyn painikkeet vastaavat näitä parametreja yksi yhteen, joten voit valita esittelysivulla ja kopioida näkemäsi osoitteen.
# Kulmamerkki, pelkkä merkki
GET https://polads.eu/badge/{PA-ID}
# Kulmamerkki tekstin kanssa
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Jatkuvasti näkyvä merkintäpalkki
GET https://polads.eu/badge/{PA-ID}?layout=labelMitä kukin parametri tekee ja mitä sen pois jättäminen tarkoittaa
layout=label valitsee palkin, ilman sitä näkyy kulmamerkki. variant=labelled näyttää tekstin suljetussa merkissä, ilman sitä jää pelkkä merkki. w ja h ilmoittavat tilan, jossa merkki on, ja ratkaisevat, miten se mukautuu ahtaassa paikassa. Jos jätät ne pois, merkki olettaa tilaa olevan, mikä pitää paikkansa vakiokoissa.
hover=0 kuuluu esittelyyn, ei sivullesi
Se pakottaa näkymän ilman osoitinta, jotta esittely voi näyttää kosketusversion työpöytäselaimessa. Oikea merkki tutkii laitteen itse. Jos lukitset sen, lähetät väärän version jokaiselle kävijälle, jonka laite on eri mieltä.
Koon kuuntelija on pakollinen
Kulmamerkki latautuu kokoon 32 kertaa 32, jotta se peittää mainoksesta mahdollisimman vähän, ja pyytää sivulta tilaa avautuessaan. Ilman kuuntelijaa se ei avaudu lainkaan. Merkintänauha on sitkeämpi ja rajautuu vain kapeilla leveyksillä.
Vain julkaistulle ilmoitukselle
Merkki toimitetaan, kun ilmoitus on vahvistettu, julkaisijan hyväksymä ja ohittanut alkamispäivänsä. Julkaisukiellossa oleva tai hyväksymätön PA-ID vastaa 404 tarkoituksella, ei virheen vuoksi.
401 Luvaton
{ "error": "Invalid or revoked SSP API token." }400 Virheellinen pyyntö
Ilmoitus löytyi, mutta sen media ei ole online. Vastaus palauttaa todellisen media-arvon, esimerkiksi print. Puuttuva tai tuntematon PA-ID palauttaa sen sijaan 404.
404 Ei löydy
{ "error": "Advertisement not found" }429 Rate Limit ylitetty
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Tämä on rajapinnan versio v1, ja jokainen vastaus kertoo sen X-API-Version-otsakkeessa. Rikkovat muutokset julkaistaan uudessa polussa sen sijaan, että tätä muutettaisiin. Versiota v1 olevaa päätepistettä ei suljeta ilman Deprecation-otsaketta vähintään 90 päivää aiemmin, RFC 8594:n mukaisesti.
Koneluettava määrittely
Täysi OpenAPI 3.1 -dokumentti on osoitteessa /api/docs. Osoita Postman, Swagger UI tai asiakasgeneraattori suoraan sinne sen sijaan, että kopioisit tämän sivun.
https://polads.eu/api/docs