OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 7 Operationen, generiert aus api/openapi.yaml. Filtern Sie nach Pfad, Aktion oder Authentifizierung. Jeder Endpunkt listet seine Eingaben auf; klappen Sie ihn auf, um eine Anfragevorlage und die Antwortcodes zu sehen. Die Vorlagen brauchen Ihre eigenen Werte und einen schemagültigen Anfragekörper.
Großgeschriebene Platzhalter durch Ihre Werte ersetzen. Für eine JSON-Anfrage speichern Sie einen Body, der dem Schema in request.json entspricht. Cookie-Beispiele verwenden ein lokales Cookie-Archiv aus einer authentifizierten Sitzung.
Überprüfungen von Agentenänderungen
Bewertungen auflisten
Die Überprüfungen des Projekts (docs/reviews.md): Playlist- und Bildschirmänderungen, die mit Propose-Zugriff vorgeschlagen wurden, die Schreibvorgänge für Kampagnen, Bildschirmordner und Verschiebungen, die einen geschützten Bildschirm erreichen (Art protected_change, docs/screen-scope.md), und bei einem Werbenetzwerk die von Käufern eingereichten Kreative (Art ad_creative).
Neueste zuerst, höchstens limit (Standard 50, höchstens 100) pro Seite; übergeben Sie next_cursor als Cursor mit denselben Filtern zurück. Zustand pending (Standard), decided (alle anderen Zustände) oder all; Art schränkt auf eine Art ein.
Eine Dashboard-Sitzung liest jede Art; ein Bearer liest die Arten, die seine Fähigkeiten abdecken (playlists für playlist_change, screens für screen_change und protected_change, advertising für ad_creative), und eine Art, die er nicht lesen kann, ist eine leere Seite. pending_count zählt die ausstehenden Überprüfungen jeder Art, die der Aufrufer sieht.
Ein auf Bildschirme beschränkter Aufrufer sieht nur die Überprüfungen screen_change und protected_change, deren gesamte Reichweite innerhalb seines Bereichs liegt (eine Überprüfung, die Bildschirme per Tag auswählt, tut das nie), und die Überprüfungen playlist_change; ad_creative-Überprüfungen sind für ihn ausgeblendet, und pending_count zählt, was er sieht.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| Status | Abfrage | optional | |
| kind | Abfrage | optional | |
| Limit | Abfrage | optional | |
| Cursor | Abfrage | optional |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reviews'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Eine Seite von Bewertungen. | ReviewList (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Bewertung erhalten
Eine Überprüfung. Eine Playlist-Änderung fügt preview hinzu: die Live- und die vorgeschlagene Playlist in der gespeicherten Form (Seiten mit resolved_media); live ist bei einer Erstellung null. Ein Bearer, der die Art der Überprüfung nicht lesen kann (siehe listReviews), erhält not_found, ebenso ein auf Bildschirme beschränkter Aufrufer bei einer Überprüfung, deren Reichweite nicht innerhalb seines Bereichs liegt.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reviews/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Überprüfung. | Überprüfung (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Review finden
Das Projekt, zu dem eine Überprüfung gehört, für den E-Mail-Link: Eine angemeldete Person, die Mitglied dieses Projekts ist, erhält dessen ID und Namen und wechselt zu diesem (PUT /api/session/project), bevor sie die Überprüfung liest. Alle anderen erhalten not_found. Funktioniert unabhängig vom ausgewählten Projekt der Sitzung.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reviews/RESOURCE_ID/locate'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Das Projekt der Überprüfung. | ReviewLocation (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Prüfung genehmigen
Genehmigt eine ausstehende Prüfung als Person, die genehmigen kann (Projektinhaber oder Mitglied mit can_approve; sonst approver_required). Das Flag wird innerhalb der Transaktion der Entscheidung erneut gelesen, sodass eine Person, deren Genehmigung inzwischen deaktiviert wurde, nichts entscheidet (approver_required). Schatten-Sitzungen des Personals können nicht entscheiden.
Ein Playlist-Update wird mit der Basisrevision als If-Match angewendet; wenn die Live-Playlist weitergegangen ist, wird die Überprüfung veraltet und der Aufruf antwortet mit review_stale.
Eine Erstellung oder Aktualisierung, deren Tag, Ordner oder alle Selektoren jetzt Medien abspielen würden, die sie bei Vorschlag nicht aufgelöst haben, die die Überprüfung nicht benennt und die die Live-Version noch nicht abspielt, wird ebenfalls veraltet (review_stale).
Eine Bildschirmänderung spielt ihre gespeicherte Anfrage erneut ab (ein Tag wird jetzt aufgelöst): Der Aufruf wendet Bildschirme für einige Sekunden an, der Rest läuft im Hintergrund weiter, während screen_change.result.applying wahr ist.
Eine Bildschirmänderung, die auf eine ausstehende Playlist-Review wartet, antwortet mit review_blocked und benennt sie; eine deren Playlist keine genehmigte Version hat, antwortet mit playlist_not_approved. include_dependents genehmigt auch in der Reihenfolge die Bildschirmänderungen, die auf diese Playlist-Review warten. Ereignisse der angewendeten Änderung tragen die Person als Akteur und den vorschlagenden Agenten als Agent.
Die Antwort trägt Warnungen (PlaylistWarning): screen_fact_missing, wenn die genehmigte Änderung Seiten, deren iframe src oder Anwendungsparameter ein Bildschirm-Token lesen, auf Bildschirme bringt, denen es fehlt. Eine entschiedene Prüfung ist review_not_pending; dieselbe Entscheidung zu wiederholen, wird wiedergegeben.
Eine als geschützt markierte Überprüfung (eine protected_change oder eine screen_change, die einen geschützten Bildschirm erreichte) wird von einer genehmigenden Person entschieden, die weder die vorschlagende Person noch die für den vorschlagenden Agenten verantwortliche Person ist: sonst second_approver_required (403), ebenso wenn die vorschlagende Person keiner Person zugeordnet werden kann (docs/screen-scope.md).
Eine auf Bildschirme beschränkte genehmigende Person entscheidet nur eine Überprüfung, deren gesamte Reichweite innerhalb des Bereichs liegt (outside_screen_scope, 403). Eine protected_change wird durch diese Anfrage als die genehmigende Person bei der Revision angewendet, gegen die sie vorgeschlagen wurde; eine Kampagne oder ein Ordner, die sich seither geändert haben oder verschwunden sind, oder Bildschirme, die weitergezogen sind, machen die Überprüfung veraltet (review_stale, 409).
Ein abhängiges Element, das nicht genehmigt werden kann, meldet dieselben Codes in dependents[].problem.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | |
| Idempotency-Key | Überschrift | optional | Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| include_dependents (optional, boolean) | Genehmigen Sie auch in der Reihenfolge die Bildschirmänderungen, die auf diese Playlist-Bewertung warten. |
Anfragevorlage und Antworten
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/reviews/RESOURCE_ID/approve'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die genehmigte Überprüfung und die Ergebnisse der Abhängigen. | ReviewDecisionResult (application/json) |
| 403 | approver_required, second_approver_required oder outside_screen_scope. | Problem (application/problem+json) |
| 409 | review_not_pending, review_stale, review_blocked oder playlist_not_approved. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Überprüfung ablehnen
Lehnt eine ausstehende Überprüfung mit einer Begründung ab, die die vorschlagende Person liest. Nur genehmigende Personen, wie bei approveReview; eine auf Bildschirme beschränkte genehmigende Person entscheidet nur eine Überprüfung innerhalb ihres Bereichs (outside_screen_scope), und keine auf Bildschirme beschränkte Person entscheidet ein Werbekreativ. Auf dem Display ändert sich nichts; eine abgelehnte Playlist-Erstellung bleibt nicht genehmigt.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | |
| Idempotency-Key | Überschrift | optional | Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Grund (erforderlich, Zeichenkette) | minLength: 1 maxLength: 500 |
Anfragevorlage und Antworten
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/reviews/RESOURCE_ID/reject'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die abgelehnte Überprüfung. | ReviewDecisionResult (application/json) |
| 403 | outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Überprüfungsänderungen anfordern
Bittet die vorschlagende Person um Änderungen mit einer Notiz, die sie liest; die vorschlagende Person schlägt erneut vor. Nur genehmigende Personen, wie bei approveReview. Bei einem Werbekreativ liest der Käufer die Notiz am Kreativ. Eine genehmigende Person mit Bereich ist wie bei rejectReview beschränkt.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | |
| Idempotency-Key | Überschrift | optional | Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Notiz (erforderlich, Zeichenkette) | minLength: 1 maxLength: 500 |
Anfragevorlage und Antworten
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/reviews/RESOURCE_ID/request-changes'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Überprüfung, Status changes_requested. | ReviewDecisionResult (application/json) |
| 403 | outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Überprüfung zurückziehen
Zieht eine ausstehende Playlist-, Bildschirm- oder protected_change-Überprüfung zurück. Ein Bearer zieht nur zurück, was sein eigener Agent oder Service-Client vorgeschlagen hat (sonst forbidden); eine Person zieht als genehmigende Person oder als verantwortliche Person des Vorschlagenden zurück; eine auf Bildschirme beschränkte Person zieht nur eine Überprüfung innerhalb ihres Bereichs zurück (outside_screen_scope).
Eine zurückgezogene Playlist-Erstellung bleibt nicht genehmigt.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich | |
| Idempotency-Key | Überschrift | optional | Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reviews/RESOURCE_ID/withdraw'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die zurückgezogene Überprüfung. | ReviewDecisionResult (application/json) |
| 403 | outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |