API Progetti

Restituisce i dettagli di conferma correnti, i blocchi di eliminazione e i dispositivi archiviati che verranno disconnessi. allowed è false, con una motivazione, quando il chiamante non può eliminare il progetto (solo il proprietario o un amministratore della sua organizzazione può; per un agente, la persona responsabile) o rimane un blocco.

Il proprietario trasferisce la proprietà a un membro esistente e verificato del progetto; questo non concede alcuna nuova appartenenza. L’appartenenza del nuovo proprietario esce da qualsiasi screen_scope e upload_scope, così il nuovo proprietario raggiunge l’intero progetto.

Una sessione dashboard di un amministratore dell’organizzazione del progetto che è membro del progetto trasferisce la proprietà allo stesso modo, da chiunque possieda il progetto; un amministratore dell’organizzazione che non è membro del progetto usa PUT /api/organizations/{org_id}/projects/{project_id}/owner.

Lo spostamento autorizzato dal proprietario trasferisce atomica occupazione dello schermo e nuovo utilizzo al pagatore di destinazione; gli addebiti storici mantengono il loro pagatore. Una destinazione che ha già tanti progetti attivi quanti ne consente il suo piano è project_limit_reached, il cui required_plan indica il piano con spazio, assente per Enterprise.

Elenca le destinazioni amministrate dal proprietario o il cui dominio verificato corrisponde alla loro email verificata

Elenca ogni appartenenza attiva dell’identità, con contesto di organizzazione e proprietario, incluse quelle escluse da questo token o dal consenso della sua concessione. Ogni voce indica in_token; discovery non aggiunge autorità e non ha limite di 64 progetti

Crea un progetto nominato di proprietà della persona responsabile verificata. Se non è specificata un’organizzazione, il progetto va all’organizzazione del dominio verificato della persona, altrimenti all’organizzazione del progetto corrente, altrimenti all’organizzazione usata più recentemente tra quelle amministrate o gratuite della persona, altrimenti a una nuova organizzazione.

Un nome organizzazione seleziona esattamente una corrispondenza visibile, altrimenti crea una nuova organizzazione. Una persona possiede un’organizzazione Standard gratuita; una nuova organizzazione oltre quella è free_organization_limit, nominando quella che possiede.

Un’organizzazione ha al massimo tanti progetti attivi quanti ne consente il suo piano (Standard 1, Plus 3, Premium 10, Education 50, Enterprise 100, ampliato dai suoi featureset); uno in più è project_limit_reached, il cui required_plan indica il piano con spazio, assente per Enterprise (contatta l’assistenza).

Un retry idempotente esatto ridistribuisce la credenziale di appartenenza sigillata per dieci minuti. L’iscrizione è esente dal limite.

Con un JWT di accesso agente (ambito identità, access:manage, un grant con accesso identità Manage) non viene consegnato alcun token progetto; il progetto si unisce al grant con Manage e tutte le capacità, e un refresh con project_id restituisce un token per esso.

Elenca i record del ciclo di vita degli inviti per il progetto corrente, escludendo i reset di accesso. Gli indirizzi dei destinatari sono visibili al progetto proprietario che li ha forniti. Token e URL delle credenziali non sono mai elencati

Crea inviti per membri o acquirenti di annunci. La consegna via email non restituisce mai una credenziale. La consegna tramite link è solo per membri e restituisce un URL, anche in caso di replay idempotente esatto entro 24 ore. Gli inviti email scadono dopo sette giorni; i link dopo 24 ore. Gli inviti email in sospeso dello stesso tipo, indirizzo e progetto sono riutilizzati.

Un membro limitato agli schermi non invita persone (outside_screen_scope).

Un invito email project_member a una persona che sarebbe un ospite esterno dell’organizzazione del progetto (non è la sua organizzazione di appartenenza) è soggetto alla policy per gli ospiti di quell’organizzazione, e risponde guest_not_allowed (403) quando la policy (allow, domains o none) non ammette l’indirizzo. L’accettazione dell’invito la controlla di nuovo.

Lo staff e gli amministratori dell’organizzazione stessa sono esenti. Uno screen_scope su un invito rientra nell’ambito degli schermi, che il piano Enterprise include; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402).

Revoca un invito in sospeso. Un invito accettato restituisce invitation_consumed. Un membro limitato agli schermi non revoca inviti (outside_screen_scope).

Accetta una richiesta di reset dell’accesso senza rivelare se una persona possiede l’indirizzo.

Viene trovata anche una persona con un indirizzo non verificato, ad esempio una registrazione in autonomia, e completare quel reset, che il suo proprietario deve confermare con replace_unverified_account, dà al proprietario della casella di posta un nuovo account (una nuova persona con la credenziale del reset, una nuova organizzazione e un nuovo progetto) ed elimina la persona non verificata, della quale nessuno aveva dimostrato che l’indirizzo le appartenesse.

Un link di reimpostazione scade un'ora dopo l'ultima richiesta. Finché il link di una persona è attivo e ha meno di un giorno, un'altra richiesta reinvia lo stesso link (al massimo una volta ogni dieci minuti) e sposta la scadenza a un'ora dalla richiesta, così una richiesta non invalida mai il link già nella casella; altrimenti un nuovo link lo sostituisce. Non c'è limite per indirizzo.

Completare una reimpostazione rimuove le altre passkey della persona (tutte le passkey per una reimpostazione della password), rimuove la password quando la nuova credenziale è una passkey, scarta un cambio di email in sospeso e chiude ogni sessione. Con o senza persona, la richiesta reinvia anche al massimo dieci inviti indirizzati all'email, e ciascun invito al massimo una volta all'ora.

Tra i dieci progetti non eliminati più recenti con indirizzo di contatto corrispondente, ogni progetto attivo con un piano del catalogo e la cui proprietà sia ancora in attesa dalla registrazione riceve nuovamente il proprio invito di registrazione, anche se è scaduto o il destinatario è già entrato come membro ordinario.

Accettare questo invito di registrazione con l’accesso esistente completa l’assegnazione della proprietà; la sola richiesta di recupero non modifica la proprietà né le credenziali. Gli inviti via email in sospeso per membri e acquirenti pubblicitari di progetti attivi con un piano del catalogo, e gli inviti in sospeso per amministratori di organizzazioni attive, occupano i posti rimanenti, dai più recenti.

Un invito reinviato mantiene il proprio ID e riceve un nuovo link e una nuova scadenza; il vecchio link smette di funzionare e il numero di inviti in sospeso del progetto non cambia. Un invito di registrazione scaduto viene ricreato come nuovo invito e occupa di nuovo un posto, quindi il conteggio aumenta di uno; viene ignorato se il progetto è pieno.

Gli altri inviti scaduti, revocati, accettati o condivisi tramite link non vengono reinviati.

Crea un nuovo progetto e il suo primo agente tramite iscrizione esplicita CLI inclusa, anche se l’indirizzo di contatto appartiene già a una persona o progetto. L’email di contatto resta non verificata e non concede autorità; indirizzi malformati restituiscono invalid_request.

Mette in coda un invito all’iscrizione nella stessa transazione. project_name è opzionale; se omesso si usa un nome leggibile di due parole. La ripetizione idempotente esatta precede i limiti di frequenza. Conserva la credenziale permanente prima di segnalare il successo; la sua busta di replay scade a issuance_expires_at e i tentativi successivi restituiscono credential_issuance_expired.

Il record di idempotenza dura 24 ore.

Avvia un accesso browser AgentID (OIDC) sull’host API derivato dall’origine pubblica di runtime (https://play.<domain> -> https://api.<domain>). Imposta un cookie di binding a uso singolo e reindirizza al punto di autorizzazione AgentID con PKCE S256. Risponde solo sull’host API.

Mentre il relying party non ha client id e secret, la rotta mostra una pagina semplice non disponibile con 503.

Completa un accesso browser AgentID sull’host API. Richiede iss uguale all’emittente configurato, il cookie di binding e una transazione monouso non scaduta.

Scambia il codice con client_secret_basic e PKCE, verifica l’id_token ES256 (iss, aud, exp con sfasamento 60 s, nonce) contro JWKS in cache, chiama userinfo e applica le regole proprietario, quindi rende una pagina codice-claim monouso. Un soggetto già associato a un agente rende la pagina già registrata.

Questa rotta non crea mai un progetto, identità o invito.

Il progetto chiamante. Non addebita il contatore API da 1 credito, quindi un progetto con zero rimanenti può ancora leggere i rimanenti e recuperare. Dopo un principale progetto riuscito, le risposte JSON /api autenticate e problemi includono ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset e ScreenRig-Credits-Included come crediti interi.

SSE, runtime, contenuto e risposte non autenticate li omettono.

Rinomina il progetto corrente. I nomi contengono da 1 a 60 caratteri stampabili e nessun testo simile a un URL.

Solo il proprietario del progetto o un amministratore della sua organizzazione può eliminarlo; ogni altro chiamante è rifiutato con forbidden. Una persona deve anche essere membro del progetto.

Un agente necessita della capacità membership target del progetto e elimina per la persona responsabile, che deve essere il proprietario o un amministratore dell’organizzazione; un agente senza persona responsabile non può eliminare, tranne l’agente che ha iscritto il progetto mentre nessuna persona ha accettato l’iscrizione.

Richiede anche il nome e la revisione correnti, zero schermi non archiviati, nessun credito, prenotazioni o debito nel proprio wallet e nessuna pubblicità attiva. Un saldo negativo accumulato sotto termini gratuiti o di lancio non blocca; l’eliminazione lo azzera con una voce di registro project_delete_writeoff. Mette in coda le notifiche ai membri e usa la lapide irreversibile.

Il piano del progetto chiamante, flag indipendenti inserzionista/schermi con la loro revisione, il set di capacità effettive derivate, le funzioni del piano che ha (plan_features) e i suoi limiti (limits). Non riflette mai una rivendicazione client; un piano sconosciuto fallisce chiuso come proibito.

Il registro di audit proprio dell’organizzazione: le modifiche ai suoi amministratori, domini e impostazioni di fatturazione, con le stesse voci, gli stessi filtri e formati di GET /api/audit. Richiede un amministratore dell’organizzazione. Fa parte del registro di audit, che il piano Enterprise include; un’organizzazione il cui piano ne è privo viene rifiutata con feature_not_in_plan (402).

Ogni piano registra le proprie modifiche.

Le notifiche dell’organizzazione, di ogni canale, dalla meno recente (al massimo 50).

Una notifica appartiene all’organizzazione e copre tutti i suoi progetti, compresi quelli aggiunti dopo (project_ids assente), oppure i progetti scelti (project_ids); agisce sugli schermi, le origini, le campagne e le schede di quei progetti esattamente come una notifica di progetto. status è failing finché lo sono le consegne di un progetto coperto, e failing_since, last_success_at e last_failure_at riassumono quelli dei progetti coperti (l’inizio di errore più antico, l’ultimo successo e l’ultimo errore).

Il segreto di firma di un webhook non viene mai restituito qui. Richiede un amministratore dell’organizzazione; per chiunque altro la risposta è not_found.

Crea una notifica dell’organizzazione, con i membri di POST /api/notifications e i progetti che copre: project_ids assente o null copre ogni progetto dell’organizzazione (quelli che ha e quelli che avrà), un elenco copre esattamente quelli, ciascuno un progetto live di questa organizzazione (altrimenti invalid_request).

I destinatari di una notifica e-mail sono owner (il proprietario di ciascun progetto coperto) oppure gli user_ids di persone dell’organizzazione (i suoi amministratori e i suoi membri dell’organizzazione) o di membri di un progetto coperto; ogni progetto invia comunque e-mail solo alle persone che ne sono membri.

Un’organizzazione ha al massimo 50 notifiche, escluse quelle predefinite create dal sistema (notification_limit_reached). Le stesse funzionalità del piano regolano canali, regole e condizioni come nelle rotte del progetto, valutate sul piano dell’organizzazione. Ogni progetto coperto riceve notification.created, e la modifica viene registrata nel registro di audit dell’organizzazione.

Il segreto di firma di un webhook viene restituito solo in questa risposta e in rotate-secret; un unico segreto firma le consegne di ogni progetto coperto. Un nuovo tentativo identico con la stessa Idempotency-Key restituisce questa stessa risposta, segreto incluso, per ventiquattro ore.

Una notifica dell’organizzazione, come la mostra GET /api/organizations/{org_id}/notifications.

Cambia gli stessi membri di PATCH /api/notifications/{id}, nella notifica e in ogni progetto coperto, più project_ids: se assente lascia invariati i progetti, null copre ogni progetto, un elenco copre esattamente quelli. Un progetto che acquisisce la notifica parte dal suo evento corrente (non viene inviato nulla di precedente); da un progetto che la perde la notifica viene eliminata.

Ogni progetto coperto riceve notification.updated, e la modifica viene registrata nel registro di audit dell’organizzazione.

Una modifica che fa coprire alla notifica un progetto che ora non copre è soggetta agli stessi controlli di piano della creazione della notifica quale diventerà (il suo canale, le sue regole e le condizioni sullo schermo, secondo il piano dell’organizzazione); coprire meno progetti non è mai soggetto a controlli, e passare da un elenco a ogni progetto copre sempre di più. If-Match protegge la revisione.

Elimina la notifica da ogni progetto che copre, con notification.deleted in ciascuno, e la registra nel registro di audit dell’organizzazione. Gli avvisi in sospeso vengono contrassegnati come falliti con webhook_deleted.

Solo notifiche webhook (qualsiasi altro canale è invalid_request). Sostituisce il segreto di firma in ogni progetto coperto contemporaneamente, così un solo ricevitore continua a verificare un solo segreto, e restituisce la notifica con quello nuovo in secret.

Come per POST /api/notifications/{id}/rotate-secret, al massimo un tentativo per progetto già in corso può ancora arrivare firmato con il vecchio segreto. Un nuovo tentativo identico con la stessa Idempotency-Key restituisce lo stesso nuovo segreto per ventiquattro ore.

Invia un notification.test attraverso il primo progetto coperto dalla notifica (per id progetto), come POST /api/notifications/{id}/test ne invia uno attraverso il proprio progetto: una consegna, il cui esito è mostrato dall’elenco delle consegne, tentata una sola volta.

Ogni progetto coperto ha lo stesso ricevitore, la stessa destinazione e lo stesso segreto, quindi un solo test dimostra il canale; l’e-mail di un test va ai destinatari di quel progetto. Una notifica che non copre nessun progetto è invalid_request.

I registri delle consegne di ogni progetto coperto dalla notifica, in un unico elenco, dal più recente in base a quando ogni riga è stata accodata. Ogni riga nomina il proprio progetto (project_id), e il suo id apre GET .../deliveries/{delivery_id}/attempts. Restituisci next_cursor come prima per la pagina successiva.

I tentativi di una consegna, dal più recente, gli ultimi 20. Una consegna che non appartiene a questa notifica è not_found.

Riattiva l’invio delle e-mail di una notifica e-mail a una persona che l’aveva interrotto con il link di annullamento dell’iscrizione contenuto nell’e-mail, in ogni progetto coperto dalla notifica (il link lo interrompe in tutti). Idempotente: se la persona non aveva interrotto nulla, non cambia niente e la risposta è la notifica così com’è.

Una modifica aumenta la revisione e aggiunge notification.updated con i dettagli change resubscribed, user_id e via api a ogni progetto coperto.

Elenca i tipi di report che GET /api/reports/{kind} costruisce, con i filtri di ciascuno, e i formati in cui un report viene scritto. Richiede la capacità dei report.

Elenca i report programmati del progetto, dal più vecchio (al massimo 50), ciascuno con il prossimo invio e l'esito dell'ultimo. Richiede la capacità del progetto.

Programma l'invio di un report via email, come allegato PDF, XLSX o CSV, ogni giorno, settimana o mese a un'ora in un fuso orario.

Ogni invio copre il periodo precedente, in giorni UTC: il giorno prima, i sette giorni precedenti o il mese scorso. recipients sono membri del progetto, indicati con user_id o con l'indirizzo email del membro; chiunque altro viene rifiutato, quindi un abbonamento non è mai un modo per scrivere a un estraneo, e un membro che se ne va smette di riceverlo.

Un’esecuzione che fallisce viene ripetuta e compare con last_status failed e last_error. Al massimo 50 per organizzazione in tutti i suoi progetti (report_subscription_limit_reached).

Richiede un amministratore designato di un’organizzazione attiva, l’autenticazione tramite cookie della stessa origine (corrispondenza esatta) e il CSRF JWT. L’attore e l’URL di ritorno sono definiti dal server. La risposta è privata e no-store. Aperto anche a un’organizzazione delegata a un reseller, per la sua carta e le fatture passate.

Richiede un amministratore designato di un’organizzazione attiva, l’autenticazione tramite cookie della stessa origine (corrispondenza esatta) e il CSRF JWT. L’attore è definito dal server. La disattivazione conserva gli importi salvati e la spesa mensile; se è disattivata, i campi importo vengono ignorati. La risposta è privata e no-store. La modifica delle impostazioni rimuove una pausa recuperabile solo dopo che ogni fattura pagabile con pagamento non riuscito è stata annullata in modo sicuro.

Attivarlo per un’organizzazione delegata a un reseller risponde con 409 billed_by_reseller; la disattivazione resta consentita.

Viste dei pagamenti di un’organizzazione attiva. Richiede il cookie del suo amministratore designato; la sola visibilità del personale non concede accesso agli acquisti. I pagamenti non configurati restituiscono available false. Il ritorno del browser non assegna mai crediti.

Avviare un acquisto prepagato per l’amministratore designato di un’organizzazione attiva. Richiede l’autenticazione tramite cookie della stessa origine e, per le sessioni JWT, un’intestazione CSRF corrispondente. Organizzazione, cliente, attore e URL di ritorno sono definiti dal server. I crediti vengono applicati solo dopo la conferma del pagamento da parte del servizio di fatturazione. In caso di risposte ambigue, riprovare con la stessa Idempotency-Key e lo stesso importo.

Un’organizzazione delegata a un reseller risponde con 409 billed_by_reseller.

Il portafoglio dell’organizzazione. Richiede un amministratore designato dell’organizzazione, un amministratore del reseller a cui l’organizzazione è delegata o una sessione staff. Non concede alcuna appartenenza al progetto.

Voci di diario attribuite a questa organizzazione al momento dell’addebito, con identità progetto e pagatore. I trasferimenti non spostano l’accesso storico. Le voci antecedenti al contesto organizzazione registrato restano nei loro estratti conto progetto. Lette dalle stesse persone che leggono il saldo (getOrganizationBillingBalance).

Il pool di utilizzo dell’organizzazione e la quota di ciascun progetto per un mese UTC. Copre l’utilizzo pagato da questa organizzazione; gli altri costi del pagante sono nell’estratto conto dell’organizzazione. Letto dalle stesse persone che leggono il saldo (getOrganizationBillingBalance).

Organizzazioni visibili, comprese quelle vuote per i loro amministratori. I nomi non sono univoci.

Gli amministratori designati e gli agenti il cui responsabile verificato è un amministratore possono rinominare un’organizzazione. Non viene concessa alcuna autorizzazione o iscrizione al progetto.

Attiva o disattiva Richiedi revisione per modifiche agent. Se attivo, ogni agente e client di servizio nel progetto ha accesso Proponi a ogni richiesta, qualunque siano le sue credenziali. Solo il proprietario del progetto o un amministratore dell’organizzazione del progetto (altrimenti vietato); le sessioni shadow dello staff non possono modificarlo.

If-Match trasporta review_policy_revision (0 consentito) ed è obbligatorio; un valore obsoleto è revision_conflict. Disattivarlo richiede una prova, la prova passkey o password che l’approvazione della connessione agente usa; attivarlo no. Le revisioni aperte restano decidibili in entrambi i casi. Aggiunge project.review_policy_changed.

Restituisce i dettagli di conferma correnti, i blocchi di eliminazione e i dispositivi archiviati che verranno disconnessi. allowed è false, con una motivazione, quando il chiamante non può eliminare il progetto (solo il proprietario o un amministratore della sua organizzazione può; per un agente, la persona responsabile) o rimane un blocco.

Il proprietario trasferisce la proprietà a un membro esistente e verificato del progetto; questo non concede alcuna nuova appartenenza. L’appartenenza del nuovo proprietario esce da qualsiasi screen_scope e upload_scope, così il nuovo proprietario raggiunge l’intero progetto.

Lo spostamento autorizzato dal proprietario trasferisce atomica occupazione dello schermo e nuovo utilizzo al pagatore di destinazione; gli addebiti storici mantengono il loro pagatore.

Elenca le destinazioni amministrate dal proprietario o il cui dominio verificato corrisponde alla loro email verificata

Elenca i record del ciclo di vita degli inviti per il progetto corrente, escludendo i reset di accesso. Gli indirizzi dei destinatari sono visibili al progetto proprietario che li ha forniti. Token e URL delle credenziali non sono mai elencati

Crea inviti per membri o acquirenti di annunci. La consegna via email non restituisce mai una credenziale. La consegna tramite link è solo per membri e restituisce un URL, anche in caso di replay idempotente esatto entro 24 ore. Gli inviti email scadono dopo sette giorni; i link dopo 24 ore. Gli inviti email in sospeso dello stesso tipo, indirizzo e progetto sono riutilizzati.

Un membro limitato agli schermi non invita persone (outside_screen_scope).

Un invito email project_member a una persona che sarebbe un ospite esterno dell’organizzazione del progetto (non è la sua organizzazione di appartenenza) è soggetto alla policy per gli ospiti di quell’organizzazione, e risponde guest_not_allowed (403) quando la policy (allow, domains o none) non ammette l’indirizzo. L’accettazione dell’invito la controlla di nuovo.

Lo staff e gli amministratori dell’organizzazione stessa sono esenti. Uno screen_scope su un invito rientra nell’ambito degli schermi, che il piano Enterprise include; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402).

Il progetto chiamante. Non addebita il contatore API da 1 credito, quindi un progetto con zero rimanenti può ancora leggere i rimanenti e recuperare. Dopo un principale progetto riuscito, le risposte JSON /api autenticate e problemi includono ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset e ScreenRig-Credits-Included come crediti interi.

SSE, runtime, contenuto e risposte non autenticate li omettono.

Rinomina il progetto corrente. I nomi contengono da 1 a 60 caratteri stampabili e nessun testo simile a un URL.

Solo il proprietario del progetto o un amministratore della sua organizzazione può eliminarlo; ogni altro chiamante è rifiutato con forbidden. Una persona deve anche essere membro del progetto.

Un agente necessita della capacità membership target del progetto e elimina per la persona responsabile, che deve essere il proprietario o un amministratore dell’organizzazione; un agente senza persona responsabile non può eliminare, tranne l’agente che ha iscritto il progetto mentre nessuna persona ha accettato l’iscrizione.

Richiede anche il nome e la revisione correnti, zero schermi non archiviati, nessun credito, prenotazioni o debito nel proprio wallet e nessuna pubblicità attiva. Un saldo negativo accumulato sotto termini gratuiti o di lancio non blocca; l’eliminazione lo azzera con una voce di registro project_delete_writeoff. Mette in coda le notifiche ai membri e usa la lapide irreversibile.

Elenca le applicazioni dalla più recente, massimo 500 per pagina. I nomi sono etichette e non devono essere unici; indirizza un’applicazione per ID. next_cursor è la posizione dell’ultima riga restituita mentre ci sono altre righe; passalo come after, con gli stessi filtri, per la pagina successiva. next_cursor è null nell’ultima pagina

Flussi un tar.gz prodotto da CLI direttamente in staging durevole limitato. I metadati sono negli header così l’archivio non è mai codificato base64 o materializzato come JSON dal server.

Il proxy davanti all’API termina una richiesta a cui non ha risposto entro circa 100 s, quindi un archivio grande su un uplink lento fallisce qui; POST /api/applications/uploads invia invece l’archivio direttamente all’archivio oggetti.

Dichiara un caricamento diretto di un tar.gz prodotto dalla CLI che crea una nuova applicazione. La risposta è un’autorizzazione firmata per esattamente un PUT di oggetto dell’archivio, quindi i byte vanno direttamente all’archivio oggetti e mai attraverso l’API, il cui proxy termina una richiesta a cui non ha risposto entro circa 100 s.

Invia l’archivio con PUT a upload_url, poi conferma con POST /api/applications/uploads/{id}/commit e attendi l’operazione. L’applicazione, la sua versione e l’operazione ricevente esistono da questa risposta, come dopo POST /api/applications. Un caricamento non confermato entro 24 ore fallisce, e un’applicazione che non ha mai pubblicato una versione viene rimossa.

La stessa Idempotency-Key e lo stesso corpo restituiscono lo stesso caricamento con un URL appena firmato. GET /api/capabilities imposta features.application_direct_uploads dove queste route sono servite.

Lista playlist versionata che può esporre pagine adslot. La lista v1 rifiuta una pagina che contiene un documento con pubblicità con version_required invece di filtrarla.

Pagine come listPlaylists, le più recenti per prime, massimo 200 per pagina e meno una volta che una pagina contiene 8 MiB di playlist memorizzate. next_cursor è la posizione dell’ultima riga restituita mentre ci sono altre righe; passalo come after, con gli stessi filtri, per la pagina successiva. next_cursor è null nell’ultima pagina. library=true elenca invece le playlist della Libreria dell’organizzazione (sola lettura; programmale oppure creane dai loro modelli).

Voce di creazione per l’unione delle pagine adslot. Al massimo 16 pagine adslot, almeno una pagina ordinaria senza visibilità, e il riutilizzo di una definizione slot su pagine diverse restano controlli server. La risoluzione dei riferimenti e il DNS restano controlli server.

Una scrittura che contiene una pagina iframe non inquadrabile dal Player web viene comunque salvata; la risposta contiene avvisi (PlaylistWarning) e il registro del progetto riceve un evento playlist.iframe_framing_refused per ogni pagina.

Una scrittura il cui src iframe, fallback_src o parametri dell'applicazione leggono un token dello schermo ({screen.field.NAME} e gli altri degli schemi delle primitive) che manca a uno schermo che mostra la playlist risponde anche con un'avvertenza screen_fact_missing che nomina i primi 20 di tali schermi; i manifest di quegli schermi omettono quella primitiva.

Un src o fallback_src di iframe che è un link di Google Presentazioni, Documenti o Fogli (condivisione, pubblicazione sul web o incorporamento) o un link di incorporamento di Microsoft 365 OneDrive o SharePoint viene memorizzato ricostruito per lo schermo, dove le presentazioni vanno in ciclo e avanzano con il delayms del link limitato alla durata della pagina, mentre Documenti, Fogli, Word ed Excel si ricaricano ogni 5 minuti.

Un codice di incorporamento <iframe> incollato in src o fallback_src viene letto per il suo src. Un file che chiede agli spettatori di accedere viene rifiutato con document_not_shared (400), il cui errors[0].field è quel src o fallback_src e il cui dettaglio indica l’impostazione di condivisione da cambiare.

La lista predefinita restituisce schermi pairing_pending e attivi. Passare state=archived per elencare solo gli schermi archiviati. Passare tag per elencare solo gli schermi i cui tag contengono esattamente quel tag; gli schermi senza tag sono omessi quando il filtro è presente.

Passa field, una volta per campo, come NAME:VALUE per elencare solo gli schermi i cui campi contengono ogni valore, e near come LAT,LON,KM per elencare solo gli schermi situati entro KM chilometri dal punto; gli schermi senza posizione vengono omessi e ogni filtro si combina con state e tag.

Passa folder come ID di una cartella schermi per elencare solo gli schermi direttamente dentro di essa (non quelli delle sue sottocartelle), oppure root per gli schermi fuori da ogni cartella.

Gli schermi sono dal più recente, al massimo 500 per pagina. next_cursor è la posizione dell’ultima riga restituita finché restano altre righe; passalo di nuovo come after, con gli stessi filtri, per la pagina successiva. next_cursor è null nell’ultima pagina. Un chiamante limitato agli schermi (docs/screen-scope.md) elenca solo gli schermi nel suo ambito.

Una richiesta che non nomina alcun progetto esclude ogni progetto in cui il chiamante è limitato agli schermi; nomina il progetto per elencarlo.

Elenca tutte le cartelle schermi nel progetto, massimo 1000, ordinate per nome.

Le cartelle organizzano gli schermi e permettono di sceglierli come destinazione: una foglia di audience di campagna {"folder": ID} corrisponde agli schermi in quella cartella e in ogni cartella al suo interno, un selettore di azione di flotta by:folder agisce sugli stessi schermi, e il default_playlist_id di una cartella è ciò che mostrano i suoi schermi senza una playlist propria. parent_id è null nella radice del progetto; costruisci l’albero da parent_id. screens conta gli schermi attivi direttamente dentro ogni cartella.

La cartella di uno schermo è Screen.folder_id. Un chiamante limitato agli schermi (docs/screen-scope.md) elenca le cartelle dentro il suo ambito e quelle sopra di esse, che sono di sola lettura così il suo albero ha una radice; le cartelle sopra non riportano il numero di schermi e le cartelle sorelle sono nascoste. Una richiesta che non nomina alcun progetto esclude ogni progetto in cui il chiamante è limitato agli schermi.

Crea una cartella schermi nella radice del progetto (parent_id nullo o assente) o dentro parent_id. I nomi sono privati di spazi, contengono da 1 a 100 caratteri Unicode senza controlli, non sono "." o ".." e sono univoci tra le cartelle dello stesso livello (resource_conflict).

Un’organizzazione contiene al massimo 1000 cartelle in tutti i suoi progetti (quota_exceeded) annidate al massimo 10 livelli (invalid_request). default_playlist_id, se impostato, deve indicare una playlist approvata (playlist_not_approved). Emette screen.folder_created.

Un chiamante limitato agli schermi (docs/screen-scope.md) crea una cartella solo dentro una cartella del suo ambito; la radice del progetto o qualsiasi altro genitore è outside_screen_scope. Creare una cartella dentro una cartella protetta è una revisione protected_change (202 pending_review) decisa da un secondo approvatore.

Sposta schermi (screen_ids) e cartelle (folder_ids) in una cartella (folder_id), o nella radice del progetto se folder_id è null, in una singola richiesta tutto o niente di massimo 1000 ID. Ogni ID deve esistere (not_found). Una cartella non può spostarsi in se stessa o in una cartella al suo interno, e lo spostamento deve mantenere ogni cartella entro 10 livelli (invalid_request).

Gli elementi già nella destinazione restano come sono; ogni schermo e ogni cartella spostati aggiornano la propria revisione. Gli schermi spostati risolvono di nuovo la loro playlist entro circa 15 secondi: levels nomina le campagne nella cui audience di cartella gli schermi entrano o dalla quale escono, e le playlist predefinite di cartella che acquisiscono o perdono. Emette screen.moved.

Un chiamante limitato agli schermi (docs/screen-scope.md) sposta schermi e cartelle dentro il suo ambito in una cartella del suo ambito; qualsiasi id o destinazione fuori dall’ambito, e la radice del progetto, fanno rifiutare l’intero spostamento (outside_screen_scope), anche quando uno schermo esce dall’ambito tra il controllo e la scrittura.

Uno spostamento dentro o fuori da una cartella protetta è una revisione protected_change (202 pending_review) decisa da un secondo approvatore.

Risponde a cosa riproducono gli schermi di un soggetto in [from, to) e perché, per il calendario della Programmazione del dashboard: esattamente uno tra screen_id, folder_id (gli schermi nella cartella e in ogni cartella al suo interno), tag o campaign_id (gli schermi del suo pubblico).

Gli schermi i cui stack hanno input identici (stessi livelli, predefinito, fuso orario e numero di display) condividono un unico gruppo con un’unica timeline, quindi un soggetto grande costa decine di timeline; un gruppo elenca fino a 500 dei suoi schermi e una risposta al massimo 200 gruppi (truncated).

Ogni gruppo riporta il proprio stack, dal più alto (takeover, campagne che raggiungono gli schermi, le voci di programmazione proprie, poi la playlist predefinita o quella della cartella più vicina), gli spans di ogni livello (riproduce su ogni display di destinazione, parziale con i display su cui riproduce, superato, oppure condizionale finché attende un’interazione o una condizione sui dati che solo un Player osserva), ciò che ogni display mostra (on_screen; la regione principale di una pagina intera) e i conflitti (due campagne con la stessa priorità in vigore insieme; un livello che è in vigore ma non riproduce mai). from e to sono istanti RFC 3339, to successivo a from, distanti al massimo 93 giorni; vengono troncati al minuto.

Le regole vengono lette nel fuso orario di ciascun gruppo come le leggono la sweep e ogni Player; ogni livello è considerato riproducibile. Un chiamante limitato agli schermi (docs/screen-scope.md) deve inviare uno screen_id o un folder_id dentro il suo ambito; un tag, un campaign_id o nessun soggetto è outside_screen_scope.

Risponde con un foglio con le colonne lette da un’importazione di programmazione e tre righe di esempio (un codice schermo, una cartella di schermi e un tag), come CSV oppure, con format=xlsx, come cartella di lavoro XLSX.

Legge un foglio di righe di programmazione rispetto al progetto e risponde con ciò che farebbe il commit, senza scrivere nulla.

Ogni riga indica una destinazione (uno schermo per id, per valore di un campo dello schermo come un codice stanza, o per nome; folder:NAME; tag:NAME; più destinazioni separate da ; o |), un contenuto (il nome di un file multimediale, oppure playlist:NAME o un id di playlist), un inizio e una fine (una sola data come fine chiude quel giorno) e, facoltativamente, timezone, days (Mon-Fri), una finestra giornaliera (daily_start, daily_end), priority da 0 a 100, un nome e i numeri dei display.

Gli orari sono letti sull’orologio di ciascuno schermo; una colonna timezone li converte da un altro fuso.

Ogni riga viene controllata e segnala i suoi errori per colonna: schermo, cartella o tag sconosciuto o ambiguo, file mancante o ambiguo, un file che non può riempire uno schermo, orari non validi o invertiti, una fine nel passato, nessuna indicazione di tempo, uno schermo senza fuso orario o playlist predefinita, due righe valide insieme su uno schermo con la stessa priorità, e più livelli di quelli che uno schermo può contenere (32), o più campagne di quelle che la sua organizzazione può avere in tutti i suoi progetti (100; ogni livello condiviso ne è una).

Le righe che coincidono per contenuto, orari, priorità e nome diventano un solo livello: uno schermo è una voce della sua programmazione propria; più schermi, una cartella o un tag sono un unico livello condiviso (una campagna), che prevale sui livelli propri di uno schermo.

La risposta elenca i livelli con ciò che un commit fa a ciascuno (create, update, unchanged), i livelli creati da un’esecuzione precedente della stessa importazione che il foglio non ha più (removals), gli stack degli schermi come sarebbero (calendar) e un fingerprint da inviare al commit. Il foglio è composto da righe JSON, CSV o XLSX, al massimo 5.000 righe.

Non disponibile per un chiamante limitato agli schermi (outside_screen_scope). L’importazione programmazione fa parte del piano Enterprise; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402). Il modello è disponibile in ogni piano.

Esegue il commit di un’importazione in anteprima: lo stesso foglio e il fingerprint restituito dalla sua anteprima. Ogni livello viene creato, aggiornato o rimosso, le programmazioni degli schermi e i livelli condivisi vengono scritti in un’unica transazione e l’evento di importazione schedule.imported viene aggiunto: tutte le righe vengono applicate, oppure nessuna.

Le playlist di un solo file necessarie ai file del foglio vengono create per prime (non cambiano nulla su alcuno schermo). Un foglio con righe con errori viene rifiutato (schedule_import_invalid); un progetto cambiato dopo l’anteprima, o righe lette in modo diverso, viene rifiutato (schedule_import_stale) e il client visualizza di nuovo l’anteprima.

Importare di nuovo lo stesso foglio con lo stesso nome non cambia nulla; una riga modificata aggiorna il suo livello e una riga rimossa rimuove il suo livello. Serve una persona che possa approvare nella dashboard e, per un agente, una credenziale con accesso in scrittura.

Un commit che aggiornerebbe o eliminerebbe una campagna riservata risponde con reserved_item (403) e non scrive nulla, a meno che non lo esegua una persona che può approvare.

Un commit che raggiunge uno schermo protetto viene rifiutato per intero con protected_target, anche quando l’importazione non ha livelli ma rimuove voci importate di uno schermo protetto o elimina una campagna importata il cui pubblico ne raggiunge uno.

In un progetto con cartelle di schermi protette un commit la cui anteprima fallisce a causa di un servizio, non del foglio, risponde con dependency_unavailable e non scrive nulla: invia di nuovo la stessa richiesta dopo una breve attesa. Un errore di convalida del foglio, della campagna o dello schermo risponde come risponderebbe il commit (invalid_request e gli altri problemi sopra).

Non disponibile per un chiamante limitato agli schermi. L’importazione programmazione fa parte del piano Enterprise; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402). Il modello è disponibile in ogni piano.

Richiede un codice link browser per il progetto autenticato e crea atomica esattamente uno schermo pairing_pending iniziale più la sua concessione di provisioning browser esistente. L’iscrizione resta solo progetto. La risposta è solo metadati sicuri e non contiene mai token di provisioning, URL frammento, cookie o prova.

Richiede una sessione di associazione Player globale a flotta di sei caratteri. I retry con Idempotency-Key esatti restituiscono il risultato originale duraturo senza consumare nuovamente la quota.

La sessione dashboard esegue il claim nel suo progetto corrente con lo stesso corpo, la stessa Idempotency-Key, gli stessi budget e gli stessi problemi, tranne che il suo not_found per un codice sconosciuto o già riscattato non nomina alcun comando CLI; è un cambio di stato, quindi segue le regole di mutazione del dashboard, una sessione shadow senza modalità di scrittura dello staff viene rifiutata, e gli eventi che il claim aggiunge nominano l’utente del dashboard. folder_id indica la cartella in cui finisce lo schermo.

Un chiamante limitato agli schermi (docs/screen-scope.md) deve inviare una cartella dentro il suo ambito e associa solo come persona che può approvare (outside_screen_scope, approver_required).

Provisioning facoltativo di un nuovo schermo, solo da browser. Crea sempre un nuovo schermo pairing_pending; al massimo cinque attendono l’associazione contemporaneamente (quota_exceeded). I nuovi tentativi esatti ricevono di nuovo lo stesso token di frammento per dieci minuti. L’associazione a sei caratteri resta il flusso predefinito e l’unico flusso di recupero. folder_id indica la cartella in cui finisce lo schermo.

Un chiamante limitato agli schermi (docs/screen-scope.md) deve inviare una cartella dentro il suo ambito (altrimenti outside_screen_scope).

Applica un’azione a una flotta selezionata senza limite di schermi. Seleziona un screen_ids unico o un tag corrispondente agli schermi attivi in ordine di creazione. La selezione risolta è fissata prima di qualsiasi mutazione, archiviata in blocchi limitati e conservata per ventiquattro ore sotto Idempotency-Key.

Ogni passaggio usa il proprio percorso di modifica a schermo singolo, mantenendo revisioni, eventi, segnali runtime e limiti per schermo. Una risposta contiene una pagina limitata di risultati; matched, succeeded e failed descrivono quella pagina. HTTP 202 include total, offset e next_cursor. Continua con lo stesso selettore, azione e Idempotency-Key, passando next_cursor come after.

Rispetta Retry-After se presente, inclusa una pagina con zero risultati. La risposta ripete Idempotency-Key, inclusa una chiave generata se il chiamante l’ha omessa; conserva questa chiave per le continuazioni. HTTP 200 termina la selezione. Le pagine risposte si riproducono esattamente, inclusi i fallimenti per schermo; i passaggi interrotti si riproducono senza ripetere i loro effetti.

Le azioni grandi sono limitate dai budget organizzazione esistenti di 600 al minuto per ricarica, toast, takeover, programmazioni playlist, riavvio, monitor e programmazioni monitor; l’esaurimento del budget dell’organizzazione mette in pausa l’azione invece di rifiutare la flotta. L’esaurimento per schermo fallisce solo quello schermo.

Un passo assign, takeover o set_playlist_schedule che associa una playlist con un formato a uno schermo il cui muro ha un'altra forma fa fallire solo quello schermo con 409 playlist_format_mismatch. Le modifiche di assegnazione e tag non hanno budget di messaggi.

Un'assegnazione la cui playlist ha un src iframe o parametri dell'applicazione che leggono un token dello schermo che manca a qualche schermo della pagina aggiunge un'avvertenza screen_fact_missing a quella pagina (warnings, PlaylistWarning). Il fallimento parziale è un risultato normale. Tutte le pagine e i tentativi con una stessa chiave sono un'unica azione conteggiata.

Le richieste usano un payload di byte limitato; usa un tag per una selezione più grande del payload di trasporto. Un selettore o un’azione malformati vengono rifiutati prima che venga toccato qualsiasi schermo. selector o action viene rifiutato prima che venga toccato qualsiasi schermo.

Un chiamante limitato agli schermi (docs/screen-scope.md) seleziona per screen_ids o per cartella, ogni schermo dentro il suo ambito; un selettore tag, uno schermo fuori dall’ambito o uno sconosciuto fa rifiutare l’intera azione (outside_screen_scope) prima che qualcosa venga fissato o proposto.

Assign, takeover, takeover_clear, set_playlist_schedule e clear_playlist_schedule che raggiungono uno schermo protetto diventano una revisione decisa da un secondo approvatore (202 pending_review) a ogni livello di accesso; set_tags, add_tags e remove_tags su uno schermo protetto sono protected_target (409).

Un’azione set_playlist_schedule con una voce in pausa (una bozza) rientra nel controllo delle modifiche alla programmazione, che il piano Enterprise include; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402).

Mostra schede del browser sugli schermi del progetto indicato; richiesta, risposta, accesso e limiti sono quelli di POST /api/tab-shares.

Elenca le campagne del progetto in ordine di precedenza (al massimo 100), l’ordine in cui la risoluzione le legge. reserved è presente su ogni campagna.

Un chiamante limitato agli schermi (docs/screen-scope.md) vede ogni campagna, con editable true solo quando l’intero pubblico è dentro il suo ambito (una foglia tag e la regola radice per ogni schermo non lo sono mai; una regola all richiede un figlio contenuto, una regola any ogni figlio) e il chiamante può cambiare ciò che viene riprodotto.

createCampaign per il progetto indicato nel percorso. reserved true riserva la campagna, e solo una persona che può approvare lo imposta (reserved_item per un agente, un client di servizio o chiunque altro), aggiungendo campaign.reserved_changed.

Un chiamante limitato agli schermi (docs/screen-scope.md) crea una campagna solo per un pubblico dentro il suo ambito (foglie folder e screen_id; nessun tag, nessuna regola per ogni schermo), altrimenti outside_screen_scope, e solo come persona che può approvare (approver_required).

Una campagna il cui pubblico raggiunge uno schermo protetto è una revisione protected_change decisa da un secondo approvatore (202 pending_review) a ogni livello di accesso. reserved true rientra nelle cartelle protette e paused true su una nuova campagna (una bozza) nel controllo delle modifiche alla programmazione, entrambi parte del piano Enterprise; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402).

Elenca le connessioni del progetto, le più recenti per prime, al massimo 200 per pagina; restituisci next_cursor come after per la successiva. Un segreto, una chiave o un token di aggiornamento non viene mai restituito: secret indica se ne è conservato uno e un indizio che non è segreto. Una lettura non porta mai un link di consenso.

Crea in questo progetto una connessione a Microsoft o a Google: modalità own_app con le credenziali proprie del cliente, oppure modalità screenrig_app, che risponde consent_url, un link monouso per la persona che lo completa (vedi createConnection). Aggiunge connection.created. Un nuovo tentativo identico con la stessa Idempotency-Key restituisce la stessa connessione.

Elenca le connessioni BI del progetto, dalla meno recente, 200 per pagina; restituisci next_cursor come cursor per la successiva. Un segreto non viene mai restituito: secret indica se è impostato e i suoi ultimi 4 caratteri.

Aggiunge una connessione a un sistema BI di proprietà del progetto. Per Grafana: il suo indirizzo (http o https su un host pubblico, con un prefisso di percorso facoltativo) e un token di account di servizio con il ruolo Viewer. Il token viene sigillato e non viene mai restituito.

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.

Un amministratore Power BI deve attivare le impostazioni sviluppatore Embed content in apps e Service principals can call Fabric public APIs per l’app (portale di amministrazione, impostazioni del tenant), l’app deve essere Membro o Amministratore di ogni area di lavoro che mostra, e i report richiedono una capacità Embedded, Fabric o Premium in produzione.

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.

Aggiungi embed_origin della risposta all’elenco dei domini consentiti dell’app collegata e abilita il segreto. Chiunque abbia un ticket di schermo può incorporare qualsiasi vista che quell’utente possa vedere, quindi usa un utente che veda solo le dashboard degli schermi. Tableau Cloud, o Tableau Server 2023.3 o successivo.

Per una pagina web con accesso (kind web): l’account di servizio di un sito che mostra la sua dashboard dietro un accesso. config.login_mode è auto (config.login_url, config.username e la password come secret: il renderer apre la pagina di accesso e compila il modulo), steps (config.login_url e config.steps, uno script di passaggi goto, fill, click, press, wait_for e wait_ms i cui valori possono contenere {{username}}, {{password}} e {{otp}}) oppure none (nessun accesso: la connessione mostra pagine con i cookie che le dai). totp_secret è la chiave base32, o l’indirizzo otpauth://, dell’app di autenticazione dell’account: il server calcola il codice monouso (RFC 6238) e invia al renderer solo il codice. cookies è un set di cookie esportato da un browser connesso, per un sito il cui accesso non si può automatizzare (single sign-on approvato su un telefono, un controllo del dispositivo); il server conserva il set e lo rinnova con i cookie che ogni acquisizione restituisce, quindi un accesso è raro.

La password, il seed e i cookie sono sigillati e mai restituiti. Usa un account di servizio in sola lettura. La password viene digitata solo in config.login_url e nei passaggi goto, quindi spostarli su un altro origin richiede di nuovo secret. Dopo cinque accessi rifiutati di fila la connessione smette di accedere finché le sue credenziali non cambiano.

Un server senza renderer di pagine risponde bi_web_unavailable. Aggiunge bi_connection.created. Un nuovo tentativo identico con la stessa Idempotency-Key restituisce questa stessa risposta.

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.

Aggiunge una vista di una dashboard Grafana della connessione o di un solo suo pannello (url: un indirizzo /d/{uid}/... sull’host della connessione, oppure target), o di un link di dashboard pubblica Grafana (kind grafana e target.public_url, senza connessione).

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.

La pagina di incorporamento mostra solo un ticket che il manifest dello schermo contiene, quindi una vista viene riprodotta solo sugli schermi del proprio progetto.

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.

Una visualizzazione Tableau Public è una vista senza connessione (kind tableau, target.public_url, ricostruita come https://public.tableau.com/views/WORKBOOK/VIEW) e accetta anche rotate_sheets. Per una pagina web (kind web): una pagina del sito della connessione web (url: un indirizzo https su un host pubblico, senza target).

Il browser sul bordo la apre già connesso, attende l’elemento wait_for se impostato e wait_ms millisecondi (fino a 10000), e disegna clip, un selettore CSS, se impostato, altrimenti l’intera pagina.

L’immagine viene ridisegnata ogni refresh_s (da 60 a 86400, 300 per impostazione predefinita) e condivisa da tutti gli schermi della stessa dimensione, e solo mentre uno schermo mostra la vista; quando un’acquisizione fallisce, l’ultima immagine resta sullo schermo. Imposta wait_for su un elemento che esiste solo quando la pagina è connessa, così una pagina di accesso non viene mai mostrata. Aggiunge bi_view.created.

Elenca i trigger di allerta CAP del progetto, dal più vecchio al più recente (al massimo 20), ciascuno con la sua URL di ingestione, nome utente e ultima allerta. La password non viene mai restituita qui.

Crea un trigger di allerta CAP: un URL in ingresso a cui un sistema di notifiche di emergenza (Everbridge, Rave, Alertus, relè IPAWS e altri mittenti CAP 1.2) invia avvisi, con credenziali HTTP Basic.

La risposta è l’unico luogo in cui appare la password (con la risposta di rotazione): conservarla subito nel sistema di invio. target è un tag (ogni schermo attivo con esso all’arrivo dell’avviso) o fino a 500 screen_ids.

Un avviso prende ogni schermo target con playlist predefinita fino a <expires> dell’avviso, altrimenti per default_for_seconds (60 a 604800, default 3600); vedi POST /api/triggers/{id}/cap. Un’organizzazione ha al massimo 20 trigger in tutti i suoi progetti (trigger_limit_reached). Aggiunge trigger.created.

Un nuovo tentativo identico con la stessa Idempotency-Key restituisce questa stessa risposta, password compresa, per ventiquattro ore. Un trigger il cui selettore raggiunge uno schermo protetto è protected_target (409), e una lettura non riuscita della protezione degli schermi è dependency_unavailable (500, ripeti la stessa richiesta); un trigger non è disponibile per un chiamante limitato agli schermi.

Elenca gli eventi duraturi del progetto in ordine crescente di sequenza

La paginazione è contigua: passa il next_cursor restituito come after per continuare esattamente da dove la pagina si è fermata. next_cursor è il cursore dell’ultimo evento restituito mentre eventi più recenti esistono già, e null alla fine della cronologia. Il limite predefinito è 50 e accetta 1-200; un valore fuori da questo intervallo è rifiutato con invalid_request e un membro errors[] che nomina limit.

L’impaginazione offset non è supportata. source=log elenca invece il log del Player: i report di condizione inviati dai Player (runtime.reported) in ordine crescente di ricezione, filtrati per screen_id e severità in una finestra da a (default ultime 24 ore, massimo 31 giorni).

I suoi cursori sono opachi: lg1_ o ev1_ a seconda di dove il server tiene il log Player, quindi restituisci quello che una pagina ha restituito; un cursore dell’altro tipo è rifiutato con invalid_request che nomina il campo. I record log Player non hanno sequenza, non sono su GET /stream/project e non sono consegnati ai webhook.

Un record è riconosciuto quando la coda del log del lettore lo accetta ed è conservato per la conservazione eventi del progetto. Segue un sondaggio con l’ultimo cursore e la finestra predefinita. I record del log del lettore non sono nella lista predefinita (source=project). from e to sono rifiutati con invalid_request a meno che source non sia log.

La lista dei progetti prende screen_id, playlist_id e application_id per leggere gli eventi di uno schermo, playlist o app, tutti limitati al progetto della credenziale (un id indica quali eventi leggere, mai di chi): screen_id mantiene gli eventi la cui risorsa è quello schermo; playlist_id gli eventi la cui risorsa è quella playlist più gli eventi che la nominano come details.playlist_id (uno schermo che la usa); application_id gli eventi la cui risorsa è quell’app più quelli la cui risorsa la porta come application_id (i suoi rilasci e voci chiave/valore).

Un valore che non è un ID del suo tipo è rifiutato con invalid_request che nomina il campo; playlist_id e application_id sono rifiutati con source=log, i cui record appartengono solo a uno schermo.

Entrambe le fonti utilizzano resource_id, tipo e gravità (minimo), combinati tra loro, con i filtri id e con la paginazione; un record di log del Player è un record runtime.reported il cui resource è il suo schermo, quindi un resource_id che non è quello schermo o un tipo che esclude runtime.reported restituisce una pagina vuota. Le pagine before (o order=desc) mostrano prima le più recenti: next_cursor è quindi il cursore dell’elemento più vecchio restituito e viene passato indietro come before per continuare con elementi più vecchi.

Senza from, una pagina source=log newest-first supera le 24 ore predefinite fino al record più vecchio conservato dal progetto, al massimo 31 giorni sotto il limite superiore della pagina per richiesta. Una pagina source=log newest-first può contenere meno di limit record, anche nessuno, con next_cursor; null la termina comunque, alla fine del log conservato.

Un chiamante limitato agli schermi (docs/screen-scope.md) legge un feed filtrato: eventi degli schermi dentro il suo ambito, delle cartelle di schermi che può vedere (le proprie, quelle sopra e quelle al loro interno; screen.moved solo quando la destinazione è dentro il suo ambito), di campagne, playlist, contenuti multimediali, applicazioni e schede, e delle revisioni playlist_change.

Ogni altro evento viene escluso, quindi una pagina può contenere meno eventi di limit, anche nessuno, con un next_cursor; continua a paginare con esso. source=log richiede uno screen_id dentro il suo ambito. Gli eventi sul progetto stesso non vengono inviati.

Il piano del progetto chiamante, flag indipendenti inserzionista/schermi con la loro revisione, il set di capacità effettive derivate, le funzioni del piano che ha (plan_features) e i suoi limiti (limits). Non riflette mai una rivendicazione client; un piano sconosciuto fallisce chiuso come proibito.

L’istantanea del saldo consapevole della sorgente del progetto chiamante. Tutti gli importi millicredito sono stringhe decimali canoniche. È un’istantanea, non un’autorità di pagamento; rails_available è falso mentre carta, tasse e rail cash-out non sono disponibili.

Paginazione cursore stabile su voci di diario immutabili pubblicate per il progetto chiamante. Le hold non sono voci pubblicate. Le correzioni collegano all'evento originale invece di riscriverlo. Non ci sono mutazioni arbitrarie di concessione o pagamento su questa superficie.

L’uso del progetto chiamante per un mese UTC, con i byte serviti e ricevuti (mai addebitati), l’archiviazione addebitata oltre quella gratuita del piano del pagante (allowance.storage_bytes) e le richieste API, gli eventi di flusso del progetto fatturati e i tentativi di consegna webhook conteggiati rispetto ai 10.000 gratuiti al mese. Un progetto che paga per sé legge il proprio pool.

Un progetto pagato da un altro pagatore condivide il pool di quel pagatore con gli altri progetti di quel pagatore; legge la propria quota, e payer nomina il pagatore. Il totale del pool del pagatore resta nelle letture di fatturazione del pagatore.

La rete di un solo venditore chiamante, inclusa la sua commissione di servizio ScreenRig risolta. I venditori non possono modificare tale commissione.

Crea la rete di un venditore chiamante se assente. Richiede screens=true. Idempotente; ripetere restituisce la stessa rete.

Imposta la tariffa predefinita del progetto del venditore per ogni 15 secondi di riproduzione completata. Una modifica che altera la tariffa effettiva di una campagna accettata mette in pausa l’intera campagna con price_change_pending; una modifica mascherata o senza effetto no. If-Match riporta la revisione della rete.

L’inventario a cui il venditore chiamante ha aderito.

Crea uno slot venditore riutilizzabile. Le immagini durano da 5 a 30 secondi e i video al massimo il limite della piattaforma di 120 secondi. Gli annunci sono sempre silenziati.

Reti a cui l’inserzionista chiamante appartiene attualmente, con l’ambito e la politica di revisione concessi. Il conteggio schermi non garantisce il conteggio impression.

Associa una revisione media pronta e di proprietà a una creatività immutabile. Non copia byte, non ricarica né rigenera. Media sconosciuti o non pronti sono rifiutati.

Crea una campagna bozza. Le bozze non trattengono denaro, non riservano nulla e non autorizzano alcuna consegna. L’attivazione richiede un preventivo esplicitamente accettato.

Versioni creatività inviate al venditore chiamante per revisione. Un venditore vede solo la creatività esatta inviata, mai la libreria dell’acquirente.

Spesa e conteggi di consegna per acquirente in una campagna. Gli importi sono stringhe decimali mcr. Non espone mai il reddito del venditore, lo stato bancario o l’uso a livello di progetto.

Lordo, commissione di servizio e netto per una finestra del venditore, con la propria prova di consegna. Non espone mai il portafoglio dell’acquirente o altre reti. Solo prove di consegna completate e autorizzate stabiliscono la fatturazione. La finestra è al massimo di 92 giorni; una finestra più ampia è invalid_request.

Quando contiene più di 5000 saldi la risposta imposta truncated, totali e conteggi coprono ancora tutti e le righe elencano solo i primi 5000.

Aggregati giornalieri di riproduzione.

JSON restituisce al massimo 200 righe e non è limitato da rate. format=csv (o Accept text/csv senza application/json) trasmette ogni riga corrispondente dentro day_from a day_to (giorni UTC inclusi; default day_to oggi e day_from 30 giorni prima; massimo 366 giorni, altrimenti invalid_request) come CSV con riga intestazione fissa (PlaybackAggregateCsv); solo la forma CSV consuma i budget playback-export-org (30 al minuto) e playback-export-ip (60 al minuto).

Entrambe le forme sono una richiesta API conteggiata. Le risposte includono Vary Accept. Un chiamante limitato agli schermi (docs/screen-scope.md) deve inviare screen_id, che deve essere uno schermo dentro il suo ambito (altrimenti outside_screen_scope); le forme CSV seguono la stessa regola.

Record per riproduzione: una riga per ogni playback.media_started accettato (o playback.video_started legacy) e una riga per ogni playback.application_started accettato (release_id impostato, campi media vuoti) del progetto chiamante, dal più vecchio per received_at, in caso di parità per inserimento. Da (incluso) e a (escluso) limite received_at; a predefinito ora, da a 24 ore prima di a, e l’intervallo è al massimo 31 giorni (invalid_request altrimenti).

Gli ultimi 5 secondi non sono ancora restituiti: il to effettivo è al massimo ora meno 5 secondi (settle lag), quindi una coda live non salta mai una riga che si impegna dietro il suo cursore. Filtrano screen_id, media_id, playlist_id (la playlist da cui è stato mostrato l’inizio) e tag (un tag schermo che lo schermo aveva quando è stato ricevuto il play).

Una pagina playlist_id può contenere meno di limit righe, anche nessuna, con next_cursor quando è stata scansionata una lunga serie di riproduzioni di altre playlist; null indica comunque la fine dell’intervallo.

JSON è una pagina di al massimo limit righe (default 200, massimo 1000) con next_cursor, null alla fine dell’intervallo; restituiscilo come cursor con gli stessi filtri. order=desc (o before) pagina i più recenti per primi nello stesso intervallo: next_cursor è allora il cursore della riga più vecchia restituita, null all’inizio dell’intervallo, e viene restituito come before (esclusivo) con gli stessi filtri; order=asc con before è rifiutato con invalid_request che nomina order, e cursor con una pagina newest-first che nomina cursor.

Una pagina più recente può contenere meno di limit righe, anche nessuna, con next_cursor; null indica comunque la fine.

Una pagina successiva non salta mai una riga esistente quando la pagina precedente è stata letta e non ne ripete una, tranne che un avvio che il Player ha reinviato dopo un report non riconosciuto (lo stesso play_id, ricevuto poco dopo) può apparire di nuovo in una pagina successiva; il flusso CSV lo elenca una volta. format=csv (o Accept text/csv senza application/json) trasmette ogni riproduzione dal cursore alla fine dell’intervallo come CSV (PlaybackPlayCsv), più recente prima sotto con order=desc; limit è rifiutato con CSV.

La misurazione è per richiesta: ogni pagina JSON costa un credito richiesta API, mentre un flusso CSV dell’intervallo completo costa uno. Ogni richiesta plays (pagina o flusso) consuma i budget playback-export-org (30 al minuto) e playback-export-ip (60 al minuto).

Uno stream limita ogni scrittura (15 secondi) e termina quando il client si disconnette; se fallisce dopo l’header 200 la connessione è abortita, quindi un export che legge fino a una fine pulita è completo. Le risposte portano Vary Accept. Le riproduzioni sono conservate per la durata di conservazione eventi del piano (30 giorni è il minimo fornito; la conservazione basata sul piano usa la finestra di 7 o 90 giorni del piano).

Un chiamante limitato agli schermi (docs/screen-scope.md) deve inviare screen_id, che deve essere uno schermo dentro il suo ambito (altrimenti outside_screen_scope); le forme CSV seguono la stessa regola.

Totali di riproduzione del progetto chiamante su giorni UTC inclusivi, letti dai rollup giornalieri: by=day restituisce una riga per giorno con riproduzioni (screen_id o media_id limita a uno schermo o media), by=screen e by=media classificano gli schermi o media più attivi (top, massimo 100), e by=screen_day restituisce la serie giornaliera degli schermi top (top massimo 10). day_to predefinito oggi (UTC) e day_from 29 giorni prima.

Una serie di giorni copre al massimo 366 giorni (92 se limitata a uno schermo o media); un ranking al massimo 92. I conteggi includono ogni inizio registrato dal progetto, inclusi quelli memorizzati prima che esistessero i rollup di riproduzione.

I rollup seguono l’ingestione fino a circa 21 minuti. truncated è true quando un ranking è stato costruito da fette di una finestra troppo grande per una lettura: copre le migliori chiavi di ogni fetta. Non è limitato da rate limit. Una richiesta API conteggiata.

Un chiamante limitato agli schermi (docs/screen-scope.md) deve inviare screen_id, che deve essere uno schermo dentro il suo ambito (altrimenti outside_screen_scope); le forme CSV seguono la stessa regola.