API de Projetos

Retorna detalhes atuais de confirmação, bloqueadores de exclusão e dispositivos arquivados que serão desconectados. allowed é falso, com um motivo, quando o solicitante não pode excluir o projeto (apenas seu proprietário ou um administrador da organização pode; para um agente, sua pessoa responsável) ou um bloqueador permanece.

O proprietário transfere a propriedade para um membro existente verificado do projeto; isso não concede nenhuma nova associação. A associação do novo proprietário deixa de ter qualquer screen_scope e upload_scope, então o novo proprietário alcança o projeto inteiro.

Uma sessão do dashboard de um administrador da organização do projeto que é membro transfere a propriedade da mesma forma, de quem for o proprietário do projeto; um administrador da organização que não é membro usa PUT /api/organizations/{org_id}/projects/{project_id}/owner.

Movimentação autorizada pelo proprietário transfere a ocupação da tela e o novo uso para o pagador de destino atomicamente; cobranças históricas mantêm seu pagador. Um destino que já tem tantos projetos ativos quanto o plano permite é project_limit_reached, cujo required_plan nomeia o plano com espaço, ausente em Enterprise.

Lista destinos que o proprietário administra ou cujo domínio verificado corresponde ao seu e-mail verificado.

Lista todas as associações ativas da identidade, com contexto de organização e proprietário, incluindo associações omitidas deste token ou do consentimento da concessão. Cada entrada marca in_token; a descoberta não adiciona autoridade e não tem limite de 64 projetos.

Cria um projeto nomeado pertencente à pessoa responsável verificada. Sem uma organização nomeada, vai para a organização do domínio verificado da pessoa, senão para a organização do projeto atual, senão para a organização que a pessoa usou mais recentemente entre as que administra ou possui como gratuita, senão uma nova organização.

Um nome de organização seleciona exatamente uma correspondência visível, caso contrário cria uma nova organização. Uma pessoa possui uma organização Standard gratuita; uma nova organização além disso é free_organization_limit, nomeando a que ela possui.

Uma organização tem no máximo tantos projetos ativos quanto o plano permite (Standard 1, Plus 3, Premium 10, Education 50, Enterprise 100, ampliado por seus featuresets); um a mais é project_limit_reached, cujo required_plan nomeia o plano com espaço, ausente em Enterprise (fale com o suporte).

Uma repetição idempotente exata reenvia sua credencial de associação selada por dez minutos. O registro está isento do limite.

Sob um JWT de acesso de agente (escopo de identidade, acesso:gerenciar, uma concessão com acesso de identidade Gerenciar) nenhum token de projeto é entregue; o projeto se junta à concessão com Gerenciar e todas as capacidades, e uma atualização com seu project_id retorna um token para ele.

Lista registros do ciclo de vida do convite para o projeto atual, excluindo reinicializações de login. Endereços dos destinatários são visíveis para o projeto proprietário, que os forneceu. Tokens e URLs de credenciais nunca são listados.

Cria convites para membros ou compradores de anúncios. Entrega por e-mail nunca retorna uma credencial. Entrega por link é apenas para membros e retorna uma URL, inclusive em replays idempotentes exatos dentro de 24 horas. Convites por e-mail expiram após sete dias; links expiram após 24 horas. Convites por e-mail pendentes do mesmo tipo, endereço e projeto são reutilizados.

Um membro limitado a telas não convida pessoas (outside_screen_scope).

Um convite por e-mail project_member a uma pessoa que seria um convidado externo da organização do projeto (essa não é a organização principal dela) está sujeito à política de convidados dessa organização, e guest_not_allowed (403) responde quando a política (allow, domains ou none) não admite o endereço. Aceitar o convite verifica novamente.

A equipe e os próprios administradores da organização estão isentos. Um screen_scope no convite é o recurso de escopo de telas, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402).

Revoga um convite pendente. Um convite aceito retorna invitation_consumed. Um membro limitado a telas não revoga convites (outside_screen_scope).

Aceita uma solicitação de reset de login sem revelar se uma pessoa possui o endereço.

Uma pessoa cujo endereço não foi verificado, como um cadastro de autoatendimento, também é encontrada, e concluir esse reset, que seu titular deve confirmar com replace_unverified_account, dá ao titular da caixa de entrada uma nova conta (uma nova pessoa com a credencial do reset, uma nova organização e um novo projeto) e exclui a pessoa não verificada, sem que ninguém tivesse demonstrado que o endereço lhe pertencia.

Um link de redefinição expira uma hora depois da última solicitação. Enquanto o link de uma pessoa estiver ativo e tiver menos de um dia, outra solicitação reenvia esse mesmo link (no máximo uma vez a cada dez minutos) e adia a expiração para uma hora após a solicitação, de modo que uma solicitação nunca invalida o link que já está na caixa de entrada; caso contrário, um novo link o substitui. Não há limite por endereço.

Concluir uma redefinição remove as outras chaves de acesso da pessoa (todas as chaves de acesso em uma redefinição de senha), remove a senha quando a nova credencial é uma chave de acesso, descarta uma alteração de e-mail pendente e encerra todas as sessões. Com ou sem pessoa, a solicitação também reenvia no máximo dez convites endereçados ao e-mail, e cada convite no máximo uma vez por hora.

Dos dez projetos não excluídos mais recentes com endereço de contato correspondente, cada projeto ativo com um plano do catálogo e cuja titularidade ainda esteja pendente desde o cadastro recebe novamente seu convite de cadastro, mesmo que ele tenha expirado ou que o destinatário já tenha entrado como membro comum.

Aceitar esse convite de cadastro com o acesso existente conclui a reivindicação de titularidade; somente solicitar a recuperação não altera a titularidade nem as credenciais. Convites por email pendentes para membros e compradores de anúncios de projetos ativos com um plano do catálogo, e convites pendentes para administradores de organizações ativas, ocupam as vagas restantes, dos mais recentes para os mais antigos.

Um convite reenviado mantém seu ID e recebe um novo link e uma nova validade; o link antigo deixa de funcionar e o número de convites pendentes do projeto não muda. Um convite de cadastro expirado volta como um novo convite e ocupa novamente uma vaga, aumentando o contador em um; ele é ignorado se o projeto estiver cheio.

Outros convites expirados, revogados, aceitos ou compartilhados por link não são reenviados.

Cria um novo projeto e seu primeiro agente por meio de inscrição explícita via CLI agrupada, mesmo quando o endereço de contato já pertence a uma pessoa ou projeto. O e-mail de contato permanece não verificado e não concede autoridade; endereços malformados retornam invalid_request.

Enfileira um convite de inscrição na mesma transação. project_name é opcional; a omissão usa um nome legível de duas palavras. A repetição idempotente exata precede os limites de taxa. Persista a credencial permanente antes de relatar sucesso; seu envelope de repetição expira em issuance_expires_at e tentativas posteriores retornam credential_issuance_expired.

O registro de idempotência dura 24 horas.

Inicia um login no navegador AgentID (OIDC) no host da API derivado da origem pública em tempo de execução (https://play.<domain> -> https://api.<domain>). Define um cookie de vínculo de uso único e redireciona para o endpoint de autorização AgentID com PKCE S256. Responde apenas no host da API.

Enquanto a parte confiável não tem id e segredo de cliente, a rota exibe uma página simples indisponível com 503.

Conclui um login AgentID no navegador no host da API. Requer iss igual ao emissor configurado, cookie de vinculação e uma transação de uso único não expirada.

Troca o código com client_secret_basic e PKCE, verifica o id_token ES256 (iss, aud, exp com desvio de 60 s, nonce) contra o JWKS em cache, chama userinfo e aplica as regras do proprietário, então renderiza uma página de código de reivindicação de uso único. Um sujeito já vinculado a um agente renderiza a página já inscrita.

Esta rota nunca cria um projeto, identidade ou convite.

O projeto chamador. Não debita o medidor de API de 1 crédito, então um projeto com saldo zero ainda pode ler o restante e se recuperar. Após um principal de projeto bem-sucedido, respostas JSON autenticadas /api e de problema incluem ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset e ScreenRig-Credits-Included como créditos inteiros.

SSE, runtime, conteúdo e respostas não autenticadas os omitem.

Renomeia o projeto atual. Os nomes contêm de 1 a 60 caracteres imprimíveis e nenhum texto com aparência de URL.

Só o proprietário do projeto ou um administrador de sua organização pode excluí-lo; qualquer outro chamador é recusado com forbidden. Uma pessoa também deve ser membro do projeto.

Um agente precisa da capacidade de projeto de associação alvo e exclui para sua pessoa responsável, que deve ser o proprietário ou um administrador da organização; um agente sem pessoa responsável não pode excluir, exceto o agente que inscreveu o projeto enquanto nenhuma pessoa aceitou sua inscrição.

Também requer o nome e revisão atuais, zero telas não arquivadas, sem crédito, reservas ou dívida em sua própria carteira e sem publicidade ao vivo. Um saldo negativo acumulado sob termos gratuitos ou de lançamento não bloqueia; a exclusão o compensa com uma entrada de razão project_delete_writeoff. Enfileira avisos para membros e usa a lápide irreversível.

O plano do projeto chamador, flags independentes de anunciante/telas com sua revisão, o conjunto derivado de capacidades efetivas, os recursos do plano que ele tem (plan_features) e seus limites (limits). Nunca reflete uma reivindicação do cliente; um plano desconhecido falha fechado como proibido.

O registro de auditoria próprio da organização: alterações em seus administradores, domínios e configurações de cobrança, com as mesmas entradas, filtros e formatos de GET /api/audit. Exige um administrador da organização. Faz parte do registro de auditoria, que o plano Enterprise inclui; uma organização cujo plano não o inclui é recusada com feature_not_in_plan (402).

Todo plano registra as suas alterações.

As notificações da organização, de todos os canais, mais antigas primeiro (no máximo 50).

Uma notificação pertence à organização e cobre todos os projetos dela, inclusive os adicionados depois (project_ids ausente), ou os projetos escolhidos (project_ids); ela age sobre as telas, fontes, campanhas e cartões desses projetos exatamente como uma notificação de projeto. status é failing enquanto as entregas de qualquer projeto coberto estiverem, e failing_since, last_success_at e last_failure_at reúnem as dos projetos cobertos (o início de falha mais antigo, o último sucesso e a última falha).

O segredo de assinatura de um webhook nunca é retornado aqui. Exige um administrador da organização; qualquer outra pessoa recebe not_found.

Cria uma notificação da organização, com os campos de POST /api/notifications e os projetos que ela cobre: project_ids ausente ou null cobre todos os projetos da organização (os que ela tem e os que vier a ter), uma lista cobre exatamente esses, cada um um projeto ativo desta organização (invalid_request caso contrário).

Os destinatários de uma notificação por e-mail são owner (o proprietário de cada projeto coberto) ou user_ids de pessoas da organização (seus administradores e membros da organização) ou membros de um projeto coberto; cada projeto ainda envia e-mail apenas às pessoas que são membros dele.

Uma organização tem no máximo 50 notificações, sem contar as padrão que o sistema cria (notification_limit_reached). Os mesmos recursos do plano restringem os canais, regras e condições como nas rotas de projeto, avaliados no plano da organização. Cada projeto coberto recebe notification.created, e a mudança é registrada no registro de auditoria da organização.

O segredo de assinatura de um webhook é retornado apenas nesta resposta e em rotate-secret; um único segredo assina as entregas de todos os projetos cobertos. Repetir a requisição exatamente igual, com o mesmo Idempotency-Key, retorna esta mesma resposta, com o segredo, por vinte e quatro horas.

Uma notificação da organização, como GET /api/organizations/{org_id}/notifications a mostra.

Altera qualquer campo que PATCH /api/notifications/{id} altera, na notificação e em todos os projetos cobertos, e project_ids: ausente mantém os projetos, null cobre todos os projetos, uma lista cobre exatamente esses. Um projeto que ganha a notificação começa no evento atual (nada anterior é enviado); um que a perde tem a notificação excluída.

Cada projeto coberto recebe notification.updated, e a mudança é registrada no registro de auditoria da organização.

Uma mudança que faz a notificação cobrir um projeto que ela não cobre hoje é restringida pelo plano como a criação da notificação tal como ficará (seu canal, suas regras e condições de tela, no plano da organização); cobrir menos projetos nunca é restringido, e passar de uma lista para todos os projetos sempre cobre mais. If-Match protege a revisão.

Exclui a notificação de todos os projetos que ela cobre, com notification.deleted em cada um, e a registra no registro de auditoria da organização. Os avisos pendentes são marcados como falhos com webhook_deleted.

Somente notificações de webhook (qualquer outro canal é invalid_request). Substitui o segredo de assinatura em todos os projetos cobertos de uma vez, para que um receptor continue verificando um único segredo, e retorna a notificação com o novo em secret.

Como em POST /api/notifications/{id}/rotate-secret, no máximo uma tentativa por projeto já em andamento ainda pode chegar assinada com o segredo antigo. Repetir a requisição exatamente igual, com o mesmo Idempotency-Key, retorna o mesmo novo segredo por vinte e quatro horas.

Envia um notification.test pelo primeiro projeto que a notificação cobre (por id de projeto), como POST /api/notifications/{id}/test envia um pelo seu projeto: uma entrega, cujo resultado a lista de entregas mostra, tentada uma única vez.

Todos os projetos cobertos têm o mesmo receptor, destino e segredo, então um teste comprova o canal; o e-mail de um teste vai para os destinatários desse projeto. Uma notificação que não cobre nenhum projeto é invalid_request.

Os registros de entregas de todos os projetos que a notificação cobre, em uma única lista, mais recentes primeiro pelo momento em que cada linha entrou na fila. Cada linha nomeia seu projeto (project_id), e seu id abre GET .../deliveries/{delivery_id}/attempts. Devolva next_cursor como antes para a próxima página.

As tentativas de uma entrega, mais recentes primeiro, as 20 mais recentes. Uma entrega que não é desta notificação é not_found.

Volta a enviar os e-mails de uma notificação a uma pessoa que os interrompeu com o link de cancelamento do e-mail, em todos os projetos que a notificação cobre (o link os interrompe em todos eles). Idempotente: uma pessoa que não está interrompida não altera nada, e a resposta é a notificação como está.

Uma mudança aumenta a revisão e adiciona notification.updated com os detalhes change resubscribed, user_id e via api a cada projeto coberto.

Lista os tipos de relatório que GET /api/reports/{kind} gera, com os filtros de cada um, e os formatos em que um relatório é gravado. Requer a capacidade de relatórios.

Lista os relatórios programados do projeto, do mais antigo ao mais recente (no máximo 50), cada um com seu próximo envio e o resultado do último. Requer a capacidade do projeto.

Programa o envio de um relatório por e-mail, como anexo PDF, XLSX ou CSV, todos os dias, semanas ou meses em um horário em um fuso horário.

Cada envio cobre o período anterior, em dias UTC: o dia anterior, os sete dias anteriores ou o mês passado. recipients são membros do projeto, indicados por user_id ou pelo endereço de e-mail do membro; qualquer outra pessoa é recusada, então uma assinatura nunca é um meio de escrever a um estranho, e um membro que sai deixa de recebê-la.

Uma execução que falha é repetida e aparece com last_status failed e last_error. No máximo 50 por organização em todos os seus projetos (report_subscription_limit_reached).

Exige um administrador designado de uma organização ativa, autenticação por cookie da mesma origem exata e CSRF por JWT. O ator e a URL de retorno são controlados pelo servidor. A resposta é privada e no-store. Também está aberto a uma organização delegada a um revendedor, para o seu cartão de pagamento e as faturas anteriores.

Exige um administrador designado de uma organização ativa, autenticação por cookie da mesma origem exata e CSRF por JWT. O ator é controlado pelo servidor. Desativar preserva os valores salvos e o gasto mensal; os campos de valor são ignorados ao desativar. A resposta é privada e no-store. Alterar as configurações remove uma pausa recuperável somente depois que qualquer fatura em aberto com falha de pagamento for anulada com segurança.

Ativá-lo para uma organização delegada a um revendedor responde 409 billed_by_reseller; desativar continua permitido.

Visões de pagamentos de uma organização ativa. Exige o cookie do administrador designado; a visibilidade da equipe, por si só, não concede acesso a compras. Pagamentos não configurados retornam available false. O retorno do navegador nunca concede créditos.

Iniciar uma compra pré-paga para o administrador designado de uma organização ativa. Exige autenticação por cookie da mesma origem e, para sessões JWT, um cabeçalho CSRF correspondente. O servidor controla a organização, o cliente, o responsável e as URLs de retorno. Os créditos são aplicados somente após o serviço de cobrança confirmar o pagamento. Em caso de respostas ambíguas, tente novamente com a mesma Idempotency-Key e o mesmo valor.

Uma organização delegada a um revendedor responde 409 billed_by_reseller.

A carteira da organização. Exige um admin designado da organização, um admin do revendedor ao qual a organização está delegada ou uma sessão da equipe. Não concede associação a nenhum projeto.

Entradas de diário atribuídas a esta organização no momento da cobrança, com identidades de projeto e pagador. Movimentações não transferem acesso histórico. Entradas anteriores ao contexto registrado da organização permanecem em seus extratos de projeto. Lido pelas mesmas pessoas que o saldo (getOrganizationBillingBalance).

O pool de uso da organização e a participação de cada projeto em um mês UTC. Cobre o uso pago por esta organização; os demais custos do pagador estão no extrato da organização. Lido pelas mesmas pessoas que o saldo (getOrganizationBillingBalance).

Organizações visíveis, incluindo organizações vazias para seus administradores. Nomes não são únicos.

Admins designados e agentes cujo responsável verificado é um admin podem renomear uma organização. Nenhuma permissão ou associação de projeto é concedida.

Ativa ou desativa Exigir revisão para alterações do agente. Enquanto ativado, todo agente e cliente de serviço no projeto tem acesso Propor em cada solicitação, independentemente das credenciais. Somente o proprietário do projeto ou um administrador da organização do projeto podem alterar (proibido para outros); sessões de sombra da equipe não podem alterar.

If-Match carrega review_policy_revision (0 permitido) e é obrigatório; um valor obsoleto é revision_conflict. Desativá-lo requer prova, a prova de passkey fresca ou senha que a aprovação de conexão do agente usa; ativá-lo não. Revisões abertas permanecem decidíveis de qualquer forma. Anexa project.review_policy_changed.

Retorna detalhes atuais de confirmação, bloqueadores de exclusão e dispositivos arquivados que serão desconectados. allowed é falso, com um motivo, quando o solicitante não pode excluir o projeto (apenas seu proprietário ou um administrador da organização pode; para um agente, sua pessoa responsável) ou um bloqueador permanece.

O proprietário transfere a propriedade para um membro existente verificado do projeto; isso não concede nenhuma nova associação. A associação do novo proprietário deixa de ter qualquer screen_scope e upload_scope, então o novo proprietário alcança o projeto inteiro.

Movimentação autorizada pelo proprietário transfere a ocupação da tela e o novo uso para o pagador de destino atomicamente; cobranças históricas mantêm seu pagador.

Lista destinos que o proprietário administra ou cujo domínio verificado corresponde ao seu e-mail verificado.

Lista registros do ciclo de vida do convite para o projeto atual, excluindo reinicializações de login. Endereços dos destinatários são visíveis para o projeto proprietário, que os forneceu. Tokens e URLs de credenciais nunca são listados.

Cria convites para membros ou compradores de anúncios. Entrega por e-mail nunca retorna uma credencial. Entrega por link é apenas para membros e retorna uma URL, inclusive em replays idempotentes exatos dentro de 24 horas. Convites por e-mail expiram após sete dias; links expiram após 24 horas. Convites por e-mail pendentes do mesmo tipo, endereço e projeto são reutilizados.

Um membro limitado a telas não convida pessoas (outside_screen_scope).

Um convite por e-mail project_member a uma pessoa que seria um convidado externo da organização do projeto (essa não é a organização principal dela) está sujeito à política de convidados dessa organização, e guest_not_allowed (403) responde quando a política (allow, domains ou none) não admite o endereço. Aceitar o convite verifica novamente.

A equipe e os próprios administradores da organização estão isentos. Um screen_scope no convite é o recurso de escopo de telas, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402).

O projeto chamador. Não debita o medidor de API de 1 crédito, então um projeto com saldo zero ainda pode ler o restante e se recuperar. Após um principal de projeto bem-sucedido, respostas JSON autenticadas /api e de problema incluem ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset e ScreenRig-Credits-Included como créditos inteiros.

SSE, runtime, conteúdo e respostas não autenticadas os omitem.

Renomeia o projeto atual. Os nomes contêm de 1 a 60 caracteres imprimíveis e nenhum texto com aparência de URL.

Só o proprietário do projeto ou um administrador de sua organização pode excluí-lo; qualquer outro chamador é recusado com forbidden. Uma pessoa também deve ser membro do projeto.

Um agente precisa da capacidade de projeto de associação alvo e exclui para sua pessoa responsável, que deve ser o proprietário ou um administrador da organização; um agente sem pessoa responsável não pode excluir, exceto o agente que inscreveu o projeto enquanto nenhuma pessoa aceitou sua inscrição.

Também requer o nome e revisão atuais, zero telas não arquivadas, sem crédito, reservas ou dívida em sua própria carteira e sem publicidade ao vivo. Um saldo negativo acumulado sob termos gratuitos ou de lançamento não bloqueia; a exclusão o compensa com uma entrada de razão project_delete_writeoff. Enfileira avisos para membros e usa a lápide irreversível.

Lista aplicativos do mais novo para o mais antigo, no máximo 500 por página. Nomes são rótulos e não precisam ser únicos; enderece um aplicativo pelo ID. next_cursor é a posição da última linha retornada enquanto houver mais linhas; passe-o de volta como after, com os mesmos filtros, para a próxima página. next_cursor é nulo na última página.

Transmite um tar.gz produzido por CLI diretamente para staging durável limitado. Metadados são carregados nos cabeçalhos para que o arquivo nunca seja codificado em base64 ou materializado como JSON pelo servidor.

O proxy na frente da API encerra uma solicitação que não respondeu em cerca de 100 s, portanto um arquivo grande em um uplink lento falha aqui; POST /api/applications/uploads envia o arquivo diretamente para o armazenamento de objetos.

Declara um upload direto de um tar.gz produzido pela CLI que cria um novo aplicativo. A resposta é uma autorização assinada para exatamente um PUT de objeto do arquivo, portanto os bytes vão diretamente para o armazenamento de objetos e nunca pela API, cujo proxy encerra uma solicitação que não respondeu em cerca de 100 s.

Envie o arquivo com PUT para upload_url, depois confirme com POST /api/applications/uploads/{id}/commit e aguarde a operação. O aplicativo, sua versão e a operação receptora existem a partir desta resposta, como após POST /api/applications. Um upload não confirmado em 24 horas falha, e um aplicativo que nunca publicou uma versão é removido.

A mesma Idempotency-Key e o mesmo corpo retornam o mesmo upload com uma URL recém-assinada. GET /api/capabilities define features.application_direct_uploads onde essas rotas são servidas.

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 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.

A lista padrão retorna telas pairing_pending e ativas. Passe state=archived para listar apenas telas arquivadas. Passe tag para listar apenas telas cujas tags contenham exatamente essa tag; telas sem tag são omitidas quando o filtro está presente.

Passe field, uma vez por campo, como NAME:VALUE para listar apenas as telas cujos campos têm todos os valores, e near como LAT,LON,KM para listar apenas as telas localizadas a até KM quilômetros do ponto; telas sem localização são omitidas, e todo filtro se combina com state e tag.

Passe folder como um ID de pasta de telas para listar apenas as telas diretamente dentro dela (não as de suas subpastas), ou root para as telas fora de qualquer pasta.

As telas vêm das mais novas para as mais antigas, no máximo 500 por página. next_cursor é a posição da última linha retornada enquanto restam mais linhas; passe-o de volta como after, com os mesmos filtros, para a página seguinte. next_cursor é null na última página. Um chamador limitado a telas (docs/screen-scope.md) lista apenas as telas do seu escopo.

Uma requisição que não nomeia um projeto deixa de fora cada projeto em que o chamador é limitado a telas; nomeie o projeto para listá-lo.

Lista todas as pastas de telas do projeto, no máximo 1000, ordenadas por nome.

Pastas organizam telas e as segmentam: uma folha de público-alvo de campanha {"folder": ID} corresponde às telas dessa pasta e de toda pasta dentro dela, um seletor de ação de frota by:folder atua sobre as mesmas telas, e o default_playlist_id de uma pasta é o que suas telas sem playlist própria exibem. parent_id é nulo na raiz do projeto; construa a árvore a partir de parent_id. screens conta as telas ativas diretamente dentro de cada pasta.

A pasta de uma tela é Screen.folder_id. Um chamador limitado a telas (docs/screen-scope.md) lista as pastas dentro do seu escopo e as pastas acima delas, que são somente leitura para que a sua árvore tenha uma raiz; as pastas acima não trazem contagem de telas e as pastas irmãs ficam ocultas. Uma requisição que não nomeia um projeto deixa de fora cada projeto em que o chamador é limitado a telas.

Cria uma pasta de telas na raiz do projeto (parent_id nulo ou ausente) ou dentro de parent_id. Nomes são aparados, têm de 1 a 100 caracteres Unicode sem controles, não são "." nem "..", e são únicos entre seus irmãos (resource_conflict).

Uma organização tem no máximo 1000 pastas em todos os seus projetos (quota_exceeded) aninhadas no máximo 10 níveis (invalid_request). default_playlist_id, quando definido, deve nomear uma playlist aprovada (playlist_not_approved). Emite screen.folder_created.

Um chamador limitado a telas (docs/screen-scope.md) só cria uma pasta dentro de uma pasta do seu escopo; a raiz do projeto ou qualquer outro pai é outside_screen_scope. Criar uma pasta dentro de uma pasta protegida é uma revisão protected_change (202 pending_review) decidida por um segundo aprovador.

Move telas (screen_ids) e pastas (folder_ids) para uma pasta (folder_id), ou para a raiz do projeto quando folder_id é null, em uma única solicitação tudo ou nada de no máximo 1000 ids. Todo id deve existir (not_found). Uma pasta não pode se mover para dentro de si mesma ou de uma pasta dentro dela, e a movimentação deve manter todas as pastas dentro de 10 níveis (invalid_request).

Itens já no destino permanecem como estão; cada tela e cada pasta movida avança sua revisão. As telas movidas resolvem novamente a playlist em cerca de 15 segundos: levels nomeia as campanhas cujo público-alvo de pasta elas entram ou deixam e as playlists padrão de pasta que ganham ou perdem. Emite screen.moved.

Um chamador limitado a telas (docs/screen-scope.md) move telas e pastas dentro do seu escopo para uma pasta do seu escopo; qualquer id ou destino fora dele, e a raiz do projeto, recusam a movimentação inteira (outside_screen_scope), inclusive quando uma tela sai do escopo entre a verificação e a gravação.

Mover para dentro ou para fora de uma pasta protegida é uma revisão protected_change (202 pending_review) decidida por um segundo aprovador.

Responde o que as telas de um assunto reproduzem em [from, to) e por quê, para o calendário de programação do painel: exatamente um entre screen_id, folder_id (as telas da pasta e de todas as pastas dentro dela), tag ou campaign_id (as telas do seu público-alvo).

Telas cujas pilhas têm entradas idênticas (os mesmos níveis, playlist padrão, fuso horário e número de displays) compartilham um grupo com uma linha do tempo, então um assunto grande custa dezenas de linhas do tempo; um grupo lista até 500 de suas telas e uma resposta no máximo 200 grupos (truncated).

Cada grupo traz sua pilha, da mais alta para a mais baixa (takeover, campanhas que alcançam as telas, suas próprias entradas de programação, depois a playlist padrão ou a da pasta mais próxima), os spans de cada nível (plays em todo display que ele alcança, partial com os displays em que é reproduzido, outranked, ou conditional enquanto aguarda interação ou uma condição de dados que só um Player observa), o que cada display mostra (on_screen; a região main de uma página inteira) e conflicts (duas campanhas de mesma prioridade vigorando ao mesmo tempo; um nível que vigora mas nunca é reproduzido). from e to são instantes RFC 3339, com to depois de from, no máximo 93 dias de distância; são truncados ao minuto.

As regras são lidas no fuso horário de cada grupo, como a varredura e todo Player as leem; todo nível é considerado reproduzível. Um chamador limitado a telas (docs/screen-scope.md) deve enviar um screen_id ou um folder_id dentro do seu escopo; uma tag, um campaign_id ou nenhum alvo é outside_screen_scope.

Responde com uma planilha com as colunas que uma importação de programação lê e três linhas de exemplo (um código de tela, uma pasta de telas e uma tag), em CSV ou, com format=xlsx, em uma pasta de trabalho XLSX.

Lê uma planilha de linhas de programação contra o projeto e responde o que o commit faria, sem gravar nada.

Cada linha indica um alvo (uma tela por id, pelo valor de um campo da tela como um código de sala, ou por nome; folder:NAME; tag:NAME; vários separados por ; ou |), o conteúdo (um nome de arquivo de mídia, ou playlist:NAME ou o id de uma playlist), um início e um fim (uma data sozinha como fim encerra esse dia) e, opcionalmente, timezone, days (Mon-Fri), uma janela diária (daily_start, daily_end), priority de 0 a 100, um nome e números de display.

Os horários são lidos no relógio próprio de cada tela; uma coluna timezone os converte de outro fuso.

Cada linha é verificada e informa seus erros por coluna: tela, pasta ou tag desconhecida ou ambígua, arquivo ausente ou ambíguo, arquivo que não consegue preencher uma tela, horários inválidos ou invertidos, um fim no passado, nenhuma informação de horário, uma tela sem fuso horário ou sem playlist padrão, duas linhas vigentes ao mesmo tempo em uma tela com a mesma prioridade, e mais níveis do que uma tela comporta (32), ou mais campanhas do que sua organização comporta em todos os seus projetos (100; cada nível compartilhado é uma delas).

Linhas que coincidem em conteúdo, horários, prioridade e nome viram um nível: uma tela é uma entrada da programação própria dessa tela; várias telas, uma pasta ou uma tag são um nível compartilhado (uma campanha), que prevalece sobre os níveis próprios de uma tela.

A resposta lista os níveis com o que um commit faz em cada um (create, update, unchanged), os níveis que uma execução anterior da mesma importação criou e que a planilha não tem mais (removals), as pilhas das telas como ficariam (calendar) e uma fingerprint para enviar ao commit. A planilha é composta por linhas JSON, CSV ou XLSX, com no máximo 5.000 linhas.

Não disponível para um chamador limitado a telas (outside_screen_scope). A importação de programação faz parte do plano Enterprise; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402). O modelo está disponível em todos os planos.

Confirma uma importação já pré-visualizada: a mesma planilha e a fingerprint que a prévia respondeu. Cada nível é criado, atualizado ou removido, as programações das telas e os níveis compartilhados são gravados em uma única transação e o evento de importação schedule.imported é registrado: todas as linhas são aplicadas ou nenhuma é.

As playlists de um arquivo de que os arquivos da planilha precisam são criadas primeiro (elas não alteram nada em nenhuma tela). Uma planilha cujas linhas têm erros é recusada (schedule_import_invalid); um projeto que mudou desde a prévia, ou linhas que são lidas de outra forma, é recusado (schedule_import_stale), e o cliente pré-visualiza de novo.

Importar a mesma planilha de novo com o mesmo nome não altera nada; uma linha alterada atualiza seu nível e uma linha removida remove seu nível. Exige uma pessoa que possa aprovar no dashboard e, para um agente, uma credencial com acesso de escrita.

Um commit que atualizaria ou excluiria uma campanha reservada responde reserved_item (403) e não grava nada, a menos que seja feito por uma pessoa que pode aprovar.

Um commit que alcança uma tela protegida é recusado por inteiro com protected_target, inclusive quando a importação não tem níveis, mas remove entradas de importação de uma tela protegida ou exclui uma campanha de importação cujo público alcança uma.

Em um projeto com pastas de telas protegidas, um commit cuja prévia falha em um serviço, e não na planilha, responde dependency_unavailable e não grava nada: envie a mesma requisição de novo após uma breve espera. Um erro de validação de planilha, campanha ou tela responde como o commit responderia (invalid_request e os outros problemas acima).

Não disponível para um chamador limitado a telas. A importação de programação faz parte do plano Enterprise; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402). O modelo está disponível em todos os planos.

Reivindica um código de link do navegador para o projeto autenticado e cria atomicamente exatamente uma tela pairing_pending inicial mais sua concessão de provisionamento de navegador existente. A inscrição permanece apenas para o projeto. A resposta é apenas metadados seguros e nunca contém token de provisionamento, URL fragmentado, cookie ou prova.

Reivindica uma sessão de pareamento Player global de frota com seis caracteres. Retentativas com a mesma Idempotency-Key retornam o resultado original durável sem consumir cota novamente.

A sessão de dashboard resgata o código no seu projeto atual com o mesmo corpo, Idempotency-Key, orçamentos e problemas, exceto que o seu not_found para um código desconhecido ou já resgatado não nomeia nenhum comando do CLI; é uma mudança de estado, então segue as regras de mutação do dashboard, uma sessão shadow sem modo de escrita de staff é recusada, e os eventos que o resgate acrescenta nomeiam o usuário do dashboard. folder_id nomeia a pasta em que a tela entra.

Um chamador limitado a telas (docs/screen-scope.md) deve enviar uma pasta dentro do seu escopo e emparelha somente como uma pessoa que pode aprovar (outside_screen_scope, approver_required).

Provisionamento opcional de nova tela, somente pelo navegador. Sempre cria uma nova tela em pairing_pending; no máximo cinco aguardam pareamento ao mesmo tempo (quota_exceeded). Novas tentativas exatas reenviam o mesmo token de fragmento por dez minutos. O emparelhamento de seis caracteres continua sendo o padrão e o único fluxo de recuperação. folder_id nomeia a pasta em que a tela entra.

Um chamador limitado a telas (docs/screen-scope.md) deve enviar uma pasta dentro do seu escopo (caso contrário, outside_screen_scope).

Aplica uma ação a uma frota selecionada sem limite de contagem de telas. Selecione screen_ids únicos ou uma tag que corresponda a telas ativas na ordem de criação. A seleção resolvida é fixada antes de qualquer mutação, armazenada em blocos limitados e mantida por vinte e quatro horas sob Idempotency-Key.

Cada etapa usa seu caminho de mutação de tela única, preservando revisões, eventos, sinais de tempo de execução e limites por tela. Uma resposta contém uma página limitada de resultados; correspondidos, bem-sucedidos e falhos descrevem essa página. HTTP 202 inclui total, offset e next_cursor. Continue com o mesmo seletor, ação e Idempotency-Key, passando next_cursor como after.

Respeite Retry-After quando presente, incluindo uma página com zero resultados. A resposta ecoa Idempotency-Key, incluindo uma chave gerada quando o chamador a omitiu; mantenha essa chave para continuações. HTTP 200 finaliza a seleção. Páginas respondidas reproduzem exatamente, incluindo falhas por tela; etapas interrompidas reproduzem sem repetir seus efeitos.

Grandes ações são controladas contra os orçamentos existentes de 600 por minuto da organização para recarregar, toast, takeover, programações de playlist, reinicialização, tela e programações de tela; exaustão do orçamento da organização pausa a ação em vez de recusar a frota. Exaustão por tela falha apenas naquela tela.

Uma atribuição, takeover ou etapa set_playlist_schedule que vincula uma playlist com um formato a uma tela cuja parede tem outra forma falha somente para essa tela com 409 playlist_format_mismatch. Mudanças de atribuição e de tag não têm orçamento de mensagens.

Uma atribuição cuja playlist tem um src de iframe ou params de aplicativo que leem um token de tela que alguma tela da página não tem adiciona um aviso screen_fact_missing a essa página (warnings, PlaylistWarning). Falha parcial é um resultado normal. Todas as páginas e novas tentativas sob uma chave são uma única ação medida.

As requisições usam uma carga de bytes limitada; use uma tag para uma seleção maior que a carga do transporte. Um seletor ou uma ação malformada é recusada antes que qualquer tela seja tocada. selector ou action é recusado antes que qualquer tela seja tocada.

Um chamador limitado a telas (docs/screen-scope.md) seleciona por screen_ids ou por pasta, todas as telas dentro do seu escopo; um seletor de tag, uma tela fora do escopo ou uma desconhecida recusa a ação inteira (outside_screen_scope) antes que qualquer coisa seja fixada ou proposta.

Assign, takeover, takeover_clear, set_playlist_schedule e clear_playlist_schedule que alcançam uma tela protegida viram uma revisão decidida por um segundo aprovador (202 pending_review) em todo nível de acesso; set_tags, add_tags e remove_tags em uma tela protegida são protected_target (409).

Uma ação set_playlist_schedule com uma entrada em pausa (um rascunho) é o recurso de controle de alterações da programação, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402).

Exibe abas do navegador em telas do projeto indicado; solicitação, resposta, acesso e limites são os de POST /api/tab-shares.

Lista as campanhas do projeto em ordem de precedência (no máximo 100), a ordem em que a resolução as lê. reserved está presente em toda campanha.

Um chamador limitado a telas (docs/screen-scope.md) vê todas as campanhas, com editable true somente quando todo o público está dentro do seu escopo (uma folha de tag e a regra de todas as telas na raiz nunca estão; uma regra all precisa de um filho contido, uma regra any de todos os filhos) e o chamador pode alterar o que é reproduzido.

createCampaign para o projeto nomeado no caminho. reserved true reserva a campanha, e somente uma pessoa que pode aprovar o define (reserved_item para um agente, um cliente de serviço ou qualquer outro), acrescentando campaign.reserved_changed.

Um chamador limitado a telas (docs/screen-scope.md) só cria uma campanha para um público dentro do seu escopo (folhas folder e screen_id; nenhuma tag, nem todas as telas), caso contrário outside_screen_scope, e somente como uma pessoa que pode aprovar (approver_required).

Uma campanha cujo público alcança uma tela protegida é uma revisão protected_change decidida por um segundo aprovador (202 pending_review) em todo nível de acesso. reserved true é o recurso de pastas protegidas e paused true em uma nova campanha (um rascunho) é o recurso de controle de alterações da programação, e ambos fazem parte do plano Enterprise; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402).

Lista as conexões do projeto, as mais recentes primeiro, no máximo 200 por página; devolva next_cursor como after para a próxima. Um segredo, uma chave ou um token de atualização nunca é devolvido: secret mostra se há um guardado e uma dica que não é secreta. Uma leitura nunca traz um link de consentimento.

Cria neste projeto uma conexão com a Microsoft ou o Google: modo own_app com as credenciais próprias do cliente, ou modo screenrig_app, que responde consent_url, um link de uso único para a pessoa que o conclui (veja createConnection). Adiciona connection.created. Uma nova tentativa exata com a mesma Idempotency-Key devolve a mesma conexão.

Lista as conexões de BI do projeto, da mais antiga para a mais recente, 200 por página; passe next_cursor de volta como cursor para a próxima. Um segredo nunca é retornado: secret mostra se está definido e seus últimos 4 caracteres.

Adiciona uma conexão a um sistema de BI que o projeto possui. Para o Grafana: o endereço dele (http ou https em um host público, com prefixo de caminho opcional) e um token de conta de serviço com a função Viewer. O token é selado e nunca é retornado.

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.

Um administrador do Power BI deve ativar as configurações de desenvolvedor Embed content in apps e Service principals can call Fabric public APIs para o app (portal de administração, configurações do locatário), o app deve ser Membro ou Administrador de cada workspace que exibe, e os relatórios precisam de uma capacidade Embedded, Fabric ou Premium em produção.

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.

Adicione embed_origin da resposta à lista de domínios permitidos do aplicativo conectado e ative o segredo. Quem tem um ticket de tela pode incorporar qualquer visualização que esse usuário possa ver, então use um usuário que veja apenas os dashboards das telas. Tableau Cloud, ou Tableau Server 2023.3 ou posterior.

Para uma página web com login (kind web): a conta de serviço de um site que mostra o dashboard atrás de um login. config.login_mode é auto (config.login_url, config.username e a senha como secret: o renderizador abre a página de login e preenche o formulário), steps (config.login_url e config.steps, um script de passos goto, fill, click, press, wait_for e wait_ms cujos valores podem conter {{username}}, {{password}} e {{otp}}) ou none (sem login: a conexão mostra páginas com os cookies que você dá a ela). totp_secret é a chave base32, ou o endereço otpauth://, do aplicativo autenticador da conta: o servidor calcula o código de uso único (RFC 6238) e envia ao renderizador apenas o código. cookies é um conjunto de cookies exportado de um navegador logado, para um site cujo login não pode ser automatizado (login único aprovado no celular, uma verificação de dispositivo); o servidor guarda o conjunto e o renova com os cookies que cada captura devolve, então um login é raro.

A senha, a semente e os cookies são selados e nunca devolvidos. Use uma conta de serviço somente leitura. A senha é digitada apenas em config.login_url e nos passos goto, então movê-los para outra origem exige secret de novo. Depois de cinco logins recusados seguidos, a conexão para de fazer login até que suas credenciais mudem.

Um servidor sem renderizador de páginas responde bi_web_unavailable. Adiciona bi_connection.created. Uma nova tentativa exata com a mesma Idempotency-Key devolve esta mesma resposta.

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.

Adiciona uma visualização de um painel do Grafana da conexão ou de um único painel interno dele (url: um endereço /d/{uid}/... no host da conexão, ou target), ou de um link de painel público do Grafana (kind grafana e target.public_url, sem conexão).

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.

A página de incorporação mostra apenas um ticket que o manifesto da tela traz, então uma visualização só é reproduzida nas telas do próprio projeto.

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.

Uma visualização do Tableau Public é uma visualização sem conexão (kind tableau, target.public_url, reconstruída como https://public.tableau.com/views/WORKBOOK/VIEW) e também aceita rotate_sheets. Para uma página web (kind web): uma página do site da conexão web (url: um endereço https em um host público, sem target).

O navegador na borda a abre já logado, espera o elemento wait_for quando definido e wait_ms milissegundos (até 10000), e desenha clip, um seletor CSS, quando definido, ou então a página inteira.

A imagem é redesenhada a cada refresh_s (60 a 86400, 300 por padrão) e compartilhada por todas as telas do mesmo tamanho, e só enquanto uma tela mostra a visualização; quando uma captura falha, a última imagem continua na tela. Defina wait_for como um elemento que só existe quando a página está logada, para que uma página de login nunca seja mostrada. Adiciona bi_view.created.

Lista os gatilhos de alerta CAP do projeto, do mais antigo para o mais recente (no máximo 20), cada um com sua URL de ingestão, nome de usuário e último alerta. A senha nunca é retornada aqui.

Cria um gatilho de alerta CAP: uma URL de entrada para a qual um sistema de notificação de emergência (Everbridge, Rave, Alertus, relés IPAWS e outros emissores CAP 1.2) envia alertas, com credenciais HTTP Basic.

A resposta é o único lugar onde a senha aparece (com a resposta de rotação): armazene-a no sistema de envio imediatamente. target é uma tag (toda tela ativa com ela quando o alerta chega) ou até 500 screen_ids.

Um alerta assume todas as telas-alvo com uma playlist padrão até o <expires> do alerta, ou para default_for_seconds (60 a 604800, padrão 3600); veja POST /api/triggers/{id}/cap. Uma organização tem no máximo 20 gatilhos em todos os seus projetos (trigger_limit_reached). Acrescenta trigger.created.

Uma nova tentativa exata com a mesma Idempotency-Key retorna esta mesma resposta, senha incluída, por vinte e quatro horas. Um gatilho cujo seletor alcança uma tela protegida é protected_target (409), e uma falha na leitura da proteção da tela é dependency_unavailable (500, repita a mesma requisição); um gatilho não está disponível para um chamador limitado a telas.

Lista eventos duráveis do projeto em ordem crescente por sequência.

Paginação é contígua: passe o next_cursor retornado como after para continuar exatamente onde a página parou. next_cursor é o cursor do último evento retornado enquanto eventos mais novos já existem, e nulo no fim do histórico. limit padrão é 50 e aceita 1-200; valor fora desse intervalo é recusado com invalid_request e um membro errors[] nomeando limit.

Paginação por offset não é suportada. source=log lista o log do Player em vez disso: os relatórios de condição enviados pelos Players (runtime.reported) em ordem crescente pelo tempo de recebimento, filtrados por screen_id e severidade em uma janela de até (por padrão as últimas 24 horas, no máximo 31 dias).

Seus cursores são opacos: lg1_ ou ev1_ conforme onde o servidor mantém o log do Player, então devolva o que uma página retornou; um cursor do outro tipo é recusado com invalid_request nomeando o campo. Registros do log do Player não têm sequência, não estão em GET /stream/project e não são entregues a webhooks.

Um registro é reconhecido quando a fila de log do Player o aceita e é mantido para a retenção de eventos do projeto. Uma consulta com o último cursor e a janela padrão segue o log. Registros de log do Player não estão na lista padrão (source=project). from e to são recusados com invalid_request a menos que source seja log.

A lista do projeto aceita screen_id, playlist_id e application_id para ler os eventos de uma tela, playlist ou aplicativo, todos limitados ao projeto da credencial (um id nomeia quais eventos ler, nunca de quem): screen_id mantém os eventos cujo recurso é essa tela; playlist_id os eventos cujo recurso é essa playlist mais os eventos que a nomeiam como details.playlist_id (uma tela que a usa); application_id os eventos cujo recurso é esse aplicativo mais os que têm esse id como application_id (seus lançamentos e entradas chave/valor).

Um valor que não é um id do seu tipo é recusado com invalid_request nomeando o campo; playlist_id e application_id são recusados com source=log, cujos registros pertencem só a uma tela.

Ambas as fontes usam resource_id, tipo e severidade (mínimo), combinados entre si, com os filtros de ID e paginação; um registro de log do Player é um registro runtime.reported cujo recurso é sua tela, então um resource_id que não seja essa tela ou um tipo que exclua runtime.reported retorna uma página vazia. before (ou order=desc) mostra os mais recentes primeiro: next_cursor é o cursor do item mais antigo retornado e passado de volta como before para continuar para itens mais antigos.

Sem from, uma página source=log mais recente primeiro alcança além das 24 horas padrão até o registro mais antigo que a retenção de eventos do projeto mantém, no máximo 31 dias abaixo da borda superior da página por requisição. Uma página source=log mais recente primeiro pode conter menos que o limite de registros, até nenhum, com um next_cursor; null ainda a encerra, no fim do log retido.

Um chamador limitado a telas (docs/screen-scope.md) lê um feed filtrado: eventos de telas dentro do seu escopo, das pastas de telas que ele pode ver (as suas próprias, as pastas acima e as de dentro; screen.moved somente quando o destino está dentro do seu escopo), de campanhas, playlists, mídia, aplicativos e cartões, e as revisões playlist_change.

Todo outro evento fica de fora, então uma página pode conter menos eventos que limit, até nenhum, com um next_cursor; continue paginando com ele. source=log precisa de um screen_id dentro do seu escopo. Eventos sobre o próprio projeto não são enviados.

O plano do projeto chamador, flags independentes de anunciante/telas com sua revisão, o conjunto derivado de capacidades efetivas, os recursos do plano que ele tem (plan_features) e seus limites (limits). Nunca reflete uma reivindicação do cliente; um plano desconhecido falha fechado como proibido.

O snapshot do saldo consciente da fonte do projeto chamador. Todos os valores em milicréditos são strings decimais canônicas. É um snapshot, não autoridade para pagar; rails_available é falso enquanto cartão, imposto e rail de saque estão indisponíveis.

Paginação cursor estável sobre entradas de diário imutáveis postadas para o projeto chamador. Holds não são entradas postadas. Correções linkam ao evento original em vez de reescrevê-lo. Não há mutação arbitrária de concessão ou pagamento nesta superfície.

O uso do projeto chamador em um mês UTC, com os bytes servidos e recebidos (nunca cobrados), o armazenamento cobrado acima do armazenamento gratuito do plano do pagador (allowance.storage_bytes) e as solicitações de API, eventos de stream do projeto faturados e tentativas de entrega de webhook contados contra os 10.000 gratuitos por mês. Um projeto que paga por si mesmo lê seu próprio pool.

Um projeto que outro pagador paga compartilha o pool desse pagador com os outros projetos do pagador; ele lê sua própria parte, e payer nomeia o pagador. O total do pool do pagador permanece nas leituras de cobrança do pagador.

A rede do vendedor que está ligando, incluindo a taxa de serviço resolvida do ScreenRig. Vendedores não podem alterar essa taxa.

Cria a única rede do vendedor que chama, se ausente. Requer telas=true. Idempotente; repetir retorna a mesma rede.

Define a taxa padrão do projeto do vendedor por 15 segundos de reprodução concluída. Uma alteração que altera a taxa efetiva de uma campanha aceita pausa toda a campanha com price_change_pending; uma alteração mascarada ou sem efeito não. If-Match carrega a revisão da rede.

O inventário optado pelo vendedor que está ligando.

Cria um slot de vendedor reutilizável. Imagens têm de 5 a 30 segundos e vídeos no máximo o teto da plataforma de 120 segundos. Anúncios estão sempre sem som.

Redes às quais o anunciante chamador pertence atualmente, com o escopo e política de revisão concedidos. Contagem de telas não é contagem garantida de impressões.

Vincula uma revisão de mídia pronta e própria a um criativo imutável. Não copia bytes, não reenvia nem recarrega geração. Mídia desconhecida ou não pronta é rejeitada.

Cria uma campanha rascunho. Rascunhos não possuem dinheiro, não reservam nada e não autorizam entrega. A ativação requer uma cotação explicitamente aceita.

Versões criativas enviadas ao vendedor que chama para revisão. Um vendedor vê apenas a criativa enviada exata, nunca a biblioteca do comprador.

Contagem de gastos e entregas do comprador para uma campanha. Os valores são strings decimais de mcr. Nunca expõe a renda do vendedor, status bancário ou uso do projeto inteiro.

Bruto, taxa de serviço e líquido no escopo do vendedor para uma janela, com sua própria evidência de entrega. Nunca expõe a carteira do comprador ou outras redes. Apenas evidência autorizada de reprodução completa estabelece entrega faturável. A janela tem no máximo 92 dias; janela maior é invalid_request.

Quando contém mais de 5000 liquidações, a resposta define truncado, totais e contagens ainda cobrem todos eles e linhas lista apenas os primeiros 5000.

Agregados diários de reprodução.

JSON retorna no máximo 200 linhas e não tem limite de taxa. format=csv (ou Accept text/csv sem application/json) transmite cada linha correspondente dentro de day_from a day_to (dias UTC inclusivos; padrão day_to hoje e day_from 30 dias antes; no máximo 366 dias, caso contrário invalid_request) como CSV com uma linha de cabeçalho fixa (PlaybackAggregateCsv); somente o formato CSV consome os orçamentos playback-export-org (30 por minuto) e playback-export-ip (60 por minuto).

Qualquer uma das formas é uma requisição de API medida. As respostas trazem Vary Accept. Um chamador limitado a telas (docs/screen-scope.md) deve enviar screen_id, e ele deve ser uma tela dentro do seu escopo (caso contrário, outside_screen_scope); as formas CSV seguem a mesma regra.

Registros por reprodução: uma linha por playback.media_started aceito (ou playback.video_started legado) e uma linha por playback.application_started aceito (release_id definido, campos de mídia vazios) do projeto solicitante, do mais antigo para o mais recente por received_at, empates por inserção. from (inclusivo) e to (exclusivo) delimitam received_at; to padrão é agora, from é 24 horas antes de to, e o intervalo é no máximo 31 dias (invalid_request caso contrário).

Os últimos 5 segundos ainda não são retornados: o effective to é no máximo agora menos 5 segundos (atraso de estabilização), então uma cauda ao vivo nunca pula uma linha que se compromete atrás do seu cursor. screen_id, media_id, playlist_id (a playlist de onde o início foi mostrado) e tag (uma tag da tela quando a reprodução foi recebida) filtram.

Uma página de playlist_id pode conter menos que o limite de linhas, até nenhuma, com next_cursor quando um longo trecho de reproduções de outras playlists foi escaneado; null ainda encerra o intervalo.

JSON é uma página de no máximo limit linhas (padrão 200, no máximo 1000) com next_cursor, null no fim do intervalo; devolva como cursor com os mesmos filtros. order=desc (ou before) pagina os mais novos primeiro dentro do mesmo intervalo: next_cursor é então o cursor da linha mais antiga retornada, null no início do intervalo, e é devolvido como before (exclusivo) com os mesmos filtros; order=asc com before é recusado com invalid_request nomeando order, e cursor com uma página newest-first nomeando cursor.

Uma página mais recente pode conter menos que o limite de linhas, até nenhuma, com um next_cursor; null ainda encerra.

Uma página posterior nunca pula uma linha que existia quando a página anterior foi lida e não repete uma, exceto que um início que o Player reenviou após um relatório não reconhecido (o mesmo play_id, recebido um momento depois) pode aparecer novamente em uma página posterior; o fluxo CSV lista isso uma vez. format=csv (ou Accept text/csv sem application/json) transmite cada reprodução do cursor até o fim do intervalo como CSV (PlaybackPlayCsv), mais recentes primeiro abaixo antes com order=desc; limite é recusado com CSV.

A medição é por requisição: cada página JSON custa um crédito de requisição API, enquanto um fluxo CSV de toda a faixa custa um. Cada requisição de plays (página ou fluxo) consome os orçamentos playback-export-org (30 por minuto) e playback-export-ip (60 por minuto).

Um stream limita cada escrita (15 segundos) e termina quando o cliente desconecta; se falhar após o cabeçalho 200 a conexão é abortada, então uma exportação que lê até um fim limpo está completa. Respostas carregam Vary Accept. As reproduções são mantidas pelo período de retenção de eventos do plano (30 dias é o mínimo padrão; retenção baseada no plano usa a janela própria de 7 ou 90 dias).

Um chamador limitado a telas (docs/screen-scope.md) deve enviar screen_id, e ele deve ser uma tela dentro do seu escopo (caso contrário, outside_screen_scope); as formas CSV seguem a mesma regra.

Totais de reprodução do projeto solicitante por dias UTC inclusivos, lidos dos resumos diários: by=day retorna uma linha por dia com reproduções (screen_id ou media_id limita a uma tela ou mídia), by=screen e by=media classificam as telas ou mídias mais ativas (top, no máximo 100), e by=screen_day retorna a série diária das telas principais (top no máximo 10). day_to padrão é hoje (UTC) e day_from é 29 dias antes.

Uma série de dias abrange no máximo 366 dias (92 quando restrita a uma tela ou mídia); um ranking no máximo 92. As contagens incluem todos os inícios que o projeto registrou, incluindo os armazenados antes da existência dos rollups de reprodução.

Rollups seguem a ingestão por até cerca de 21 minutos. truncated é verdadeiro quando um ranking foi construído a partir de fatias de uma janela muito grande para uma leitura: cobre as melhores chaves de cada fatia. Não tem limite de taxa. Uma solicitação de API medida.

Um chamador limitado a telas (docs/screen-scope.md) deve enviar screen_id, e ele deve ser uma tela dentro do seu escopo (caso contrário, outside_screen_scope); as formas CSV seguem a mesma regra.