API Listes de lecture

Liste de playlists versionnées pouvant exposer des pages d’emplacement publicitaire. La liste v1 refuse une page contenant un document publicitaire avec version_required au lieu de le filtrer.

Pages comme listPlaylists, les plus récentes d’abord, au maximum 200 par page et moins une fois qu’une page contient 8 Mio de listes de lecture stockées. next_cursor est la position de la dernière ligne retournée tant qu’il reste des lignes ; renvoyez-le comme after, avec les mêmes filtres, pour la page suivante. next_cursor est nul à la dernière page. library=true liste à la place les listes de lecture de la Bibliothèque de l’organisation (en lecture seule ; planifiez-les ou créez-en à partir de leurs modèles).

Entrée de création pour l’union des pages d’emplacement publicitaire. Au maximum 16 pages d’emplacement, au moins une page ordinaire sans visibilité, et la réutilisation d’une définition d’emplacement sur différentes pages restent des vérifications serveur. La résolution de référence et le DNS restent des vérifications serveur.

Une session du tableau de bord (l’éditeur de pages) crée la liste de lecture en direct, jamais comme proposition, attribuée à la personne, et exige le propriétaire du projet ou un membre qui peut approuver (sinon approver_required) ; un média qu’elle nomme et qui attend son examen est media_pending_review (409), là où l’écriture en direct d’un agent l’approuve.

Une écriture contenant une page iframe que le Player web ne peut pas encadrer est tout de même enregistrée ; sa réponse comprend des avertissements (PlaylistWarning) et le journal du projet reçoit un événement playlist.iframe_framing_refused par page concernée.

Une écriture dont le src d’iframe, le fallback_src ou les params d’application lisent un jeton d’écran ({screen.field.NAME} et les autres des schémas de primitives) qui manque à un écran affichant la liste de lecture répond aussi avec un avertissement screen_fact_missing nommant les 20 premiers de ces écrans ; les manifestes de ces écrans omettent cette primitive.

Un src ou fallback_src d’iframe qui est un lien Google Slides, Docs ou Sheets (partage, publication sur le Web ou intégration) ou un lien Embed Microsoft 365 OneDrive ou SharePoint est stocké reconstruit pour l’écran, où Slides boucle et avance selon le delayms du lien plafonné à la durée de la page, et Docs, Sheets, Word et Excel se rechargent toutes les 5 minutes.

Un code d’intégration <iframe> collé dans src ou fallback_src est lu pour son src. Un fichier qui demande aux spectateurs de se connecter est refusé avec document_not_shared (400), dont errors[0].field est ce src ou fallback_src et dont detail nomme le paramètre de partage à modifier.

Mise à jour versionnée acceptant l’union des pages d’emplacement publicitaire. If-Match porte la révision de la liste de lecture.

Une session du tableau de bord (l’éditeur de pages) remplace la liste de lecture en direct, jamais comme proposition, attribuée à la personne ; elle exige le propriétaire du projet ou un membre qui peut approuver (sinon approver_required) et If-Match (invalid_request s’il manque) ; une liste de lecture qu’aucune personne n’a encore approuvée est playlist_not_approved (409), comme pour patchPlaylistStructure, et un média qu’une page nomme et qui attend son examen est media_pending_review (409).

Une écriture contenant une page iframe que le Player web ne peut pas encadrer est tout de même enregistrée ; sa réponse comprend des avertissements (PlaylistWarning) et le journal du projet reçoit un événement playlist.iframe_framing_refused par page concernée.

Une écriture dont le src d’iframe, le fallback_src ou les params d’application lisent un jeton d’écran ({screen.field.NAME} et les autres des schémas de primitives) qui manque à un écran affichant la liste de lecture répond aussi avec un avertissement screen_fact_missing nommant les 20 premiers de ces écrans ; les manifestes de ces écrans omettent cette primitive.

Un src ou fallback_src d’iframe qui est un lien Google Slides, Docs ou Sheets (partage, publication sur le Web ou intégration) ou un lien Embed Microsoft 365 OneDrive ou SharePoint est stocké reconstruit pour l’écran, où Slides boucle et avance selon le delayms du lien plafonné à la durée de la page, et Docs, Sheets, Word et Excel se rechargent toutes les 5 minutes.

Un code d’intégration <iframe> collé dans src ou fallback_src est lu pour son src. Un fichier qui demande aux spectateurs de se connecter est refusé avec document_not_shared (400), dont errors[0].field est ce src ou fallback_src et dont detail nomme le paramètre de partage à modifier.

Ne modifie que les champs de premier niveau fournis : name, pages, audio, format ou fields. Les champs omis sont conservés à partir du même instantané de transaction. Les pages, audio et format fournis remplacent la valeur complète ; audio null retire la bande sonore et format null retire le format. Les éléments de tableaux imbriqués ne sont pas fusionnés.

Une modification de nom seule d’une playlist approuvée ne revalide ni ne résout à nouveau son contenu inchangé, y compris les anciens formats de page stockés. Le contenu fourni et les relations audio/signal de page sont validés. If-Match protège optionnellement la révision ; les patchs identiques sont sans effet et les tentatives idempotentes rejouent la réponse originale.

Les droits Propose et la politique de révision fonctionnent comme pour PUT, y compris les avertissements qu’une valeur pages fournie reçoit pour une page iframe que le Player web ne peut pas encadrer. PUT reste un remplacement complet du document.

Marque comme supprimée une liste de lecture appartenant au projet authentifié. Refusé avec resource_conflict (409) tant qu’un écran, y compris archivé ou en attente, l’utilise par défaut, dans sa programmation ou pour une prise de contrôle, qu’un dossier d’écrans l’utilise par défaut ou qu’une campagne la diffuse.

La session du tableau de bord peut aussi supprimer ; elle crée et remplace des listes de lecture avec createPlaylistV2 et updatePlaylistV2 et modifie leur structure via patchPlaylistStructure.

Une personne connectée modifie la structure d’une liste de lecture et jamais ce que ses pages affichent : son nom, l’ordre de ses pages, quelles pages restent, et l’avance et la visibilité de chaque page conservée. pages est le nouvel ordre complet ; une page stockée qu’elle omet est supprimée, et un identifiant que la liste de lecture ne détient pas, ou un identifiant répété, est invalid_request à pages[i].id.

Le canevas, la transition, audio_cue, les primitives et les notes d’une page conservée sont toujours ceux stockés : le corps ne contient aucun membre pour eux, et tout autre membre est refusé.

Les pages conservées passent par la même résolution et validation que toute liste de lecture stockée, donc un élément média supprimé depuis est refusé (resource_conflict) et la liste de lecture conserve au maximum une page ordinaire sans visibilité, 16 pages de créneaux publicitaires et ses signaux audio_end. advance remplace l’avance de la page (une page de créneau publicitaire n’en a pas) ; visibility remplace la visibilité de la page lorsqu’un objet, la supprime lorsqu’elle est nulle et la conserve lorsqu’elle est omise.

Un changement qui laisse la liste de lecture telle que stockée est une opération sans effet. If-Match porte la révision de la liste de lecture et est obligatoire (invalid_request en son absence, revision_conflict si obsolète). L’écriture est immédiatement effective sur chaque écran affichant la liste de lecture et est attribuée à la personne sur playlist.updated ; ce n’est jamais une proposition, donc la réponse n’est jamais 202.

Une liste de lecture qu’aucune personne n’a encore approuvée (approved_revision 0) est refusée avec playlist_not_approved (409) : décidez d’abord de sa revue. Un nom qu’une autre liste de lecture du projet utilise donne resource_conflict. Session du tableau de bord seulement ; les agents modifient les listes de lecture avec patchPlaylist, et une personne modifie ce que les pages affichent avec updatePlaylistV2.

La réponse porte des avertissements (PlaylistWarning) comme pour toute écriture, dont screen_fact_missing lorsqu’un écran qui affiche la liste de lecture n’a pas une valeur que lisent le src d’un iframe ou les params d’une application de ses pages. Le corps fait au plus 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.

Une révision dont le contenu est le contenu actuel ne change rien et répond avec la liste de lecture actuelle. Exige un identifiant qui publie en direct (interdit pour celui dont les écritures sont proposées pour révision) ou une session de tableau de bord du propriétaire du projet ou d’un membre pouvant approuver (approver_required) ; une liste de lecture qu’aucune personne n’a encore approuvée donne playlist_not_approved (409).

Comme pour toute écriture, la réponse porte des avertissements (PlaylistWarning), dont screen_fact_missing lorsqu’un écran qui affiche la liste de lecture n’a pas une valeur que lisent le src d’un iframe ou les params d’une application des pages promues.

Définit, ou avec null efface, les valeurs de champ d'une liste de lecture créée à partir d'un modèle, et recrée ses pages à partir de la révision actuelle du modèle : les valeurs sont vérifiées comme à la création, et les changements de marque faits sur le modèle depuis atteignent cette copie. N'envoyez aucune valeur pour seulement mettre la copie à jour.

Classe de révision comme toute écriture de liste de lecture : le propriétaire ou un membre qui peut approuver (session du tableau de bord) et un identifiant Manage écrivent en direct, un contributeur seulement pour ses listes et dossiers, et Propose transforme le changement en révision (202). Une liste de lecture qui n'a pas été créée à partir d'un modèle est invalid_request. If-Match est facultatif.

Les listes de lecture créées à partir d'un modèle (au plus 1000, par nom), chacune avec la révision du modèle dont ses pages sont issues et si le modèle en a une plus récente.

Les pages que contiendrait une liste de lecture créée à partir du modèle avec ces valeurs, vérifiées par toutes les règles. Ne fait que calculer ; rien n'est enregistré.

Ajoute une page à une liste de lecture approuvée sans renvoyer les autres : à la fin, ou devant la page nommée par before.

Les pages que la liste de lecture contient déjà sont conservées telles que stockées et revérifiées avec la nouvelle en une seule passe, de sorte que les règles entre pages (1 à 100 pages, une page ordinaire sans visibilité, 16 pages d’emplacement publicitaire, 1024 références de médias) voient le résultat : une règle enfreinte donne invalid_request avec field (page.id lorsque l’identifiant est pris, before lorsqu’il ne désigne aucune page).

La validité de page de la liste de lecture est la visibilité propre à la page (from, until, windows, data), dans le fuseau horaire de chaque écran, until étant exclusif.

Classe de révision : en Proposer, le changement devient une révision (202) ; un changement de page ultérieur de la même liste de lecture par le même proposant prolonge cette révision en attente tant qu’elle repose sur la révision en direct, de sorte que les changements successifs ne se remplacent pas, et l’approbation les applique tous ou aucun (review_stale lorsque la liste de lecture a évolué) ; la révision en attente d’un changement de page d’un autre proposant n’est ni prolongée ni remplacée, et le changement attend avec resource_conflict (409).

Avec Gérer, ou depuis une session du tableau de bord du propriétaire ou d’un membre qui peut approuver (sinon approver_required), elle est en direct. If-Match est facultatif : s’il est présent, il doit être la révision en direct. Une liste de lecture qu’aucune personne n’a encore approuvée donne playlist_not_approved (409).

Un téléverseur (docs/uploaders.md) n’ajoute qu’une page média de ses dossiers à l’une de ses listes de lecture (outside_upload_scope sinon) ; un membre téléverseur en Proposer est le proposant de la révision (kind person).

Remplace une page d’une liste de lecture approuvée, sur place, sans renvoyer les autres. Le corps est la page et son identifiant est page_id. Une page inconnue donne not_found.

Tout le reste est comme pour addPlaylistPage : validé avec les pages conservées en une seule passe, classe de révision (202 en Proposer, chaînée à une révision de changement de page en attente), en direct avec Gérer ou par une personne qui approuve, If-Match facultatif, playlist_not_approved pour une liste de lecture qu’aucune personne n’a approuvée.

Un téléverseur ne remplace qu’une page média de ses dossiers, par une autre page média de ses dossiers ; en mode Proposer, les pages qui attendent dans sa propre révision peuvent aussi être remplacées par lui.

Supprime une page d’une liste de lecture approuvée. La liste de lecture conserve de 1 à 100 pages et une page ordinaire sans visibilité (invalid_request sinon). Une page inconnue donne not_found. Tout le reste est comme pour replacePlaylistPage. Un téléverseur ne supprime qu’une page média de ses dossiers.