API de Playlists

Lista de playlists versionadas que pode expor páginas de adslot. A lista v1 recusa uma página que contém um documento com anúncios com version_required em vez de filtrá-la.

Páginas como listPlaylists, mais recentes primeiro, no máximo 200 por página e menos quando uma página contém 8 MiB de playlists armazenadas. next_cursor é a posição da última linha retornada enquanto houver mais linhas; passe-o como after, com os mesmos filtros, para a próxima página. next_cursor é nulo na última página. library=true lista, em vez disso, as playlists da Biblioteca da organização (somente leitura; programe-as ou crie a partir dos modelos delas).

Entrada de criação para a união de páginas de adslot. No máximo 16 páginas de adslot, pelo menos uma página comum sem visibilidade, e o reuso de uma definição de slot em páginas diferentes permanecem verificações do servidor. Resolução de referência e DNS continuam verificações do servidor.

Uma sessão do dashboard (o editor de páginas) cria a playlist no ar, nunca como proposta, atribuída à pessoa, e exige o proprietário do projeto ou um membro que possa aprovar (caso contrário, approver_required); mídia que ela nomeia e que aguarda revisão é media_pending_review (409), onde a escrita no ar de um agente a aprova.

Uma gravação que contém uma página iframe que o Player web não consegue enquadrar é salva mesmo assim; a resposta traz avisos (PlaylistWarning) e o registro do projeto recebe um evento playlist.iframe_framing_refused por página.

Uma escrita cujo src de iframe, fallback_src ou params de aplicativo leem um token de tela ({screen.field.NAME} e os outros dos esquemas de primitiva) que uma tela que mostra a playlist não tem também responde com um aviso screen_fact_missing nomeando as primeiras 20 telas assim; os manifestos dessas telas deixam essa primitiva de fora.

Um src ou fallback_src de iframe que seja um link do Google Apresentações, Docs ou Planilhas (compartilhar, publicar na web ou incorporar) ou um link de incorporação do Microsoft 365 OneDrive ou SharePoint é armazenado reconstruído para a tela, onde as apresentações repetem e avançam com o delayms do link limitado à duração da página, e Docs, Planilhas, Word e Excel recarregam a cada 5 minutos.

Um código de incorporação <iframe> colado em src ou fallback_src é lido pelo seu src. Um arquivo que pede login aos espectadores é recusado com document_not_shared (400), cujo errors[0].field é esse src ou fallback_src e cujo detalhe nomeia a configuração de compartilhamento a mudar.

Atualização versionada aceitando a união da página adslot. If-Match carrega a revisão da playlist.

Uma sessão do dashboard (o editor de páginas) substitui a playlist no ar, nunca como proposta, atribuída à pessoa; exige o proprietário do projeto ou um membro que possa aprovar (caso contrário, approver_required) e If-Match (invalid_request quando ausente); uma playlist sem aprovação de pessoa ainda é playlist_not_approved (409), como em patchPlaylistStructure, e mídia que uma página nomeia e que aguarda revisão é media_pending_review (409).

Uma gravação que contém uma página iframe que o Player web não consegue enquadrar é salva mesmo assim; a resposta traz avisos (PlaylistWarning) e o registro do projeto recebe um evento playlist.iframe_framing_refused por página.

Uma escrita cujo src de iframe, fallback_src ou params de aplicativo leem um token de tela ({screen.field.NAME} e os outros dos esquemas de primitiva) que uma tela que mostra a playlist não tem também responde com um aviso screen_fact_missing nomeando as primeiras 20 telas assim; os manifestos dessas telas deixam essa primitiva de fora.

Um src ou fallback_src de iframe que seja um link do Google Apresentações, Docs ou Planilhas (compartilhar, publicar na web ou incorporar) ou um link de incorporação do Microsoft 365 OneDrive ou SharePoint é armazenado reconstruído para a tela, onde as apresentações repetem e avançam com o delayms do link limitado à duração da página, e Docs, Planilhas, Word e Excel recarregam a cada 5 minutos.

Um código de incorporação <iframe> colado em src ou fallback_src é lido pelo seu src. Um arquivo que pede login aos espectadores é recusado com document_not_shared (400), cujo errors[0].field é esse src ou fallback_src e cujo detalhe nomeia a configuração de compartilhamento a mudar.

Altera apenas os campos de nível superior enviados: name, pages, audio, format ou fields. Os campos omitidos são preservados do mesmo instantâneo da transação. pages, audio e format enviados substituem o valor completo; audio null remove a trilha sonora e format null remove o formato. Elementos de arrays aninhados não são mesclados.

Uma edição apenas de nome de uma playlist aprovada não revalida nem resolve novamente seu conteúdo inalterado, incluindo formatos de página armazenados mais antigos. Conteúdo fornecido e relações de áudio/sinal de página são validados. If-Match protege opcionalmente a revisão; patches idênticos são operações sem efeito e tentativas idempotentes repetem a resposta original.

O acesso Propose e a política de revisão funcionam como em PUT, incluindo os avisos para um valor pages enviado com uma página iframe que o Player web não consegue enquadrar. PUT continua substituindo o documento inteiro.

Marca como excluída uma playlist pertencente ao projeto autenticado. Recusado com resource_conflict (409) enquanto alguma tela, inclusive arquivada ou pendente, a usar como padrão, em sua programação ou como substituição temporária, enquanto uma pasta de telas a usar como padrão ou enquanto uma campanha a reproduzir.

A sessão do dashboard pode também excluir; cria e substitui playlists com createPlaylistV2 e updatePlaylistV2 e altera sua estrutura via patchPlaylistStructure.

Uma pessoa conectada altera a estrutura de uma playlist e nunca o que suas páginas mostram: seu nome, a ordem das páginas, quais páginas permanecem e o avanço e visibilidade de cada página mantida. pages é a nova ordem completa; uma página armazenada que ela omite é removida, e um id que a playlist não possui, ou um repetido, é invalid_request em pages[i].id.

A tela mantida tem canvas, transição, audio_cue, primitivas e comentários sempre os armazenados: o corpo não tem membro para eles, e qualquer outro membro é recusado.

As páginas mantidas passam pela mesma resolução e validação que qualquer playlist armazenada, então um item de mídia excluído desde então é recusado (resource_conflict) e a playlist ainda mantém uma página comum sem visibilidade, no máximo 16 páginas de slots de anúncio e seus sinais audio_end. advance substitui o avanço da página (uma página de slot de anúncio não tem); visibility substitui a visibilidade da página quando um objeto, remove quando nulo e mantém quando omitido.

Uma alteração que mantém a playlist como armazenada é uma operação sem efeito. If-Match carrega a revisão da playlist e é obrigatório (invalid_request quando ausente, revision_conflict quando desatualizado). A gravação é aplicada imediatamente em todas as telas que exibem a playlist e é atribuída à pessoa em playlist.updated; nunca é uma proposta, portanto a resposta nunca é 202.

Uma playlist que nenhuma pessoa aprovou ainda (approved_revision 0) é recusada com playlist_not_approved (409): decida primeiro sua revisão. Um nome que outra playlist do projeto usa é resource_conflict. Somente a sessão do dashboard; agentes alteram playlists com patchPlaylist, e uma pessoa altera o que as páginas mostram com updatePlaylistV2.

A resposta traz avisos (PlaylistWarning) como em qualquer escrita, entre eles screen_fact_missing quando uma tela que mostra a playlist não tem um valor que o src de um iframe ou os params de aplicativo de suas páginas leem. O corpo tem no máximo 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.

Uma revisão cujo conteúdo é o conteúdo atual não muda nada e responde com a playlist atual. Exige uma credencial que publique ao vivo (proibido para uma cujas gravações são propostas para revisão) ou uma sessão de painel do proprietário do projeto ou de um membro que possa aprovar (approver_required); uma playlist que nenhuma pessoa aprovou ainda é playlist_not_approved (409).

Como em qualquer escrita, a resposta traz avisos (PlaylistWarning), entre eles screen_fact_missing quando uma tela que mostra a playlist não tem um valor que o src de um iframe ou os params de aplicativo das páginas promovidas leem.

Define, ou com null limpa, os valores de campo de uma playlist criada a partir de um modelo e recria as suas páginas a partir da revisão atual do modelo: os valores são verificados como na criação e as mudanças de marca feitas no modelo desde então chegam a esta cópia. Não envie valores para apenas atualizar a cópia.

Classe de revisão como qualquer gravação de playlist: o proprietário ou um membro que possa aprovar (sessão do painel) e uma credencial Manage gravam ao vivo, um uploader só para as suas playlists e pastas, e Propose transforma a alteração em uma revisão (202). Uma playlist que não foi criada a partir de um modelo é invalid_request. If-Match é opcional.

As playlists criadas a partir de um modelo (no máximo 1000, por nome), cada uma com a revisão do modelo de que as suas páginas foram criadas e se o modelo tem uma mais recente.

As páginas que uma playlist criada a partir do modelo com estes valores teria, verificadas por todas as regras. Apenas calcula; nada é armazenado.

Adiciona uma página a uma playlist aprovada sem enviar as outras: no fim, ou antes da página indicada por before.

As páginas que a playlist já contém são mantidas como armazenadas e verificadas novamente com a nova em uma só passada, de modo que as regras entre páginas (1 a 100 páginas, uma página comum sem visibilidade, 16 páginas de espaço publicitário, 1024 referências de mídia) enxergam o resultado: uma regra violada resulta em invalid_request com field (page.id quando o id já está em uso, before quando não nomeia nenhuma página).

A validade de página da playlist é a visibilidade própria da página (from, until, windows, data), no fuso horário de cada tela, com until exclusivo.

Classe de revisão: em Propor, a alteração se torna uma revisão (202); uma alteração de página posterior da mesma playlist pelo mesmo proponente estende essa revisão pendente enquanto ela se baseia na revisão ao vivo, de modo que alterações sucessivas não se substituem, e a aprovação aplica todas ou nenhuma (review_stale quando a playlist avançou); a revisão pendente de uma alteração de página de outro proponente não é estendida nem substituída, e a alteração aguarda com resource_conflict (409).

Com Gerenciar, ou a partir de uma sessão do dashboard do proprietário ou de um membro que possa aprovar (caso contrário, approver_required), vai ao ar. If-Match é opcional: quando presente, deve ser a revisão ao vivo. Uma playlist que nenhuma pessoa aprovou ainda é playlist_not_approved (409).

Um uploader (docs/uploaders.md) adiciona apenas uma página de mídia de suas pastas a uma de suas playlists (caso contrário, outside_upload_scope); um membro uploader em Propor é o proponente da revisão (kind person).

Substitui uma página de uma playlist aprovada, no mesmo lugar, sem enviar as outras. O corpo é a página e seu id é page_id. Uma página desconhecida é not_found.

Todo o resto é como em addPlaylistPage: validado com as páginas mantidas em uma só passada, classe de revisão (202 em Propor, encadeada a uma revisão pendente de alteração de página), no ar com Gerenciar ou por uma pessoa que aprova, If-Match opcional, playlist_not_approved para uma playlist que nenhuma pessoa aprovou.

Um uploader substitui apenas uma página de mídia de suas pastas por outra página de mídia de suas pastas; em Propor, também pode substituir as páginas que aguardam em sua própria revisão.

Remove uma página de uma playlist aprovada. A playlist mantém de 1 a 100 páginas e uma página comum sem visibilidade (caso contrário, invalid_request). Uma página desconhecida é not_found. Todo o resto é como em replacePlaylistPage. Um uploader remove apenas uma página de mídia de suas pastas.