Projekte-API

Gibt aktuelle Bestätigungsdetails, Löschblocker und archivierte Geräte zurück, die getrennt werden. allowed ist false mit einem Grund, wenn der Aufrufer das Projekt nicht löschen darf (nur dessen Eigentümer oder ein Administrator der Organisation; für einen Agenten die verantwortliche Person) oder ein Blocker bleibt.

Der Inhaber überträgt das Eigentum an ein verifiziertes bestehendes Projektmitglied; dies gewährt keine neue Mitgliedschaft. Die Mitgliedschaft des neuen Inhabers verliert jedes screen_scope und upload_scope, sodass der neue Inhaber das gesamte Projekt erreicht.

Eine Dashboard-Sitzung eines Admins der Organisation des Projekts, der Mitglied ist, überträgt die Inhaberschaft auf dieselbe Weise, vom jeweiligen Projektinhaber aus; ein Organisations-Admin, der kein Mitglied ist, verwendet PUT /api/organizations/{org_id}/projects/{project_id}/owner.

Vom Eigentümer autorisierte Verschiebung überträgt Bildschirmbelegung und neue Nutzung atomar auf den Zielzahler; historische Gebühren behalten ihren Zahler. Ein Ziel, das bereits so viele aktive Projekte hat, wie sein Plan erlaubt, ergibt project_limit_reached, dessen required_plan den Plan mit Platz nennt, bei Enterprise nicht vorhanden.

Ziele auflisten, die der Inhaber verwaltet oder deren verifizierte Domain mit seiner verifizierten E-Mail übereinstimmt.

Jede aktive Mitgliedschaft der Identität mit Organisations- und Inhaber-Kontext auflisten, einschließlich Mitgliedschaften, die in diesem Token oder dessen Zustimmung ausgelassen sind. Jeder Eintrag markiert in_token; Discovery fügt keine Berechtigung hinzu und hat keine 64-Projekt-Grenze.

Erstellt ein benanntes Projekt, das der verifizierten verantwortlichen Person gehört. Ohne benannte Organisation wird es der Organisation der verifizierten Domain der Person zugeordnet, sonst der Organisation des aktuellen Projekts, sonst der Organisation, die die Person zuletzt unter denen verwaltet oder als ihre kostenlose besitzt, sonst einer neuen Organisation.

Ein Organisationsname wählt genau eine sichtbare Übereinstimmung aus, andernfalls wird eine neue Organisation erstellt. Eine Person besitzt eine kostenlose Standard-Organisation; eine neue Organisation darüber hinaus ist free_organization_limit, benannt nach der, die sie besitzt.

Eine Organisation hat höchstens so viele aktive Projekte, wie ihr Plan erlaubt (Standard 1, Plus 3, Premium 10, Education 50, Enterprise 100, erweitert durch ihre featuresets); ein weiteres ist project_limit_reached, dessen required_plan den Plan mit Platz nennt, bei Enterprise nicht vorhanden (Support kontaktieren).

Ein exakter idempotenter Wiederholungsversuch liefert seine versiegelte Mitgliedschaftsberechtigung für zehn Minuten erneut. Die Registrierung ist von der Begrenzung ausgenommen.

Unter einem Agenten-Zugriffs-JWT (Identitätsbereich, access:manage, eine Erlaubnis mit Identitätszugriff Manage) wird kein Projekttoken ausgegeben; das Projekt wird mit Manage und allen Berechtigungen der Erlaubnis hinzugefügt, und ein Refresh mit seiner project_id gibt ein Token dafür zurück.

Einladungs-Lebenszyklusdatensätze für das aktuelle Projekt auflisten, ohne Anmelderücksetzungen. Empfängeradressen sind für das besitzende Projekt sichtbar, das sie bereitgestellt hat. Tokens und Anmelde-URLs werden niemals aufgelistet.

Erstellt Einladungen für Mitglieder oder Anzeigenkäufer. E-Mail-Zustellung gibt niemals Zugangsdaten zurück. Link-Zustellung ist nur für Mitglieder und gibt eine URL zurück, auch bei genauem idempotentem Wiederholen innerhalb von 24 Stunden. E-Mail-Einladungen verfallen nach sieben Tagen; Links nach 24 Stunden. Ausstehende E-Mail-Einladungen desselben Typs, derselben Adresse und desselben Projekts werden wiederverwendet.

Ein auf Bildschirme beschränktes Mitglied lädt keine Personen ein (outside_screen_scope).

Eine project_member-Einladung per E-Mail an eine Person, die ein externer Gast der Organisation des Projekts wäre (es ist nicht ihre Heimatorganisation), unterliegt der Gastrichtlinie dieser Organisation, und guest_not_allowed (403) antwortet, wenn die Richtlinie (allow, domains oder none) die Adresse nicht zulässt. Die Annahme der Einladung prüft erneut.

Mitarbeiter und die eigenen Admins der Organisation sind ausgenommen. Ein screen_scope in der Einladung fällt unter den Bildschirmbereich, den der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

Widerruft eine ausstehende Einladung. Eine angenommene Einladung gibt invitation_consumed zurück. Ein auf Bildschirme beschränktes Mitglied widerruft keine Einladungen (outside_screen_scope).

Akzeptiert eine Anfrage zum Zurücksetzen der Anmeldung, ohne zu offenbaren, ob eine Person die Adresse besitzt.

Auch eine Person mit nicht verifizierter Adresse, etwa nach einer Selbstregistrierung, wird gefunden, und das Abschließen dieses Zurücksetzens, das der Inhaber des Posteingangs mit replace_unverified_account bestätigen muss, gibt diesem ein neues Konto (eine neue Person mit den Zugangsdaten des Zurücksetzens, eine neue Organisation und ein neues Projekt) und löscht die nicht verifizierte Person, für die niemand gezeigt hatte, dass die Adresse zu ihr gehört.

Ein Link zum Zurücksetzen läuft eine Stunde nach der letzten Anforderung ab. Solange der Link einer Person aktiv und weniger als einen Tag alt ist, sendet eine weitere Anforderung denselben Link erneut (höchstens einmal alle zehn Minuten) und verschiebt seinen Ablauf auf eine Stunde nach der Anforderung, sodass eine Anforderung den Link im Posteingang nie ungültig macht; andernfalls ersetzt ihn ein neuer Link. Es gibt kein Limit pro Adresse.

Das Abschließen eines Zurücksetzens entfernt die anderen Passkeys der Person (bei einem Zurücksetzen des Passworts alle Passkeys), entfernt das Passwort, wenn die neue Anmeldeinformation ein Passkey ist, verwirft eine ausstehende Änderung der E-Mail-Adresse und beendet jede Sitzung. Mit oder ohne Person sendet die Anfrage außerdem höchstens zehn an die E-Mail-Adresse gerichtete Einladungen erneut, jede Einladung höchstens einmal pro Stunde.

Von den zehn neuesten nicht gelöschten Projekten mit passender Kontaktadresse erhält jedes aktive Projekt mit einem Katalogtarif und einer noch ausstehenden Eigentumsübernahme aus der Registrierung seine Registrierungseinladung erneut, auch wenn sie abgelaufen ist oder die empfangende Person bereits als gewöhnliches Mitglied beigetreten ist.

Das Annehmen dieser Registrierungseinladung mit der vorhandenen Anmeldung schließt die Eigentumsübernahme ab; die Wiederherstellungsanfrage allein ändert weder Eigentum noch Anmeldedaten. Ausstehende E-Mail-Einladungen für Mitglieder und Anzeigenkunden zu aktiven Projekten mit Katalogtarif sowie ausstehende Einladungen für Organisationsadministratoren zu bestehenden Organisationen füllen die übrigen Plätze, die neuesten zuerst.

Eine erneut gesendete Einladung behält ihre ID und erhält einen neuen Link und ein neues Ablaufdatum; der alte Link wird ungültig, und die Anzahl der ausstehenden Einladungen des Projekts bleibt gleich. Eine abgelaufene Registrierungseinladung wird als neue Einladung erstellt und belegt wieder einen Einladungsplatz. Die Anzahl steigt daher um eins; bei einem vollen Projekt wird sie übersprungen.

Andere abgelaufene sowie widerrufene, angenommene und per Link geteilte Einladungen werden nicht erneut gesendet.

Erstellt ein neues Projekt und dessen ersten Agenten durch explizite gebündelte CLI-Anmeldung, auch wenn die Kontaktadresse bereits zu einer Person oder einem Projekt gehört. Die Kontakt-E-Mail bleibt unverifiziert und gewährt keine Befugnis; fehlerhafte Adressen führen zu invalid_request.

Stellt eine Einladung zur Anmeldung in derselben Transaktion in die Warteschlange. project_name ist optional; bei Weglassen wird ein lesbarer Zwei-Wort-Name verwendet. Exakte idempotente Wiederholung erfolgt vor den Ratenbegrenzungen. Speichern Sie die dauerhafte Berechtigung, bevor Sie den Erfolg melden; ihr Wiederholungszeitraum endet bei issuance_expires_at, und spätere Versuche geben credential_issuance_expired zurück.

Der Idempotenzdatensatz gilt 24 Stunden.

Startet eine AgentID (OIDC) Browser-Anmeldung beim API-Host, abgeleitet vom öffentlichen Laufzeit-Ursprung (https://play.<domain> -> https://api.<domain>). Setzt ein einmaliges Bindungs-Cookie und leitet zum AgentID-Autorisierungsendpunkt mit PKCE S256 weiter. Antwortet nur auf dem API-Host.

Während die vertrauende Partei keine Client-ID und kein Geheimnis hat, rendert die Route eine einfache nicht verfügbare Seite mit 503.

Schließt eine AgentID-Browseranmeldung am API-Host ab. Erfordert iss gleich dem konfigurierten Aussteller, das Bindungscookie und eine nicht abgelaufene Einmal-Transaktion.

Tauscht den Code mit client_secret_basic und PKCE, überprüft das ES256 id_token (iss, aud, exp mit 60 s Toleranz, nonce) gegen die zwischengespeicherte JWKS, ruft userinfo auf und erzwingt die Besitzerregeln, dann rendert eine einmalig verwendbare Anspruchscode-Seite. Ein bereits an einen Agenten gebundener Subjekt rendert die bereits registrierte Seite.

Diese Route erstellt niemals ein Projekt, eine Identität oder eine Einladung.

Das aufrufende Projekt. Belastet nicht den 1-Credit-API-Zähler, sodass ein Projekt mit null verbleibenden Credits weiterhin verbleibende Credits lesen und sich erholen kann. Nach erfolgreicher Projekt-Hauptauthentifizierung enthalten authentifizierte /api JSON- und Problemantworten ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset und ScreenRig-Credits-Included als ganze Credits.

SSE-, Runtime-, Content- und nicht authentifizierte Antworten lassen diese weg.

Aktuelles Projekt umbenennen. Namen enthalten 1–60 druckbare Zeichen und keinen URL-ähnlichen Text.

Nur der Projektinhaber oder ein Administrator seiner Organisation darf es löschen; jeder andere Anrufer wird mit forbidden abgelehnt. Eine Person muss auch Mitglied des Projekts sein.

Ein Agent benötigt die Zielmitgliedschafts-Projektfähigkeit und löscht für seine verantwortliche Person, die Eigentümer oder Organisationsadministrator sein muss; ein Agent ohne verantwortliche Person kann nicht löschen, außer der Agent, der das Projekt eingeschrieben hat, während noch keine Person die Einschreibung akzeptiert hat.

Erfordert außerdem den aktuellen Namen und die Revision, null nicht archivierte Bildschirme, kein Guthaben, keine Reservierungen oder Schulden in der eigenen Wallet und keine Live-Werbung. Ein negativer Saldo unter kostenlosen oder Startbedingungen blockiert nicht; die Löschung schreibt ihn mit einem project_delete_writeoff-Buchungseintrag ab. Wartet auf Mitgliederbenachrichtigungen und verwendet den irreversiblen Tombstone.

Der Plan des aufrufenden Projekts, unabhängige Werbetreibende/Bildschirm-Flags mit ihrer Revision, die abgeleitete effektive Fähigkeitensammlung, die Plan-Funktionen, die es hat (plan_features), und seine Limits (limits). Spiegelt niemals eine Kundenbehauptung wider; ein unbekannter Plan schlägt geschlossen als verboten fehl.

Das eigene Audit-Protokoll der Organisation: Änderungen an ihren Administratoren, Domains und Abrechnungseinstellungen, mit denselben Einträgen, Filtern und Formaten wie GET /api/audit. Erfordert einen Administrator der Organisation. Teil des Audit-Protokolls, das der Enterprise-Plan enthält; eine Organisation, deren Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

In jedem Plan werden die Änderungen aufgezeichnet.

Die Benachrichtigungen der Organisation, alle Kanäle, älteste zuerst (höchstens 50).

Eine Benachrichtigung gehört zur Organisation und deckt jedes ihrer Projekte ab, auch später hinzugefügte (project_ids fehlt), oder die gewählten Projekte (project_ids); sie wirkt auf die Bildschirme, Quellen, Kampagnen und Karten dieser Projekte genau wie eine Projektbenachrichtigung. status ist failing, solange die Zustellungen eines abgedeckten Projekts es sind, und failing_since, last_success_at und last_failure_at fassen die der abgedeckten Projekte zusammen (den frühesten Fehlerbeginn, den letzten Erfolg und den letzten Fehler).

Das Signing-Secret eines Webhooks wird hier nie zurückgegeben. Erfordert einen Admin der Organisation; alle anderen erhalten not_found.

Erstellt eine Benachrichtigung der Organisation, mit den Feldern von POST /api/notifications und den Projekten, die sie abdeckt: Fehlendes oder auf null gesetztes project_ids deckt jedes Projekt der Organisation ab (die vorhandenen und die später hinzukommenden), eine Liste deckt genau diese ab, jeweils ein Live-Projekt dieser Organisation (sonst invalid_request).

Die Empfänger einer E-Mail-Benachrichtigung sind owner (der Inhaber jedes abgedeckten Projekts) oder user_ids von Personen der Organisation (ihre Admins und Heimatmitglieder) oder von Mitgliedern eines abgedeckten Projekts; jedes Projekt versendet E-Mails weiterhin nur an die Personen, die seine Mitglieder sind.

Eine Organisation hat höchstens 50 Benachrichtigungen, die vom System angelegten Standardbenachrichtigungen nicht mitgezählt (notification_limit_reached). Kanäle, Regeln und Bedingungen werden durch dieselben Planfunktionen eingeschränkt wie bei den Projektrouten, bemessen am Plan der Organisation. Jedes abgedeckte Projekt erhält notification.created, und die Änderung wird im Audit-Protokoll der Organisation aufgezeichnet.

Das Signing-Secret eines Webhooks wird nur in dieser Antwort und in rotate-secret zurückgegeben; ein Secret signiert die Zustellungen jedes abgedeckten Projekts. Eine exakte Wiederholung mit demselben Idempotency-Key liefert vierundzwanzig Stunden lang dieselbe Antwort, Secret eingeschlossen.

Eine Benachrichtigung der Organisation, so wie GET /api/organizations/{org_id}/notifications sie zeigt.

Ändert jedes Feld, das PATCH /api/notifications/{id} ändert, in der Benachrichtigung und in jedem abgedeckten Projekt, sowie project_ids: Fehlt es, bleiben die Projekte unverändert, null deckt jedes Projekt ab, eine Liste deckt genau diese ab. Ein Projekt, das die Benachrichtigung neu erhält, beginnt bei seinem aktuellen Ereignis (nichts Früheres wird gesendet); bei einem Projekt, das sie verliert, wird die Benachrichtigung gelöscht.

Jedes abgedeckte Projekt erhält notification.updated, und die Änderung wird im Audit-Protokoll der Organisation aufgezeichnet.

Eine Änderung, durch die die Benachrichtigung ein Projekt abdeckt, das sie bisher nicht abdeckt, wird so geprüft wie das Erstellen der Benachrichtigung in ihrer künftigen Form (Kanal, Regeln und Display-Bedingungen, nach dem Plan der Organisation); weniger Projekte abzudecken wird nie geprüft, und der Wechsel von einer Liste zu jedem Projekt deckt immer mehr ab. If-Match schützt die Revision.

Löscht die Benachrichtigung aus jedem Projekt, das sie abdeckt, mit notification.deleted in jedem, und zeichnet das im Audit-Protokoll der Organisation auf. Ausstehende Meldungen werden mit webhook_deleted als fehlgeschlagen markiert.

Nur Webhook-Benachrichtigungen (jeder andere Kanal ist invalid_request). Ersetzt das Signing-Secret in allen abgedeckten Projekten auf einmal, sodass ein Empfänger weiterhin ein einziges Secret prüft, und gibt die Benachrichtigung mit dem neuen Secret in secret zurück.

Wie bei POST /api/notifications/{id}/rotate-secret kann höchstens ein bereits laufender Versuch pro Projekt noch mit dem alten Secret signiert eintreffen. Eine exakte Wiederholung mit demselben Idempotency-Key liefert vierundzwanzig Stunden lang dasselbe neue Secret.

Sendet ein notification.test über das erste Projekt, das die Benachrichtigung abdeckt (nach Projekt-ID), so wie POST /api/notifications/{id}/test eines über sein Projekt sendet: eine Zustellung, deren Ergebnis die Liste der Zustellungen zeigt, einmal versucht.

Jedes abgedeckte Projekt hat denselben Empfänger, dasselbe Ziel und dasselbe Secret, sodass ein Test den Kanal nachweist; die E-Mail eines Tests geht an die Empfänger dieses Projekts. Eine Benachrichtigung, die kein Projekt abdeckt, ist invalid_request.

Die Zustellungsprotokolle jedes Projekts, das die Benachrichtigung abdeckt, als eine Liste, neueste zuerst, geordnet nach dem Zeitpunkt, zu dem jede Zeile in die Warteschlange gestellt wurde. Jede Zeile nennt ihr Projekt (project_id), und mit ihrer id rufen Sie GET .../deliveries/{delivery_id}/attempts auf. Geben Sie next_cursor wie bisher zurück, um die nächste Seite zu erhalten.

Die Versuche einer Zustellung, neueste zuerst, die letzten 20. Eine Zustellung, die nicht zu dieser Benachrichtigung gehört, ist not_found.

Schickt der Person einer E-Mail-Benachrichtigung wieder E-Mails, nachdem sie diese mit dem Abmeldelink in der E-Mail beendet hat, in jedem Projekt, das die Benachrichtigung abdeckt (der Link beendet sie in allen). Idempotent: Eine Person, die nicht abgemeldet ist, ändert nichts, und die Antwort ist die Benachrichtigung, wie sie ist.

Eine Änderung erhöht die Revision und hängt notification.updated mit den Details change resubscribed, user_id und via api bei jedem abgedeckten Projekt an.

Listet die Berichtsarten, die GET /api/reports/{kind} erstellt, mit den Filtern jeder Art und den Formaten, in denen ein Bericht geschrieben wird. Erfordert die Berichtsberechtigung.

Listet die geplanten Berichte des Projekts, älteste zuerst (höchstens 50), jeden mit seinem nächsten Lauf und dem Ergebnis des letzten. Erfordert die Projektberechtigung.

Plant den E-Mail-Versand eines Berichts als PDF-, XLSX- oder CSV-Anhang, täglich, wöchentlich oder monatlich zu einer Uhrzeit in einer Zeitzone.

Jeder Lauf deckt den Zeitraum davor in UTC-Tagen ab: den Vortag, die sieben Tage davor oder den letzten Monat. recipients sind Mitglieder des Projekts, benannt per user_id oder per E-Mail-Adresse des Mitglieds; alle anderen werden abgelehnt, ein Abonnement ist also nie ein Weg, Außenstehende anzuschreiben, und ein Mitglied, das geht, erhält es nicht mehr.

Ein fehlgeschlagener Lauf wird wiederholt und erscheint mit last_status failed und last_error. Höchstens 50 pro Organisation über alle ihre Projekte (report_subscription_limit_reached).

Erfordert einen designierten Administrator einer aktiven Organisation, Cookie-Authentifizierung mit exakt demselben Ursprung und JWT-CSRF. Akteur und Rückkehr-URL werden vom Server festgelegt. Die Antwort ist privat und no-store. Steht auch einer an einen Reseller delegierten Organisation offen, für ihre Karte und vergangene Rechnungen.

Erfordert einen designierten Administrator einer aktiven Organisation, Cookie-Authentifizierung mit exakt demselben Ursprung und JWT-CSRF. Der Akteur wird vom Server festgelegt. Das Deaktivieren bewahrt gespeicherte Beträge und die monatlichen Ausgaben; Betragsfelder werden bei Deaktivierung ignoriert. Die Antwort ist privat und no-store. Das Ändern der Einstellungen hebt eine behebbare Pause erst auf, nachdem jede fehlgeschlagene, noch zahlbare Rechnung sicher storniert wurde.

Das Aktivieren für eine an einen Reseller delegierte Organisation antwortet mit 409 billed_by_reseller; das Deaktivieren bleibt möglich.

Zahlungsansichten einer aktiven Organisation. Erfordert das Cookie ihres zuständigen Administrators; die Sichtbarkeit für Mitarbeitende allein gewährt keinen Kaufzugriff. Nicht konfigurierte Zahlungen geben available false zurück. Die Rückkehr im Browser schreibt niemals Guthaben gut.

Einen vorausbezahlten Kauf für den zuständigen Administrator einer aktiven Organisation starten. Erfordert Cookie-Authentifizierung desselben Ursprungs und für JWT-Sitzungen einen passenden CSRF-Header. Organisation, Kunde, Akteur und Rückkehr-URLs werden vom Server festgelegt. Guthaben wird erst nach Zahlungsbestätigung durch den Abrechnungsdienst gutgeschrieben. Bei unklaren Antworten mit derselben Idempotency-Key und demselben Betrag erneut versuchen.

Eine an einen Reseller delegierte Organisation antwortet mit 409 billed_by_reseller.

Das Organisations-Wallet. Erfordert einen benannten Organisations-Admin, einen Admin des Resellers, an den die Organisation delegiert ist, oder eine Mitarbeiter-Sitzung. Gewährt keine Projektmitgliedschaft.

Journal-Einträge, die dieser Organisation zum Zeitpunkt der Belastung zugeordnet sind, mit Projekt- und Zahler-Identitäten. Verschiebungen übertragen keinen historischen Zugriff. Einträge, die vor dem aufgezeichneten Organisationskontext liegen, bleiben in ihren Projektabrechnungen. Wird von denselben Personen gelesen wie das Guthaben (getOrganizationBillingBalance).

Der Nutzungspool der Organisation und der Anteil jedes Projekts für einen UTC-Monat. Deckt die von dieser Organisation bezahlte Nutzung ab; andere Kosten des Zahlers stehen in der Abrechnung der Organisation. Wird von denselben Personen gelesen wie das Guthaben (getOrganizationBillingBalance).

Sichtbare Organisationen, einschließlich leerer Organisationen für deren Administratoren. Namen sind nicht eindeutig.

Beauftragte Administratoren und Agenten, deren verifizierte verantwortliche Person ein Administrator ist, dürfen eine Organisation umbenennen. Es werden keine Projektberechtigungen oder Mitgliedschaften gewährt.

Schaltet „Überprüfung für Agentenänderungen erforderlich“ ein oder aus. Während es aktiviert ist, wird jeder Agent und jeder Dienstclient im Projekt bei jeder Anfrage auf Vorschlagszugang beschränkt, unabhängig von den mitgeführten Anmeldeinformationen. Nur der Projektinhaber oder ein Administrator der Projektorganisation (sonst verboten); Mitarbeiter-Schatten-Sitzungen können dies nicht ändern.

If-Match trägt review_policy_revision (0 erlaubt) und ist erforderlich; ein veralteter Wert ist revision_conflict. Das Deaktivieren erfordert einen Nachweis, den der Agent für Verbindungsfreigabe mit frischem Passkey oder Passwort verwendet; das Aktivieren nicht. Offene Bewertungen bleiben in beiden Fällen entscheidbar. Fügt project.review_policy_changed hinzu.

Gibt aktuelle Bestätigungsdetails, Löschblocker und archivierte Geräte zurück, die getrennt werden. allowed ist false mit einem Grund, wenn der Aufrufer das Projekt nicht löschen darf (nur dessen Eigentümer oder ein Administrator der Organisation; für einen Agenten die verantwortliche Person) oder ein Blocker bleibt.

Der Inhaber überträgt das Eigentum an ein verifiziertes bestehendes Projektmitglied; dies gewährt keine neue Mitgliedschaft. Die Mitgliedschaft des neuen Inhabers verliert jedes screen_scope und upload_scope, sodass der neue Inhaber das gesamte Projekt erreicht.

Vom Eigentümer autorisierte Verschiebung überträgt Bildschirmbelegung und neue Nutzung atomar auf den Zielzahler; historische Gebühren behalten ihren Zahler.

Ziele auflisten, die der Inhaber verwaltet oder deren verifizierte Domain mit seiner verifizierten E-Mail übereinstimmt.

Einladungs-Lebenszyklusdatensätze für das aktuelle Projekt auflisten, ohne Anmelderücksetzungen. Empfängeradressen sind für das besitzende Projekt sichtbar, das sie bereitgestellt hat. Tokens und Anmelde-URLs werden niemals aufgelistet.

Erstellt Einladungen für Mitglieder oder Anzeigenkäufer. E-Mail-Zustellung gibt niemals Zugangsdaten zurück. Link-Zustellung ist nur für Mitglieder und gibt eine URL zurück, auch bei genauem idempotentem Wiederholen innerhalb von 24 Stunden. E-Mail-Einladungen verfallen nach sieben Tagen; Links nach 24 Stunden. Ausstehende E-Mail-Einladungen desselben Typs, derselben Adresse und desselben Projekts werden wiederverwendet.

Ein auf Bildschirme beschränktes Mitglied lädt keine Personen ein (outside_screen_scope).

Eine project_member-Einladung per E-Mail an eine Person, die ein externer Gast der Organisation des Projekts wäre (es ist nicht ihre Heimatorganisation), unterliegt der Gastrichtlinie dieser Organisation, und guest_not_allowed (403) antwortet, wenn die Richtlinie (allow, domains oder none) die Adresse nicht zulässt. Die Annahme der Einladung prüft erneut.

Mitarbeiter und die eigenen Admins der Organisation sind ausgenommen. Ein screen_scope in der Einladung fällt unter den Bildschirmbereich, den der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

Das aufrufende Projekt. Belastet nicht den 1-Credit-API-Zähler, sodass ein Projekt mit null verbleibenden Credits weiterhin verbleibende Credits lesen und sich erholen kann. Nach erfolgreicher Projekt-Hauptauthentifizierung enthalten authentifizierte /api JSON- und Problemantworten ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset und ScreenRig-Credits-Included als ganze Credits.

SSE-, Runtime-, Content- und nicht authentifizierte Antworten lassen diese weg.

Aktuelles Projekt umbenennen. Namen enthalten 1–60 druckbare Zeichen und keinen URL-ähnlichen Text.

Nur der Projektinhaber oder ein Administrator seiner Organisation darf es löschen; jeder andere Anrufer wird mit forbidden abgelehnt. Eine Person muss auch Mitglied des Projekts sein.

Ein Agent benötigt die Zielmitgliedschafts-Projektfähigkeit und löscht für seine verantwortliche Person, die Eigentümer oder Organisationsadministrator sein muss; ein Agent ohne verantwortliche Person kann nicht löschen, außer der Agent, der das Projekt eingeschrieben hat, während noch keine Person die Einschreibung akzeptiert hat.

Erfordert außerdem den aktuellen Namen und die Revision, null nicht archivierte Bildschirme, kein Guthaben, keine Reservierungen oder Schulden in der eigenen Wallet und keine Live-Werbung. Ein negativer Saldo unter kostenlosen oder Startbedingungen blockiert nicht; die Löschung schreibt ihn mit einem project_delete_writeoff-Buchungseintrag ab. Wartet auf Mitgliederbenachrichtigungen und verwendet den irreversiblen Tombstone.

Anwendungen neueste zuerst auflisten, maximal 500 pro Seite. Namen sind Bezeichnungen und müssen nicht eindeutig sein; eine Anwendung wird über die ID adressiert. next_cursor ist die Position der zuletzt zurückgegebenen Zeile, solange weitere Zeilen vorhanden sind; geben Sie ihn als after mit denselben Filtern für die nächste Seite zurück. next_cursor ist auf der letzten Seite null.

Streamt ein CLI-erzeugtes tar.gz direkt in eine begrenzte dauerhafte Staging-Umgebung. Metadaten werden in Headern übertragen, sodass das Archiv nie base64-kodiert oder vom Server als JSON materialisiert wird.

Der Proxy vor der API beendet eine Anfrage, die er nicht innerhalb von etwa 100 s beantwortet hat, sodass ein großes Archiv bei langsamer Uplink-Verbindung hier fehlschlägt; POST /api/applications/uploads sendet das Archiv stattdessen direkt an den Objektspeicher.

Erklärt einen direkten Upload eines von der CLI erzeugten tar.gz, das eine neue Anwendung erstellt. Die Antwort ist eine signierte Autorisierung für genau einen Objekt-PUT des Archivs, sodass die Bytes direkt an den Objektspeicher gehen und nie durch die API, deren Proxy eine Anfrage beendet, die er nicht innerhalb von etwa 100 s beantwortet hat.

Senden Sie das Archiv per PUT an upload_url, bestätigen Sie dann mit POST /api/applications/uploads/{id}/commit und warten Sie auf die Operation. Die Anwendung, ihre Version und die empfangende Operation existieren ab dieser Antwort, wie nach POST /api/applications. Ein Upload, der nicht innerhalb von 24 Stunden bestätigt wird, schlägt fehl, und eine Anwendung, die nie eine Version veröffentlicht hat, wird entfernt.

Derselbe Idempotency-Key und derselbe Body beantworten denselben Upload mit einer frisch signierten URL. GET /api/capabilities setzt features.application_direct_uploads, wo diese Routen bedient werden.

Versionierte Playlist-Liste, die Adslot-Seiten anzeigen kann. Die v1-Liste lehnt eine Seite ab, die ein werbetragendes Dokument mit version_required enthält, anstatt es zu filtern.

Seiten wie listPlaylists, neueste zuerst, höchstens 200 pro Seite und weniger, sobald eine Seite 8 MiB gespeicherte Playlists enthält. next_cursor ist die Position der zuletzt zurückgegebenen Zeile, während weitere Zeilen vorhanden sind; geben Sie ihn als after mit denselben Filtern für die nächste Seite zurück. next_cursor ist auf der letzten Seite null. library=true listet stattdessen die Playlists der Bibliothek der Organisation auf (schreibgeschützt; planen Sie sie ein oder erstellen Sie Playlists aus ihren Vorlagen).

Erstellungseintrag für die Werbeplatzseiten-Vereinigung. Maximal 16 Werbeplatzseiten, mindestens eine gewöhnliche Seite ohne Sichtbarkeit und die Wiederverwendung einer Slot-Definition auf verschiedenen Seiten bleiben Serverschecks. Referenzauflösung und DNS bleiben Serverschecks.

Ein Schreibvorgang mit einer iframe-Seite, die die Player-Web-App nicht einbetten kann, wird trotzdem gespeichert; die Antwort enthält Warnungen (PlaylistWarning) und das Projektprotokoll erhält pro Seite ein Ereignis playlist.iframe_framing_refused.

Ein Schreibvorgang, dessen iframe src, fallback_src oder Anwendungsparameter ein Bildschirm-Token ({screen.field.NAME} und die anderen der Primitiv-Schemas) lesen, das einem Bildschirm fehlt, der die Playlist zeigt, antwortet ebenfalls mit einer screen_fact_missing-Warnung, die die ersten 20 solcher Bildschirme nennt; die Manifeste dieser Bildschirme lassen dieses Primitiv weg.

Ein iframe-src oder -fallback_src, der ein Link zu Google Slides, Docs oder Sheets (Freigabe, Im Web veröffentlichen oder Einbetten) oder ein Embed-Link zu Microsoft 365 OneDrive oder SharePoint ist, wird für den Bildschirm umgebaut gespeichert; Slides laufen dort in einer Schleife und wechseln nach dem delayms des Links, begrenzt auf die Dauer der Seite, Docs, Sheets, Word und Excel laden alle 5 Minuten neu.

Ein eingefügter <iframe>-Einbettungscode in src oder fallback_src wird auf seine src ausgelesen. Eine Datei, die Betrachter zur Anmeldung auffordert, wird mit document_not_shared (400) abgelehnt; errors[0].field ist dann dieses src oder fallback_src und detail nennt die zu ändernde Freigabeeinstellung.

Die Standardliste gibt pairing_pending und aktive Bildschirme zurück. Übergeben Sie state=archived, um nur archivierte Bildschirme aufzulisten. Übergeben Sie tag, um nur Bildschirme aufzulisten, deren Tags genau diesen Tag enthalten; ungetaggte Bildschirme werden bei vorhandenem Filter ausgelassen.

Übergeben Sie field je Feld einmal als NAME:VALUE, um nur Bildschirme aufzulisten, deren Felder jeden Wert enthalten, und near als LAT,LON,KM, um nur Bildschirme aufzulisten, die höchstens KM Kilometer vom Punkt entfernt liegen; Bildschirme ohne Standort werden ausgelassen, und jeder Filter lässt sich mit state und tag kombinieren.

Übergeben Sie folder als Bildschirmordner-ID, um nur die Bildschirme direkt darin aufzulisten (nicht die seiner Unterordner), oder root für die Bildschirme außerhalb jedes Ordners.

Bildschirme sind nach Neuesten zuerst sortiert, höchstens 500 pro Seite. next_cursor ist die Position der letzten zurückgegebenen Zeile, solange weitere Zeilen vorhanden sind; geben Sie ihn mit denselben Filtern als after zurück, um die nächste Seite zu erhalten. next_cursor ist auf der letzten Seite null. Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) listet nur die Bildschirme in seinem Bereich auf.

Eine Anfrage, die kein Projekt nennt, lässt jedes Projekt aus, in dem der Aufrufer auf Bildschirme beschränkt ist; nennen Sie das Projekt, um es aufzulisten.

Alle Bildschirmordner im Projekt auflisten, maximal 1000, sortiert nach Name.

Ordner organisieren Bildschirme und sprechen sie gezielt an: Ein Zielgruppenblatt {"folder": ID} einer Kampagne trifft auf die Bildschirme in diesem Ordner und in jedem darin enthaltenen Ordner zu, ein Flottenaktions-Selektor by:folder wirkt auf dieselben Bildschirme, und die default_playlist_id eines Ordners ist das, was seine Bildschirme ohne eigene Playlist anzeigen. parent_id ist null an der Projektwurzel; bauen Sie den Baum aus parent_id. screens zählt die Live-Bildschirme direkt in jedem Ordner.

Der Ordner eines Bildschirms ist Screen.folder_id. Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) listet die Ordner innerhalb seines Bereichs und die Ordner darüber auf, die schreibgeschützt sind, damit sein Baum eine Wurzel hat; Ordner darüber tragen keine Bildschirmanzahl, und Geschwisterordner sind ausgeblendet. Eine Anfrage, die kein Projekt nennt, lässt jedes Projekt aus, in dem der Aufrufer auf Bildschirme beschränkt ist.

Erstellt einen Bildschirmordner in der Projektwurzel (parent_id null oder nicht vorhanden) oder innerhalb von parent_id. Namen werden getrimmt, enthalten 1 bis 100 Unicode-Zeichen ohne Steuerzeichen, sind nicht "." oder ".." und sind unter den Ordnern derselben Ebene eindeutig (resource_conflict).

Eine Organisation hält höchstens 1000 Ordner über alle ihre Projekte (quota_exceeded), maximal 10 Ebenen tief (invalid_request). default_playlist_id muss, wenn gesetzt, eine genehmigte Playlist benennen (playlist_not_approved). Sendet screen.folder_created.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) erstellt einen Ordner nur innerhalb eines Ordners seines Bereichs; die Projektwurzel oder jedes andere übergeordnete Element ist outside_screen_scope. Das Erstellen eines Ordners in einem geschützten Ordner ist eine protected_change-Überprüfung (202 pending_review), die eine zweite genehmigende Person entscheidet.

Verschiebt Bildschirme (screen_ids) und Ordner (folder_ids) in einen Ordner (folder_id) oder zur Projektwurzel, wenn folder_id null ist, in einer einzigen Alles-oder-Nichts-Anfrage mit maximal 1000 IDs. Jede ID muss existieren (not_found). Ein Ordner kann nicht in sich selbst oder einen darin enthaltenen Ordner verschoben werden, und die Verschiebung muss alle Ordner innerhalb von 10 Ebenen halten (invalid_request).

Elemente, die sich bereits am Ziel befinden, bleiben unverändert; jeder verschobene Bildschirm und Ordner erhöht seine Revision. Verschobene Bildschirme lösen ihre Playlist innerhalb von etwa 15 Sekunden neu auf: levels nennt die Kampagnen, in deren Ordner-Zielgruppe sie eintreten oder aus der sie austreten, und die Standard-Playlists von Ordnern, die sie erhalten oder verlieren. Sendet screen.moved.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) verschiebt Bildschirme und Ordner innerhalb seines Bereichs in einen Ordner seines Bereichs; jede ID oder jedes Ziel außerhalb davon sowie die Projektwurzel lehnen die gesamte Verschiebung ab (outside_screen_scope), auch wenn ein Bildschirm den Bereich zwischen Prüfung und Schreiben verlässt.

Ein Verschieben in einen geschützten Ordner hinein oder aus ihm heraus ist eine protected_change-Überprüfung (202 pending_review), die eine zweite genehmigende Person entscheidet.

Beantwortet, was die Bildschirme eines Subjekts über [from, to) abspielen und warum, für den Zeitplankalender des Dashboards: genau eines von screen_id, folder_id (die Bildschirme im Ordner und in jedem darin enthaltenen Ordner), tag oder campaign_id (die Bildschirme ihrer Zielgruppe).

Bildschirme, deren Stacks identische Eingaben haben (dieselben Ebenen, Standard, Zeitzone und Display-Anzahl), teilen sich eine Gruppe mit einer Zeitleiste, sodass ein großes Subjekt nur Dutzende Zeitleisten kostet; eine Gruppe listet bis zu 500 ihrer Bildschirme und eine Antwort höchstens 200 Gruppen (truncated).

Jede Gruppe trägt ihren Stack, höchste zuerst (Übernahme, Kampagnen, die die Bildschirme erreichen, deren eigene Zeitplaneinträge, dann die Standard-Playlist oder die des nächstgelegenen Ordners), die spans jeder Ebene (spielt auf jedem Display, auf das sie zielt, partial mit den Displays, auf denen sie spielt, outranked oder conditional, solange sie auf Interaktion oder eine Datenbedingung wartet, die nur ein Player beobachtet), was jedes Display zeigt (on_screen; die Hauptregion einer Vollseite) und conflicts (zwei Kampagnen gleicher Priorität, die gleichzeitig gelten; eine Ebene, die gilt, aber nie spielt). from und to sind RFC-3339-Zeitpunkte, to nach from, höchstens 93 Tage auseinander; sie werden auf die Minute gekürzt.

Regeln werden in der Zeitzone jeder Gruppe gelesen, so wie der Sweep und jeder Player sie lesen; jede Ebene gilt als abspielbar. Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) muss eine screen_id oder eine folder_id innerhalb seines Bereichs senden; ein Tag, eine campaign_id oder kein Subjekt ist outside_screen_scope.

Liefert eine Tabelle mit den Spalten, die ein Zeitplan-Import liest, und drei Beispielzeilen (ein Bildschirmcode, ein Bildschirmordner und ein Tag) als CSV oder, mit format=xlsx, als XLSX-Arbeitsmappe.

Liest eine Tabelle mit Zeitplanzeilen gegen das Projekt und liefert, was ihr Commit bewirken würde, ohne etwas zu schreiben.

Jede Zeile nennt ein Ziel (einen Bildschirm per ID, per Wert eines Bildschirmfelds wie eines Raumcodes oder per Namen; folder:NAME; tag:NAME; mehrere getrennt durch ; oder |), Inhalt (einen Mediendateinamen oder playlist:NAME oder eine Playlist-ID), einen Beginn und ein Ende (ein Datum allein als Ende schließt diesen Tag) und optional timezone, days (Mon-Fri), ein Tagesfenster (daily_start, daily_end), priority 0 bis 100, einen Namen und Display-Nummern.

Zeiten werden auf der eigenen Uhr jedes Bildschirms gelesen; eine timezone-Spalte rechnet sie aus einer anderen Zone um.

Jede Zeile wird geprüft und meldet ihre Fehler nach Spalte: unbekannter oder mehrdeutiger Bildschirm, Ordner oder Tag, fehlende oder mehrdeutige Datei, eine Datei, die einen Bildschirm nicht füllen kann, ungültige oder umgekehrte Zeiten, ein Ende in der Vergangenheit, keine Zeitangabe, ein Bildschirm ohne Zeitzone oder Standard-Playlist, zwei Zeilen, die auf einem Bildschirm gleichzeitig mit derselben Priorität gelten, und mehr Ebenen, als ein Bildschirm fasst (32), oder mehr Kampagnen, als seine Organisation über alle ihre Projekte fasst (100; jede gemeinsame Ebene ist eine davon).

Zeilen, die in Inhalt, Zeiten, Priorität und Name übereinstimmen, werden zu einer Ebene: Ein Bildschirm ist ein Eintrag im eigenen Zeitplan dieses Bildschirms; mehrere Bildschirme, ein Ordner oder ein Tag sind eine gemeinsame Ebene (eine Kampagne), die Vorrang vor den eigenen Ebenen eines Bildschirms hat.

Die Antwort listet die Ebenen auf, mit dem, was ein Commit mit jeder tut (create, update, unchanged), die Ebenen, die ein früherer Lauf desselben Imports angelegt hat und die die Tabelle nicht mehr enthält (removals), die Stapel der Bildschirme, wie sie wären (calendar), und einen Fingerprint, der an den Commit gesendet wird. Die Tabelle besteht aus JSON-Zeilen, CSV oder XLSX, höchstens 5,000 Zeilen.

Für einen auf Bildschirme beschränkten Aufrufer nicht verfügbar (outside_screen_scope). Der Zeitplan-Import ist Teil des Enterprise-Plans; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt. Die Vorlage ist in jedem Plan offen.

Führt einen in der Vorschau angezeigten Import als Commit aus: dieselbe Tabelle und der Fingerprint, den ihre Vorschau geliefert hat. Jede Ebene wird angelegt, aktualisiert oder entfernt, die Zeitpläne der Bildschirme und die gemeinsamen Ebenen werden in einer Transaktion geschrieben, und das Importereignis schedule.imported wird angehängt: Alle Zeilen werden angewendet oder keine.

Die Ein-Datei-Playlists, die die Dateien der Tabelle benötigen, werden zuerst angelegt (sie ändern nichts auf einem Bildschirm). Eine Tabelle, deren Zeilen Fehler haben, wird abgelehnt (schedule_import_invalid); ein Projekt, das sich seit der Vorschau geändert hat, oder Zeilen, die anders gelesen werden, werden abgelehnt (schedule_import_stale), und der Client ruft die Vorschau erneut auf.

Wird dieselbe Tabelle unter demselben Namen erneut importiert, ändert sich nichts; eine geänderte Zeile aktualisiert ihre Ebene, und eine entfernte Zeile entfernt ihre Ebene. Erfordert eine Person, die im Dashboard genehmigen kann, und für einen Agenten Zugangsdaten mit Schreibzugriff.

Ein Commit, der eine reservierte Kampagne aktualisieren oder löschen würde, wird mit reserved_item (403) beantwortet und schreibt nichts, es sei denn, eine Person, die genehmigen kann, führt den Commit aus.

Ein Commit, der einen geschützten Bildschirm erreicht, wird vollständig mit protected_target abgelehnt, auch wenn der Import keine levels hat, aber Importeinträge eines geschützten Bildschirms entfernt oder eine Import-Kampagne löscht, deren Zielgruppe einen solchen erreicht.

In einem Projekt mit geschützten Bildschirmordnern wird ein Commit, dessen Vorschau an einem Dienst scheitert, nicht am Blatt, mit dependency_unavailable beantwortet und schreibt nichts: Senden Sie dieselbe Anfrage nach kurzer Wartezeit erneut. Ein Validierungsfehler bei Blatt, Kampagne oder Bildschirm wird so beantwortet, wie es der Commit täte (invalid_request und die anderen oben genannten Probleme).

Für einen auf Bildschirme beschränkten Aufrufer nicht verfügbar. Der Zeitplan-Import ist Teil des Enterprise-Plans; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt. Die Vorlage ist in jedem Plan offen.

Beansprucht einen Browser-Link-Code für das authentifizierte Projekt und erstellt atomar genau einen ersten pairing_pending Bildschirm plus dessen bestehenden Browser-Berechtigungsnachweis. Die Anmeldung bleibt projektbezogen. Die Antwort enthält nur sichere Metadaten und niemals einen Bereitstellungstoken, Fragment-URL, Cookie oder Nachweis.

Beansprucht eine fleet-weite sechsstellige Player-Pairing-Sitzung. Exakte Idempotency-Key-Wiederholungen liefern das dauerhafte Originalergebnis ohne erneuten Verbrauch des Kontingents.

Die Dashboard-Sitzung beansprucht den Code in ihrem aktuellen Projekt mit demselben Body, Idempotency-Key, denselben Budgets und Problemen, mit dem Unterschied, dass sein not_found bei einem unbekannten oder bereits beanspruchten Code keinen CLI-Befehl nennt; es ist eine Zustandsänderung, daher folgt es den Dashboard-Mutationsregeln, eine Schattensitzung ohne Staff-Schreibmodus wird abgelehnt, und die Ereignisse, die der Claim anhängt, nennen den Dashboard-Benutzer. folder_id nennt den Ordner, in dem der Bildschirm landet.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) muss einen Ordner innerhalb seines Bereichs senden und koppelt nur als Person, die genehmigen kann (outside_screen_scope, approver_required).

Optionale Bereitstellung eines neuen Bildschirms, nur im Browser. Legt immer einen neuen Bildschirm mit pairing_pending an; höchstens fünf warten gleichzeitig auf die Kopplung (quota_exceeded). Exakte Wiederholungen liefern zehn Minuten lang dasselbe Fragment-Token erneut aus. Die sechsstellige Kopplung bleibt der Standard- und einzige Wiederherstellungsablauf. folder_id nennt den Ordner, in dem der Bildschirm landet.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) muss einen Ordner innerhalb seines Bereichs senden (sonst outside_screen_scope).

Wendet eine Aktion auf eine ausgewählte Flotte ohne Bildschirmanzahlbegrenzung an. Wählen Sie eindeutige screen_ids oder einen Tag, der aktive Bildschirme in Erstellungsreihenfolge abdeckt. Die aufgelöste Auswahl wird vor jeder Änderung fixiert, in begrenzten Blöcken gespeichert und für vierundzwanzig Stunden unter Idempotency-Key aufbewahrt.

Jeder Schritt verwendet seinen Ein-Bildschirm-Mutationspfad, bewahrt Revisionen, Ereignisse, Laufzeitsignale und Bildschirmbegrenzungen. Eine Antwort enthält eine begrenzte Seite von Ergebnissen; Übereinstimmungen, Erfolge und Fehler beschreiben diese Seite. HTTP 202 enthält total, offset und next_cursor. Fahren Sie mit demselben Selektor, Aktion und Idempotency-Key fort und übergeben Sie next_cursor als after.

Berücksichtigen Sie Retry-After, wenn vorhanden, auch bei einer Seite mit null Ergebnissen. Die Antwort gibt Idempotency-Key zurück, einschließlich eines generierten Schlüssels, wenn der Aufrufer ihn weggelassen hat; bewahren Sie diesen Schlüssel für Fortsetzungen auf. HTTP 200 beendet die Auswahl. Beantwortete Seiten werden exakt wiedergegeben, einschließlich bildschirmbezogener Fehler; unterbrochene Schritte werden ohne Wiederholung ihrer Effekte erneut abgespielt.

Große Aktionen werden gegen die bestehenden 600-pro-Minute-Organisationsbudgets für Neu laden, Toast, Übernahme, Playlist-Zeitpläne, Neustart, Display und Display-Zeitpläne abgestimmt; Erschöpfung des Organisationsbudgets pausiert die Aktion, statt die Flotte abzulehnen. Pro-Bildschirm-Erschöpfung schlägt nur bei diesem Bildschirm fehl.

Ein assign-, takeover- oder set_playlist_schedule-Schritt, der eine Playlist mit einem Format an einen Bildschirm bindet, dessen Wand eine andere Form hat, lässt nur diesen Bildschirm mit 409 playlist_format_mismatch fehlschlagen. Zuweisungen und Tag-Änderungen haben kein Nachrichtenbudget.

Eine Zuweisung, deren Playlist ein iframe src oder Anwendungsparameter hat, die ein Bildschirm-Token lesen, das einem Bildschirm der Seite fehlt, fügt dieser Seite eine screen_fact_missing-Warnung hinzu (warnings, PlaylistWarning). Teilweises Scheitern ist ein normales Ergebnis. Alle Seiten und Wiederholungen unter einem Schlüssel sind eine gemessene Aktion.

Anfragen verwenden eine begrenzte Byte-Nutzlast; verwenden Sie einen Tag für eine Auswahl, die größer ist als die Transport-Nutzlast. Ein fehlerhafter Selektor oder eine fehlerhafte Aktion wird abgelehnt, bevor ein Bildschirm berührt wird. selector oder action wird abgelehnt, bevor ein Bildschirm berührt wird.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) wählt per screen_ids oder per Ordner aus, jeweils jeden Bildschirm innerhalb seines Bereichs; ein Tag-Selektor, ein Bildschirm außerhalb des Bereichs oder ein unbekannter Bildschirm lehnt die gesamte Aktion ab (outside_screen_scope), bevor etwas festgeschrieben oder vorgeschlagen wird.

Assign, takeover, takeover_clear, set_playlist_schedule und clear_playlist_schedule, die einen geschützten Bildschirm erreichen, werden auf jeder Zugriffsstufe zu einer Überprüfung, die eine zweite genehmigende Person entscheidet (202 pending_review); set_tags, add_tags und remove_tags auf einem geschützten Bildschirm sind protected_target (409).

Eine set_playlist_schedule-Aktion mit einem pausierten Eintrag (einem Entwurf) fällt unter die Änderungskontrolle für Zeitpläne, die der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

Zeigt Browser-Tabs auf Bildschirmen im benannten Projekt; Anfrage, Antwort, Zugriff und Limits entsprechen POST /api/tab-shares.

Listet die Kampagnen des Projekts in Rangfolge auf (höchstens 100), in der Reihenfolge, in der die Auflösung sie liest. reserved ist bei jeder Kampagne vorhanden.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) sieht jede Kampagne, mit editable true nur dann, wenn die gesamte Zielgruppe innerhalb seines Bereichs liegt (ein Tag-Blatt und die Wurzelregel für jeden Bildschirm sind es nie; eine all-Regel braucht ein enthaltenes Kind, eine any-Regel jedes Kind) und der Aufrufer ändern darf, was abgespielt wird.

createCampaign für das im Pfad genannte Projekt. reserved true reserviert die Kampagne, und nur eine Person, die genehmigen kann, setzt es (reserved_item für einen Agenten, einen Service-Client oder jeden anderen), wobei campaign.reserved_changed angehängt wird.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) erstellt eine Kampagne nur für eine Zielgruppe innerhalb seines Bereichs (Blätter vom Typ folder und screen_id; kein Tag, nicht alle Bildschirme), sonst outside_screen_scope, und nur als Person, die genehmigen kann (approver_required).

Eine Kampagne, deren Zielgruppe einen geschützten Bildschirm erreicht, ist auf jeder Zugriffsstufe eine protected_change-Überprüfung, die eine zweite genehmigende Person entscheidet (202 pending_review). reserved true fällt unter die geschützten Ordner und paused true bei einer neuen Kampagne (einem Entwurf) unter die Änderungskontrolle für Zeitpläne, beide Teil des Enterprise-Plans; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

Listet die Verbindungen des Projekts auf, neueste zuerst, höchstens 200 pro Seite; geben Sie next_cursor als after für die nächste zurück. Ein Secret, ein Schlüssel oder ein Aktualisierungs-Token wird nie zurückgegeben: secret zeigt, ob eines gehalten wird, und einen Hinweis, der nicht geheim ist. Ein Lesezugriff enthält nie einen Zustimmungslink.

Legt in diesem Projekt eine Verbindung zu Microsoft oder Google an: Modus own_app mit den eigenen Zugangsdaten des Kunden oder Modus screenrig_app, der consent_url beantwortet, einen einmaligen Link für die Person, die ihn abschließt (siehe createConnection). Hängt connection.created an. Ein exakter Wiederholungsversuch mit demselben Idempotency-Key gibt dieselbe Verbindung zurück.

Listet die BI-Verbindungen des Projekts auf, älteste zuerst, 200 pro Seite; geben Sie next_cursor als cursor für die nächste zurück. Ein Secret wird nie zurückgegeben: secret zeigt, ob es gesetzt ist, und seine letzten 4 Zeichen.

Fügt eine Verbindung zu einem BI-System hinzu, das dem Projekt gehört. Für Grafana: seine Adresse (http oder https auf einem öffentlichen Host, mit optionalem Pfadpräfix) und ein Service-Account-Token mit der Rolle Viewer. Das Token wird versiegelt und nie zurückgegeben.

Grafana renders dashboards for screens through its Image Renderer plugin or remote rendering service, so the customer installs one; run POST /api/bi-connections/{id}/test to check. For Power BI (kind powerbi): config.tenant_id and config.client_id of a Microsoft Entra app registration and its client secret value as secret.

Ein Power-BI-Administrator muss für die App die Entwicklereinstellungen Embed content in apps und Service principals can call Fabric public APIs aktivieren (Admin-Portal, Mandanteneinstellungen), die App muss Mitglied oder Administrator jedes Arbeitsbereichs sein, den sie zeigt, und Berichte brauchen im Produktivbetrieb eine Embedded-, Fabric- oder Premium-Kapazität.

For Tableau (kind tableau): config.url (the https address of Tableau Server, or of your Tableau Cloud pod such as https://10ay.online.tableau.com), config.site (the site content URL, empty for the default site), config.client_id and config.secret_id of a connected app with direct trust, config.username (the Tableau user the screens views are shown as) and the secret value as secret.

Fügen Sie embed_origin der Antwort zur Domain-Zulassungsliste der verbundenen App hinzu und aktivieren Sie das Secret. Wer ein Bildschirm-Ticket hält, kann jede Ansicht einbetten, die dieser Benutzer sehen kann; verwenden Sie daher einen Benutzer, der nur die Bildschirm-Dashboards sieht. Tableau Cloud oder Tableau Server 2023.3 oder neuer.

Für eine Webseite mit Anmeldung (kind web): das Dienstkonto einer Website, die ihr Dashboard hinter einer Anmeldung zeigt. config.login_mode ist auto (config.login_url, config.username und das Passwort als secret: Der Renderer öffnet die Anmeldeseite und füllt das Formular aus), steps (config.login_url und config.steps, ein Skript aus den Schritten goto, fill, click, press, wait_for und wait_ms, deren Werte {{username}}, {{password}} und {{otp}} enthalten dürfen) oder none (keine Anmeldung: Die Verbindung zeigt Seiten mit den Cookies, die Sie ihr geben). totp_secret ist der Base32-Schlüssel oder die otpauth://-Adresse der Authenticator-App des Kontos: Der Server berechnet den Einmalcode (RFC 6238) und sendet dem Renderer nur den Code. cookies ist ein aus einem angemeldeten Browser exportierter Cookie-Satz für eine Website, deren Anmeldung sich nicht skripten lässt (Single Sign-on, das auf einem Telefon genehmigt wird, eine Geräteprüfung); der Server behält den Satz und erneuert ihn aus den Cookies, die jede Erfassung zurückgibt, sodass eine Anmeldung selten ist.

Das Passwort, der Seed und die Cookies werden versiegelt und nie zurückgegeben. Verwenden Sie ein schreibgeschütztes Dienstkonto. Das Passwort wird nur in config.login_url und die goto-Schritte eingegeben, sodass das Verlegen auf einen anderen Ursprung erneut secret verlangt. Nach fünf abgelehnten Anmeldungen in Folge meldet sich die Verbindung nicht mehr an, bis sich ihre Zugangsdaten ändern.

Ein Server ohne Seiten-Renderer antwortet mit bi_web_unavailable. Hängt bi_connection.created an. Ein exakter Wiederholungsversuch mit demselben Idempotency-Key gibt dieselbe Antwort zurück.

Lists the project's BI views, oldest first, 200 to a page; pass next_cursor back as cursor for the next. Each carries embed_url, the address an iframe primitive shows (content_fit fill); it is null where this server has no embed host.

Fügt eine Ansicht eines Grafana-Dashboards der Verbindung oder eines einzelnen seiner Panels hinzu (url: eine Adresse /d/{uid}/... auf dem Host der Verbindung, oder target) oder eines öffentlichen Grafana-Dashboard-Links (kind grafana und target.public_url, ohne Verbindung).

Put the answer's embed_url in an iframe primitive: the server renders the dashboard as a PNG through Grafana's /render API, refreshed every refresh_s (30 to 86400, default 300) and shared by every screen of the same size; the screen never talks to Grafana. A public dashboard plays live from Grafana, which must allow embedding.

Die Einbettungsseite zeigt nur ein Ticket, das das Manifest des Bildschirms enthält, sodass eine Ansicht nur auf den Bildschirmen ihres eigenen Projekts läuft.

For Power BI (kind powerbi): a report of a workspace the connection's app is a member of (url: an app.powerbi.com /groups/{workspace}/reports/{report} address, or target with workspace_id and report_id), with pages to show and rotate_s to rotate through them (pages listing two or more, or rotate_all_pages, need rotate_s of 10 to 3600; one report page needs none), and refresh_s of 0 (no refresh) or 60 to 86400 (default 300).

The page asks the server for a short-lived view-only embed token (GenerateToken, App owns data) and renews it before it expires; the screen never holds the client secret. A Power BI Publish to web link is a view without a connection (kind powerbi, target.public_url https://app.powerbi.com/view?r=...), framed as it is.

For Tableau (kind tableau): a view of the connection site (url: an address copied from Tableau, such as https://HOST/t/SITE/views/WORKBOOK/VIEW or Tableau Cloud https://HOST/#/site/SITE/views/WORKBOOK/VIEW, or Workbook/View; or target.view), optionally with target.rotate_sheets and rotate_s of 10 to 3600 to turn the workbook published sheets (rotate_s and rotate_sheets go together; rotate_sheets may be given as the whole target beside url), and refresh_s of 0 (no refresh) or 60 to 86400 (default 300).

The page asks the server for a five minute JWT with only the embed scope, signed with the connected app secret, and builds the Embedding API v3 tableau-viz from the Tableau host; the screen never holds the secret.

Eine Tableau-Public-Visualisierung ist eine Ansicht ohne Verbindung (kind tableau, target.public_url, neu aufgebaut als https://public.tableau.com/views/WORKBOOK/VIEW) und akzeptiert ebenfalls rotate_sheets. Für eine Webseite (kind web): eine Seite der Website der Web-Verbindung (url: eine https-Adresse auf einem öffentlichen Host, ohne target).

Der Browser am Rand öffnet sie angemeldet, wartet auf das Element wait_for, wenn gesetzt, und wait_ms Millisekunden (bis zu 10000) und zeichnet clip, einen CSS-Selektor, wenn gesetzt, sonst die ganze Seite.

Das Bild wird alle refresh_s (60 bis 86400, standardmäßig 300) neu gezeichnet und von allen Bildschirmen gleicher Größe geteilt, und nur, solange ein Bildschirm die Ansicht zeigt; schlägt eine Erfassung fehl, bleibt das letzte Bild auf dem Bildschirm. Setzen Sie wait_for auf ein Element, das nur existiert, wenn die Seite angemeldet ist, damit nie eine Anmeldeseite gezeigt wird. Hängt bi_view.created an.

Listet die CAP-Alarmauslöser des Projekts auf, älteste zuerst (maximal 20), jeweils mit ihrer Ingest-URL, dem Benutzernamen und dem neuesten Alarm. Das Passwort wird hier niemals zurückgegeben.

Erstellt einen CAP-Alarm-Trigger: eine eingehende URL, an die ein Notifikationssystem (Everbridge, Rave, Alertus, IPAWS-Relays und andere CAP 1.2 Sender) Alarme mit HTTP Basic-Zugangsdaten sendet.

Die Antwort ist der einzige Ort, an dem das Passwort erscheint (mit der Antwort drehen): Speichern Sie es sofort im sendenden System. Ziel ist ein Tag (jeder aktive Bildschirm mit diesem, wenn die Warnung eintrifft) oder bis zu 500 screen_ids.

Eine Warnung übernimmt jeden Zielbildschirm mit einer Standard-Playlist bis zum <expires> der Warnung, sonst für default_for_seconds (60 bis 604800, Standard 3600); siehe POST /api/triggers/{id}/cap. Eine Organisation hat höchstens 20 Trigger über alle ihre Projekte (trigger_limit_reached). Fügt trigger.created hinzu.

Eine exakte Wiederholung mit demselben Idempotency-Key gibt vierundzwanzig Stunden lang dieselbe Antwort zurück, einschließlich des Passworts. Ein Trigger, dessen Selektor einen geschützten Bildschirm erreicht, ist protected_target (409), und ein fehlgeschlagenes Lesen des Bildschirmschutzes ist dependency_unavailable (500, dieselbe Anfrage wiederholen); ein Trigger steht einem auf Bildschirme beschränkten Aufrufer nicht zur Verfügung.

Dauerhafte Projekt-Ereignisse aufsteigend nach Sequenz auflisten.

Paging ist zusammenhängend: Geben Sie den zurückgegebenen next_cursor als after weiter, um genau dort fortzusetzen, wo die Seite aufgehört hat. next_cursor ist der Cursor des zuletzt zurückgegebenen Ereignisses, während neuere Ereignisse bereits existieren, und null am Ende der Historie. Limit standardmäßig 50 und akzeptiert 1-200; ein Wert außerhalb dieses Bereichs wird mit invalid_request und einem errors[]-Element abgelehnt, das limit benennt.

Offset-Paging wird nicht unterstützt. source=log listet stattdessen das Player-Protokoll auf: die Bedingungsberichte, die Spieler senden (runtime.reported), aufsteigend nach Empfangszeit, gefiltert nach screen_id und Schweregrad über ein Zeitfenster von bis (standardmäßig die letzten 24 Stunden, maximal 31 Tage).

Seine Cursor sind undurchsichtig: lg1_ oder ev1_ je nachdem, wo der Server das Player-Protokoll speichert, also geben Sie den zurück, den eine Seite geliefert hat; ein Cursor des anderen Typs wird mit invalid_request abgelehnt, der das Feld nennt. Player-Protokolleinträge haben keine Sequenz, sind nicht auf GET /stream/project und werden nicht an Webhooks geliefert.

Ein Eintrag wird bestätigt, wenn die Player-Log-Warteschlange ihn akzeptiert und für die Ereignisaufbewahrung des Projekts gespeichert wird. Eine Abfrage mit dem letzten Cursor und dem Standardfenster folgt dem Log. Player-Log-Einträge sind nicht in der Standardliste (source=project). from und to werden mit invalid_request abgelehnt, sofern source nicht log ist.

Die Projektliste nimmt screen_id, playlist_id und application_id, um die Ereignisse eines Bildschirms, einer Playlist oder einer Anwendung zu lesen, alle auf das Projekt der Anmeldeinformationen beschränkt (eine ID benennt, welche Ereignisse gelesen werden, niemals wessen): screen_id enthält die Ereignisse, deren Ressource dieser Bildschirm ist; playlist_id die Ereignisse, deren Ressource diese Playlist ist, plus die Ereignisse, die sie als details.playlist_id benennen (ein Bildschirm, der sie verwendet); application_id die Ereignisse, deren Ressource diese Anwendung ist, plus diejenigen, deren Ressource sie als application_id trägt (ihre Releases und Schlüssel/Wert-Einträge).

Ein Wert, der keine ID seines Typs ist, wird mit invalid_request abgelehnt, wobei das Feld benannt wird; playlist_id und application_id werden mit source=log abgelehnt, dessen Datensätze nur zu einem Bildschirm gehören.

Beide Quellen verwenden resource_id, Typ und Schweregrad (mindestens), kombiniert miteinander, mit den ID-Filtern und mit der Paginierung; ein Player-Protokolleintrag ist ein runtime.reported-Eintrag, dessen Ressource sein Bildschirm ist, daher ergibt eine resource_id, die nicht dieser Bildschirm ist, oder ein Typ, der runtime.reported ausschließt, eine leere Seite. Vorher (oder order=desc) zeigt die neuesten zuerst: next_cursor ist dann der Cursor des ältesten zurückgegebenen Elements und wird als before zurückgegeben, um zu älteren Elementen fortzufahren.

Ohne from erreicht eine neueste-zuerst source=log-Seite über die standardmäßigen 24 Stunden hinaus den ältesten Datensatz, den die Ereignisaufbewahrung des Projekts hält, höchstens 31 Tage unterhalb der oberen Seitenkante pro Anfrage. Eine neueste-zuerst source=log-Seite kann weniger als limit Datensätze enthalten, auch keine, mit next_cursor; null beendet sie dennoch am Ende des aufbewahrten Logs.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) liest einen gefilterten Feed: Ereignisse von Bildschirmen innerhalb seines Bereichs, von den Bildschirmordnern, die er sehen kann (seine eigenen, die darüber und die darin; screen.moved nur, wenn das Ziel innerhalb seines Bereichs liegt), von Kampagnen, Playlists, Medien, Anwendungen und Karten sowie playlist_change-Überprüfungen.

Jedes andere Ereignis wird ausgelassen, sodass eine Seite weniger Ereignisse als limit enthalten kann, sogar keine, mit einem next_cursor; blättern Sie damit weiter. source=log braucht eine screen_id innerhalb des Bereichs. Ereignisse über das Projekt selbst werden nicht gesendet.

Der Plan des aufrufenden Projekts, unabhängige Werbetreibende/Bildschirm-Flags mit ihrer Revision, die abgeleitete effektive Fähigkeitensammlung, die Plan-Funktionen, die es hat (plan_features), und seine Limits (limits). Spiegelt niemals eine Kundenbehauptung wider; ein unbekannter Plan schlägt geschlossen als verboten fehl.

Die quellenbewusste Kontostandsaufnahme des aufrufenden Projekts. Alle Millicredit-Beträge sind kanonische Dezimalstrings. Es ist eine Momentaufnahme, keine Zahlungsbefugnis; rails_available ist falsch, solange Karte, Steuer und Auszahlungs-Schiene nicht verfügbar sind.

Stabile Cursor-Paginierung über unveränderliche veröffentlichte Journal-Einträge für das aufrufende Projekt. Holds sind keine veröffentlichten Einträge. Korrekturen verlinken auf das Originalereignis, anstatt es umzuschreiben. Es gibt keine willkürliche Gewährungs- oder Auszahlungsänderung auf dieser Ebene.

Die Nutzung des aufrufenden Projekts für einen UTC-Monat, mit den ausgelieferten und empfangenen Bytes (nie berechnet), dem Speicher, der über dem kostenlosen Speicher des Plans des Zahlers berechnet wird (allowance.storage_bytes), sowie den API-Anfragen, abgerechneten Projekt-Stream-Ereignissen und Webhook-Zustellversuchen, die auf die kostenlosen 10.000 pro Monat angerechnet werden. Ein Projekt, das für sich selbst zahlt, liest seinen eigenen Pool.

Ein Projekt, für das ein anderer Zahler bezahlt, teilt den Pool dieses Zahlers mit dessen anderen Projekten; es liest seinen eigenen Anteil, und payer nennt den Zahler. Der Pool-Gesamtbetrag des Zahlers bleibt in den Abrechnungen des Zahlers.

Das Netzwerk des anrufenden Verkäufers, einschließlich der berechneten ScreenRig-Bereitstellungsgebühr. Verkäufer können diese Gebühr nicht ändern.

Erstellt das eine Netzwerk des aufrufenden Verkäufers, falls nicht vorhanden. Erfordert screens=true. Idempotent; Wiederholungen geben dasselbe Netzwerk zurück.

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.

Das vom anrufenden Verkäufer ausgewählte Inventar.

Erstellt einen wiederverwendbaren Verkäuferplatz. Bilder dauern 5-30 Sekunden, Videos höchstens die Plattformbegrenzung von 120 Sekunden. Anzeigen sind immer stummgeschaltet.

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.

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.

Erstellt eine Entwurfskampagne. Entwürfe enthalten kein Geld, reservieren nichts und autorisieren keine Auslieferung. Die Aktivierung erfordert ein ausdrücklich akzeptiertes Angebot.

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.

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.

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.

Tägliche Wiedergabeaggregate.

JSON gibt höchstens 200 Zeilen zurück und ist nicht rate-limitiert. format=csv (oder Accept text/csv ohne application/json) streamt jede passende Zeile innerhalb von day_from bis day_to (einschließlich UTC-Tage; Standard day_to heute und day_from 30 Tage früher; höchstens 366 Tage, sonst invalid_request) als CSV mit einer festen Kopfzeile (PlaybackAggregateCsv); nur die CSV-Form verbraucht die Budgets playback-export-org (30 pro Minute) und playback-export-ip (60 pro Minute).

Beide Formen sind eine gemessene API-Anfrage. Antworten tragen Vary Accept. Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) muss screen_id senden, und es muss ein Bildschirm innerhalb seines Bereichs sein (sonst outside_screen_scope); die CSV-Formen folgen derselben Regel.

Pro Wiedergabeaufzeichnung: eine Zeile pro akzeptiertem playback.media_started (oder veraltetem playback.video_started) und eine Zeile pro akzeptiertem playback.application_started (release_id gesetzt, Medienfelder leer) des aufrufenden Projekts, älteste zuerst nach received_at, bei Gleichstand nach Einfügung. Von (einschließlich) und bis (ausschließlich) begrenzt received_at; bis standardmäßig jetzt, von bis 24 Stunden vor bis, und der Bereich beträgt höchstens 31 Tage (sonst invalid_request).

Die neuesten 5 Sekunden werden noch nicht zurückgegeben: Das effektive Ende ist höchstens jetzt minus 5 Sekunden (settle lag), sodass ein Live-Tail niemals eine hinter seinem Cursor liegende Zeile überspringt. Gefiltert werden screen_id, media_id, playlist_id (die Playlist, von der der Start angezeigt wurde) und tag (ein Bildschirm-Tag, den der Bildschirm beim Empfang der Wiedergabe trug).

Eine playlist_id-Seite kann weniger als limit Zeilen enthalten, sogar keine, mit einem next_cursor, wenn ein langer Abschnitt von Wiedergaben anderer Playlists durchsucht wurde; null beendet dennoch den Bereich.

JSON ist eine Seite mit höchstens limit Zeilen (Standard 200, höchstens 1000) mit next_cursor, null am Ende des Bereichs; geben Sie ihn mit denselben Filtern als cursor zurück. order=desc (oder before) zeigt innerhalb desselben Bereichs die neuesten zuerst: next_cursor ist dann der Cursor der ältesten zurückgegebenen Zeile, null am Anfang des Bereichs, und wird als before (exklusiv) mit denselben Filtern zurückgegeben; order=asc mit before wird mit invalid_request abgelehnt, das order nennt, und cursor mit einer newest-first-Seite nennt cursor.

Eine nach Neuheit sortierte Seite kann weniger als die Limit-Zeilen enthalten, sogar keine, mit einem next_cursor; null beendet sie dennoch.

Eine spätere Seite überspringt niemals eine Zeile, die beim Lesen der früheren Seite existierte, und wiederholt keine, außer dass ein Start, den der Player nach einem nicht bestätigten Bericht erneut sendete (die gleiche play_id, kurz danach empfangen), auf einer späteren Seite erneut erscheinen kann; der CSV-Stream listet sie einmal auf. format=csv (oder Accept text/csv ohne application/json) streamt jeden Play vom Cursor bis zum Ende des Bereichs als CSV (PlaybackPlayCsv), neueste zuerst unten vor mit order=desc; Limit wird mit CSV abgelehnt.

Die Abrechnung erfolgt pro Anfrage: Jede JSON-Seite kostet einen API-Anfrage-Credit, während ein CSV-Stream des gesamten Bereichs einen kostet. Jede Abfrage für Wiedergaben (Seite oder Stream) verbraucht die Budgets playback-export-org (30 pro Minute) und playback-export-ip (60 pro Minute).

Ein Stream begrenzt jeden Schreibvorgang (15 Sekunden) und endet, wenn der Client die Verbindung trennt; schlägt er nach dem 200-Header fehl, wird die Verbindung abgebrochen, sodass ein Export, der bis zum sauberen Ende liest, vollständig ist. Antworten enthalten Vary Accept. Wiedergaben werden für die Ereignisaufbewahrung des Plans aufbewahrt (30 Tage sind der ausgelieferte Mindestwert; planbasierte Aufbewahrung verwendet das eigene 7- oder 90-Tage-Fenster des Plans).

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) muss screen_id senden, und es muss ein Bildschirm innerhalb seines Bereichs sein (sonst outside_screen_scope); die CSV-Formen folgen derselben Regel.

Wiedergabesummen des aufrufenden Projekts über inklusive UTC-Tage, gelesen aus den Tageszusammenfassungen: by=day gibt eine Zeile pro Tag mit Wiedergaben zurück (screen_id oder media_id schränkt auf einen Bildschirm oder ein Medium ein), by=screen und by=media sortieren die meistgenutzten Bildschirme oder Medien (Top, höchstens 100), und by=screen_day gibt die Tagesreihe der Top-Bildschirme zurück (Top höchstens 10). day_to standardmäßig heute (UTC) und day_from 29 Tage davor.

Eine Tagesreihe umfasst höchstens 366 Tage (92 bei Eingrenzung auf einen Bildschirm oder Medien); ein Ranking höchstens 92. Die Zählungen umfassen jeden Start, den das Projekt aufgezeichnet hat, einschließlich der vor der Einführung von Play-Rollups gespeicherten.

Rollups folgen der Erfassung um bis zu etwa 21 Minuten. truncated ist true, wenn ein Ranking aus Ausschnitten eines Fensters erstellt wurde, das zu groß für einen Lesevorgang ist: Es umfasst die besten Schlüssel jedes Ausschnitts. Nicht rate-limitiert. Eine gemessene API-Anfrage.

Ein auf Bildschirme beschränkter Aufrufer (docs/screen-scope.md) muss screen_id senden, und es muss ein Bildschirm innerhalb seines Bereichs sein (sonst outside_screen_scope); die CSV-Formen folgen derselben Regel.