API Projets

Retourne les détails actuels de confirmation, les bloqueurs de suppression et les appareils archivés qui seront déconnectés. allowed est faux, avec une raison, quand l’appelant ne peut pas supprimer le projet (seul son propriétaire ou un administrateur de son organisation peut ; pour un agent, sa personne responsable) ou qu’un bloqueur subsiste.

Le propriétaire transfère la propriété à un membre existant vérifié du projet ; cela n’accorde aucune nouvelle adhésion. L’adhésion du nouveau propriétaire perd tout screen_scope et upload_scope, de sorte que le nouveau propriétaire accède à tout le projet.

Une session du tableau de bord d’un administrateur de l’organisation du projet qui est membre du projet transfère la propriété de la même façon, à partir de son propriétaire actuel, quel qu’il soit ; un administrateur de l’organisation qui n’est pas membre du projet utilise PUT /api/organizations/{org_id}/projects/{project_id}/owner.

Le transfert autorisé par le propriétaire transfère atomiquement l’occupation de l’écran et la nouvelle utilisation au payeur de destination ; les frais historiques conservent leur payeur. Une destination qui détient déjà autant de projets actifs que son forfait le permet est project_limit_reached, dont required_plan nomme le forfait qui a de la place, absent pour Enterprise.

Liste les destinations que le propriétaire administre ou dont le domaine vérifié correspond à son courriel vérifié.

Liste chaque adhésion active de l’identité, avec contexte d’organisation et de propriétaire, y compris les adhésions omises de ce jeton ou du consentement de sa délégation. Chaque entrée marque in_token ; la découverte n’ajoute aucune autorité et n’a pas de limite de 64 projets.

Crée un projet nommé appartenant à la personne responsable vérifiée. Sans organisation nommée, il est attribué à l’organisation du domaine vérifié de la personne, sinon à l’organisation du projet actuel, sinon à l’organisation la plus récemment utilisée parmi celles qu’elle administre ou détient gratuitement, sinon à une nouvelle organisation.

Un nom d’organisation sélectionne exactement une correspondance visible, sinon crée une nouvelle organisation. Une personne détient une organisation Standard gratuite ; une nouvelle organisation au-delà est free_organization_limit, nommant celle qu’elle détient.

Une organisation contient au maximum autant de projets actifs que son forfait le permet (Standard 1, Plus 3, Premium 10, Education 50, Enterprise 100, élargi par ses featuresets) ; un projet de plus est project_limit_reached, dont required_plan nomme le forfait qui a de la place, absent pour Enterprise (communiquez avec le soutien).

Une nouvelle tentative idempotente exacte redélivre son justificatif d’adhésion scellé pendant dix minutes. L’inscription est exemptée de la limite.

Sous un JWT d’accès agent (portée identité, accès : gérer, une subvention avec accès identité Gérer) aucun jeton de projet n’est délivré ; le projet rejoint la subvention avec Gérer et toutes les capacités, et un rafraîchissement avec son project_id renvoie un jeton pour lui.

Liste les enregistrements du cycle de vie des invitations pour le projet actuel, à l’exclusion des réinitialisations de connexion. Les adresses des destinataires sont visibles par le projet propriétaire, qui les a fournies. Les jetons et URL d’identifiants ne sont jamais listés.

Crée des invitations de membres ou d’acheteurs de publicité. La livraison par courriel ne retourne jamais de justificatif. La livraison par lien est réservée aux membres et retourne une URL, y compris lors d’une relecture idempotente exacte dans les 24 heures. Les invitations par courriel expirent après sept jours ; les liens expirent après 24 heures. Les invitations par courriel en attente du même type, adresse et projet sont réutilisées.

Un membre limité aux écrans n’invite pas de personnes (outside_screen_scope).

Une invitation par courriel project_member adressée à une personne qui serait un invité externe de l’organisation du projet (ce n’est pas son organisation d’appartenance) est soumise à la politique relative aux invités de cette organisation, et guest_not_allowed (403) répond lorsque la politique (allow, domains ou none) n’admet pas l’adresse. L’acceptation de l’invitation vérifie de nouveau.

Le personnel et les administrateurs de l’organisation sont exemptés. Un screen_scope sur l’invitation relève du périmètre d’écrans, que le forfait Enterprise inclut ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402).

Révoque une invitation en cours. Une invitation acceptée renvoie invitation_consumed. Un membre limité aux écrans ne révoque pas d’invitations (outside_screen_scope).

Accepte une demande de réinitialisation de connexion sans révéler si une personne détient l’adresse.

Une personne dont l’adresse n’est pas vérifiée, comme une inscription en libre-service, est trouvée aussi, et la réinitialisation menée à terme, que son propriétaire doit confirmer avec replace_unverified_account, donne au propriétaire de la boîte de réception un nouveau compte (une nouvelle personne avec le justificatif de la réinitialisation, une nouvelle organisation et un nouveau projet) et supprime la personne non vérifiée, dont personne n’avait montré que l’adresse lui appartenait.

Un lien de réinitialisation expire une heure après la dernière demande. Tant que le lien d’une personne est actif et date de moins d’un jour, une nouvelle demande renvoie ce même lien (au plus une fois toutes les dix minutes) et repousse son expiration à une heure après la demande, de sorte qu’une demande n’invalide jamais le lien déjà reçu; sinon, un nouveau lien le remplace. Il n’y a pas de limite par adresse.

Terminer une réinitialisation supprime les autres clés d’accès de la personne (toutes ses clés d’accès pour une réinitialisation du mot de passe), supprime le mot de passe lorsque le nouvel identifiant est une clé d’accès, abandonne un changement d’adresse courriel en attente et met fin à toutes les sessions. Avec ou sans personne, la demande renvoie aussi au plus dix invitations adressées au courriel, et chaque invitation au plus une fois par heure.

Parmi les dix projets non supprimés les plus récents dont l’adresse de contact correspond, chaque projet actif avec un forfait du catalogue et dont la propriété demeure en attente depuis l’inscription reçoit de nouveau son invitation d’inscription, même si elle a expiré ou si son destinataire s’est déjà joint comme membre ordinaire.

Accepter cette invitation d’inscription avec la connexion existante termine la prise de propriété; demander la récupération ne modifie à lui seul ni la propriété ni les identifiants. Les invitations par courriel en attente pour les membres et les acheteurs publicitaires de projets actifs avec un forfait du catalogue, ainsi que les invitations en attente pour les administrateurs d’organisations actives, occupent les places restantes, les plus récentes en premier.

Une invitation renvoyée conserve son ID et reçoit un nouveau lien et une nouvelle échéance; l’ancien lien cesse de fonctionner et le nombre d’invitations en attente du projet reste inchangé. Une invitation d’inscription expirée revient comme une nouvelle invitation qui occupe de nouveau une place : le compteur augmente donc de un, et elle est ignorée si le projet est plein.

Les autres invitations expirées, ainsi que les invitations révoquées, acceptées ou partagées par lien, ne sont pas renvoyées.

Crée un nouveau projet et son premier agent via une inscription explicite groupée CLI, même si l’adresse de contact appartient déjà à une personne ou un projet. Le courriel de contact reste non vérifié et n’accorde aucune autorité ; les adresses mal formées renvoient invalid_request.

Met en file une invitation d’inscription dans la même transaction. project_name est optionnel ; son omission utilise un nom lisible de deux mots. La relecture idempotente exacte précède les limites de débit. Persistez la clé permanente avant de signaler le succès ; son enveloppe de relecture expire à issuance_expires_at et les nouvelles tentatives ultérieures retournent credential_issuance_expired.

L’enregistrement d’idempotence dure 24 heures.

Démarre une connexion navigateur AgentID (OIDC) sur l’hôte API dérivé de l’origine publique d’exécution (https://play.<domain> -> https://api.<domain>). Définit un cookie de liaison à usage unique et redirige vers le point d’autorisation AgentID avec PKCE S256. Répond uniquement sur l’hôte API.

Tant que la partie de confiance n’a pas d’identifiant client ni de secret, la route affiche une page simple indisponible avec 503.

Complète une connexion AgentID navigateur sur l’hôte API. Nécessite iss égal à l’émetteur configuré, le cookie de liaison, et une transaction à usage unique non expirée.

Échange le code avec client_secret_basic et PKCE, vérifie le id_token ES256 (iss, aud, exp avec un décalage de 60 s, nonce) contre le JWKS mis en cache, appelle userinfo et applique les règles du propriétaire, puis affiche une page de code de revendication à usage unique. Un sujet déjà lié à un agent affiche la page déjà inscrit.

Cette route ne crée jamais de projet, d’identité ou d’invitation.

Le projet appelant. Ne débite pas le compteur API de 1 crédit, donc un projet à zéro restant peut encore lire le restant et récupérer. Après un principal de projet réussi, les réponses JSON /api authentifiées et les réponses de problème incluent ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset, et ScreenRig-Credits-Included en crédits entiers.

Les réponses SSE, runtime, contenu et non authentifiées les omettent.

Renomme le projet actuel. Les noms contiennent de 1 à 60 caractères imprimables et aucun texte ressemblant à une URL.

Seul le propriétaire du projet ou un administrateur de son organisation peut le supprimer ; tout autre appelant est refusé avec forbidden. Une personne doit aussi être membre du projet.

Un agent a besoin de la capacité projet d’adhésion cible et supprime pour sa personne responsable, qui doit être le propriétaire ou un administrateur d’organisation ; un agent sans personne responsable ne peut pas supprimer, sauf l’agent qui a inscrit le projet alors qu’aucune personne n’a accepté son inscription.

Nécessite aussi le nom et la révision actuels, zéro écran non archivé, aucun crédit, réservation ou dette dans son propre portefeuille et aucune publicité en direct. Un solde négatif accumulé sous les conditions gratuites ou de lancement ne bloque pas ; la suppression l’efface avec une écriture project_delete_writeoff. Met en file d’attente les avis aux membres et utilise la pierre tombale irréversible.

Le plan du projet appelant, les indicateurs indépendants annonceur/écrans avec leur révision, l’ensemble des capacités effectives dérivées, les fonctionnalités de plan dont il dispose (plan_features) et ses limites (limits). Ne reflète jamais une revendication client ; un plan inconnu échoue fermé comme interdit.

Le journal d’audit propre à l’organisation : les modifications de ses administrateurs, de ses domaines et de ses paramètres de facturation, avec les mêmes entrées, filtres et formats que GET /api/audit. Nécessite un administrateur de l’organisation. Fait partie du journal d’audit, que le forfait Enterprise inclut ; une organisation dont le forfait n’inclut pas cette fonctionnalité est refusée avec feature_not_in_plan (402).

Chaque forfait consigne ses modifications.

Les notifications de l’organisation, de tous les canaux, de la plus ancienne à la plus récente (50 au plus).

Une notification appartient à l’organisation et couvre chacun de ses projets, y compris les projets ajoutés plus tard (project_ids absent), ou les projets choisis (project_ids) ; elle agit sur les écrans, les sources, les campagnes et les cartes de ces projets exactement comme une notification de projet. status est failing tant que les livraisons d’un projet couvert le sont, et failing_since, last_success_at et last_failure_at regroupent celles des projets couverts (le plus ancien début d’échec, le dernier succès et le dernier échec).

Le secret de signature d’un webhook n’est jamais renvoyé ici. Exige un administrateur de l’organisation; toute autre personne obtient not_found.

Crée une notification de l’organisation, avec les membres de POST /api/notifications et les projets qu’elle couvre : project_ids absent ou null couvre tous les projets de l’organisation (ceux qu’elle a et ceux qu’elle obtiendra), une liste couvre exactement ceux-ci, chacun étant un projet actif de cette organisation (sinon invalid_request).

Les destinataires d’une notification par courriel sont owner (le propriétaire de chaque projet couvert), ou des user_ids de personnes de l’organisation (ses administrateurs et ses membres) ou de membres d’un projet couvert; chaque projet n’envoie quand même de courriel qu’aux personnes qui en sont membres.

Une organisation compte au plus 50 notifications, sans compter celles que le système crée par défaut (notification_limit_reached). Les mêmes fonctionnalités de forfait contrôlent les canaux, les règles et les conditions que sur les routes de projet, évaluées d’après le forfait de l’organisation. Chaque projet couvert reçoit notification.created, et la modification est consignée dans le journal d’audit de l’organisation.

Le secret de signature d’un webhook n’est renvoyé que dans cette réponse et dans rotate-secret; un seul secret signe les livraisons de chaque projet couvert. Une nouvelle tentative identique avec la même Idempotency-Key renvoie cette même réponse, secret compris, pendant vingt-quatre heures.

Une notification de l’organisation, telle que la montre GET /api/organizations/{org_id}/notifications.

Modifie tout membre que PATCH /api/notifications/{id} modifie, dans la notification et dans chaque projet couvert, ainsi que project_ids : absent laisse les projets inchangés, null couvre tous les projets, une liste couvre exactement ceux-ci. Un projet qui gagne la notification démarre à son événement courant (rien d’antérieur n’est envoyé); un projet qui la perd voit la notification supprimée.

Chaque projet couvert reçoit notification.updated, et la modification est consignée dans le journal d’audit de l’organisation.

Une modification qui fait couvrir à la notification un projet qu’elle ne couvre pas actuellement est contrôlée comme la création de la notification telle qu’elle sera (son canal, ses règles et ses conditions d’affichage, selon le forfait de l’organisation); couvrir moins de projets n’est jamais contrôlé, et passer d’une liste à tous les projets en couvre toujours davantage. If-Match protège la révision.

Supprime la notification de chaque projet qu’elle couvre, avec notification.deleted dans chacun, et la consigne dans le journal d’audit de l’organisation. Les avis en attente sont marqués comme échoués avec webhook_deleted.

Notifications webhook seulement (tout autre canal donne invalid_request). Remplace le secret de signature dans tous les projets couverts à la fois, de sorte qu’un récepteur continue de vérifier un seul secret, et renvoie la notification avec le nouveau dans secret.

Comme sur POST /api/notifications/{id}/rotate-secret, au plus une tentative par projet déjà en cours peut encore arriver signée avec l’ancien secret. Une nouvelle tentative identique avec la même Idempotency-Key renvoie le même nouveau secret pendant vingt-quatre heures.

Envoie un notification.test par le premier projet que couvre la notification (selon l’id de projet), comme POST /api/notifications/{id}/test en envoie un par son projet : une livraison, dont la liste des livraisons montre le résultat, tentée une seule fois.

Chaque projet couvert a le même récepteur, la même destination et le même secret, de sorte qu’un seul test valide le canal; le courriel d’un test va aux destinataires de ce projet. Une notification qui ne couvre aucun projet donne invalid_request.

Les journaux de livraison de chaque projet que couvre la notification, en une seule liste, de la plus récente à la plus ancienne selon le moment de mise en file d’attente de chaque ligne. Chaque ligne nomme son projet (project_id), et son id ouvre GET .../deliveries/{delivery_id}/attempts. Renvoyez next_cursor comme auparavant pour la page suivante.

Les tentatives d’une livraison, de la plus récente à la plus ancienne, les 20 plus récentes. Une livraison qui n’appartient pas à cette notification donne not_found.

Envoie de nouveau les courriels d’une notification par courriel à une personne qui s’est désabonnée avec le lien de désabonnement de son courriel, dans chaque projet que couvre la notification (le lien la désabonne de tous). Idempotent : une personne qui n’est pas désabonnée ne change rien, et la réponse est la notification telle qu’elle est.

Un changement incrémente la révision et ajoute notification.updated, avec les détails change resubscribed, user_id et via api, à chaque projet couvert.

Liste les types de rapports que construit GET /api/reports/{kind}, avec les filtres de chacun, et les formats dans lesquels un rapport s'écrit. Exige la capacité des rapports.

Liste les rapports planifiés du projet, du plus ancien au plus récent (au plus 50), chacun avec son prochain envoi et le résultat du dernier. Exige la capacité du projet.

Planifie l'envoi d'un rapport par courriel, en pièce jointe PDF, XLSX ou CSV, chaque jour, chaque semaine ou chaque mois à une heure dans un fuseau horaire.

Chaque envoi couvre la période qui le précède, en jours UTC : la veille, les sept jours précédents ou le mois dernier. recipients sont des membres du projet, désignés par user_id ou par l'adresse courriel du membre; toute autre personne est refusée, de sorte qu'un abonnement ne sert jamais à écrire à un étranger, et un membre qui part cesse de le recevoir.

Une exécution qui échoue est reprise et s’affiche avec last_status failed et last_error. Au plus 50 par organisation, tous projets confondus (report_subscription_limit_reached).

Exige un administrateur désigné d’une organisation active, une authentification par cookie strictement de même origine et un JWT CSRF. L’acteur et l’URL de retour sont déterminés par le serveur. La réponse est privée et no-store. Ouvert aussi à une organisation déléguée à un revendeur, pour sa carte de paiement et ses factures passées.

Exige un administrateur désigné d’une organisation active, une authentification par cookie strictement de même origine et un JWT CSRF. L’acteur est déterminé par le serveur. La désactivation conserve les montants enregistrés et les dépenses mensuelles; les champs de montant sont ignorés lorsque la recharge est désactivée. La réponse est privée et no-store. La modification des paramètres lève une pause récupérable seulement après que toute facture payable en échec a été annulée en toute sécurité.

L’activer pour une organisation déléguée à un revendeur répond 409 billed_by_reseller; la désactivation reste permise.

Vues des paiements d’une organisation active. Nécessite le cookie de son administrateur désigné; la visibilité du personnel ne donne aucun accès aux achats. Les paiements non configurés renvoient available false. Un retour du navigateur n’accorde jamais de crédits.

Lancer un achat prépayé pour l’administrateur désigné d’une organisation active. Nécessite une authentification par cookie de même origine et, pour les sessions JWT, un en-tête CSRF correspondant. Le serveur définit l’organisation, le client, l’acteur et les URL de retour. Les crédits sont appliqués uniquement après confirmation du paiement par le service de facturation. En cas de réponse ambiguë, réessayer avec la même Idempotency-Key et le même montant.

Une organisation déléguée à un revendeur répond 409 billed_by_reseller.

Le portefeuille de l’organisation. Nécessite un administrateur d’organisation désigné, un administrateur du revendeur auquel l’organisation est déléguée ou une session de personnel. N’accorde aucune adhésion à un projet.

Entrées de journal attribuées à cette organisation au moment de la facturation, avec identités du projet et du payeur. Les transferts ne déplacent pas l’accès historique. Les entrées antérieures au contexte organisationnel enregistré restent dans leurs relevés de projet. Lues par les mêmes personnes que le solde (getOrganizationBillingBalance).

Le pool d’utilisation de l’organisation et la part de chaque projet pour un mois UTC. Couvre l’utilisation payée par cette organisation; les autres coûts de payeur figurent dans le relevé de l’organisation. Lu par les mêmes personnes que le solde (getOrganizationBillingBalance).

Organisations visibles, y compris les organisations vides pour leurs administrateurs. Les noms ne sont pas uniques.

Les administrateurs désignés et les agents dont la personne responsable vérifiée est un administrateur peuvent renommer une organisation. Aucun droit de projet ou adhésion n’est accordé.

Active ou désactive Exiger une révision pour les modifications d’agent. Lorsqu’activé, chaque agent et client de service sur le projet est soumis à un accès Proposer à chaque requête, quel que soit son justificatif. Seul le propriétaire du projet ou un administrateur de l’organisation du projet (interdit autrement) peut modifier cela ; les sessions d’ombre du personnel ne peuvent pas le changer.

If-Match porte review_policy_revision (0 autorisé) et est requis ; une valeur périmée est revision_conflict. Le désactiver nécessite une preuve, la nouvelle clé d’accès ou la preuve de mot de passe que l’approbation de connexion agent utilise ; l’activer non. Les révisions ouvertes restent décidables dans les deux cas. Ajoute project.review_policy_changed.

Retourne les détails actuels de confirmation, les bloqueurs de suppression et les appareils archivés qui seront déconnectés. allowed est faux, avec une raison, quand l’appelant ne peut pas supprimer le projet (seul son propriétaire ou un administrateur de son organisation peut ; pour un agent, sa personne responsable) ou qu’un bloqueur subsiste.

Le propriétaire transfère la propriété à un membre existant vérifié du projet ; cela n’accorde aucune nouvelle adhésion. L’adhésion du nouveau propriétaire perd tout screen_scope et upload_scope, de sorte que le nouveau propriétaire accède à tout le projet.

Le transfert autorisé par le propriétaire transfère atomiquement l’occupation de l’écran et la nouvelle utilisation au payeur de destination ; les frais historiques conservent leur payeur.

Liste les destinations que le propriétaire administre ou dont le domaine vérifié correspond à son courriel vérifié.

Liste les enregistrements du cycle de vie des invitations pour le projet actuel, à l’exclusion des réinitialisations de connexion. Les adresses des destinataires sont visibles par le projet propriétaire, qui les a fournies. Les jetons et URL d’identifiants ne sont jamais listés.

Crée des invitations de membres ou d’acheteurs de publicité. La livraison par courriel ne retourne jamais de justificatif. La livraison par lien est réservée aux membres et retourne une URL, y compris lors d’une relecture idempotente exacte dans les 24 heures. Les invitations par courriel expirent après sept jours ; les liens expirent après 24 heures. Les invitations par courriel en attente du même type, adresse et projet sont réutilisées.

Un membre limité aux écrans n’invite pas de personnes (outside_screen_scope).

Une invitation par courriel project_member adressée à une personne qui serait un invité externe de l’organisation du projet (ce n’est pas son organisation d’appartenance) est soumise à la politique relative aux invités de cette organisation, et guest_not_allowed (403) répond lorsque la politique (allow, domains ou none) n’admet pas l’adresse. L’acceptation de l’invitation vérifie de nouveau.

Le personnel et les administrateurs de l’organisation sont exemptés. Un screen_scope sur l’invitation relève du périmètre d’écrans, que le forfait Enterprise inclut ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402).

Le projet appelant. Ne débite pas le compteur API de 1 crédit, donc un projet à zéro restant peut encore lire le restant et récupérer. Après un principal de projet réussi, les réponses JSON /api authentifiées et les réponses de problème incluent ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset, et ScreenRig-Credits-Included en crédits entiers.

Les réponses SSE, runtime, contenu et non authentifiées les omettent.

Renomme le projet actuel. Les noms contiennent de 1 à 60 caractères imprimables et aucun texte ressemblant à une URL.

Seul le propriétaire du projet ou un administrateur de son organisation peut le supprimer ; tout autre appelant est refusé avec forbidden. Une personne doit aussi être membre du projet.

Un agent a besoin de la capacité projet d’adhésion cible et supprime pour sa personne responsable, qui doit être le propriétaire ou un administrateur d’organisation ; un agent sans personne responsable ne peut pas supprimer, sauf l’agent qui a inscrit le projet alors qu’aucune personne n’a accepté son inscription.

Nécessite aussi le nom et la révision actuels, zéro écran non archivé, aucun crédit, réservation ou dette dans son propre portefeuille et aucune publicité en direct. Un solde négatif accumulé sous les conditions gratuites ou de lancement ne bloque pas ; la suppression l’efface avec une écriture project_delete_writeoff. Met en file d’attente les avis aux membres et utilise la pierre tombale irréversible.

Liste les applications, les plus récentes d’abord, au maximum 500 par page. Les noms sont des étiquettes et ne doivent pas être uniques ; adressez une application par son identifiant. next_cursor est la position de la dernière ligne retournée tant qu’il reste des lignes ; renvoyez-le comme after, avec les mêmes filtres, pour la page suivante. next_cursor est null à la dernière page.

Diffuse un tar.gz produit par CLI directement dans une mise en scène durable bornée. Les métadonnées sont dans les en-têtes, donc l’archive n’est jamais enveloppée en base64 ni matérialisée en JSON par le serveur.

Le proxy devant l’API met fin à une requête à laquelle il n’a pas répondu en environ 100 s, donc une grande archive sur une liaison montante lente échoue ici ; POST /api/applications/uploads envoie plutôt l’archive directement au magasin d’objets.

Déclare un téléversement direct d’un tar.gz produit par la CLI qui crée une nouvelle application. La réponse est une autorisation signée pour exactement un PUT d’objet de l’archive, donc les octets vont directement au magasin d’objets et ne passent jamais par l’API, dont le proxy met fin à une requête à laquelle il n’a pas répondu en environ 100 s.

Envoyez l’archive par PUT à upload_url, puis validez avec POST /api/applications/uploads/{id}/commit et attendez l’opération. L’application, sa version et l’opération de réception existent dès cette réponse, comme après POST /api/applications. Un téléversement non validé dans les 24 heures échoue, et une application qui n’a jamais publié de version est supprimée.

La même Idempotency-Key et le même corps renvoient le même téléversement avec une URL fraîchement signée. GET /api/capabilities définit features.application_direct_uploads là où ces routes sont servies.

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

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

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

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

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

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

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

La liste par défaut retourne les écrans pairing_pending et actifs. Passez state=archived pour lister uniquement les écrans archivés. Passez tag pour lister uniquement les écrans dont les tags contiennent ce tag exact ; les écrans sans tag sont omis lorsque le filtre est présent.

Passez field, une fois par champ, sous la forme NAME:VALUE pour ne lister que les écrans dont les champs contiennent toutes les valeurs, et near sous la forme LAT,LON,KM pour ne lister que les écrans situés à KM kilomètres ou moins du point; les écrans sans emplacement sont omis, et chaque filtre se combine avec state et tag.

Passez folder comme ID de dossier d’écrans pour ne lister que les écrans directement à l’intérieur (pas ceux de ses sous-dossiers), ou root pour les écrans hors de tout dossier.

Les écrans sont du plus récent au plus ancien, 500 par page au plus. next_cursor est la position de la dernière ligne renvoyée tant qu’il reste des lignes ; renvoyez-le comme after, avec les mêmes filtres, pour la page suivante. next_cursor est null sur la dernière page. Un appelant limité aux écrans (docs/screen-scope.md) ne liste que les écrans de son périmètre.

Une requête qui ne nomme aucun projet omet chaque projet où l’appelant est limité aux écrans ; nommez le projet pour le lister.

Liste chaque dossier d’écrans du projet, au maximum 1000, ordonnés par nom.

Les dossiers organisent les écrans et les ciblent : une feuille d’audience de campagne {"folder": ID} correspond aux écrans de ce dossier et de chaque dossier à l’intérieur, un sélecteur d’action de flotte by:folder agit sur les mêmes écrans, et le default_playlist_id d’un dossier est ce que montrent ses écrans sans liste de lecture propre. parent_id est null à la racine du projet ; construisez l’arbre à partir de parent_id. screens compte les écrans actifs directement à l’intérieur de chaque dossier.

Le dossier d’un écran est Screen.folder_id. Un appelant limité aux écrans (docs/screen-scope.md) liste les dossiers de son périmètre et les dossiers au-dessus, qui sont en lecture seule pour que son arbre ait une racine ; les dossiers au-dessus n’ont pas de nombre d’écrans et les dossiers frères sont masqués. Une requête qui ne nomme aucun projet omet chaque projet où l’appelant est limité aux écrans.

Crée un dossier d’écrans à la racine du projet (parent_id null ou absent) ou à l’intérieur de parent_id. Les noms sont tronqués, contiennent de 1 à 100 caractères Unicode sans contrôles, ne sont ni "." ni "..", et sont uniques parmi les dossiers frères (resource_conflict).

Une organisation contient au maximum 1000 dossiers, tous projets confondus (quota_exceeded), imbriqués au maximum à 10 niveaux (invalid_request). default_playlist_id, lorsqu’il est défini, doit nommer une liste de lecture approuvée (playlist_not_approved). Émet screen.folder_created.

Un appelant limité aux écrans (docs/screen-scope.md) ne crée un dossier que dans un dossier de son périmètre ; la racine du projet ou tout autre parent est outside_screen_scope. Créer un dossier dans un dossier protégé est une révision protected_change (202 pending_review) décidée par un second approbateur.

Déplace des écrans (screen_ids) et des dossiers (folder_ids) dans un dossier (folder_id), ou à la racine du projet lorsque folder_id est null, en une seule requête tout ou rien d’au plus 1000 identifiants. Chaque identifiant doit exister (not_found). Un dossier ne peut pas être déplacé dans lui-même ni dans un dossier qu’il contient, et le déplacement doit maintenir chaque dossier dans une profondeur maximale de 10 niveaux (invalid_request).

Les éléments déjà dans la destination sont laissés tels quels ; chaque écran et dossier déplacé fait avancer sa révision. Les écrans déplacés réévaluent leur liste de lecture en 15 secondes environ : levels nomme les campagnes dont ils rejoignent ou quittent l’audience de dossier et les listes de lecture par défaut de dossier qu’ils gagnent ou perdent. Émet screen.moved.

Un appelant limité aux écrans (docs/screen-scope.md) déplace des écrans et des dossiers de son périmètre vers un dossier de son périmètre ; tout ID ou toute destination en dehors de celui-ci, ainsi que la racine du projet, fait refuser tout le déplacement (outside_screen_scope), y compris quand un écran quitte le périmètre entre la vérification et l’écriture.

Un déplacement vers l’intérieur ou l’extérieur d’un dossier protégé est une révision protected_change (202 pending_review) décidée par un second approbateur.

Répond à ce que jouent les écrans d’un sujet sur [from, to) et pourquoi, pour le calendrier de programmation du tableau de bord : exactement un parmi screen_id, folder_id (les écrans du dossier et de chaque dossier qu’il contient), tag ou campaign_id (les écrans de son audience).

Les écrans dont les piles ont des entrées identiques (mêmes niveaux, défaut, fuseau horaire et nombre d’afficheurs) partagent un groupe avec une seule chronologie, de sorte qu’un grand sujet coûte quelques dizaines de chronologies ; un groupe liste jusqu’à 500 de ses écrans et une réponse au plus 200 groupes (truncated).

Chaque groupe porte sa pile, la plus prioritaire en premier (prise de contrôle, campagnes qui atteignent les écrans, leurs propres entrées de programmation, puis la liste de lecture par défaut ou celle du dossier le plus proche), les périodes de chaque niveau (plays sur chaque afficheur qu’il cible, partial avec les afficheurs sur lesquels il joue, outranked, ou conditional tant qu’il attend une interaction ou une condition de données que seul un Player observe), ce que montre chaque afficheur (on_screen ; la région principale d’une page complète) et conflicts (deux campagnes de même priorité en vigueur à la fois ; un niveau en vigueur qui ne joue jamais). from et to sont des instants RFC 3339, to après from, à au plus 93 jours d’écart ; ils sont tronqués à la minute.

Les règles sont lues dans le fuseau horaire de chaque groupe, comme le font le balayage et chaque Player ; chaque niveau est jugé jouable. Un appelant limité aux écrans (docs/screen-scope.md) doit envoyer un screen_id ou un folder_id dans son périmètre ; une étiquette, un campaign_id ou l’absence de sujet est outside_screen_scope.

Répond avec une feuille contenant les colonnes que lit une importation d’horaires et trois lignes d’exemple (un code d’écran, un dossier d’écrans et une étiquette), en CSV ou, avec format=xlsx, en classeur XLSX.

Lit une feuille de lignes d’horaire par rapport au projet et répond à ce que ferait sa validation, sans rien écrire.

Chaque ligne nomme une cible (un écran par identifiant, par la valeur d’un champ d’écran comme un code de salle, ou par nom ; folder:NAME ; tag:NAME ; plusieurs séparées par ; ou |), un contenu (un nom de fichier multimédia, ou playlist:NAME ou un identifiant de liste de lecture), un début et une fin (une date seule comme fin ferme ce jour), et facultativement timezone, days (Mon-Fri), une plage quotidienne (daily_start, daily_end), priority de 0 à 100, un nom et des numéros d’affichage.

Les heures sont lues sur l’horloge propre à chaque écran ; une colonne timezone les convertit depuis un autre fuseau.

Chaque ligne est vérifiée et signale ses erreurs par colonne : écran, dossier ou étiquette inconnu ou ambigu, fichier manquant ou ambigu, fichier qui ne peut pas remplir un écran, heures invalides ou inversées, fin dans le passé, aucune indication de temps, écran sans fuseau horaire ni liste de lecture par défaut, deux lignes en vigueur en même temps sur un écran à la même priorité, et plus de niveaux que n’en contient un écran (32), ou plus de campagnes que n’en contient son organisation, tous projets confondus (100 ; chaque niveau partagé en compte une).

Les lignes qui s’accordent sur le contenu, les heures, la priorité et le nom forment un seul niveau : un écran donne une entrée de l’horaire propre à cet écran ; plusieurs écrans, un dossier ou une étiquette donnent un niveau partagé (une campagne), qui l’emporte sur les niveaux propres d’un écran.

La réponse liste les niveaux avec ce que fait une validation à chacun (create, update, unchanged), les niveaux qu’une exécution antérieure de la même importation a créés et que la feuille n’a plus (removals), les piles des écrans telles qu’elles seraient (calendar), et une empreinte à envoyer à la validation. La feuille est des lignes JSON, un CSV ou un XLSX, de 5 000 lignes au plus.

Non disponible pour un appelant limité aux écrans (outside_screen_scope). L’importation d’horaires fait partie du forfait Enterprise ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402). Le modèle est ouvert à tous les forfaits.

Valide une importation prévisualisée : la même feuille et l’empreinte que son aperçu a renvoyée. Chaque niveau est créé, mis à jour ou supprimé, les horaires des écrans et les niveaux partagés sont écrits en une seule transaction, et l’événement d’importation schedule.imported est ajouté : toutes les lignes s’appliquent ou aucune.

Les listes de lecture à fichier unique dont les fichiers de la feuille ont besoin sont créées en premier (elles ne changent rien sur aucun écran). Une feuille dont les lignes ont des erreurs est refusée (schedule_import_invalid) ; un projet qui a changé depuis l’aperçu, ou des lignes qui se lisent autrement, est refusé (schedule_import_stale), et le client refait un aperçu.

Importer de nouveau la même feuille sous le même nom ne change rien ; une ligne modifiée met à jour son niveau et une ligne retirée supprime son niveau. Demande une personne qui peut approuver dans le tableau de bord et, pour un agent, des identifiants avec accès en écriture.

Une validation qui mettrait à jour ou supprimerait une campagne réservée répond reserved_item (403) et n’écrit rien, sauf si elle est validée par une personne qui peut approuver.

Une validation qui atteint un écran protégé est refusée en entier avec protected_target, même quand l’importation n’a aucun niveau mais retire les entrées d’importation d’un écran protégé ou supprime une campagne d’importation dont l’audience en atteint un.

Dans un projet avec des dossiers d’écrans protégés, une validation dont l’aperçu échoue à cause d’un service, et non de la feuille, répond dependency_unavailable et n’écrit rien : renvoyez la même requête après une courte attente. Une erreur de validation de feuille, de campagne ou d’écran répond comme la validation le ferait (invalid_request et les autres problèmes ci-dessus).

Non disponible pour un appelant limité aux écrans. L’importation d’horaires fait partie du forfait Enterprise ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402). Le modèle est ouvert à tous les forfaits.

Réclame un code de lien de navigateur pour le projet authentifié et crée atomiquement exactement un écran pairing_pending initial plus sa subvention de provisioning de navigateur existante. L’inscription reste limitée au projet. La réponse contient uniquement des métadonnées sûres et ne contient jamais de jeton de provisioning, URL fragmentée, cookie ou preuve.

Réclame une session d’association Player globale à la flotte de six caractères. Les tentatives Idempotency-Key exactes retournent le résultat original durable sans consommer à nouveau le quota.

La session du tableau de bord réclame dans son projet actuel avec le même corps, la même Idempotency-Key, les mêmes budgets et les mêmes problèmes, sauf que son not_found pour un code inconnu ou déjà réclamé ne nomme aucune commande CLI ; c’est un changement d’état, il suit donc les règles de mutation du tableau de bord, une session fantôme sans mode d’écriture du personnel est refusée, et les événements que la réclamation ajoute nomment l’utilisateur du tableau de bord. folder_id nomme le dossier où l’écran arrive.

Un appelant limité aux écrans (docs/screen-scope.md) doit envoyer un dossier de son périmètre et ne jumelle qu’en tant que personne qui peut approuver (outside_screen_scope, approver_required).

Provisionnement facultatif d’un nouvel écran, réservé au navigateur. Crée toujours un nouvel écran pairing_pending ; au plus cinq attendent d’être jumelés en même temps (quota_exceeded). Les nouvelles tentatives exactes redonnent le même jeton de fragment pendant dix minutes. Le jumelage à six caractères reste la valeur par défaut et le seul flux de récupération. folder_id nomme le dossier où l’écran arrive.

Un appelant limité aux écrans (docs/screen-scope.md) doit envoyer un dossier de son périmètre (sinon outside_screen_scope).

Applique une action à une flotte sélectionnée sans limite de nombre d’écrans. Sélectionnez un screen_ids unique ou une étiquette correspondant aux écrans actifs dans l’ordre de création. La sélection résolue est épinglée avant toute mutation, stockée en morceaux limités, et conservée pendant vingt-quatre heures sous Idempotency-Key.

Chaque étape utilise son chemin de mutation à écran unique, en préservant les révisions, événements, signaux d’exécution et limites par écran. Une réponse contient une page limitée de résultats ; correspondants, réussis et échoués décrivent cette page. HTTP 202 inclut le total, l’offset et next_cursor. Continuez avec le même sélecteur, la même action et Idempotency-Key, en passant next_cursor comme after.

Respectez Retry-After lorsqu’il est présent, y compris une page avec zéro résultat. La réponse renvoie Idempotency-Key, y compris une clé générée lorsque l’appelant l’a omise ; conservez cette clé pour les suites. Le HTTP 200 termine la sélection. Les pages répondues rejouent exactement, y compris les échecs par écran ; les étapes interrompues rejouent sans répéter leurs effets.

Les grandes actions sont limitées par les budgets existants de 600 par minute et par organisation pour rechargement, toast, prise de contrôle, horaires de playlist, redémarrage, affichage et horaires d’affichage ; l’épuisement du budget de l’organisation met l’action en pause au lieu de refuser la flotte. L’épuisement par écran échoue uniquement pour cet écran.

Une étape assign, takeover ou set_playlist_schedule qui lie une liste de lecture ayant un format à un écran dont le mur a une autre forme échoue pour cet écran seul avec 409 playlist_format_mismatch. Les changements d’assignation et d’étiquette n’ont pas de budget de messages.

Une assignation dont la liste de lecture contient un src d’iframe ou des params d’application qui lisent un jeton d’écran manquant à un écran de la page ajoute un avertissement screen_fact_missing à cette page (warnings, PlaylistWarning). L’échec partiel est un résultat normal. Toutes les pages et tentatives sous une même clé forment une seule action mesurée.

Les requêtes utilisent une charge utile en octets bornée ; utilisez une étiquette pour une sélection plus grande que la charge utile de transport. Un sélecteur ou une action mal formé est refusé avant qu’un écran soit touché. Un sélecteur ou une action mal formé est refusé avant qu’un écran soit touché.

Un appelant limité aux écrans (docs/screen-scope.md) sélectionne par screen_ids ou par dossier, chaque écran de son périmètre ; un sélecteur d’étiquette, un écran en dehors du périmètre ou un écran inconnu fait refuser toute l’action (outside_screen_scope) avant que quoi que ce soit soit épinglé ou proposé.

Assign, takeover, takeover_clear, set_playlist_schedule et clear_playlist_schedule qui atteignent un écran protégé deviennent une révision décidée par un second approbateur (202 pending_review) à tous les niveaux d’accès ; set_tags, add_tags et remove_tags sur un écran protégé donnent protected_target (409).

Une action set_playlist_schedule avec une entrée en pause (un brouillon) relève du contrôle des changements d’horaire, que le forfait Enterprise inclut ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402).

Affiche des onglets de navigateur sur les écrans du projet nommé; la requête, la réponse, l’accès et les limites sont ceux de POST /api/tab-shares.

Liste les campagnes du projet par ordre de priorité (au plus 100), l’ordre dans lequel la résolution les lit. reserved est présent sur chaque campagne.

Un appelant limité aux écrans (docs/screen-scope.md) voit chaque campagne, avec editable à true seulement quand toute l’audience est dans son périmètre (une feuille d’étiquette et la règle racine de tous les écrans ne le sont jamais ; une règle all exige un enfant contenu, une règle any chaque enfant) et que l’appelant peut modifier ce qui est diffusé.

createCampaign pour le projet nommé dans le chemin. reserved à true réserve la campagne, et seule une personne qui peut approuver le définit (reserved_item pour un agent, un client de service ou toute autre personne), ce qui ajoute campaign.reserved_changed.

Un appelant limité aux écrans (docs/screen-scope.md) ne crée une campagne que pour une audience dans son périmètre (feuilles folder et screen_id ; ni étiquette, ni tous les écrans), sinon outside_screen_scope, et seulement en tant que personne qui peut approuver (approver_required).

Une campagne dont l’audience atteint un écran protégé est une révision protected_change décidée par un second approbateur (202 pending_review) à tous les niveaux d’accès. reserved true relève des dossiers protégés et paused true sur une nouvelle campagne (un brouillon) relève du contrôle des changements d’horaire, les deux faisant partie du forfait Enterprise ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402).

Liste les connexions du projet, les plus récentes d’abord, au plus 200 par page ; renvoyez next_cursor comme after pour la suivante. Un secret, une clé ou un jeton d’actualisation n’est jamais renvoyé : secret indique si l’un d’eux est conservé et un indice qui n’est pas secret. Une lecture ne porte jamais de lien de consentement.

Crée dans ce projet une connexion à Microsoft ou à Google : le mode own_app avec les propres identifiants du client, ou le mode screenrig_app, qui répond consent_url, un lien à usage unique pour la personne qui le complète (voir createConnection). Ajoute connection.created. Une nouvelle tentative identique avec la même Idempotency-Key renvoie la même connexion.

Liste les connexions BI du projet, de la plus ancienne à la plus récente, 200 par page ; renvoyez next_cursor comme cursor pour la suivante. Un secret n’est jamais renvoyé : secret indique s’il est défini et ses 4 derniers caractères.

Ajoute une connexion à un système BI que le projet possède. Pour Grafana : son adresse (http ou https sur un hôte public, avec un préfixe de chemin facultatif) et un jeton de compte de service avec le rôle Viewer. Le jeton est scellé et jamais renvoyé.

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 administrateur Power BI doit activer les paramètres de développeur Embed content in apps et Service principals can call Fabric public APIs pour l’application (portail d’administration, paramètres du locataire), l’application doit être Membre ou Administrateur de chaque espace de travail qu’elle affiche, et les rapports ont besoin d’une capacité Embedded, Fabric ou Premium en production.

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.

Ajoutez embed_origin de la réponse à la liste d’autorisation des domaines de l’application connectée et activez le secret. Quiconque détient un ticket d’écran peut intégrer toute vue que cet utilisateur peut voir : utilisez donc un utilisateur qui ne voit que les tableaux de bord des écrans. Tableau Cloud, ou Tableau Server 2023.3 ou version ultérieure.

Pour une page web avec connexion (kind web) : le compte de service d’un site qui affiche son tableau de bord derrière une connexion. config.login_mode est auto (config.login_url, config.username et le mot de passe comme secret : le moteur de rendu ouvre la page de connexion et remplit le formulaire), steps (config.login_url et config.steps, un script d’étapes goto, fill, click, press, wait_for et wait_ms dont les valeurs peuvent contenir {{username}}, {{password}} et {{otp}}) ou none (aucune connexion : la connexion affiche les pages avec les cookies que vous lui donnez). totp_secret est la clé base32, ou l’adresse otpauth://, de l’application d’authentification du compte : le serveur calcule le code à usage unique (RFC 6238) et n’envoie au moteur de rendu que le code. cookies est un fichier de cookies exporté d’un navigateur connecté, pour un site dont la connexion ne peut pas être scriptée (authentification unique approuvée sur un téléphone, vérification d’appareil) ; le serveur garde le fichier et le renouvelle à partir des cookies que renvoie chaque capture, de sorte qu’une connexion est rare.

Le mot de passe, la graine et les cookies sont scellés et jamais renvoyés. Utilisez un compte de service en lecture seule. Le mot de passe n’est saisi que dans config.login_url et les étapes goto : les déplacer vers une autre origine exige donc secret de nouveau. Après cinq connexions refusées de suite, la connexion cesse de se connecter jusqu’à ce que ses identifiants changent.

Un serveur sans moteur de rendu de pages répond bi_web_unavailable. Ajoute bi_connection.created. Une nouvelle tentative identique avec la même Idempotency-Key renvoie cette même réponse.

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.

Ajoute une vue d’un tableau de bord Grafana de la connexion, ou d’un seul de ses panneaux (url : une adresse /d/{uid}/... sur l’hôte de la connexion, ou target), ou d’un lien de tableau de bord public Grafana (kind grafana et target.public_url, sans connexion).

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 page d’intégration n’affiche qu’un ticket que porte le manifeste de l’écran : une vue ne passe donc que sur les écrans de son propre projet.

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.

Une visualisation Tableau Public est une vue sans connexion (kind tableau, target.public_url, reconstruite comme https://public.tableau.com/views/WORKBOOK/VIEW) et accepte aussi rotate_sheets. Pour une page web (kind web) : une page du site de la connexion web (url : une adresse https sur un hôte public, sans target).

Le navigateur en périphérie l’ouvre en étant connecté, attend l’élément wait_for s’il est défini et wait_ms millisecondes (jusqu’à 10000), et dessine clip, un sélecteur CSS, s’il est défini, sinon la page entière.

L’image est redessinée toutes les refresh_s (60 à 86400, 300 par défaut) et partagée par tous les écrans de même taille, et seulement tant qu’un écran affiche la vue ; quand une capture échoue, la dernière image reste à l’écran. Réglez wait_for sur un élément qui n’existe que lorsque la page est connectée, de sorte qu’une page de connexion ne soit jamais affichée. Ajoute bi_view.created.

Liste les déclencheurs d’alerte CAP du projet, du plus ancien au plus récent (au maximum 20), chacun avec son URL d’ingestion, nom d’utilisateur et dernière alerte. Le mot de passe n’est jamais retourné ici.

Crée un déclencheur d’alerte CAP : une URL entrante à laquelle un système de notification d’urgence (Everbridge, Rave, Alertus, relais IPAWS et autres émetteurs CAP 1.2) poste des alertes, avec des identifiants HTTP Basic.

La réponse est le seul endroit où le mot de passe apparaît (avec la réponse de rotation) : stockez-le immédiatement dans le système d’envoi. target est une balise (chaque écran actif avec elle à l’arrivée de l’alerte) ou jusqu’à 500 screen_ids.

Une alerte prend le contrôle de chaque écran cible avec une liste de lecture par défaut jusqu’à l’alerte <expires>, sinon pour default_for_seconds (60 à 604800, défaut 3600) ; voir POST /api/triggers/{id}/cap. Une organisation a au maximum 20 déclencheurs, tous projets confondus (trigger_limit_reached). Ajoute trigger.created.

Une nouvelle tentative exacte avec la même Idempotency-Key renvoie cette même réponse, mot de passe compris, pendant vingt-quatre heures. Un déclencheur dont le sélecteur atteint un écran protégé donne protected_target (409), et un échec de lecture de la protection d’un écran donne dependency_unavailable (500, relancez la même requête) ; un déclencheur n’est pas disponible pour un appelant limité aux écrans.

Liste les événements durables du projet par ordre croissant de séquence.

La pagination est contiguë : passez le next_cursor retourné comme after pour continuer exactement là où la page s’est arrêtée. next_cursor est le curseur du dernier événement retourné tant que des événements plus récents existent déjà, et nul à la fin de l’historique. limit par défaut à 50 et accepte 1-200 ; une valeur hors plage est refusée avec invalid_request et un membre errors[] nommant limit.

Le décalage de pagination n’est pas supporté. source=log liste le journal du Player à la place : les rapports de conditions envoyés par les Players (runtime.reported) triés par heure de réception, filtrés par screen_id et gravité sur une fenêtre de à (par défaut les dernières 24 heures, au maximum 31 jours).

Ses curseurs sont opaques : lg1_ ou ev1_ selon l'endroit où le serveur garde le journal du Player, donc renvoyez celui qu'une page a retourné ; un curseur de l'autre type est refusé avec invalid_request nommant le champ. Les enregistrements du journal du Player n'ont pas de séquence, ne sont pas sur GET /stream/project et ne sont pas livrés aux webhooks.

Un enregistrement est reconnu lorsque la file d’attente du journal du lecteur l’accepte et est conservé pour la rétention d’événements du projet. Un sondage avec le dernier curseur et la fenêtre par défaut suit le journal. Les enregistrements du journal du lecteur ne figurent pas dans la liste par défaut (source=project). from et to sont refusés avec invalid_request sauf si source est log.

La liste de projets prend screen_id, playlist_id et application_id pour lire les événements d’un écran, d’une liste de lecture ou d’une application, tous limités au projet des identifiants (un id nomme quels événements lire, jamais à qui) : screen_id garde les événements dont la ressource est cet écran ; playlist_id les événements dont la ressource est cette liste de lecture plus ceux qui la nomment comme details.playlist_id (un écran la prenant) ; application_id les événements dont la ressource est cette application plus ceux dont la ressource la porte comme application_id (ses versions et entrées clé/valeur).

Une valeur qui n’est pas un identifiant de son type est refusée avec invalid_request nommant le champ ; playlist_id et application_id sont refusés avec source=log, dont les enregistrements appartiennent uniquement à un écran.

Les deux sources prennent resource_id, type et gravité (au minimum), combinés entre eux, avec les filtres d’identifiant et la pagination ; un enregistrement de journal Player est un enregistrement runtime.reported dont la ressource est son écran, donc un resource_id qui n’est pas cet écran ou un type qui exclut runtime.reported renvoie une page vide. before (ou order=desc) affiche les plus récents en premier : next_cursor est alors le curseur de l’élément le plus ancien retourné et renvoyé comme before pour continuer vers les éléments plus anciens.

Sans from, une page source=log la plus récente d’abord remonte au-delà des 24 heures par défaut jusqu’au plus ancien enregistrement que la rétention d’événements du projet conserve, au maximum 31 jours sous le bord supérieur de la page par requête. Une page source=log la plus récente d’abord peut contenir moins que limit d’enregistrements, voire aucun, avec un next_cursor ; null la termine toujours, à la fin du journal conservé.

Un appelant limité aux écrans (docs/screen-scope.md) lit un flux filtré : les événements des écrans de son périmètre, des dossiers d’écrans qu’il peut voir (les siens, ceux au-dessus et ceux à l’intérieur ; screen.moved seulement quand la destination est dans son périmètre), des campagnes, des listes de lecture, des médias, des applications et des cartes, et les révisions playlist_change.

Tout autre événement est omis, de sorte qu’une page peut contenir moins d’événements que limit, voire aucun, avec un next_cursor ; continuez la pagination avec celui-ci. source=log exige un screen_id dans son périmètre. Les événements sur le projet lui-même ne sont pas envoyés.

Le plan du projet appelant, les indicateurs indépendants annonceur/écrans avec leur révision, l’ensemble des capacités effectives dérivées, les fonctionnalités de plan dont il dispose (plan_features) et ses limites (limits). Ne reflète jamais une revendication client ; un plan inconnu échoue fermé comme interdit.

Le snapshot du solde conscient de la source du projet appelant. Tous les montants en millicrédits sont des chaînes décimales canoniques. C’est un snapshot, pas une autorité de paiement ; rails_available est faux tant que la carte, la taxe et la voie de retrait sont indisponibles.

Pagination stable par curseur sur les entrées de journal immuables publiées pour le projet appelant. Les retenues ne sont pas des entrées publiées. Les corrections renvoient à l’événement original au lieu de le réécrire. Il n’y a aucune mutation arbitraire de subvention ou de paiement sur cette surface.

L’utilisation du projet appelant pour un mois UTC, avec les octets servis et reçus (jamais facturés), le stockage facturé au-delà du stockage gratuit du forfait du payeur (allowance.storage_bytes), et les requêtes API, les événements de flux de projet facturés et les tentatives de livraison par webhook comptés dans la limite gratuite de 10 000 par mois. Un projet qui paie pour lui-même lit son propre pool.

Un projet qu’un autre payeur finance partage la réserve de ce payeur avec les autres projets du payeur ; il lit sa propre part, et payer nomme le payeur. Le total de la réserve du payeur reste sur les lectures de facturation du payeur.

Le réseau unique du vendeur appelant, incluant ses frais de service ScreenRig résolus. Les vendeurs ne peuvent pas modifier ces frais.

Crée le réseau unique du vendeur appelant s’il est absent. Nécessite screens=true. Idempotent ; la répétition retourne le même réseau.

Définit le taux par défaut du projet du vendeur par tranche de 15 secondes de lecture terminée. Un changement qui modifie le taux effectif d’une campagne acceptée met en pause toute cette campagne avec price_change_pending ; un changement masqué ou sans effet ne le fait pas. If-Match porte la révision du réseau.

L’inventaire auquel le vendeur appelant a souscrit.

Crée un emplacement vendeur réutilisable. Les images durent de 5 à 30 secondes et les vidéos au maximum la limite de la plateforme de 120 secondes. Les publicités sont toujours muettes.

Réseaux auxquels l’annonceur appelant appartient actuellement, avec la portée et la politique de révision qui lui ont été accordées. Le nombre d’écrans n’est pas un nombre d’impressions garanti.

Lie une révision média prête et possédée à une création immuable. Ne copie pas les octets, ne téléverse pas à nouveau, ni ne recharge la génération. Les médias inconnus ou non prêts sont rejetés.

Crée une campagne brouillon. Les brouillons ne détiennent pas d’argent, ne réservent rien et n’autorisent aucune diffusion. L’activation nécessite un devis explicitement accepté.

Versions créatives soumises au vendeur appelant pour revue. Un vendeur voit uniquement la création soumise exacte, jamais la bibliothèque de l’acheteur.

Dépenses et livraisons limitées à un acheteur pour une campagne. Les montants sont des chaînes décimales mcr. Ne révèle jamais les revenus du vendeur, l’état bancaire ou l’usage global du projet.

Brut, frais de service et net à l’échelle du vendeur pour une fenêtre, avec ses propres preuves de diffusion. Ne révèle jamais le portefeuille de l’acheteur ni d’autres réseaux. Seules les preuves de diffusion terminée autorisées établissent une diffusion facturable. La fenêtre fait au maximum 92 jours ; une fenêtre plus large est invalid_request.

Quand il contient plus de 5000 règlements, la réponse définit tronqué, les totaux et les comptes couvrent toujours tous, et les lignes listent seulement les 5000 premiers.

Agrégats quotidiens de lecture.

JSON retourne au plus 200 lignes et n’est pas limité en débit. format=csv (ou Accept text/csv sans application/json) diffuse chaque ligne correspondante entre day_from et day_to (jours UTC inclus ; day_to par défaut aujourd’hui et day_from 30 jours avant ; au plus 366 jours, sinon invalid_request) en CSV avec une ligne d’en-tête fixe (PlaybackAggregateCsv) ; seule la forme CSV dépense les budgets playback-export-org (30 par minute) et playback-export-ip (60 par minute).

Chaque forme est une requête d’API mesurée. Les réponses portent Vary Accept. Un appelant limité aux écrans (docs/screen-scope.md) doit envoyer screen_id, qui doit être un écran de son périmètre (sinon outside_screen_scope) ; les formes CSV suivent la même règle.

Enregistrements par lecture : une ligne par playback.media_started accepté (ou playback.video_started ancien) et une ligne par playback.application_started accepté (release_id défini, champs médias vides) du projet appelant, du plus ancien au plus récent selon received_at, égalités selon insertion. bornes from (incluse) et to (exclue) sur received_at ; to par défaut à maintenant, from à 24 heures avant to, et la plage au maximum 31 jours (sinon invalid_request).

Les 5 dernières secondes ne sont pas encore retournées : la fin effective est au plus maintenant moins 5 secondes (délai de stabilisation), donc une queue en direct ne saute jamais une ligne qui s’engage derrière son curseur. screen_id, media_id, playlist_id (la liste de lecture dont le début a été montré), et tag (une étiquette d’écran portée par l’écran lors de la réception de la lecture) filtrent.

Une page playlist_id peut contenir moins de lignes que la limite, voire aucune, avec un next_cursor quand une longue série de lectures d’autres listes a été parcourue ; null met toujours fin à la plage.

JSON est une page d'au plus limit lignes (par défaut 200, au plus 1000) avec next_cursor, null à la fin de la plage ; renvoyez-le comme cursor avec les mêmes filtres. order=desc (ou before) pagine les plus récentes en premier dans la même plage : next_cursor est alors le curseur de la ligne la plus ancienne retournée, null au début de la plage, et est renvoyé comme before (exclusif) avec les mêmes filtres ; order=asc avec before est refusé avec invalid_request nommant order, et cursor avec une page newest-first nommant cursor.

Une page la plus récente en premier peut contenir moins de lignes que la limite, voire aucune, avec un next_cursor ; null met toujours fin à la liste.

Une page ultérieure ne saute jamais une ligne qui existait lorsque la page antérieure a été lue et ne répète pas une ligne, sauf qu’un démarrage du Player renvoyé après un rapport non accusé de réception (le même play_id, reçu un instant plus tard) peut apparaître à nouveau sur une page ultérieure ; le flux CSV le liste une fois. format=csv (ou Accept text/csv sans application/json) diffuse chaque lecture du curseur à la fin de la plage en CSV (PlaybackPlayCsv), le plus récent en bas avant avec order=desc ; la limite est refusée avec CSV.

La mesure se fait par requête : chaque page JSON coûte un crédit de requête API, tandis qu’un flux CSV couvrant toute la plage en coûte un seul. Chaque requête de lectures (page ou flux) utilise les budgets playback-export-org (30 par minute) et playback-export-ip (60 par minute).

Un flux limite chaque écriture (15 secondes) et se termine à la déconnexion du client ; s’il échoue après l’en-tête 200, la connexion est interrompue, donc une exportation qui lit jusqu’à une fin propre est complète. Les réponses portent Vary Accept. Les lectures sont conservées pour la rétention d’événements du forfait (30 jours est le minimum livré ; la rétention selon le forfait utilise la fenêtre propre de 7 ou 90 jours).

Un appelant limité aux écrans (docs/screen-scope.md) doit envoyer screen_id, qui doit être un écran de son périmètre (sinon outside_screen_scope) ; les formes CSV suivent la même règle.

Totaux de lecture du projet appelant sur des jours UTC inclusifs, lus depuis les totaux quotidiens : by=day renvoie une ligne par jour avec lectures (screen_id ou media_id restreint à un écran ou média), by=screen et by=media classent les écrans ou médias les plus actifs (top, au plus 100), et by=screen_day renvoie la série journalière des écrans principaux (top au plus 10). day_to par défaut aujourd’hui (UTC) et day_from 29 jours avant.

Une série de jours couvre au maximum 366 jours (92 lorsqu’elle est restreinte à un écran ou un média) ; un classement au maximum 92. Les comptes incluent chaque démarrage enregistré par le projet, y compris ceux stockés avant l’existence des rollups de lecture.

Les rollups suivent l’ingestion jusqu’à environ 21 minutes. truncated est vrai lorsqu’un classement a été construit à partir de tranches d’une fenêtre trop grande pour une seule lecture : il couvre les meilleures clés de chaque tranche. Pas de limitation de débit. Une requête API mesurée.

Un appelant limité aux écrans (docs/screen-scope.md) doit envoyer screen_id, qui doit être un écran de son périmètre (sinon outside_screen_scope) ; les formes CSV suivent la même règle.