Kumppani-API:n dokumentaatio

401 INVALID_TOKEN

Mikään aktiivinen tunniste ei vastaa Bearer-tunnistetietoa, tai tunniste on peruutettu. Myös puuttuvaan tai virheelliseen Authorization-otsakkeeseen vastataan tilakoodilla 401, mutta vain metrics-päätepiste liittää siihen tämän virhekoodin. SSP-tunnisteeseen kumppanipäätepisteessä vastataan samalla tavalla.

{
  "error": "Invalid or revoked partner API token. This endpoint only accepts partner tokens, not SSP tokens.",
  "code": "INVALID_TOKEN"
}

{
  "error": "Invalid or revoked partner API token.",
  "code": "INVALID_TOKEN"
}

{
  "error": "Missing or invalid Authorization header. Expected: Bearer <token>",
  "code": "INVALID_TOKEN"
}

{
  "error": "Missing or invalid Authorization header. Expected: Bearer <token>"
}

403 PRO_PLAN_REQUIRED

Tunniste on kelvollinen, mutta sen julkaisijalla ei ole Pro-tilausta. Tilaus tarkistetaan ennen käyttöoikeustasoa, joten jos vain luku -tunniste kuuluu julkaisijalle, jolla ei ole Pro-tilausta, virhe koskee tilausta eikä käyttöoikeustasoa.

{
  "error": "The Pro plan is required to use the partner API.",
  "code": "PRO_PLAN_REQUIRED"
}

403 INSUFFICIENT_SCOPE

Tunniste on kelvollinen ja kuuluu Pro-tilaukseen, mutta siltä puuttuu mittareiden ilmoittamiseen tarvittava käyttöoikeustaso metrics:write.

{
  "error": "This token is not authorised to write metrics. Required scope: metrics:write.",
  "code": "INSUFFICIENT_SCOPE"
}

403 FORBIDDEN

Ilmoitus kuuluu toiselle julkaisijalle. Mitään ei kirjoiteta.

{
  "error": "This advertisement belongs to a different publisher.",
  "code": "FORBIDDEN"
}

400 INVALID_METRICS

Pyynnön runko ei ole kelvollista JSON-muotoa, tai jokin kahdesta määrästä puuttuu, on negatiivinen tai ei ole kokonaisluku. Vastauksessa luetellaan, mikä ei kelvannut.

{
  "error": "Invalid engagement metrics",
  "code": "INVALID_METRICS",
  "issues": [
    {
      "path": "viewsCount",
      "message": "Too small: expected number to be >=0"
    }
  ]
}

{
  "error": "Invalid request body",
  "code": "INVALID_METRICS"
}

409 METRICS_NOT_APPLICABLE

Ilmoitus ei kuulu niiden ilmoitusten piiriin, joille sitoutumismittarit on määritelty. Liitteen II huomautus 15 koskee verkossa julkaistua tai natiivia ilmoitusta, jossa on käytetty kohdentamistekniikoita tai mainosten näyttämistekniikoita ja jonka näyttäminen on alkanut. Mitään ei kirjoiteta.

{
  "error": "Engagement metrics do not apply to this notice",
  "code": "METRICS_NOT_APPLICABLE"
}

404 NOT_FOUND

Mikään ilmoitus ei vastaa tätä PA-ID:tä, tai se ei ole vielä sinulle näkyvissä. Lue yllä oleva osio ennen kuin oletat tunnisteen olevan virheellinen.

{
  "error": "Advertisement not found",
  "code": "NOT_FOUND"
}

{
  "error": "Advertisement not found"
}

{
  "error": "Advertisement not found or not yet confirmed"
}

429 RATE_LIMITED

Tunnistekohtainen raja ylittyi. Vastaus sisältää X-RateLimit-Limit-, X-RateLimit-Remaining- ja X-RateLimit-Reset-otsakkeet.

{
  "error": "Rate limit exceeded",
  "code": "RATE_LIMITED",
  "limit": 1000,
  "remaining": 0,
  "reset": "2026-05-14T15:14:00.000Z"
}

{
  "error": "Rate limit exceeded",
  "limit": 1000,
  "remaining": 0,
  "reset": "2026-05-14T15:14:00.000Z"
}

Koneluettava määrittely

Koko OpenAPI 3.1 -dokumentti on saatavilla osoitteessa /api/docs. Ohjaa Postman, Swagger UI tai asiakasgeneraattori suoraan siihen sen sijaan, että kopioisit tämän sivun tiedot käsin.