API de Proyectos

Devuelve detalles actuales de confirmación, bloqueadores de eliminación y dispositivos archivados que serán desconectados. allowed es falso, con una razón, cuando el llamante no puede eliminar el proyecto (solo su propietario o un administrador de su organización puede; para un agente, su persona responsable) o queda un bloqueador.

El propietario transfiere la propiedad a un miembro existente y verificado del proyecto; esto no concede ninguna membresía nueva. La membresía del nuevo propietario deja cualquier screen_scope y upload_scope, así que el nuevo propietario accede a todo el proyecto.

Una sesión del dashboard de un administrador de la organización del proyecto que es miembro transfiere la propiedad de la misma manera, desde quien es propietario del proyecto; un administrador de la organización que no es miembro usa PUT /api/organizations/{org_id}/projects/{project_id}/owner.

El movimiento autorizado por el propietario transfiere la ocupación de la pantalla y el nuevo uso al pagador destino atómicamente; los cargos históricos mantienen su pagador. Un destino que ya tiene tantos proyectos activos como permite su plan es project_limit_reached, cuyo required_plan nombra el plan con espacio, ausente en Enterprise.

Lista destinos que el propietario administra o cuyo dominio verificado coincide con su correo electrónico verificado.

Lista todas las membresías activas de la identidad, con contexto de organización y propietario, incluyendo membresías omitidas de este token o el consentimiento de su concesión. Cada entrada marca in_token; el descubrimiento no añade autoridad y no tiene límite de 64 proyectos.

Crea un proyecto con nombre propiedad de la persona responsable verificada. Si no se nombra organización, se asigna a la organización del dominio verificado de la persona, o a la organización del proyecto actual, o a la organización que la persona usó más recientemente entre las que administra o tiene como gratuita, o a una nueva organización.

Un nombre de organización selecciona exactamente una coincidencia visible, de lo contrario crea una nueva organización. Una persona tiene una organización Standard gratuita; una nueva organización más allá de esa es free_organization_limit, nombrando la que posee.

Una organización tiene como máximo tantos proyectos activos como permite su plan (Standard 1, Plus 3, Premium 10, Education 50, Enterprise 100, ampliado por sus featuresets); uno más es project_limit_reached, cuyo required_plan nombra el plan con espacio, ausente en Enterprise (comuníquese con soporte).

Un reintento idempotente exacto vuelve a entregar su credencial de membresía sellada durante diez minutos. La inscripción está exenta del límite.

Bajo un JWT de acceso de agente (alcance de identidad, access:manage, una concesión con acceso de identidad Manage) no se entrega token de proyecto; el proyecto se une a la concesión con Manage y todas las capacidades, y una actualización con su project_id devuelve un token para él.

Lista registros del ciclo de vida de invitaciones para el proyecto actual, excluyendo restablecimientos de inicio de sesión. Las direcciones de destinatarios son visibles para el proyecto propietario, que las suministró. Nunca se listan tokens ni URLs de credenciales.

Crea invitaciones para miembros o compradores de anuncios. La entrega por correo electrónico nunca devuelve una credencial. La entrega por enlace es solo para miembros y devuelve una URL, incluso en reintentos idempotentes exactos dentro de 24 horas. Las invitaciones por correo electrónico expiran tras siete días; los enlaces expiran tras 24 horas. Las invitaciones por correo electrónico pendientes del mismo tipo, dirección y proyecto se reutilizan.

Un miembro limitado a pantallas no invita a personas (outside_screen_scope).

Una invitación por correo electrónico project_member a una persona que sería un invitado externo de la organización del proyecto (no es su organización principal) está sujeta a la política de invitados de esa organización, y responde guest_not_allowed (403) cuando la política (allow, domains o none) no admite la dirección. Aceptar la invitación lo comprueba de nuevo.

El personal y los propios administradores de la organización están exentos. Un screen_scope en la invitación corresponde al alcance de pantallas, que incluye el plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402).

Revoca una invitación pendiente. Una invitación aceptada devuelve invitation_consumed. Un miembro limitado a pantallas no revoca invitaciones (outside_screen_scope).

Acepta una solicitud de restablecimiento de inicio de sesión sin revelar si una persona posee la dirección.

También se encuentra a una persona cuya dirección no está verificada, como un registro de autoservicio, y completar ese restablecimiento, que su propietario debe confirmar con replace_unverified_account, da al propietario de la bandeja de entrada una cuenta nueva (una persona nueva con la credencial del restablecimiento, una organización y un proyecto nuevos) y elimina a la persona no verificada, de quien nadie había demostrado que la dirección le pertenecía.

Un enlace de restablecimiento caduca una hora después de la última solicitud. Mientras el enlace de una persona siga activo y tenga menos de un día, otra solicitud reenvía ese mismo enlace (como máximo una vez cada diez minutos) y lleva su caducidad a una hora desde la solicitud, de modo que una solicitud nunca invalida el enlace que ya está en la bandeja de entrada; si no, un enlace nuevo lo reemplaza. No hay límite por dirección.

Completar un restablecimiento elimina las demás claves de acceso de la persona (todas sus claves de acceso en un restablecimiento de contraseña), elimina la contraseña cuando la nueva credencial es una clave de acceso, descarta un cambio de correo pendiente y cierra todas las sesiones. Con o sin persona, la solicitud también reenvía como máximo diez invitaciones dirigidas al correo, y cada invitación como máximo una vez por hora.

De los diez proyectos no eliminados más recientes cuya dirección de contacto coincide, cada proyecto activo con un plan del catálogo y cuya propiedad siga pendiente desde la inscripción recibe de nuevo su invitación de inscripción, aunque haya caducado o la persona destinataria ya se haya unido como miembro ordinario.

Aceptar esa invitación de inscripción con el inicio de sesión existente completa la reclamación de propiedad; solicitar la recuperación por sí solo no cambia la propiedad ni las credenciales. Las invitaciones por correo pendientes para miembros y compradores de anuncios de proyectos activos con un plan del catálogo, y las invitaciones pendientes para administradores de organizaciones activas, ocupan las plazas restantes, de la más reciente a la más antigua.

Una invitación reenviada conserva su ID y recibe un enlace y una fecha de caducidad nuevos; el enlace anterior deja de funcionar y el número de invitaciones pendientes del proyecto no cambia. Una invitación de inscripción caducada vuelve como una invitación nueva que ocupa de nuevo una plaza, por lo que el contador aumenta en uno; se omite si el proyecto está lleno.

No se reenvían otras invitaciones caducadas, ni las revocadas, aceptadas o compartidas mediante enlace.

Crea un nuevo proyecto y su primer agente mediante inscripción explícita con CLI agrupada, incluso si la dirección de contacto ya pertenece a una persona o proyecto. El correo de contacto permanece sin verificar y no otorga autoridad; direcciones malformadas devuelven invalid_request.

Encola una invitación de inscripción en la misma transacción. project_name es opcional; si se omite, se usa un nombre legible de dos palabras. La repetición idempotente exacta precede a los límites de frecuencia. Persista la credencial permanente antes de informar el éxito; su sobre de repetición expira en issuance_expires_at y los reintentos posteriores devuelven credential_issuance_expired.

El registro de idempotencia dura 24 horas.

Inicia un inicio de sesión de navegador AgentID (OIDC) en el host API derivado del origen público en tiempo de ejecución (https://play.<domain> -> https://api.<domain>). Establece una cookie de enlace de un solo uso y redirige al punto de autorización AgentID con PKCE S256. Responde solo en el host API.

Mientras la parte confiable no tiene id de cliente ni secreto, la ruta muestra una página simple de no disponible con 503.

Completa un inicio de sesión AgentID en navegador en el host API. Requiere iss igual al emisor configurado, la cookie de enlace y una transacción de un solo uso no expirada.

Intercambia el código con client_secret_basic y PKCE, verifica el id_token ES256 (iss, aud, exp con desviación de 60 s, nonce) contra el JWKS en caché, llama a userinfo y aplica las reglas del propietario, luego muestra una página de código de reclamación de un solo uso. Un sujeto ya vinculado a un agente muestra la página ya inscrita.

Esta ruta nunca crea un proyecto, identidad o invitación.

El proyecto que llama. No debita el medidor API de 1 crédito, por lo que un proyecto con saldo cero aún puede leer el saldo restante y recuperarse. Después de un principal de proyecto exitoso, las respuestas JSON autenticadas /api y de problemas incluyen ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset y ScreenRig-Credits-Included como créditos enteros.

SSE, runtime, contenido y respuestas no autenticadas los omiten.

Renombra el proyecto actual. Los nombres contienen de 1 a 60 caracteres imprimibles y no texto con apariencia de URL.

Solo el propietario del proyecto o un administrador de su organización puede eliminarlo; cualquier otro llamante es rechazado con forbidden. Una persona también debe ser miembro del proyecto.

Un agente necesita la capacidad de proyecto de membresía objetivo y elimina para su persona responsable, que debe ser el propietario o un administrador de la organización; un agente sin persona responsable no puede eliminar, excepto el agente que inscribió el proyecto mientras nadie ha aceptado su inscripción.

También requiere el nombre y la revisión actuales, cero pantallas no archivadas, sin crédito, reservas ni deuda en su propia billetera y sin publicidad en vivo. Un saldo negativo acumulado bajo términos gratuitos o de lanzamiento no bloquea; la eliminación lo cancela con una entrada de libro mayor project_delete_writeoff. Encola avisos para miembros y usa la lápida irreversible.

El plan del proyecto que llama, indicadores independientes de anunciante/pantallas con su revisión, el conjunto de capacidades efectivas derivadas, las funciones del plan que tiene (plan_features) y sus límites (limits). Nunca refleja una reclamación del cliente; un plan desconocido falla cerrado como prohibido.

El registro de auditoría propio de la organización: los cambios en sus administradores, dominios y ajustes de facturación, con las mismas entradas, filtros y formatos que GET /api/audit. Requiere un administrador de la organización. Forma parte del registro de auditoría, que incluye el plan Enterprise; una organización cuyo plan no lo incluye se rechaza con feature_not_in_plan (402).

Todos los planes registran sus cambios.

Las notificaciones de la organización, de todos los canales, de la más antigua a la más reciente (máximo 50).

Una notificación pertenece a la organización y cubre todos sus proyectos, incluidos los añadidos después (project_ids ausente), o los proyectos elegidos (project_ids); actúa sobre las pantallas, fuentes, campañas y tarjetas de esos proyectos exactamente igual que una notificación de proyecto. status es failing mientras lo estén las entregas de cualquier proyecto cubierto, y failing_since, last_success_at y last_failure_at integran las de los proyectos cubiertos (el inicio de fallo más antiguo, el último éxito y el último fallo).

El secreto de firma de un webhook nunca se devuelve aquí. Requiere un administrador de la organización; para cualquier otra persona es not_found.

Crea una notificación de la organización, con los miembros de POST /api/notifications y los proyectos que cubre: project_ids ausente o null cubre todos los proyectos de la organización (los que tiene y los que reciba), una lista cubre exactamente esos, cada uno un proyecto activo de esta organización (invalid_request en caso contrario).

Los destinatarios de una notificación por correo electrónico son owner (el propietario de cada proyecto cubierto), o user_ids de personas de la organización (sus administradores y miembros de la organización) o de miembros de un proyecto cubierto; cada proyecto sigue enviando correo solo a las personas que son miembros de él.

Una organización tiene como máximo 50 notificaciones, sin contar las predeterminadas que crea el sistema (notification_limit_reached). Las mismas funciones del plan restringen los canales, reglas y condiciones que en las rutas de proyecto, evaluadas según el plan de la organización. Cada proyecto cubierto recibe notification.created, y el cambio queda registrado en el registro de auditoría de la organización.

El secreto de firma de un webhook se devuelve solo en esta respuesta y en rotate-secret; un único secreto firma las entregas de todos los proyectos cubiertos. Un reintento exacto con la misma Idempotency-Key devuelve esta misma respuesta, secreto incluido, durante veinticuatro horas.

Una notificación de la organización, tal como la muestra GET /api/organizations/{org_id}/notifications.

Cambia los mismos miembros que PATCH /api/notifications/{id}, en la notificación y en cada proyecto cubierto, y project_ids: ausente deja los proyectos, null cubre todos los proyectos, una lista cubre exactamente esos. Un proyecto que gana la notificación empieza desde su evento actual (no se envía nada anterior); a uno que la pierde se le elimina la notificación.

Cada proyecto cubierto recibe notification.updated, y el cambio queda registrado en el registro de auditoría de la organización.

Un cambio que hace que la notificación cubra un proyecto que hoy no cubre se somete a la misma verificación que la creación de la notificación tal como quedará (su canal, reglas y condiciones de pantalla, según el plan de la organización); cubrir menos proyectos nunca se verifica, y pasar de una lista a todos los proyectos siempre cubre más. If-Match protege la revisión.

Elimina la notificación de todos los proyectos que cubre, con notification.deleted en cada uno, y la registra en el registro de auditoría de la organización. Los avisos pendientes se marcan como fallidos con webhook_deleted.

Solo notificaciones de webhook (cualquier otro canal es invalid_request). Reemplaza el secreto de firma en todos los proyectos cubiertos a la vez, de modo que un receptor sigue verificando un solo secreto, y devuelve la notificación con el nuevo en secret.

Como en POST /api/notifications/{id}/rotate-secret, como máximo un intento por proyecto que ya está en vuelo todavía puede llegar firmado con el secreto anterior. Un reintento exacto con la misma Idempotency-Key devuelve el mismo secreto nuevo durante veinticuatro horas.

Envía un notification.test a través del primer proyecto que cubre la notificación (por id de proyecto), igual que POST /api/notifications/{id}/test lo envía a través de su proyecto: una entrega, cuyo resultado muestra la lista de entregas, intentada una sola vez.

Todos los proyectos cubiertos tienen el mismo receptor, destino y secreto, así que una prueba basta para comprobar el canal; el correo electrónico de una prueba va a los destinatarios de ese proyecto. Una notificación que no cubre ningún proyecto es invalid_request.

Los registros de entregas de todos los proyectos que cubre la notificación, en una sola lista, con las filas más recientes primero según cuándo se puso en cola cada una. Cada fila nombra su proyecto (project_id), y su id abre GET .../deliveries/{delivery_id}/attempts. Pase next_cursor de vuelta como antes para la página siguiente.

Los intentos de una entrega, de los más recientes a los más antiguos, hasta los 20 más recientes. Una entrega que no es de esta notificación es not_found.

Vuelve a enviar los correos de una notificación por correo electrónico a una persona que los detuvo con el enlace para cancelar la suscripción de su correo, en todos los proyectos que cubre la notificación (el enlace la detiene en todos). Idempotente: una persona que no está detenida no cambia nada, y la respuesta es la notificación tal como es.

Un cambio incrementa la revisión y agrega notification.updated con los detalles change resubscribed, user_id y via api a cada proyecto cubierto.

Lista los tipos de informe que construye GET /api/reports/{kind}, con los filtros de cada uno, y los formatos en que se escribe un informe. Requiere la capacidad de informes.

Lista los informes programados del proyecto, del más antiguo al más reciente (como máximo 50), cada uno con su próximo envío y el resultado del último. Requiere la capacidad del proyecto.

Programa el envío de un informe por correo, como adjunto PDF, XLSX o CSV, cada día, semana o mes a una hora en una zona horaria.

Cada envío cubre el periodo anterior, en días UTC: el día anterior, los siete días anteriores o el mes pasado. recipients son miembros del proyecto, indicados por user_id o por la dirección de correo del miembro; cualquier otra persona se rechaza, así que una suscripción nunca sirve para escribir a un extraño, y un miembro que se va deja de recibirla.

Una ejecución fallida se reintenta y aparece con last_status failed y last_error. Como máximo 50 por organización en todos sus proyectos (report_subscription_limit_reached).

Requiere un administrador designado de una organización activa, autenticación por cookie del mismo origen exacto y CSRF de JWT. El actor y la URL de retorno los controla el servidor. La respuesta es privada y no-store. También está abierto a una organización delegada en un revendedor, para su tarjeta y sus facturas pasadas.

Requiere un administrador designado de una organización activa, autenticación por cookie del mismo origen exacto y CSRF de JWT. El actor lo controla el servidor. Deshabilitar conserva los importes guardados y el gasto mensual; los campos de importe se ignoran cuando se deshabilita. La respuesta es privada y no-store. Cambiar la configuración levanta una pausa recuperable solo después de que se anule de forma segura cualquier factura por pagar fallida.

Activarlo para una organización delegada en un revendedor responde 409 billed_by_reseller; desactivarlo sigue disponible.

Vistas de pagos de una organización activa. Requiere la cookie de su administrador designado; la visibilidad del personal por sí sola no concede acceso a compras. Los pagos sin configurar devuelven available false. El regreso del navegador nunca concede créditos.

Iniciar una compra prepagada para el administrador designado de una organización activa. Requiere autenticación mediante cookie del mismo origen y, para las sesiones JWT, un encabezado CSRF coincidente. El servidor controla la organización, el cliente, el actor y las URL de retorno. Los créditos se aplican solo cuando el servicio de facturación confirma el pago. Ante respuestas ambiguas, reintentar con la misma Idempotency-Key y el mismo importe.

Una organización delegada en un revendedor responde 409 billed_by_reseller.

La billetera de la organización. Requiere un administrador designado de la organización, un administrador del revendedor en el que está delegada la organización o una sesión de personal. No otorga membresía de proyecto.

Entradas de diario atribuidas a esta organización en el momento del cargo, con identidades de proyecto y pagador. Los movimientos no transfieren acceso histórico. Las entradas anteriores al contexto registrado de la organización permanecen en sus estados de cuenta del proyecto. Las leen las mismas personas que el saldo (getOrganizationBillingBalance).

El fondo de uso de la organización y la participación de cada proyecto durante un mes UTC. Cubre el uso pagado por esta organización; los demás costos del pagador están en el estado de cuenta de la organización. Las leen las mismas personas que el saldo (getOrganizationBillingBalance).

Organizaciones visibles, incluidas las organizaciones vacías para sus administradores. Los nombres no son únicos.

Los administradores designados y agentes cuyo responsable verificado es un administrador pueden renombrar una organización. No se concede permiso ni membresía de proyecto.

Activa o desactiva Requerir revisión para cambios de agente. Mientras está activado, cada agente y cliente de servicio en el proyecto tiene acceso Proponer en cada solicitud, sin importar sus credenciales. Solo el propietario del proyecto o un administrador de la organización del proyecto pueden cambiarlo (prohibido para otros); las sesiones de sombra del personal no pueden modificarlo.

If-Match lleva review_policy_revision (0 permitido) y es obligatorio; un valor obsoleto es revision_conflict. Desactivarlo requiere prueba, la prueba de passkey fresca o password que usa la aprobación de conexión del agente; activarlo no. Las revisiones abiertas permanecen decidibles de cualquier modo. Añade project.review_policy_changed.

Devuelve detalles actuales de confirmación, bloqueadores de eliminación y dispositivos archivados que serán desconectados. allowed es falso, con una razón, cuando el llamante no puede eliminar el proyecto (solo su propietario o un administrador de su organización puede; para un agente, su persona responsable) o queda un bloqueador.

El propietario transfiere la propiedad a un miembro existente y verificado del proyecto; esto no concede ninguna membresía nueva. La membresía del nuevo propietario deja cualquier screen_scope y upload_scope, así que el nuevo propietario accede a todo el proyecto.

El movimiento autorizado por el propietario transfiere la ocupación de la pantalla y el nuevo uso al pagador destino atómicamente; los cargos históricos mantienen su pagador.

Lista destinos que el propietario administra o cuyo dominio verificado coincide con su correo electrónico verificado.

Lista registros del ciclo de vida de invitaciones para el proyecto actual, excluyendo restablecimientos de inicio de sesión. Las direcciones de destinatarios son visibles para el proyecto propietario, que las suministró. Nunca se listan tokens ni URLs de credenciales.

Crea invitaciones para miembros o compradores de anuncios. La entrega por correo electrónico nunca devuelve una credencial. La entrega por enlace es solo para miembros y devuelve una URL, incluso en reintentos idempotentes exactos dentro de 24 horas. Las invitaciones por correo electrónico expiran tras siete días; los enlaces expiran tras 24 horas. Las invitaciones por correo electrónico pendientes del mismo tipo, dirección y proyecto se reutilizan.

Un miembro limitado a pantallas no invita a personas (outside_screen_scope).

Una invitación por correo electrónico project_member a una persona que sería un invitado externo de la organización del proyecto (no es su organización principal) está sujeta a la política de invitados de esa organización, y responde guest_not_allowed (403) cuando la política (allow, domains o none) no admite la dirección. Aceptar la invitación lo comprueba de nuevo.

El personal y los propios administradores de la organización están exentos. Un screen_scope en la invitación corresponde al alcance de pantallas, que incluye el plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402).

El proyecto que llama. No debita el medidor API de 1 crédito, por lo que un proyecto con saldo cero aún puede leer el saldo restante y recuperarse. Después de un principal de proyecto exitoso, las respuestas JSON autenticadas /api y de problemas incluyen ScreenRig-Credits-Remaining, ScreenRig-Credits-Reset y ScreenRig-Credits-Included como créditos enteros.

SSE, runtime, contenido y respuestas no autenticadas los omiten.

Renombra el proyecto actual. Los nombres contienen de 1 a 60 caracteres imprimibles y no texto con apariencia de URL.

Solo el propietario del proyecto o un administrador de su organización puede eliminarlo; cualquier otro llamante es rechazado con forbidden. Una persona también debe ser miembro del proyecto.

Un agente necesita la capacidad de proyecto de membresía objetivo y elimina para su persona responsable, que debe ser el propietario o un administrador de la organización; un agente sin persona responsable no puede eliminar, excepto el agente que inscribió el proyecto mientras nadie ha aceptado su inscripción.

También requiere el nombre y la revisión actuales, cero pantallas no archivadas, sin crédito, reservas ni deuda en su propia billetera y sin publicidad en vivo. Un saldo negativo acumulado bajo términos gratuitos o de lanzamiento no bloquea; la eliminación lo cancela con una entrada de libro mayor project_delete_writeoff. Encola avisos para miembros y usa la lápida irreversible.

Lista aplicaciones, las más nuevas primero, máximo 500 por página. Los nombres son etiquetas y no necesitan ser únicos; diríjase a una aplicación por ID. next_cursor es la posición de la última fila devuelta mientras queden más filas; páselo como after, con los mismos filtros, para la siguiente página. next_cursor es nulo en la última página.

Transmite un tar.gz producido por CLI directamente a un almacenamiento duradero limitado. Los metadatos se llevan en los encabezados para que el archivo nunca se codifique en base64 ni se materialice como JSON por el servidor.

El proxy frente a la API termina una solicitud que no ha respondido en unos 100 s, por lo que un archivo grande en una subida lenta falla aquí; POST /api/applications/uploads envía el archivo directamente al almacén de objetos.

Declara una carga directa de un tar.gz producido por la CLI que crea una nueva aplicación. La respuesta es una autorización firmada para exactamente un PUT de objeto del archivo, por lo que los bytes van directamente al almacén de objetos y nunca pasan por la API, cuyo proxy termina una solicitud que no ha respondido en unos 100 s.

Envíe el archivo con PUT a upload_url, luego confirme con POST /api/applications/uploads/{id}/commit y espere la operación. La aplicación, su versión y la operación receptora existen desde esta respuesta, como después de POST /api/applications. Una carga no confirmada en 24 horas falla, y una aplicación que nunca publicó una versión se elimina.

La misma Idempotency-Key y el mismo cuerpo devuelven la misma carga con una URL recién firmada. GET /api/capabilities establece features.application_direct_uploads donde se sirven estas rutas.

Lista de listas de reproducción versionadas que puede exponer páginas de espacios publicitarios. La lista v1 rechaza una página que contiene un documento con anuncios con version_required en lugar de filtrarla.

Páginas como listPlaylists, las más nuevas primero, máximo 200 por página y menos una vez que una página contiene 8 MiB de listas de reproducción almacenadas. next_cursor es la posición de la última fila devuelta mientras quedan más filas; páselo como after, con los mismos filtros, para la siguiente página. next_cursor es null en la última página. library=true enumera en su lugar las listas de reproducción de la Biblioteca de la organización (solo lectura; prográmelas o cree otras a partir de sus plantillas).

Entrada de creación para la unión de páginas de espacio publicitario. Como máximo 16 páginas de espacio publicitario, al menos una página ordinaria sin visibilidad, y la reutilización de una definición de espacio en diferentes páginas siguen siendo verificaciones del servidor. La resolución de referencias y DNS siguen siendo verificaciones del servidor.

Una escritura que contiene una página iframe que el Player web no puede encuadrar se guarda de todos modos; la respuesta incluye advertencias (PlaylistWarning) y el registro del proyecto recibe un evento playlist.iframe_framing_refused por cada página.

Una escritura cuyo src de iframe, fallback_src o params de aplicación leen un token de pantalla ({screen.field.NAME} y los demás de los esquemas de primitivas) que le falta a una pantalla que muestra la lista de reproducción también responde con una advertencia screen_fact_missing que nombra las primeras 20 pantallas de ese tipo; los manifiestos de esas pantallas omiten esa primitiva.

Un src o fallback_src de iframe que sea un enlace de Google Slides, Docs o Sheets (compartir, Publicar en la web o insertar) o un enlace Embed de Microsoft 365 OneDrive o SharePoint se almacena reconstruido para la pantalla: Slides se repite y avanza según el delayms del enlace, limitado a la duración de la página, y Docs, Sheets, Word y Excel se recargan cada 5 minutos.

Un código de inserción <iframe> pegado en src o fallback_src se lee por su src. Un archivo que pide a los espectadores que inicien sesión se rechaza con document_not_shared (400), cuyo errors[0].field es ese src o fallback_src y cuyo detalle nombra el ajuste de uso compartido que hay que cambiar.

La lista predeterminada devuelve pantallas pairing_pending y activas. Pase state=archived para listar solo pantallas archivadas. Pase tag para listar solo pantallas cuyos tags contengan exactamente esa etiqueta; las pantallas sin etiqueta se omiten cuando el filtro está presente.

Pase field, una vez por campo, como NAME:VALUE para listar solo las pantallas cuyos campos contienen todos los valores, y near como LAT,LON,KM para listar solo las pantallas ubicadas a KM kilómetros o menos del punto; se omiten las pantallas sin ubicación, y todos los filtros se combinan con state y tag.

Pase folder como un ID de carpeta de pantallas para listar solo las pantallas directamente dentro de ella (no las de sus subcarpetas), o root para las pantallas fuera de toda carpeta.

Las pantallas van de la más reciente a la más antigua, como máximo 500 por página. next_cursor es la posición de la última fila devuelta mientras quedan más filas; páselo de vuelta como after, con los mismos filtros, para la página siguiente. next_cursor es null en la última página. Un llamador limitado a pantallas (docs/screen-scope.md) lista solo las pantallas de su alcance.

Una solicitud que no nombra ningún proyecto omite cada proyecto donde el llamador está limitado a pantallas; nombre el proyecto para listarlo.

Lista todas las carpetas de pantallas del proyecto, como máximo 1000, ordenadas por nombre.

Las carpetas organizan las pantallas y las seleccionan: una hoja de audiencia de campaña {"folder": ID} coincide con las pantallas de esa carpeta y de cada carpeta que contiene, un selector de acción de flota by:folder actúa sobre las mismas pantallas, y el default_playlist_id de una carpeta es lo que muestran sus pantallas que no tienen una lista de reproducción propia. parent_id es null en la raíz del proyecto; construya el árbol a partir de parent_id. screens cuenta las pantallas en vivo directamente dentro de cada carpeta.

La carpeta de una pantalla es Screen.folder_id. Un llamador limitado a pantallas (docs/screen-scope.md) lista las carpetas dentro de su alcance y las carpetas que están encima, que son de solo lectura para que su árbol tenga raíz; las carpetas de arriba no llevan recuento de pantallas y las carpetas hermanas se ocultan. Una solicitud que no nombra ningún proyecto omite cada proyecto donde el llamador está limitado a pantallas.

Crea una carpeta de pantallas en la raíz del proyecto (parent_id nulo o ausente) o dentro de parent_id. Los nombres se recortan, tienen de 1 a 100 caracteres Unicode sin controles, no son "." ni ".." y son únicos entre las carpetas del mismo nivel (resource_conflict).

Una organización tiene como máximo 1000 carpetas en todos sus proyectos (quota_exceeded) anidadas a lo sumo 10 niveles (invalid_request). default_playlist_id, cuando se establece, debe nombrar una lista de reproducción aprobada (playlist_not_approved). Emite screen.folder_created.

Un llamador limitado a pantallas (docs/screen-scope.md) crea una carpeta solo dentro de una carpeta de su alcance; la raíz del proyecto o cualquier otro padre es outside_screen_scope. Crear una carpeta dentro de una carpeta protegida es una revisión protected_change (202 pending_review) decidida por un segundo aprobador.

Mueve pantallas (screen_ids) y carpetas (folder_ids) a una carpeta (folder_id), o a la raíz del proyecto cuando folder_id es null, en una sola solicitud de todo o nada de como máximo 1000 ids. Todos los ids deben existir (not_found). Una carpeta no puede moverse dentro de sí misma ni dentro de una carpeta contenida en ella, y el movimiento debe mantener todas las carpetas dentro de 10 niveles (invalid_request).

Los elementos que ya están en el destino se dejan tal cual; cada pantalla y carpeta movidas avanza su revisión. Las pantallas movidas vuelven a resolver su lista de reproducción en unos 15 segundos: levels nombra las campañas cuya audiencia de carpeta entran o dejan y las listas de reproducción predeterminadas de carpeta que ganan o pierden. Emite screen.moved.

Un llamador limitado a pantallas (docs/screen-scope.md) mueve pantallas y carpetas dentro de su alcance a una carpeta de su alcance; cualquier id o destino fuera de él, y la raíz del proyecto, rechazan todo el movimiento (outside_screen_scope), también cuando una pantalla sale del alcance entre la comprobación y la escritura.

Un movimiento hacia dentro o fuera de una carpeta protegida es una revisión protected_change decidida por un segundo aprobador (202 pending_review).

Responde qué reproducen las pantallas de un sujeto durante [from, to) y por qué, para el calendario de Horario del panel: exactamente uno de screen_id, folder_id (las pantallas de la carpeta y de cada carpeta dentro de ella), tag o campaign_id (las pantallas de su audiencia).

Las pantallas cuyas pilas tienen entradas idénticas (los mismos niveles, predeterminado, zona horaria y número de pantallas) comparten un grupo con una línea de tiempo, de modo que un sujeto grande cuesta decenas de líneas de tiempo; un grupo lista hasta 500 de sus pantallas y una respuesta, como máximo 200 grupos (truncated).

Cada grupo lleva su pila, de mayor a menor (takeover, las campañas que alcanzan las pantallas, sus propias entradas de horario, luego la lista de reproducción predeterminada o la de la carpeta más cercana), los tramos de cada nivel (se reproduce en cada pantalla a la que apunta, parcial con las pantallas en las que se reproduce, superado, o condicional mientras espera una interacción o una condición de datos que solo un Player observa), lo que muestra cada pantalla (on_screen; la región principal de una página completa) y conflictos (dos campañas de una misma prioridad vigentes a la vez; un nivel que rige pero nunca se reproduce). from y to son instantes RFC 3339, con to posterior a from y como máximo 93 días de diferencia; se truncan al minuto.

Las reglas se leen en la zona horaria de cada grupo, igual que las leen el barrido y cada Player; todo nivel se juzga reproducible. Un llamador limitado a pantallas (docs/screen-scope.md) debe enviar un screen_id o un folder_id dentro de su alcance; una etiqueta, un campaign_id o ningún asunto es outside_screen_scope.

Responde con una hoja con las columnas que lee una importación de programación y tres filas de ejemplo (un código de pantalla, una carpeta de pantallas y una etiqueta), como CSV o, con format=xlsx, un libro XLSX.

Lee una hoja de filas de programación contra el proyecto y responde qué haría confirmarla, sin escribir nada.

Cada fila indica un destino (una pantalla por id, por el valor de un campo de pantalla como un código de sala, o por nombre; folder:NAME; tag:NAME; varios separados por ; o |), el contenido (un nombre de archivo multimedia, o playlist:NAME o un id de lista de reproducción), un inicio y un fin (una fecha sola como fin cierra ese día) y, opcionalmente, timezone, days (Mon-Fri), una ventana diaria (daily_start, daily_end), priority de 0 a 100, un nombre y números de pantalla.

Las horas se leen en el reloj propio de cada pantalla; una columna timezone las convierte desde otra zona.

Cada fila se verifica e informa sus errores por columna: pantalla, carpeta o etiqueta desconocida o ambigua, archivo faltante o ambiguo, un archivo que no puede llenar una pantalla, horas inválidas o invertidas, un fin en el pasado, ninguna indicación de tiempo, una pantalla sin zona horaria o sin lista de reproducción predeterminada, dos filas vigentes a la vez en una pantalla con la misma prioridad, y más niveles de los que admite una pantalla (32), o más campañas de las que admite su organización en todos sus proyectos (100; cada nivel compartido cuenta como una).

Las filas que coinciden en contenido, horas, prioridad y nombre forman un nivel: una pantalla es una entrada de la programación propia de esa pantalla; varias pantallas, una carpeta o una etiqueta son un nivel compartido (una campaña), que prevalece sobre los niveles propios de una pantalla.

La respuesta lista los niveles con lo que hace una confirmación a cada uno (create, update, unchanged), los niveles que una ejecución anterior de la misma importación creó y que la hoja ya no tiene (removals), las pilas de las pantallas tal como quedarían (calendar) y una huella para enviar a la confirmación. La hoja son filas JSON, CSV o XLSX, de como máximo 5,000 filas.

No disponible para un llamador limitado a pantallas (outside_screen_scope). La importación de programación forma parte del plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402). La plantilla está abierta en todos los planes.

Confirma una importación con vista previa: la misma hoja y la huella que respondió su vista previa. Cada nivel se crea, se actualiza o se elimina, las programaciones de las pantallas y los niveles compartidos se escriben en una sola transacción, y se añade el evento de importación schedule.imported: todas las filas se aplican o ninguna.

Primero se crean las listas de reproducción de un solo archivo que necesitan los archivos de la hoja (no cambian nada en ninguna pantalla). Una hoja cuyas filas tienen errores se rechaza (schedule_import_invalid); un proyecto que cambió desde la vista previa, o filas que se leen de otra forma, se rechaza (schedule_import_stale), y el cliente previsualiza de nuevo.

Importar la misma hoja de nuevo con el mismo nombre no cambia nada; una fila modificada actualiza su nivel y una fila eliminada elimina su nivel. Requiere una persona que pueda aprobar en el dashboard y, para un agente, una credencial con acceso de escritura.

Una confirmación que actualizaría o eliminaría una campaña reservada responde reserved_item (403) y no escribe nada, a menos que la confirme una persona que puede aprobar.

Una confirmación que alcanza una pantalla protegida se rechaza por completo con protected_target, también cuando la importación no tiene niveles pero elimina entradas de importación de una pantalla protegida o elimina una campaña de importación cuya audiencia alcanza una.

En un proyecto con carpetas de pantallas protegidas, una confirmación cuya vista previa falla en un servicio, no en la hoja, responde dependency_unavailable y no escribe nada: envíe la misma solicitud de nuevo tras una breve espera. Un error de validación de hoja, campaña o pantalla responde como lo haría la confirmación (invalid_request y los demás problemas de arriba).

No disponible para un llamador limitado a pantallas. La importación de programación forma parte del plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402). La plantilla está abierta en todos los planes.

Reclama un código de enlace de navegador para el proyecto autenticado y crea atómicamente exactamente una pantalla first pairing_pending más su concesión de aprovisionamiento de navegador existente. La inscripción sigue siendo solo para el proyecto. La respuesta es solo metadatos seguros y nunca contiene un token de aprovisionamiento, URL fragmentada, cookie o prueba.

Reclama una sesión de emparejamiento de Player global para la flota con seis caracteres. Reintentos con la misma Idempotency-Key devuelven el resultado original duradero sin consumir cuota nuevamente.

La sesión del panel lo reclama en su proyecto actual con el mismo cuerpo, Idempotency-Key, presupuestos y problemas, salvo que su not_found para un código desconocido o ya reclamado no nombra ningún comando de la CLI; es un cambio de estado, así que sigue las reglas de mutación del panel, se rechaza una sesión sombra sin modo de escritura del personal, y los eventos que añade la reclamación nombran al usuario del panel. folder_id nombra la carpeta en la que queda la pantalla.

Un llamador limitado a pantallas (docs/screen-scope.md) debe enviar una carpeta dentro de su alcance y empareja solo como persona que puede aprobar (outside_screen_scope, approver_required).

Aprovisionamiento opcional de una pantalla nueva, solo en navegador. Siempre crea una pantalla nueva en pairing_pending; como máximo cinco esperan a vincularse a la vez (quota_exceeded). Los reintentos exactos vuelven a entregar el mismo token de fragmento durante diez minutos. El emparejamiento de seis caracteres sigue siendo el flujo predeterminado y el único de recuperación. folder_id nombra la carpeta en la que queda la pantalla.

Un llamador limitado a pantallas (docs/screen-scope.md) debe enviar una carpeta dentro de su alcance (de lo contrario outside_screen_scope).

Aplica una acción a una flota seleccionada sin límite de conteo de pantallas. Seleccione screen_ids únicos o una etiqueta que coincida con pantallas activas en orden de creación. La selección resuelta se fija antes de cualquier mutación, se almacena en fragmentos limitados y se mantiene durante veinticuatro horas bajo Idempotency-Key.

Cada paso utiliza su ruta de mutación de pantalla única, preservando revisiones, eventos, señales de tiempo de ejecución y límites por pantalla. Una respuesta contiene una página limitada de resultados; coincidentes, exitosos y fallidos describen esa página. HTTP 202 incluye total, offset y next_cursor. Continúe con el mismo selector, acción y Idempotency-Key, pasando next_cursor como after.

Respete Retry-After cuando esté presente, incluso una página con cero resultados. La respuesta refleja Idempotency-Key, incluyendo una clave generada cuando el llamante la omitió; conserve esta clave para continuaciones. HTTP 200 finaliza la selección. Las páginas respondidas se reproducen exactamente, incluyendo fallos por pantalla; los pasos interrumpidos se reproducen sin repetir sus efectos.

Las acciones grandes se regulan según los presupuestos existentes de 600 por minuto por organización para recarga, toast, toma de control, programación de listas de reproducción, reinicio, pantalla y programación de pantalla; el agotamiento del presupuesto de la organización pausa la acción en lugar de rechazar la flota. El agotamiento por pantalla falla solo esa pantalla.

Un paso assign, takeover o set_playlist_schedule que vincula una lista de reproducción con formato a una pantalla cuyo muro tiene otra forma falla solo para esa pantalla con 409 playlist_format_mismatch. Las asignaciones y los cambios de etiquetas no tienen presupuesto de mensajes.

Una asignación cuya lista de reproducción tiene un src de iframe o parámetros de aplicación que leen un token de pantalla que le falta a alguna pantalla de la página añade una advertencia screen_fact_missing a esa página (warnings, PlaylistWarning). El fallo parcial es un resultado normal. Todas las páginas y reintentos bajo una misma clave son una sola acción medida.

Las solicitudes usan una carga útil de bytes acotada; use una etiqueta para una selección mayor que la carga útil del transporte. Un selector o una acción mal formados se rechazan antes de tocar ninguna pantalla. El selector o la acción se rechazan antes de tocar ninguna pantalla.

Un llamador limitado a pantallas (docs/screen-scope.md) selecciona por screen_ids o por carpeta, cada pantalla dentro de su alcance; un selector de etiqueta, una pantalla fuera del alcance o una desconocida rechaza toda la acción (outside_screen_scope) antes de que se fije o se proponga nada.

Assign, takeover, takeover_clear, set_playlist_schedule y clear_playlist_schedule que alcanzan una pantalla protegida se convierte en una revisión que decide un segundo aprobador (202 pending_review) en todos los niveles de acceso; set_tags, add_tags y remove_tags en una pantalla protegida son protected_target (409).

Una acción set_playlist_schedule con una entrada pausada (un borrador) corresponde al control de cambios de la programación, que incluye el plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402).

Muestra pestañas del navegador en pantallas del proyecto indicado; solicitud, respuesta, acceso y límites son los de POST /api/tab-shares.

Lista las campañas del proyecto en orden de precedencia (como máximo 100), el orden en que las lee la resolución. reserved está presente en cada campaña.

Un llamador limitado a pantallas (docs/screen-scope.md) ve todas las campañas, con editable true solo cuando toda la audiencia está dentro de su alcance (una hoja de etiqueta y la regla raíz de todas las pantallas nunca lo están; una regla all necesita un hijo contenido, una regla any todos los hijos) y el llamador puede cambiar lo que se reproduce.

createCampaign para el proyecto nombrado en la ruta. reserved true reserva la campaña, y solo lo define una persona que puede aprobar (reserved_item para un agente, un cliente de servicio o cualquier otro), añadiendo campaign.reserved_changed.

Un llamador limitado a pantallas (docs/screen-scope.md) crea una campaña solo para una audiencia dentro de su alcance (hojas folder y screen_id; ni tag ni la regla de todas las pantallas), de lo contrario outside_screen_scope, y solo como persona que puede aprobar (approver_required).

Una campaña cuya audiencia alcanza una pantalla protegida es una revisión protected_change decidida por un segundo aprobador (202 pending_review) en todos los niveles de acceso. reserved true corresponde a las carpetas protegidas y paused true en una campaña nueva (un borrador) corresponde al control de cambios de la programación, y ambos forman parte del plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402).

Lista las conexiones del proyecto, las más recientes primero, como máximo 200 por página; devuelva next_cursor como after para la siguiente. Un secreto, una clave o un token de actualización nunca se devuelve: secret indica si hay uno guardado y una pista que no es secreta. Una lectura nunca incluye un enlace de consentimiento.

Crea en este proyecto una conexión con Microsoft o Google: modo own_app con las credenciales propias del cliente, o modo screenrig_app, que responde consent_url, un enlace de un solo uso para la persona que lo completa (vea createConnection). Añade connection.created. Un reintento exacto con la misma Idempotency-Key devuelve la misma conexión.

Lista las conexiones BI del proyecto, de la más antigua a la más reciente, 200 por página; devuelva next_cursor como cursor para la siguiente. Un secreto nunca se devuelve: secret indica si está definido y sus últimos 4 caracteres.

Agrega una conexión a un sistema BI del que el proyecto es propietario. Para Grafana: su dirección (http o https en un host público, con un prefijo de ruta opcional) y un token de cuenta de servicio con el rol Viewer. El token se sella y nunca se devuelve.

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 administrador de Power BI debe activar los ajustes de desarrollador Embed content in apps y Service principals can call Fabric public APIs para la aplicación (portal de administración, configuración del inquilino), la aplicación debe ser Miembro o Administrador de cada área de trabajo que muestre, y los informes necesitan una capacidad Embedded, Fabric o Premium en producción.

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.

Añada embed_origin de la respuesta a la lista de dominios permitidos de la aplicación conectada y habilite el secreto. Cualquiera que tenga un ticket de pantalla puede incrustar cualquier vista que ese usuario pueda ver, así que use un usuario que solo vea los paneles de las pantallas. Tableau Cloud, o Tableau Server 2023.3 o posterior.

Para una página web con inicio de sesión (kind web): la cuenta de servicio de un sitio que muestra su panel tras un inicio de sesión. config.login_mode es auto (config.login_url, config.username y la contraseña como secret: el renderizador abre la página de inicio de sesión y rellena el formulario), steps (config.login_url y config.steps, un script de pasos goto, fill, click, press, wait_for y wait_ms cuyos valores pueden contener {{username}}, {{password}} y {{otp}}) o none (sin inicio de sesión: la conexión muestra páginas con las cookies que usted le da). totp_secret es la clave base32, o la dirección otpauth://, de la aplicación de autenticación de la cuenta: el servidor calcula el código de un solo uso (RFC 6238) y envía al renderizador solo el código. cookies es un conjunto de cookies exportado de un navegador con la sesión iniciada, para un sitio cuyo inicio de sesión no se puede automatizar (inicio de sesión único que se aprueba en un teléfono, una comprobación de dispositivo); el servidor guarda el conjunto y lo renueva con las cookies que devuelve cada captura, así que un inicio de sesión es raro.

La contraseña, la semilla y las cookies se sellan y nunca se devuelven. Use una cuenta de servicio de solo lectura. La contraseña se escribe solo en config.login_url y en los pasos goto, así que moverlos a otro origen exige secret de nuevo. Tras cinco inicios de sesión rechazados seguidos, la conexión deja de iniciar sesión hasta que cambian sus credenciales.

Un servidor sin renderizador de páginas responde bi_web_unavailable. Añade bi_connection.created. Un reintento exacto con la misma Idempotency-Key devuelve esta misma respuesta.

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.

Agrega una vista de un panel de Grafana de la conexión o de uno solo de sus paneles (url: una dirección /d/{uid}/... en el host de la conexión, o target), o de un enlace de panel público de Grafana (kind grafana y target.public_url, sin conexión).

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 página de inserción solo muestra un ticket que lleva el manifiesto de la pantalla, así que una vista solo se reproduce en las pantallas de su propio proyecto.

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 visualización de Tableau Public es una vista sin conexión (kind tableau, target.public_url, reconstruida como https://public.tableau.com/views/WORKBOOK/VIEW) y también acepta rotate_sheets. Para una página web (kind web): una página del sitio de la conexión web (url: una dirección https en un host público, sin target).

El navegador en el borde la abre con la sesión iniciada, espera el elemento wait_for si está definido y wait_ms milisegundos (hasta 10000), y dibuja clip, un selector CSS, si está definido, o si no la página entera.

La imagen se redibuja cada refresh_s (60 a 86400, 300 por defecto) y la comparten todas las pantallas del mismo tamaño, y solo mientras una pantalla muestra la vista; cuando falla una captura, la última imagen sigue en pantalla. Defina wait_for con un elemento que solo exista cuando la página tiene la sesión iniciada, para que nunca se muestre una página de inicio de sesión. Añade bi_view.created.

Enumera los disparadores de alerta CAP del proyecto, del más antiguo al más reciente (máximo 20), cada uno con su URL de ingestión, nombre de usuario y última alerta. La contraseña nunca se devuelve aquí.

Crea un disparador de alerta CAP: una URL entrante a la que un sistema de notificaciones de emergencia (Everbridge, Rave, Alertus, relés IPAWS y otros emisores CAP 1.2) envía alertas, con credenciales HTTP Basic.

La respuesta es el único lugar donde aparece la contraseña (con la respuesta de rotación): guárdela en el sistema de envío de inmediato. target es una etiqueta (todas las pantallas activas con ella cuando llega la alerta) o hasta 500 screen_ids.

Una alerta toma todas las pantallas objetivo con una lista de reproducción predeterminada hasta que la alerta <expires>, o para default_for_seconds (60 a 604800, por defecto 3600); vea POST /api/triggers/{id}/cap. Una organización tiene como máximo 20 disparadores en todos sus proyectos (trigger_limit_reached). Añade trigger.created.

Un reintento exacto con la misma Idempotency-Key devuelve esta misma respuesta, contraseña incluida, durante veinticuatro horas. Un activador cuyo selector alcanza una pantalla protegida es protected_target (409), y una lectura fallida de la protección de pantallas es dependency_unavailable (500, repita la misma solicitud); un activador no está disponible para un llamador limitado a pantallas.

Lista eventos duraderos del proyecto en orden ascendente por secuencia.

La paginación es contigua: pase el next_cursor devuelto como after para continuar exactamente donde la página se detuvo. next_cursor es el cursor del último evento devuelto mientras ya existen eventos más nuevos, y null al final del historial. limit por defecto es 50 y acepta 1-200; un valor fuera de ese rango se rechaza con invalid_request y un miembro errors[] nombrando limit.

No se admite paginación por desplazamiento. source=log lista el registro del Player en su lugar: los informes de condición que envían los Players (runtime.reported) en orden ascendente por hora de recepción, filtrados por screen_id y severidad en una ventana desde hasta (por defecto las últimas 24 horas, máximo 31 días).

Sus cursores son opacos: lg1_ o ev1_ según dónde el servidor guarda el registro del Player, así que devuelva el que una página retornó; un cursor del otro tipo se rechaza con invalid_request nombrando el campo. Los registros del Player no tienen secuencia, no están en GET /stream/project y no se entregan a webhooks.

Un registro se reconoce cuando la cola del log del Player lo acepta y se mantiene para la retención de eventos del proyecto. Una consulta con el último cursor y la ventana predeterminada sigue al log. Los registros del log del Player no están en la lista predeterminada (source=project). from y to se rechazan con invalid_request a menos que source sea log.

La lista de proyectos toma screen_id, playlist_id y application_id para leer los eventos de una pantalla, lista de reproducción o aplicación, todos con alcance al proyecto de la credencial (un id indica qué eventos leer, nunca de quién): screen_id mantiene los eventos cuyo recurso es esa pantalla; playlist_id los eventos cuyo recurso es esa lista de reproducción más los eventos que la nombran como details.playlist_id (una pantalla que la toma); application_id los eventos cuyo recurso es esa aplicación más los que llevan esa aplicación como application_id (sus versiones y entradas clave/valor).

Un valor que no es un id de su tipo se rechaza con invalid_request nombrando el campo; playlist_id y application_id se rechazan con source=log, cuyos registros pertenecen solo a una pantalla.

Ambas fuentes toman resource_id, tipo y severidad (como mínimo), combinados entre sí, con los filtros de id y con paginación; un registro de log de Player es un registro runtime.reported cuyo recurso es su pantalla, por lo que un resource_id que no sea esa pantalla o un tipo que excluya runtime.reported responde con una página vacía. Las páginas before (o order=desc) muestran primero las más nuevas: next_cursor es entonces el cursor del ítem más antiguo devuelto y se pasa de nuevo como before para continuar hacia ítems más antiguos.

Sin from, una página newest-first source=log alcanza más allá de las 24 horas predeterminadas hasta el registro más antiguo que la retención de eventos del proyecto conserva, como máximo 31 días por debajo del límite superior de la página por solicitud. Una página newest-first source=log puede contener menos registros que el límite, incluso ninguno, con un next_cursor; null aún la termina, al final del registro retenido.

Un llamador limitado a pantallas (docs/screen-scope.md) lee un feed filtrado: eventos de pantallas dentro de su alcance, de las carpetas de pantallas que puede ver (las suyas, las que están encima y las que están dentro; screen.moved solo cuando el destino está dentro de su alcance), de campañas, listas de reproducción, medios, aplicaciones y tarjetas, y revisiones playlist_change.

Se omite cualquier otro evento, así que una página puede contener menos eventos que limit, incluso ninguno, con un next_cursor; siga paginando con él. source=log necesita un screen_id dentro de su alcance. No se envían los eventos sobre el propio proyecto.

El plan del proyecto que llama, indicadores independientes de anunciante/pantallas con su revisión, el conjunto de capacidades efectivas derivadas, las funciones del plan que tiene (plan_features) y sus límites (limits). Nunca refleja una reclamación del cliente; un plan desconocido falla cerrado como prohibido.

La instantánea del saldo consciente de la fuente del proyecto que llama. Todos los montos en milicréditos son cadenas decimales canónicas. Es una instantánea, no autoridad para pagar; rails_available es falso mientras la tarjeta, impuestos y canal de retiro no estén disponibles.

Paginación estable con cursor sobre entradas de diario inmutables publicadas para el proyecto que llama. Las retenciones no son entradas publicadas. Las correcciones enlazan al evento original en lugar de reescribirlo. No hay mutación arbitraria de concesión o pago en esta superficie.

El uso del proyecto que llama durante un mes UTC, con los bytes servidos y recibidos (nunca se cobran), el almacenamiento cobrado por encima del almacenamiento gratuito del plan del pagador (allowance.storage_bytes), y las solicitudes de API, los eventos de flujo del proyecto facturados y los intentos de entrega de webhook contados frente a los 10,000 gratuitos al mes. Un proyecto que paga por sí mismo lee su propio fondo.

Un proyecto que otro pagador paga comparte el grupo de ese pagador con los otros proyectos del pagador; lee su propia parte, y payer nombra al pagador. El total del grupo del pagador permanece en las lecturas de facturación del pagador.

La red única del vendedor que llama, incluyendo su tarifa resuelta de servicio de ScreenRig. Los vendedores no pueden cambiar esa tarifa.

Crea la única red del vendedor que llama si no existe. Requiere screens=true. Idempotente; repetir devuelve la misma red.

Establece la tarifa predeterminada del proyecto del vendedor por cada 15 segundos de reproducción completada. Un cambio que altera la tarifa efectiva de una campaña aceptada pausa toda esa campaña con price_change_pending; un cambio enmascarado o sin efecto no. If-Match lleva la revisión de la red.

El inventario seleccionado por el vendedor que llama.

Crea un espacio de vendedor reutilizable. Las imágenes duran de 5 a 30 segundos y los videos como máximo el límite de la plataforma de 120 segundos. Los anuncios siempre están silenciados.

Redes a las que pertenece actualmente el anunciante que llama, con el alcance y la política de revisión otorgados. El conteo de pantallas no garantiza impresiones.

Vincula una revisión de contenido multimedia lista y propia a una creativa inmutable. No copia bytes, no vuelve a subir ni recarga generación. Se rechaza contenido multimedia desconocido o no listo.

Crea una campaña en borrador. Los borradores no contienen dinero, no reservan nada y no autorizan entregas. La activación requiere una cotización aceptada explícitamente.

Versiones creativas enviadas al vendedor que llama para revisión. Un vendedor ve solo la creatividad enviada exacta, nunca la biblioteca del comprador.

Gastos y conteos de entrega limitados al comprador para una campaña. Las cantidades son cadenas decimales mcr. Nunca expone ingresos del vendedor, estado bancario o uso del proyecto.

Bruto, tarifa de servicio y neto con alcance del vendedor para una ventana, con su propia evidencia de entrega. Nunca expone la cartera del comprador u otras redes. Solo la evidencia autorizada de reproducción completa establece la entrega facturable. La ventana es como máximo de 92 días; una ventana más amplia es invalid_request.

Cuando contiene más de 5000 liquidaciones, la respuesta establece truncado, totales y recuentos aún cubren todos ellos y filas lista solo los primeros 5000.

Agregados diarios de reproducción.

JSON devuelve a lo sumo 200 filas y no tiene límite de tasa. format=csv (o Accept text/csv sin application/json) transmite cada fila coincidente dentro de day_from a day_to (días UTC inclusivos; por defecto day_to hoy y day_from 30 días antes; máximo 366 días, sino invalid_request) como CSV con una fila fija de encabezado (PlaybackAggregateCsv); solo el formulario CSV consume los presupuestos playback-export-org (30 por minuto) y playback-export-ip (60 por minuto).

Cualquiera de las dos formas es una solicitud API medida. Las respuestas llevan Vary Accept. Un llamador limitado a pantallas (docs/screen-scope.md) debe enviar screen_id y debe ser una pantalla dentro de su alcance (de lo contrario outside_screen_scope); las formas CSV siguen la misma regla.

Registros por reproducción: una fila por cada playback.media_started aceptado (o playback.video_started heredado) y una fila por cada playback.application_started aceptado (release_id establecido, campos de medios vacíos) del proyecto que llama, el más antiguo primero por received_at, empates por inserción. desde (inclusive) y hasta (exclusivo) límite received_at; hasta por defecto ahora, desde hasta 24 horas antes de hasta, y el rango es como máximo 31 días (invalid_request de lo contrario).

Los últimos 5 segundos aún no se devuelven: el to efectivo es como máximo ahora menos 5 segundos (retraso de asentamiento), por lo que una cola en vivo nunca omite una fila que se compromete detrás de su cursor. Filtran screen_id, media_id, playlist_id (la lista de reproducción desde la que se mostró el inicio) y tag (una etiqueta de pantalla que la pantalla tenía cuando se recibió la reproducción).

Una página de playlist_id puede contener menos filas que el límite, incluso ninguna, con un next_cursor cuando se escaneó un largo tramo de reproducciones de otras listas; null aún termina el rango.

JSON es una página de a lo sumo limit filas (por defecto 200, máximo 1000) con next_cursor, null al final del rango; devuélvalo como cursor con los mismos filtros. order=desc (o before) pagina los más nuevos primero dentro del mismo rango: next_cursor es entonces el cursor de la fila más antigua devuelta, null al inicio del rango, y se devuelve como before (exclusivo) con los mismos filtros; order=asc con before se rechaza con invalid_request nombrando order, y cursor con una página newest-first nombrando cursor.

Una página con lo más nuevo primero puede contener menos filas que el límite, incluso ninguna, con un next_cursor; null aún termina la lista.

Una página posterior nunca omite una fila que existía cuando se leyó la página anterior y no repite una, excepto que un inicio que el Player reenvió tras un reporte no reconocido (el mismo play_id, recibido un momento después) puede aparecer de nuevo en una página posterior; el flujo CSV la lista una vez. format=csv (o Aceptar text/csv sin application/json) transmite cada reproducción desde el cursor hasta el final del rango como CSV (PlaybackPlayCsv), más recientes primero abajo antes con order=desc; se rechaza limit con CSV.

La medición es por solicitud: cada página JSON cuesta un crédito de solicitud API, mientras que un flujo CSV de todo el rango cuesta uno. Cada solicitud de reproducciones (página o flujo) consume los presupuestos playback-export-org (30 por minuto) y playback-export-ip (60 por minuto).

Un flujo delimita cada escritura (15 segundos) y termina cuando el cliente se desconecta; si falla después del encabezado 200, la conexión se aborta, por lo que una exportación que lee hasta un final limpio está completa. Las respuestas llevan Vary Accept. Las reproducciones se mantienen por la retención de eventos del plan (30 días es el mínimo entregado; la retención basada en el plan usa la ventana propia de 7 o 90 días del plan).

Un llamador limitado a pantallas (docs/screen-scope.md) debe enviar screen_id y debe ser una pantalla dentro de su alcance (de lo contrario outside_screen_scope); las formas CSV siguen la misma regla.

Totales de reproducción del proyecto que llama durante días UTC inclusivos, leídos de los resúmenes diarios: by=day devuelve una fila por día con reproducciones (screen_id o media_id lo limita a una pantalla o medio), by=screen y by=media clasifican las pantallas o medios más activos (top, máximo 100), y by=screen_day devuelve la serie diaria de las pantallas principales (top máximo 10). day_to por defecto es hoy (UTC) y day_from 29 días antes.

Una serie de días abarca como máximo 366 días (92 cuando se limita a una pantalla o medio); un ranking como máximo 92. Los conteos incluyen cada inicio que el proyecto ha registrado, incluidos los almacenados antes de que existieran los rollups de reproducción.

Los rollups siguen la ingestión hasta aproximadamente 21 minutos. truncated es verdadero cuando un ranking se construyó a partir de fragmentos de una ventana demasiado grande para una lectura: cubre las mejores claves de cada fragmento. No tiene límite de tasa. Una solicitud de API medida.

Un llamador limitado a pantallas (docs/screen-scope.md) debe enviar screen_id y debe ser una pantalla dentro de su alcance (de lo contrario outside_screen_scope); las formas CSV siguen la misma regla.