OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 46 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.
Private Werbenetzwerke und Kampagnen
Werbenetzwerk abrufen
Das Netzwerk des anrufenden Verkäufers, einschließlich der berechneten ScreenRig-Bereitstellungsgebühr. Verkäufer können diese Gebühr nicht ändern.
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. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/network'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Netzwerk. | AdvertisingNetwork (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) |
Werbenetzwerk erstellen
Erstellt das eine Netzwerk des aufrufenden Verkäufers, falls nicht vorhanden. Erfordert screens=true. Idempotent; Wiederholungen geben dasselbe Netzwerk zurück.
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. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (erforderlich, Zeichenkette) | maxLength: 120 |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/network'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Netzwerk. | AdvertisingNetwork (application/json) |
| 403 | verboten – das Projekt verfügt nicht über Bildschirmfunktionalität oder hat einen unbekannten Tarif. | 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) |
Standard-Werbesatz festlegen
Setzt den Standardtarif des Verkäufers pro 15 Sekunden abgeschlossener Wiedergabe im Projekt. Eine Änderung, die den effektiven Tarif einer akzeptierten Kampagne ändert, pausiert diese gesamte Kampagne mit price_change_pending; eine maskierte oder wirkungslose Änderung nicht. If-Match trägt die Netzwerkrevision.
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. |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| rate_mcr_per_15s (erforderlich, McrString) | Exakte ganze Millicredit-Menge als kanonische Dezimalzeichenfolge. 1 Credit entspricht 1000 mcr. Muster: "^-?[0-9]+$" |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/network/rate'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Netzwerk aktualisiert. | AdvertisingNetwork (application/json) |
| 412 | revision_conflict – If-Match ist veraltet. | 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) |
Werbeinventar auflisten
Das vom anrufenden Verkäufer ausgewählte Inventar.
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. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/inventory'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Inventar. | AdvertisingInventoryList (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) |
Werbeinventar einstellen
Legt das Inventar eines eigenen Bildschirms an oder aktualisiert es. Prüft den Besitz des Bildschirms. Ein rate-Override von null stellt die Vererbung wieder her, nicht null. Eine Änderung, die den effektiven Tarif einer akzeptierten Kampagne ändert, pausiert diese Kampagne. Ein Bildschirm in einem geschützten Bildschirmordner ist protected_target (409).
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. |
| screen_id | Pfad | erforderlich | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
| 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 |
|---|---|
| impressions_per_hour (optional, inline) | Die Schätzung des Verkäufers für die Impressionen, die dieser Bildschirm in einer Stunde liefert. Jede abgeschlossene Wiedergabe zählt diesen Wert mal ihre Sekunden geteilt durch 3600 als geschätzte Impressionen in Berichten. Null oder fehlend bedeutet keine Schätzung. |
| ads_enabled (erforderlich, Boolean) | |
| site_name (optional, Zeichenfolge) | maxLength: 120 |
| Stadt (optional, Zeichenfolge) | maxLength: 120 |
| Region (optional, Zeichenkette) | maxLength: 120 |
| venue_type (optional, string) | maxLength: 64 |
| audience_tags (optional, array) | |
| Platzierung (optional, Zeichenfolge) | maxLength: 120 |
| public_description (optional, Zeichenkette) | maxLength: 500 |
| rate_override_mcr_per_15s (optional, inline) | Null stellt die Vererbung vom Projektstandard wieder her; es bedeutet niemals Null. |
Anfragevorlage und Antworten
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/inventory/SCREEN_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Gespeicherter Bestand. | AdvertisingInventory (application/json) |
| 403 | forbidden - der Bildschirm gehört nicht zu diesem Projekt; outside_screen_scope oder approver_required bei einem auf Bildschirme beschränkten Aufrufer. | Problem (application/problem+json) |
| 409 | protected_target - der Bildschirm liegt in einem geschützten Bildschirmordner, und die Änderung hat kein Überprüfungsformular (docs/screen-scope.md); heben Sie den Schutz des Ordners über eine Überprüfung auf, nehmen Sie die Änderung vor und schützen Sie den Ordner wieder. | Problem (application/problem+json) |
| 412 | revision_conflict. | 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) |
Werbeplätze auflisten
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. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/slots'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Slots. | AdvertisingSlotList (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) |
Werbeplatz erstellen
Erstellt einen wiederverwendbaren Verkäuferplatz. Bilder dauern 5-30 Sekunden, Videos höchstens die Plattformbegrenzung von 120 Sekunden. Anzeigen sind immer stummgeschaltet.
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. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (erforderlich, Zeichenkette) | minLength: 1 maxLength: 120 |
| aktiviert (optional, Boolean) | |
| accepted_media (erforderlich, Array) | |
| max_image_duration_ms (erforderlich, Ganzzahl) | Minimum: 5000 Maximum: 30000 |
| max_video_duration_ms (erforderlich, Ganzzahl) | Minimum: 1000 Maximum: 120000 |
| rate_override_mcr_per_15s (optional, inline) | |
| vast_tag_url (optional, inline) | Der eigene VAST 2-4-Werbetag des Verkäufers, der versucht wird, wenn keine eingeladene Kampagne diesen Slot auf den eigenen Bildschirmen des Verkäufers füllt. Nur HTTPS auf Port 443 oder 8443 zu einem öffentlichen Host. Das Backend ruft es ab, folgt bis zu fünf Wrappers, nimmt die gewählte progressive MP4- oder WebM-Mediendatei in die Medien des Projekts auf und feuert Impression, creativeView und start bei akzeptiertem Start, complete bei akzeptiertem Abschluss und Error bei Fehlern. Quartile-Tracker werden nicht ausgelöst. Makros [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] und [SCREENRIG_PAGE_ID] werden erweitert. Der Slot muss Video akzeptieren. Null, abwesend oder leer löscht das Tag. Käufer sehen es nie. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/slots'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Slotslot. | AdvertisingSlot (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) |
Werbeslot aktualisieren
Aktualisiert einen Verkäufer-Slot. If-Match enthält die Slot-Revision. Eine Preisüberschreibung prüft die Preisgrenze erneut. Ein optionaler Idempotency-Key wiederholt 24 Stunden lang das ursprünglich gespeicherte Ergebnis für denselben Slot, Body und If-Match, auch nach späteren Änderungen. Geänderte Wiederverwendung liefert idempotency_mismatch. Ein neuer veralteter Schreibzugriff liefert revision_conflict.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
| 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 |
|---|---|
| Name (erforderlich, Zeichenkette) | minLength: 1 maxLength: 120 |
| aktiviert (optional, Boolean) | |
| accepted_media (erforderlich, Array) | |
| max_image_duration_ms (erforderlich, Ganzzahl) | Minimum: 5000 Maximum: 30000 |
| max_video_duration_ms (erforderlich, Ganzzahl) | Minimum: 1000 Maximum: 120000 |
| rate_override_mcr_per_15s (optional, inline) | |
| vast_tag_url (optional, inline) | Der eigene VAST 2-4-Werbetag des Verkäufers, der versucht wird, wenn keine eingeladene Kampagne diesen Slot auf den eigenen Bildschirmen des Verkäufers füllt. Nur HTTPS auf Port 443 oder 8443 zu einem öffentlichen Host. Das Backend ruft es ab, folgt bis zu fünf Wrappers, nimmt die gewählte progressive MP4- oder WebM-Mediendatei in die Medien des Projekts auf und feuert Impression, creativeView und start bei akzeptiertem Start, complete bei akzeptiertem Abschluss und Error bei Fehlern. Quartile-Tracker werden nicht ausgelöst. Makros [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] und [SCREENRIG_PAGE_ID] werden erweitert. Der Slot muss Video akzeptieren. Null, abwesend oder leer löscht das Tag. Käufer sehen es nie. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/slots/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Slot aktualisiert. | AdvertisingSlot (application/json) |
| 409 | idempotency_mismatch. | Problem (application/problem+json) |
| 412 | revision_conflict. | 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) |
Werbemitgliedschaften auflisten
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. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/memberships'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Mitgliedschaften. | AdvertisingMembershipList (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) |
Werbemitgliedschaft aktualisieren
Explizite Verkäufer-Richtlinien-/Bereichsbearbeitung. Eine aktive Mitgliedschaft wird hier geändert, niemals durch das Senden einer zweiten Einladung. Bereichsänderungen stoppen neue Auswahl; die finanzielle Historie bleibt erhalten.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Richtlinie (erforderlich, Zeichenfolge) | Erlaubt: "trusted", "review_required" |
| screen_ids (erforderlich, Array) | |
| slot_ids (erforderlich, Array) |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/memberships/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Mitgliedschaft aktualisiert. | AdvertisingMembership (application/json) |
| 412 | revision_conflict. | 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) |
Werbemitgliedschaft widerrufen
Widerruft eine Mitgliedschaft. Stoppt die neue Auswahl für dieses Netzwerk; das Werbetreibenden-Flag, andere Mitgliedschaften oder abgeschlossene Historien werden nicht gelöscht.
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 POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/memberships/RESOURCE_ID/revoke'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Widerrufene Mitgliedschaft. | AdvertisingMembership (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) |
Gemeinsame Werbenetzwerke auflisten
Netzwerke, denen der aufrufende Werbetreibende derzeit angehört, mit dem Umfang und der Überprüfungspolitik, die ihm gewährt wurden. Die Bildschirmanzahl ist keine garantierte Impressionenzahl.
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. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/networks'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Beigetretene Netzwerke. | AdvertisingJoinedNetworkList (application/json) |
| 403 | verboten – dem Projekt fehlt das Werbetreibenden-Flag. | 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) |
Gemeinsames Werbeinventar auflisten
Ausgewähltes Inventar und wiederverwendbare Slots innerhalb der Mitgliedschaft des Anrufers. Zeigt niemals Screenshots, Playlists oder projektweite Daten des Verkäufers an.
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. |
| seller_project_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/advertising/networks/SELLER_PROJECT_ID/inventory'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Erlaubte Bestände und Slots. | AdvertisingJoinedInventory (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) |
Werbekreativen auflisten
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. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/creatives'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Kreative. | AdvertisingCreativeList (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) |
Werbemittel erstellen
Bindet eine fertige, eigene Medienrevision an eine unveränderliche Kreativität. Kopiert keine Bytes, lädt nicht erneut hoch und berechnet keine neue Generation. Unbekannte oder nicht fertige Medien werden abgelehnt.
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. |
| 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 |
|---|---|
| media_id (erforderlich, Zeichenkette) | |
| copy (optional, Zeichenfolge) | maxLength: 500 |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/creatives'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Kreativ. | AdvertisingCreative (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) |
Werbekreative abrufen
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/advertising/creatives/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Kreativ. | AdvertisingCreative (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) |
Werbekampagnen des Verkäufers auflisten
Die eingereichten Käuferkampagnen des aufrufenden Verkäufers, einschließlich Kampagnen ohne Plays und des Verlaufs nach dem Widerruf des Käuferzugriffs. Gibt höchstens 100 Kampagnen in ID-Reihenfolge zurück. Entwürfe, andere Netzwerke und die Gesamtbudgets des Käufers sind privat. Folgen Sie next_after mit after, bis es fehlt.
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. |
| nach | Abfrage | optional | Das next_after der vorherigen Seite. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/seller-campaigns'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Eingereichte Käuferkampagnen im Netzwerk dieses Verkäufers. | AdvertisingSellerCampaignList (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) |
Werbekampagne des Verkäufers abrufen
Die schreibgeschützte Verkäuferansicht einer eingereichten Käuferkampagne. Inventar und die über die gesamte Laufzeit abgerechnete Auslieferung betreffen nur den aufrufenden Verkäufer. Die Finanzen des Käufers insgesamt und andere Netzwerke sind privat. Ein unbeteiligter Verkäufer erhält not_found.
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/advertising/seller-campaigns/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Kampagnen- und Auslieferungsdetails des Verkäufers. | AdvertisingSellerCampaignDetail (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) |
Werbekampagnen auflisten
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. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Kampagnen. | AdvertisingCampaignList (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) |
Werbekampagne erstellen
Erstellt eine Entwurfskampagne. Entwürfe enthalten kein Geld, reservieren nichts und autorisieren keine Auslieferung. Die Aktivierung erfordert ein ausdrücklich akzeptiertes Angebot.
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. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (erforderlich, Zeichenkette) | minLength: 1 maxLength: 120 |
| category (optional, AdvertisingCategory) | Die Kategorie des Werbetreibenden. Zwei Anzeigen einer Kategorie laufen auf einem Bildschirm nie im selben Werbeblock; eine Anzeige ohne Kategorie wird nie getrennt. Erlaubt: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities" |
| daily_cap_mcr (erforderlich, McrString) | Exakte ganze Millicredit-Menge als kanonische Dezimalzeichenfolge. 1 Credit entspricht 1000 mcr. Muster: "^-?[0-9]+$" |
| lifetime_cap_mcr (erforderlich, McrString) | Exakte ganze Millicredit-Menge als kanonische Dezimalzeichenfolge. 1 Credit entspricht 1000 mcr. Muster: "^-?[0-9]+$" |
| image_duration_ms (optional, integer) | Kampagnenweite Bildanzeigedauer. Videos behalten ihre serverbestätigte Dauer. Standard: 10000 Minimum: 5000 Maximum: 30000 |
| max_play_price_mcr (optional, Inline) | Positiver maximaler Preis für abgeschlossene Wiedergabe. Weglassen für keine zusätzliche Obergrenze. |
| flight_start (erforderlich, Zeichenkette) | Format: "date-time" |
| flight_end (erforderlich, Zeichenkette) | Format: "date-time" |
| Netzwerke (erforderlich, Array) |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Entwurfskampagne. | AdvertisingCampaign (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) |
Werbekampagne abrufen
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/advertising/campaigns/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Kampagne. | AdvertisingCampaign (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) |
Werbekampagne aktualisieren
Entwurf einer Kampagne aktualisieren. If-Match enthält die Kampagnenrevision. Eine Budgetkürzung unter bereits ausgegebenes plus reserviertes Budget wird mit dem minimal erlaubten Wert abgelehnt.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (erforderlich, Zeichenkette) | minLength: 1 maxLength: 120 |
| category (optional, AdvertisingCategory) | Die Kategorie des Werbetreibenden. Zwei Anzeigen einer Kategorie laufen auf einem Bildschirm nie im selben Werbeblock; eine Anzeige ohne Kategorie wird nie getrennt. Erlaubt: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities" |
| daily_cap_mcr (erforderlich, McrString) | Exakte ganze Millicredit-Menge als kanonische Dezimalzeichenfolge. 1 Credit entspricht 1000 mcr. Muster: "^-?[0-9]+$" |
| lifetime_cap_mcr (erforderlich, McrString) | Exakte ganze Millicredit-Menge als kanonische Dezimalzeichenfolge. 1 Credit entspricht 1000 mcr. Muster: "^-?[0-9]+$" |
| image_duration_ms (optional, integer) | Kampagnenweite Bildanzeigedauer. Videos behalten ihre serverbestätigte Dauer. Standard: 10000 Minimum: 5000 Maximum: 30000 |
| max_play_price_mcr (optional, Inline) | Positiver maximaler Preis für abgeschlossene Wiedergabe. Weglassen für keine zusätzliche Obergrenze. |
| flight_start (erforderlich, Zeichenkette) | Format: "date-time" |
| flight_end (erforderlich, Zeichenkette) | Format: "date-time" |
| Netzwerke (erforderlich, Array) |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Kampagne aktualisiert. | AdvertisingCampaign (application/json) |
| 412 | revision_conflict. | 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) |
Angebot Werbekampagne
Bewertet die aktuellen effektiven Tarife, Formate, Dauern, Laufzeiten und Limits der Kampagne vor der Aktivierung. Das Angebot ist zeitlich begrenzt und wird ungültig, sobald eine Preisgenerierung oder ein effektiver Tarif geändert wird.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/quote'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Angebot. | AdvertisingQuote (application/json) |
| 412 | revision_conflict. | 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) |
Werbekampagne aktivieren
Akzeptiert explizit das benannte aktuelle Angebot und aktiviert die Kampagne. Prüft atomar Eigentum, Mitgliedschaft, Angebotsablauf, Tarifrevisionen, akzeptierten Bereich und Ablehnung bei gleichem Projekt, dann werden Kaufbedingungen aufgezeichnet. Es erfolgt keine Wallet-Belastung und kein Verkäuferumsatz durch die Annahme der Bedingungen. Derselbe Schlüssel mit demselben Body wird wiederholt; ein geänderter Body ist ein Konflikt.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
| 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 |
|---|---|
| quote_id (erforderlich, Zeichenkette) |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/activate'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Aktive oder zur Überprüfung ausstehende Kampagne. | AdvertisingCampaign (application/json) |
| 409 | quote_stale oder self_deal oder resource_conflict. | 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) |
Werbekampagne pausieren
Pausiert neue Reservierungen für diese Kampagne. Bereits gestartete gültige Anzeigen werden normalerweise beendet und nach Abschluss abgerechnet.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/pause'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Kampagne pausiert. | AdvertisingCampaign (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) |
Werbekampagne fortsetzen
Setzt eine manuell pausierte Kampagne fort. Sie kann eine Sperre wegen price_change_pending nicht aufheben; eine Aufladung, ein Zeitplan-Tick oder eine Verkäuferaktion kann diese Zustimmung nicht liefern.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/resume'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Kampagne fortgesetzt. | AdvertisingCampaign (application/json) |
| 409 | price_change_pending - Bitte zuerst die aktuellen Tarife akzeptieren. | 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) |
Werbepreise akzeptieren
Die ausdrückliche Zustimmung des Käufers zu geänderten effektiven Preisen, gebunden an Angebots-ID, Kampagnenrevision und aktuelle Preisgenerationen. Sie ersetzt atomar zukünftige Lieferbedingungen, protokolliert den Akteur und die Zeit und hebt die blockierende Preisänderung auf. Eine weitere gleichzeitige Preisänderung pausiert die Kampagne.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| quote_id (erforderlich, Zeichenkette) |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/accept-rates'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Reaktivierte Kampagne. | AdvertisingCampaign (application/json) |
| 409 | price_change_pending oder quote_stale. | 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) |
Werbebewertungen auflisten
Kreativversionen, die dem aufrufenden Verkäufer zur Prüfung vorgelegt werden. Ein Verkäufer sieht nur exakt eingereichte Kreative, niemals die Bibliothek des Käufers.
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. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Überprüfungen. | AdvertisingReviewList (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) |
Werbeprüfung genehmigen
Genehmigt eine genaue eingereichte kreative Überarbeitung. Die Genehmigung wählt nicht das Budget des Käufers oder gewährt Zugriff auf dessen Medienbibliothek. Eine Person muss in der Lage sein, Bewertungen zu genehmigen (approver_required). Dieselbe Bewertung ist auch als Typ ad_creative unter /api/reviews. erreichbar.
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 POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/approve'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Genehmigte Prüfung. | AdvertisingReview (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) |
Werbeüberprüfung ablehnen
Lehnt eine genau eingereichte kreative Überarbeitung mit einem Grund ab, den der Käufer auf der Kreativität liest. Eine Person muss Überprüfungen genehmigen können (approver_required).
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 |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Grund (erforderlich, Zeichenkette) | minLength: 1 maxLength: 500 |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/reject'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Abgelehnte Überprüfung. | AdvertisingReview (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) |
Werbeausgaben abrufen
Käuferbezogene Ausgaben- und Lieferzahlen für eine Kampagne. Beträge sind dezimale mcr-Strings. Es werden niemals die Einnahmen des Verkäufers, der Bankstatus oder die projektweite Nutzung offengelegt.
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. |
| Format | Abfrage | optional | json (Standard) liefert den Bericht als JSON. csv, xlsx und pdf liefern dieselben Zeilen als Dateianhang (jede Seite eines seitenweisen Berichts, bis zu 50000 Zeilen). |
| campaign_id | Abfrage | erforderlich |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/spend?campaign_id=CAMPAIGN_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Ausgabenbericht. | AdvertisingSpendReport (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) |
Werbelieferung abrufen
Brutto, Servicegebühr und Netto des Verkäufers für ein Fenster mit eigenem Liefernachweis. Es werden niemals die Brieftasche des Käufers oder andere Netzwerke offengelegt. Nur autorisierte Nachweise über abgeschlossene Wiedergaben begründen eine abrechenbare Lieferung. Das Fenster ist höchstens 92 Tage; ein größeres Fenster ist invalid_request.
Wenn mehr als 5000 Abrechnungen vorliegen, setzt die Antwort truncated, Summen und Zählungen decken dennoch alle ab und Zeilen listen nur die frühesten 5000 auf.
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. |
| Format | Abfrage | optional | json (Standard) liefert den Bericht als JSON. csv, xlsx und pdf liefern dieselben Zeilen als Dateianhang (jede Seite eines seitenweisen Berichts, bis zu 50000 Zeilen). |
| von | Abfrage | erforderlich | |
| bis | Abfrage | erforderlich |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/delivery?from=FROM&to=TO'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Zustellungsbericht. | AdvertisingDeliveryReport (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) |
Werbe-Direktkampagnen auflisten
Die Direktkampagnen des aufrufenden Verkäufers, neueste zuerst, mit ihrem Pacing.
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. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Direktkampagnen. | AdvertisingDirectCampaignList (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) |
Werbe-Direktkampagne erstellen
Bucht eine Direktkampagne, ein Geschäft, das der Verkäufer mit einem externen Werbetreibenden geschlossen hat, auf dem eigenen Werbeinventar des Verkäufers. Sie bewegt kein Geld; der Verkäufer stellt dem Werbetreibenden Rechnung, und der Preis wird für den Wert im Bericht erfasst. Sie ist sofort aktiv und befüllt Slots vor Marktplatzkampagnen.
Eine Kampagne mit Ziel wird gleichmäßig über ihre Laufzeit getaktet und spielt zuerst, solange sie hinter dem Pacing liegt; eine Kampagne ohne Ziel nimmt während ihrer Laufzeit jeden berechtigten Slot. Zwei Anzeigen einer Kategorie laufen auf einem Bildschirm nie im selben Werbeblock. Ein Ziel über der Verfügbarkeitsschätzung wird mit goal_overbooked abgelehnt, sofern overbook nicht true ist.
Derselbe Schlüssel mit demselben Body wird wiederholt beantwortet; ein geänderter Body ist ein Konflikt.
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. |
| Idempotency-Key | Überschrift | erforderlich |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (erforderlich, Zeichenkette) | minLength: 1 maxLength: 200 |
| advertiser (erforderlich, string) | minLength: 1 maxLength: 200 |
| category (optional, AdvertisingCategory) | Die Kategorie des Werbetreibenden. Zwei Anzeigen einer Kategorie laufen auf einem Bildschirm nie im selben Werbeblock; eine Anzeige ohne Kategorie wird nie getrennt. Erlaubt: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities" |
| flight_start (erforderlich, Zeichenkette) | Format: "date-time" |
| flight_end (erforderlich, Zeichenkette) | Format: "date-time" |
| goal_plays (optional, integer) | Die auszuliefernden Wiedergaben, gleichmäßig über die Laufzeit getaktet. Null oder weggelassen nimmt jeden berechtigten Slot während der Laufzeit. Minimum: 0 Maximum: 1000000000000 |
| price (optional, AdvertisingDirectPrice) | Der vom Verkäufer erfasste Preis des Geschäfts. screenRIG berechnet ihn nie; er bewertet den Bericht. |
| media_ids (erforderlich, array) | Die bereiten Bilder und Videos des Verkäufers, jedes einmal genannt. |
| image_duration_ms (optional, integer) | Kampagnenweite Bildanzeigedauer. Videos behalten ihre serverbestätigte Dauer. Standard: 10000 Minimum: 5000 Maximum: 30000 |
| screen_ids (optional, array) | Leer bedeutet jeden teilnehmenden Bildschirm. |
| slot_ids (optional, array) | Leer bedeutet jeden aktivierten Slot. |
| venue_types (optional, array) | |
| cities (optional, array) | |
| tags (optional, array) | |
| dayparts (optional, array) | |
| overbook (optional, boolean) | Bucht ein Ziel über der Verfügbarkeitsschätzung. Ohne dies wird die Anfrage mit goal_overbooked abgelehnt. Standard: false |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/direct-campaigns'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Direktkampagne. | AdvertisingDirectCampaign (application/json) |
| 402 | feature_not_in_plan — der Plan des Projekts enthält keine Direktkampagnen; required_plan nennt den Plan, der sie enthält. | Problem (application/problem+json) |
| 409 | goal_overbooked oder resource_conflict. | 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) |
Werbe-Direktkampagne abrufen
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/advertising/direct-campaigns/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Direktkampagne. | AdvertisingDirectCampaign (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) |
Werbe-Direktkampagne aktualisieren
Ersetzt die Entwurfsfelder der Kampagne. If-Match enthält die Kampagnenrevision. Ausgelieferte Wiedergaben bleiben erhalten. Die noch auszuliefernden Wiedergaben werden gegen die Verfügbarkeitsschätzung geprüft, wobei die eigene Buchung der Kampagne außen vor bleibt, und overbook bucht sie trotzdem.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (erforderlich, Zeichenkette) | minLength: 1 maxLength: 200 |
| advertiser (erforderlich, string) | minLength: 1 maxLength: 200 |
| category (optional, AdvertisingCategory) | Die Kategorie des Werbetreibenden. Zwei Anzeigen einer Kategorie laufen auf einem Bildschirm nie im selben Werbeblock; eine Anzeige ohne Kategorie wird nie getrennt. Erlaubt: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities" |
| flight_start (erforderlich, Zeichenkette) | Format: "date-time" |
| flight_end (erforderlich, Zeichenkette) | Format: "date-time" |
| goal_plays (optional, integer) | Die auszuliefernden Wiedergaben, gleichmäßig über die Laufzeit getaktet. Null oder weggelassen nimmt jeden berechtigten Slot während der Laufzeit. Minimum: 0 Maximum: 1000000000000 |
| price (optional, AdvertisingDirectPrice) | Der vom Verkäufer erfasste Preis des Geschäfts. screenRIG berechnet ihn nie; er bewertet den Bericht. |
| media_ids (erforderlich, array) | Die bereiten Bilder und Videos des Verkäufers, jedes einmal genannt. |
| image_duration_ms (optional, integer) | Kampagnenweite Bildanzeigedauer. Videos behalten ihre serverbestätigte Dauer. Standard: 10000 Minimum: 5000 Maximum: 30000 |
| screen_ids (optional, array) | Leer bedeutet jeden teilnehmenden Bildschirm. |
| slot_ids (optional, array) | Leer bedeutet jeden aktivierten Slot. |
| venue_types (optional, array) | |
| cities (optional, array) | |
| tags (optional, array) | |
| dayparts (optional, array) | |
| overbook (optional, boolean) | Bucht ein Ziel über der Verfügbarkeitsschätzung. Ohne dies wird die Anfrage mit goal_overbooked abgelehnt. Standard: false |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Aktualisierte Direktkampagne. | AdvertisingDirectCampaign (application/json) |
| 402 | feature_not_in_plan — der Plan des Projekts enthält keine Direktkampagnen; required_plan nennt den Plan, der sie enthält. | Problem (application/problem+json) |
| 409 | goal_overbooked oder resource_conflict. | Problem (application/problem+json) |
| 412 | revision_conflict. | 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) |
Werbe-Direktkampagne pausieren
Stoppt neue Wiedergaben einer aktiven Kampagne. Ausgelieferte Wiedergaben und die Laufzeit bleiben erhalten. Eine pausierte oder beendete Kampagne ist ein resource_conflict.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/pause'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Pausierte Direktkampagne. | AdvertisingDirectCampaign (application/json) |
| 412 | revision_conflict. | 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) |
Werbe-Direktkampagne fortsetzen
Setzt eine pausierte Direktkampagne fort. Eine Kampagne mit Ziel, die während der Pause hinter das Pacing zurückgefallen ist, spielt zuerst, bis sie wieder im Pacing liegt. Eine aktive oder beendete Kampagne ist ein resource_conflict.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/resume'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Fortgesetzte Direktkampagne. | AdvertisingDirectCampaign (application/json) |
| 402 | feature_not_in_plan — der Plan des Projekts enthält keine Direktkampagnen; required_plan nennt den Plan, der sie enthält. | Problem (application/problem+json) |
| 412 | revision_conflict. | 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) |
Werbe-Direktkampagne beenden
Beendet eine aktive oder pausierte Kampagne vor dem Ende ihrer Laufzeit. Eine beendete Kampagne spielt nicht mehr und behält ihren Bericht.
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 | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/end'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Beendete Direktkampagne. | AdvertisingDirectCampaign (application/json) |
| 412 | revision_conflict. | 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) |
Bericht der Werbe-Direktkampagne abrufen
Die Auslieferung einer Direktkampagne für ein Fenster, mit ihrem Pacing, dem erfassten Wert der ausgelieferten Wiedergaben und Zeilen nach UTC-Tag, Bildschirm, Slot und Medium. Ohne from und to ist das Fenster die gesamte Laufzeit. Enthält das Fenster mehr Zeilen, als der Bericht auflistet, setzt die Antwort truncated, und die Summen decken weiterhin jede Wiedergabe ab.
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. |
| Format | Abfrage | optional | json (Standard) liefert den Bericht als JSON. csv, xlsx und pdf liefern dieselben Zeilen als Dateianhang (jede Seite eines seitenweisen Berichts, bis zu 50000 Zeilen). |
| id | Pfad | erforderlich | |
| von | Abfrage | optional | |
| bis | Abfrage | optional |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/report'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Bericht der Direktkampagne. | AdvertisingDirectReport (application/json) |
| 402 | feature_not_in_plan — der Plan des Projekts enthält keine Direktkampagnen; required_plan nennt den Plan, der sie enthält. | 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) |
Werbeverfügbarkeit schätzen
Schätzt die Wiedergaben, die ein Direktziel auf dem angegebenen Inventar und in der angegebenen Laufzeit buchen kann. Es ist ein Lesevorgang und ändert nichts. Die Schätzung sind die jüngsten Werbeslot-Vorkommen der Zielbildschirme, hochgerechnet auf die Laufzeit, abzüglich der Ziele, die andere Direktkampagnen auf denselben Bildschirmen noch benötigen.
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. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| screen_ids (optional, array) | Leer bedeutet jeden teilnehmenden Bildschirm. |
| slot_ids (optional, array) | Leer bedeutet jeden aktivierten Slot. |
| venue_types (optional, array) | |
| cities (optional, array) | |
| tags (optional, array) | |
| dayparts (optional, array) | |
| flight_start (erforderlich, Zeichenkette) | Format: "date-time" |
| flight_end (erforderlich, Zeichenkette) | Format: "date-time" |
| exclude_campaign_id (optional, string) | Lässt die eigene Buchung dieser Direktkampagne bei booked_plays außen vor, für eine Bearbeitung. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/availability'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Verfügbarkeitsschätzung. | AdvertisingAvailability (application/json) |
| 402 | feature_not_in_plan — der Plan des Projekts enthält keine Direktkampagnen; required_plan nennt den Plan, der sie enthält. | 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) |
Werbe-Befüllungsstatistik abrufen
Das Werbeslot-Angebot des aufrufenden Verkäufers für ein Zeitfenster, pro UTC-Tag und insgesamt. Jedes Vorkommen wird durch eine direkte Kampagne, eine Marktplatzkampagne oder den VAST-Tag gefüllt oder bleibt mit Begründung ungefüllt. Das angefragte Fenster umfasst höchstens 35 Tage, standardmäßig die letzten 7. Das Angebot hat stündliche Genauigkeit.
Alle UTC-Stunden, die das angefragte halboffene Zeitfenster überlappen, werden vollständig einbezogen; from wird auf UTC-Stundengrenzen ab- und to aufgerundet. Ein bereits ausgerichtetes to bleibt exklusiv. Die Antwort liefert diese effektiven Grenzen, die bis zu 35 Tage plus eine Stunde umfassen können.
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. |
| Format | Abfrage | optional | json (Standard) liefert den Bericht als JSON. csv, xlsx und pdf liefern dieselben Zeilen als Dateianhang (jede Seite eines seitenweisen Berichts, bis zu 50000 Zeilen). |
| von | Abfrage | optional | |
| bis | Abfrage | optional |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/fill'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Befüllungsstatistik. | AdvertisingFillStats (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) |
Werbebewertung abrufen
Verkäuferdetails für eine Bewertung seines Netzwerks. Gibt die Bewertung und die exakt eingereichte kreative Version zurück. Es werden niemals andere Medien des Käufers offengelegt.
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/advertising/reviews/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Überprüfung und deren Kreativmaterial. | AdvertisingReviewDetail (application/json) |
| 404 | not_found - die Bewertung ist diesem Verkäufer unbekannt. | 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) |
Werbebewertungsinhalt abrufen
Streamt nur die exakte kreative Revision, auf die sich die eigene Überprüfung dieses Verkäufers bezieht. Das Eigentum bleibt beim Käuferprojekt; kein Objekt-Schlüssel oder signierter Speicherort wird veröffentlicht, und keine anderen Käufer-Medien sind erreichbar. Der ETag ist der starke SHA-256 der Kreativität und ändert sich nie für eine Überprüfung.
Eine Dashboard-Sitzungsantwort ist privat, no-cache, sodass der Browser eine Kopie behält und sie mit If-None-Match erneut validiert; eine Projekt-Bearer-Antwort bleibt privat, no-store.
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 | |
| Bereich | Überschrift | optional | V1 akzeptiert nur einen Bytebereich. |
| If-None-Match | Überschrift | optional | Starker kreativer SHA-256 ETag, der von dieser Route zurückgegeben wird. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/content'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die exakten Kreativbytes der Überprüfung. | kein Körper; Header: Accept-Ranges, Content-Length, ETag, Cache-Control |
| 206 | Ein standardkonformer Bytebereich. | kein Körper; Header: Content-Range, ETag, Cache-Control |
| 304 | Das ETag der Kreativität stimmt mit If-None-Match überein, geprüft nachdem die Überprüfung im Verkäuferprojekt abgeschlossen ist. Es wird kein Body oder Ausgangszähler erzeugt. | kein Körper; Header: ETag, Cache-Control |
| 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) |
Werbung überprüfen Inhalt
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 | |
| Bereich | Überschrift | optional | V1 akzeptiert nur einen Bytebereich. |
Anfragevorlage und Antworten
curl --request HEAD --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/content'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Nur Metadaten. | kein Körper; Header: Content-Length, ETag |
| 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) |
Werbeüberprüfungsänderungen anfordern
Der Verkäufer bittet den Käufer um Änderungen an einer eingereichten kreativen Revision. Die Überprüfung wird zu changes_requested mit der Notiz im Grund; der Käufer liest sie an der Kreativität, und die nächste Überprüfung, die die Kampagne für diesen Verkäufer öffnet, verknüpft previous_review_id. Eine Person muss Überprüfungen genehmigen können (approver_required).
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 |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Notiz (erforderlich, Zeichenkette) | minLength: 1 maxLength: 500 |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/request-changes'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Überprüfung, Status changes_requested. | AdvertisingReview (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) |