Τεκμηρίωση API για συνεργάτες

401 INVALID_TOKEN

Κανένα ενεργό διακριτικό δεν αντιστοιχεί στο διαπιστευτήριο Bearer, ή το διακριτικό έχει ανακληθεί. Μια κεφαλίδα Authorization που λείπει ή είναι εσφαλμένη επιστρέφει επίσης 401, αλλά μόνο το τελικό σημείο metrics τη συνοδεύει με αυτόν τον κωδικό. Ένα διακριτικό SSP σε τελικό σημείο συνεργάτη λαμβάνει την ίδια απόκριση.

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

Το διακριτικό είναι έγκυρο, αλλά ο εκδότης του δεν έχει το πρόγραμμα Pro. Αυτό ελέγχεται πριν από το επίπεδο πρόσβασης, οπότε ένα διακριτικό μόνο ανάγνωσης που ανήκει σε εκδότη χωρίς Pro αναφέρει το πρόγραμμα και όχι το επίπεδο πρόσβασης.

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

403 INSUFFICIENT_SCOPE

Το διακριτικό είναι έγκυρο και έχει Pro, αλλά του λείπει το επίπεδο πρόσβασης metrics:write που απαιτείται για την αναφορά μετρήσεων.

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

403 FORBIDDEN

Η διαφήμιση ανήκει σε άλλον εκδότη. Δεν γράφεται τίποτα.

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

400 INVALID_METRICS

Το σώμα του αιτήματος δεν είναι έγκυρο JSON ή οι δύο τιμές μέτρησης λείπουν, είναι αρνητικές ή δεν είναι ακέραιες. Η απόκριση αναφέρει τι απέτυχε.

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

Η ανακοίνωση βρίσκεται εκτός του πεδίου για το οποίο ορίζονται οι μετρήσεις αλληλεπίδρασης. Η σημείωση 15 του παραρτήματος II καλύπτει επιγραμμική ή εγγενή ανακοίνωση που χρησιμοποίησε τεχνικές στόχευσης ή τεχνικές παράδοσης διαφημίσεων και έχει αρχίσει να προβάλλεται. Δεν καταχωρίζεται τίποτα.

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

404 NOT_FOUND

Καμία ανακοίνωση δεν αντιστοιχεί σε αυτό το PA-ID ή δεν είναι ακόμη ορατή σε εσάς. Διαβάστε την παραπάνω ενότητα πριν υποθέσετε ότι το αναγνωριστικό είναι λανθασμένο.

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

{
  "error": "Advertisement not found"
}

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

429 RATE_LIMITED

Το όριο ανά διακριτικό ξεπεράστηκε. Η απόκριση φέρει X-RateLimit-Limit, X-RateLimit-Remaining και 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"
}

Προδιαγραφή αναγνώσιμη από μηχανή

Το πλήρες έγγραφο OpenAPI 3.1 διατίθεται στη διεύθυνση /api/docs. Συνδέστε το Postman, το Swagger UI ή μια γεννήτρια πελατών απευθείας σε αυτό, αντί να αντιγράφετε αυτή τη σελίδα.