SSP API dokumentācija
Piedāvājuma puses platformas API programmatiskajām reklāmu platformām
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 pieprasījumu minūtē
Likmes ierobežojums tiek piemērots vienam SSP pilnvaram
/online-advertisement/{PAID}📊 Kompakts etiķetes formāts
Šis galapunkts atgriež kompaktu, ES saderīgu caurspīdīguma etiķeti, kas ir piemērota rādīšanai kopā ar tiešsaistes reklāmām. Darbojas tikai reklāmām ar mediju = "tiešsaiste".
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"
}Parādiet etiķeti savā platformā:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Galvenes formāts
Authorization: Bearer YOUR_SSP_TOKENTokena formāts
64 rakstzīmju heksadecimālā virkne (256 bitu entropija)
Token Management
SSP pilnvaras pārvalda tikai sistēmas administratori. Sazinieties ar administratoru, lai iegūtu pilnvaru.
Neviens plāns nav piemērojams
SSP pilnvaru izsniedz integratoram, nevis izdevējam, tāpēc tā nepieder nevienam izdevēja kontam un nav plāna, ko pārbaudīt. Atšķirībā no partneru API šeit nekas nav atkarīgs no abonēšanas. Partnera pilnvara šajā galapunktā tiek noraidīta ar kodu 401, un SSP pilnvara tāpat tiek noraidīta partneru galapunktos.
Kad galapunkts atgriež 404
Sludinājums tiek atrasts pēc tā paša redzamības noteikuma kā publiskajā reģistrā. Sludinājums, kas vēl nav apstiprināts, ko izdevējs vēl nav akceptējis, vai kura publicēšanas sākuma datums vēl ir nākotnē, atgriež 404. Tātad kods 404 nepierāda, ka PA-ID būtu nepareizs.
Iepriekš minētais galapunkts atgriež vienas rindas marķējuma tekstu marķējumam, ko zīmē jūsu pašu platforma. Zīme atgriež gatavu, interaktīvu paziņojumu, ko rāmī novietojat blakus reklāmai. Abi apraksta vienu un to pašu pārredzamības paziņojumu.
Viens URL katrai versijai
Demonstrācijas vadīklas atbilst šiem parametriem viens pret vienu, tāpēc varat izvēlēties demonstrācijas lapā un nokopēt redzamo adresi.
# Stūra zīme, tikai zīme
GET https://polads.eu/badge/{PA-ID}
# Stūra zīme ar uzrakstu
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Pastāvīgi redzama marķējuma josla
GET https://polads.eu/badge/{PA-ID}?layout=labelKo dara katrs parametrs un ko nozīmē to izlaist
layout=label izvēlas joslu, bez tā tiek rādīta stūra zīme. variant=labelled rāda uzrakstu uz aizvērtās zīmes, bez tā paliek tikai zīme. w un h norāda vietu, kurā zīme atrodas, un nosaka, kā tā pielāgojas šaurā vietā. Ja tos izlaidīsiet, zīme pieņems, ka vietas pietiek, un tas atbilst standarta formātiem.
hover=0 ir domāts demonstrācijai, nevis jūsu lapai
Tas uzspiež skatu bez kursora, lai demonstrācija varētu parādīt skārienversiju datora pārlūkā. Īstā zīme pati pārbauda ierīci. To nostiprinot, jūs nosūtīsiet nepareizo versiju katram apmeklētājam, kura ierīce apgalvo pretējo.
Izmēra klausītājs ir obligāts
Stūra zīme ielādējas 32 reiz 32 izmērā, lai pēc iespējas mazāk aizsegtu reklāmu, un, atveroties, palūdz lapai vietu. Bez klausītāja tā vispār neatveras. Marķējuma josla ir iecietīgāka un tiek nogriezta tikai šauros platumos.
Pieejama tikai publicētam paziņojumam
Zīme tiek piegādāta, kad paziņojums ir apstiprināts, izdevēja parakstīts un pagājis tā sākuma datums. Ar embargo apliktais vai neapstiprinātais PA-ID ar nolūku atbild 404, nevis kļūdas dēļ.
Atveriet interaktīvo demonstrāciju un kopējiet iegulšanas kodu
401 Nesankcionēts
{ "error": "Invalid or revoked SSP API token." }400 Nederīgs pieprasījums
Sludinājums tika atrasts, bet tā medijs nav online. Atbilde atgriež faktisko medija vērtību, piemēram, print. Trūkstošs vai nezināms PA-ID atgriež 404.
404 Nav atrasts
{ "error": "Advertisement not found" }429 Likmes ierobežojums pārsniegts
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Šī ir API versija v1, un katra atbilde to norāda galvenē X-API-Version. Saderību lauzošas izmaiņas iznāk jaunā ceļā, nevis maina šo. Versijas v1 galapunkts netiks izslēgts bez Deprecation galvenes vismaz 90 dienas iepriekš, saskaņā ar RFC 8594.
Mašīnlasāma specifikācija
Pilns OpenAPI 3.1 dokuments ir pieejams vietnē /api/docs. Norādiet Postman, Swagger UI vai klienta ģeneratoru tieši uz turieni, nevis pārrakstiet šo lapu.
https://polads.eu/api/docs