Dokumentace partnerského API

401 INVALID_TOKEN

Žádný aktivní token neodpovídá pověření Bearer, nebo byl token odvolán. Chybějící nebo chybně formátovaná hlavička Authorization rovněž vrací 401, ale tímto kódem ji označuje pouze koncový bod metrics. Token SSP na partnerském koncovém bodu dostane stejnou odpověď.

{
  "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

Token je platný, ale jeho vydavatel nemá tarif Pro. Tarif se ověřuje před rozsahem oprávnění, takže token pouze pro čtení patřící vydavateli bez tarifu Pro ohlásí chybu tarifu, nikoli rozsahu.

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

403 INSUFFICIENT_SCOPE

Token je platný a má tarif Pro, ale chybí mu rozsah metrics:write potřebný k hlášení metrik.

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

403 FORBIDDEN

Inzerát patří jinému vydavateli. Nic se nezapisuje.

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

400 INVALID_METRICS

Tělo požadavku není platný JSON, nebo některý z obou počtů chybí, je záporný či není celé číslo. Odpověď uvádí, co neprošlo kontrolou.

{
  "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

Oznámení o transparentnosti nespadá do rozsahu, pro který jsou metriky zapojení definovány. Poznámka 15 přílohy II se vztahuje na online nebo nativní oznámení o transparentnosti, u něhož byly použity techniky cílení nebo techniky doručování reklamních sdělení a jehož zobrazování již začalo. Nic se nezapisuje.

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

404 NOT_FOUND

Tomuto PA-ID neodpovídá žádné oznámení o transparentnosti, nebo pro vás zatím není viditelné. Než usoudíte, že je identifikátor chybný, přečtěte si oddíl výše.

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

{
  "error": "Advertisement not found"
}

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

429 RATE_LIMITED

Byl překročen limit pro daný token. Odpověď obsahuje hlavičky X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset.

{
  "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"
}

Strojově čitelná specifikace

Úplný dokument OpenAPI 3.1 je k dispozici na adrese /api/docs. Místo přepisování této stránky do něj rovnou nasměrujte Postman, Swagger UI nebo generátor klientů.