Playlists-API

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.

Eine Dashboard-Sitzung (der Seiteneditor) erstellt die Playlist sofort live, nie als Vorschlag, der Person zugeschrieben, und braucht den Projektinhaber oder ein Mitglied, das genehmigen kann (sonst approver_required); Medien, die sie nennt und die auf ihre Prüfung warten, sind media_pending_review (409), wo der Live-Schreibvorgang eines Agenten sie genehmigt.

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.

Versioniertes Update, das die Adslot-Seitenunion akzeptiert. If-Match enthält die Playlist-Revision.

Eine Dashboard-Sitzung (der Seiteneditor) ersetzt die Playlist sofort live, nie als Vorschlag, der Person zugeschrieben; sie braucht den Projektinhaber oder ein Mitglied, das genehmigen kann (sonst approver_required), und If-Match (invalid_request, wenn es fehlt); eine Playlist, die noch keine Person genehmigt hat, ist playlist_not_approved (409), wie bei patchPlaylistStructure, und Medien, die eine Seite nennt und die auf ihre Prüfung warten, sind media_pending_review (409).

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.

Nur angegebene Felder der obersten Ebene ändern: name, pages, audio, format oder fields. Nicht angegebene Felder bleiben aus demselben Transaktions-Snapshot erhalten. Angegebene pages, audio und format ersetzen den vollständigen Wert; audio null entfernt den Soundtrack und format null das Format. Verschachtelte Array-Elemente werden nicht zusammengeführt.

Eine reine Namensänderung einer genehmigten Playlist validiert oder löst deren unveränderten Inhalt nicht neu auf, einschließlich älterer gespeicherter Seitenformate. Gelieferte Inhalte und Audio-/Seiten-Cue-Beziehungen werden validiert. If-Match schützt optional die Revision; identische Patches sind No-Ops, und idempotente Wiederholungen geben die ursprüngliche Antwort wieder.

Propose-Zugriff und Prüfregeln gelten wie bei PUT, einschließlich der Warnungen für einen übergebenen pages-Wert mit einer iframe-Seite, die die Player-Web-App nicht einbetten kann. PUT ersetzt weiterhin das gesamte Dokument.

Entfernt eine Playlist des authentifizierten Projekts per Tombstone. Wird mit resource_conflict (409) abgelehnt, solange ein Bildschirm, einschließlich archivierter oder ausstehender Bildschirme, sie als Standard, im Playlist-Zeitplan oder als Übernahme verwendet, ein Bildschirmordner sie als Standard verwendet oder eine Kampagne sie abspielt.

Die Dashboard-Sitzung kann auch löschen; sie erstellt und ersetzt Playlists mit createPlaylistV2 und updatePlaylistV2 und ändert ihre Struktur über patchPlaylistStructure.

Eine angemeldete Person ändert die Struktur einer Playlist, niemals jedoch, was ihre Seiten zeigen: Name, Reihenfolge der Seiten, welche Seiten bleiben und die Vorlaufzeit und Sichtbarkeit jeder behaltenen Seite. pages ist die vollständige neue Reihenfolge; eine gespeicherte Seite, die ausgelassen wird, wird entfernt, und eine ID, die die Playlist nicht enthält oder doppelt vorkommt, ist invalid_request bei pages[i].id.

Die Leinwand, Übergang, audio_cue, Primitive und Kommentare einer gespeicherten Seite sind immer die gespeicherten: Der Body hat kein Mitglied dafür, und jedes andere Mitglied wird abgelehnt.

Die gespeicherten Seiten durchlaufen dieselbe Auflösung und Validierung wie jede gespeicherte Playlist, sodass ein seitdem gelöschtes Medienobjekt abgelehnt wird (resource_conflict) und die Playlist höchstens eine gewöhnliche Seite ohne Sichtbarkeit, bis zu 16 Werbeplatzseiten und deren audio_end-Cues behält. advance ersetzt das advance der Seite (eine Werbeplatzseite hat kein advance); visibility ersetzt die Sichtbarkeit der Seite bei einem Objekt, entfernt sie bei null und behält sie bei Auslassung.

Eine Änderung, die die Playlist unverändert lässt, ist eine No-Op. If-Match enthält die Playlist-Revision und ist erforderlich (invalid_request bei Fehlen, revision_conflict bei veraltet). Die Änderung wird sofort auf jedem Bildschirm, der die Playlist anzeigt, live übernommen und der Person in playlist.updated zugeordnet; es ist niemals ein Vorschlag, daher ist die Antwort niemals 202.

Eine Playlist, die noch keine Person genehmigt hat (approved_revision 0), wird mit playlist_not_approved (409) abgelehnt: Entscheiden Sie zuerst über ihre Prüfung. Ein Name, den eine andere Playlist des Projekts verwendet, ist resource_conflict. Nur die Dashboard-Sitzung; Agenten ändern Playlists mit patchPlaylist, und eine Person ändert mit updatePlaylistV2, was Seiten zeigen.

Die Antwort trägt Warnungen (PlaylistWarning) wie bei jedem Schreibvorgang, darunter screen_fact_missing, wenn einem Bildschirm, der die Playlist zeigt, ein Wert fehlt, den ein iframe src oder Anwendungsparameter ihrer Seiten lesen. Der Body beträgt höchstens 64 KiB.

The playlist's revisions, newest first: each revision a write stored (a create, a replace, a patch, a structure change, an applied review, a promote) with its name, its page count, the kind of change and who made it.

History begins with the revision a playlist held when revision history was first recorded: until its next write the list holds that revision alone, with change baseline. Revisions are kept for as long as the playlist is. At most 50 per page; next_cursor while more remain, null on the last page.

One revision of the playlist and the playlist as it stood at that revision: its name, pages, soundtrack and format, with revision set to this one. A revision the playlist never had, or one from before its history began, is not_found.

Makes an earlier revision current again by copying it forward: its pages, soundtrack and format become a new revision, the current one plus one, whose change is promoted and restored_from names the revision copied. The playlist keeps its current name, earlier revisions stay as they were, and every screen that shows the playlist updates as for any other write.

If-Match is required and names the current revision (invalid_request when absent, revision_conflict when stale). The pages are resolved again as a structure change resolves them: a selector matches today's media, and media or a web app the revision named that is gone or not ready refuses the promote with the problem a write would get.

Eine Revision, deren Inhalt der aktuelle Inhalt ist, ändert nichts und antwortet mit der aktuellen Playlist. Erfordert Zugangsdaten, die live veröffentlichen (verboten für solche, deren Schreibzugriffe zur Prüfung vorgeschlagen werden), oder eine Dashboard-Sitzung des Projekteigentümers oder eines Mitglieds, das genehmigen darf (approver_required); eine Playlist, die noch keine Person genehmigt hat, ergibt playlist_not_approved (409).

Wie bei jedem Schreibvorgang trägt die Antwort Warnungen (PlaylistWarning), darunter screen_fact_missing, wenn einem Bildschirm, der die Playlist zeigt, ein Wert fehlt, den ein iframe src oder Anwendungsparameter der promoteten Seiten lesen.

Setzt Feldwerte einer aus einer Vorlage erstellten Playlist, oder löscht sie mit null, und erstellt ihre Seiten neu aus der aktuellen Version der Vorlage: Die Werte werden wie beim Erstellen geprüft, und seither an der Vorlage vorgenommene Markenänderungen erreichen diese Kopie. Senden Sie keine Werte, um die Kopie nur auf den neuesten Stand zu bringen.

Prüfklasse wie bei jedem Playlist-Schreibzugriff: Die Inhaberin oder der Inhaber oder ein Mitglied, das genehmigen darf (Dashboard-Sitzung), und ein Manage-Zugang schreiben live, ein Uploader nur für seine Playlists und Ordner, und Propose macht die Änderung zur Prüfung (202). Eine Playlist, die nicht aus einer Vorlage erstellt wurde, ist invalid_request. If-Match ist optional.

Die aus einer Vorlage erstellten Playlists (höchstens 1000, nach Name), jeweils mit der Vorlagenversion, aus der ihre Seiten erstellt wurden, und ob die Vorlage eine neuere hat.

Die Seiten, die eine aus der Vorlage mit diesen Werten erstellte Playlist enthalten würde, geprüft nach allen Playlist-Regeln. Berechnet nur; nichts wird gespeichert.

Fügt einer genehmigten Playlist eine Seite hinzu, ohne die anderen zu senden: am Ende oder vor der durch before benannten Seite.

Die Seiten, die die Playlist bereits enthält, bleiben wie gespeichert und werden zusammen mit der neuen in einem Durchgang erneut geprüft, sodass die seitenübergreifenden Regeln (1 bis 100 Seiten, eine gewöhnliche Seite ohne Sichtbarkeit, 16 Werbeplatz-Seiten, 1024 Medienverweise) das Ergebnis sehen: Eine verletzte Regel ergibt invalid_request mit field (page.id, wenn die ID vergeben ist, before, wenn es keine Seite benennt).

Die Seitengültigkeit der Playlist ist die eigene Sichtbarkeit der Seite (from, until, windows, data), in der Zeitzone jedes Bildschirms, until ist exklusiv.

Überprüfungsklasse: Bei Vorschlagen wird die Änderung zu einer Überprüfung (202); eine spätere Seitenänderung derselben Playlist durch denselben Vorschlagenden erweitert diese ausstehende Überprüfung, solange sie auf der Live-Revision basiert, sodass aufeinanderfolgende Änderungen einander nicht ersetzen und die Genehmigung alle oder keine anwendet (review_stale, wenn die Playlist sich weiterentwickelt hat); die ausstehende Überprüfung einer Seitenänderung eines anderen Vorschlagenden wird weder erweitert noch ersetzt, und die Änderung wartet mit resource_conflict (409).

Mit Verwalten oder aus einer Dashboard-Sitzung des Eigentümers oder eines Mitglieds, das genehmigen kann (sonst approver_required), ist sie live. If-Match ist optional: Falls angegeben, muss es die Live-Revision sein. Eine Playlist, die noch keine Person genehmigt hat, ergibt playlist_not_approved (409).

Ein Uploader (docs/uploaders.md) fügt einer seiner Playlists nur eine Medienseite aus seinen Ordnern hinzu (sonst outside_upload_scope); ein Uploader-Mitglied mit Vorschlagen ist der Vorschlagende der Überprüfung (kind person).

Ersetzt eine Seite einer genehmigten Playlist an Ort und Stelle, ohne die anderen zu senden. Der Body ist die Seite, ihre ID ist page_id. Eine unbekannte Seite ergibt not_found.

Alles andere ist wie bei addPlaylistPage: in einem Durchgang mit den beibehaltenen Seiten validiert, Überprüfungsklasse (202 bei Vorschlagen, angehängt an eine ausstehende Überprüfung einer Seitenänderung), live mit Verwalten oder durch eine genehmigende Person, If-Match optional, playlist_not_approved für eine Playlist, die keine Person genehmigt hat.

Ein Uploader ersetzt nur eine Medienseite aus seinen Ordnern durch eine andere Medienseite aus seinen Ordnern; bei Vorschlagen kann er auch die Seiten ersetzen, die in seiner eigenen Überprüfung warten.

Entfernt eine Seite einer genehmigten Playlist. Die Playlist behält 1 bis 100 Seiten und eine gewöhnliche Seite ohne Sichtbarkeit (sonst invalid_request). Eine unbekannte Seite ergibt not_found. Alles andere ist wie bei replacePlaylistPage. Ein Uploader entfernt nur eine Medienseite aus seinen Ordnern.