Publicidad: referencia de la API, endpoints y ejemplos

OpenAPI YAML OpenAPI JSON problemas YAML Resumen de la API

Este grupo tiene 46 operaciones, generadas a partir de api/openapi.yaml. Filtre por ruta, acción o autenticación. Cada endpoint indica sus entradas; despliéguelo para ver una plantilla de solicitud y los códigos de respuesta. Las plantillas necesitan sus propios valores y un cuerpo válido según el esquema.

Reemplace los marcadores en mayúsculas con sus valores. Para una solicitud JSON, guarde un cuerpo que coincida con el esquema en request.json. Los ejemplos de cookies usan un frasco de cookies local de una sesión autenticada.

Redes y campañas publicitarias privadas

GET/api/advertising/network¶

Obtener red publicitaria

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

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingNetwork

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/network'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Red.	AdvertisingNetwork (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/network¶

Crear red publicitaria

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

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingNetworkCreate
ID de operación: createAdvertisingNetwork

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Campos del cuerpo de la solicitud

Campo	Descripción
nombre (requerido, cadena)	maxLength: 120

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/network'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Red.	AdvertisingNetwork (application/json)
403	prohibido: el proyecto carece de capacidad para pantalla o tiene un plan desconocido.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/network/rate¶

Establecer tarifa predeterminada de publicidad

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.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingRate
ID de operación: setAdvertisingDefaultRate

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Campos del cuerpo de la solicitud

Campo	Descripción
rate_mcr_per_15s (requerido, McrString)	Cantidad exacta de milicréditos enteros como cadena decimal canónica. 1 crédito es 1000 mcr. pattern: "^-?[0-9]+$"

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/network/rate'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Red actualizada.	AdvertisingNetwork (application/json)
412	revision_conflict: If-Match está obsoleto.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/inventory¶

Listar inventario publicitario

El inventario seleccionado por el vendedor que llama.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingInventory

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/inventory'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Inventario.	AdvertisingInventoryList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

PUT/api/advertising/inventory/{screen_id}¶

Poner inventario publicitario

Crea o actualiza el inventario de una pantalla propia. Verifica la propiedad de la pantalla. Una anulación de tarifa con null restaura la herencia, no cero. Un cambio que altera la tarifa efectiva de una campaña aceptada pausa esa campaña. Una pantalla de una carpeta de pantallas protegida es protected_target (409).

Autenticación: projectBearer
Cuerpo de la solicitud: AdvertisingInventoryWrite
ID de operación: putAdvertisingInventory

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
screen_id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

Campo	Descripción
impressions_per_hour (opcional, en línea)	La estimación del vendedor de las impresiones que esta pantalla ofrece en una hora. Cada reproducción completada cuenta este valor multiplicado por sus segundos y dividido entre 3600 como impresiones estimadas en los informes. Null o ausente significa sin estimación.
ads_enabled (requerido, booleano)
site_name (opcional, cadena)	maxLength: 120
ciudad (opcional, cadena)	maxLength: 120
región (opcional, cadena)	maxLength: 120
venue_type (opcional, cadena)	maxLength: 64
audience_tags (opcional, arreglo)
ubicación (opcional, cadena)	maxLength: 120
public_description (opcional, cadena)	maxLength: 500
rate_override_mcr_per_15s (opcional, en línea)	Null restaura la herencia del valor predeterminado del proyecto; nunca significa cero.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/inventory/SCREEN_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Inventario almacenado.	AdvertisingInventory (application/json)
403	forbidden - la pantalla no pertenece a este proyecto; outside_screen_scope o approver_required para un llamador limitado a pantallas.	Problema (application/problem+json)
409	protected_target - la pantalla está en una carpeta de pantallas protegida y el cambio no tiene una vía de revisión (docs/screen-scope.md); quite la protección de la carpeta mediante una revisión, haga el cambio y proteja la carpeta de nuevo.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/slots¶

Listar espacios publicitarios

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingSlots

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/slots'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Ranuras.	AdvertisingSlotList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/slots¶

Crear espacio publicitario

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.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingSlotWrite
ID de operación: createAdvertisingSlot

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Campos del cuerpo de la solicitud

Campo	Descripción
nombre (requerido, cadena)	minLength: 1 maxLength: 120
habilitado (opcional, booleano)
accepted_media (requerido, arreglo)
max_image_duration_ms (requerido, entero)	mínimo: 5000 máximo: 30000
max_video_duration_ms (requerido, entero)	mínimo: 1000 máximo: 120000
rate_override_mcr_per_15s (opcional, en línea)
vast_tag_url (opcional, en línea)	La propia etiqueta de anuncio VAST 2-4 del vendedor, probada cuando ninguna campaña invitada llena este espacio en las pantallas propias del vendedor. Solo HTTPS en puerto 443 o 8443 a un host público. El backend lo obtiene, sigue hasta cinco Wrappers, ingiere el MediaFile MP4 o WebM progresivo elegido en los medios del proyecto y dispara Impression, creativeView y start en un inicio aceptado, complete en una finalización aceptada y Error en fallo. No se disparan rastreadores de cuartiles. Se expanden las macros [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] y [SCREENRIG_PAGE_ID]. La ranura debe aceptar video. Null, ausente o vacío limpia la etiqueta. Los compradores nunca la ven.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/slots'

Respuestas

Estado	Significado	Cuerpo y encabezados
201	Ranuraslot.	AdvertisingSlot (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/slots/{id}¶

Actualizar espacio publicitario

Actualiza un espacio del vendedor. If-Match lleva su revisión. Un cambio de tarifa vuelve a ejecutar el límite de precios. Un Idempotency-Key opcional reproduce el resultado original confirmado durante 24 horas con el mismo espacio, cuerpo e If-Match, incluso tras ediciones posteriores. La reutilización modificada devuelve idempotency_mismatch. Una nueva escritura obsoleta devuelve revision_conflict.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingSlotWrite
ID de operación: updateAdvertisingSlot

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

Campo	Descripción
nombre (requerido, cadena)	minLength: 1 maxLength: 120
habilitado (opcional, booleano)
accepted_media (requerido, arreglo)
max_image_duration_ms (requerido, entero)	mínimo: 5000 máximo: 30000
max_video_duration_ms (requerido, entero)	mínimo: 1000 máximo: 120000
rate_override_mcr_per_15s (opcional, en línea)
vast_tag_url (opcional, en línea)	La propia etiqueta de anuncio VAST 2-4 del vendedor, probada cuando ninguna campaña invitada llena este espacio en las pantallas propias del vendedor. Solo HTTPS en puerto 443 o 8443 a un host público. El backend lo obtiene, sigue hasta cinco Wrappers, ingiere el MediaFile MP4 o WebM progresivo elegido en los medios del proyecto y dispara Impression, creativeView y start en un inicio aceptado, complete en una finalización aceptada y Error en fallo. No se disparan rastreadores de cuartiles. Se expanden las macros [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] y [SCREENRIG_PAGE_ID]. La ranura debe aceptar video. Null, ausente o vacío limpia la etiqueta. Los compradores nunca la ven.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/slots/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Espacio actualizado.	AdvertisingSlot (application/json)
409	idempotency_mismatch.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/memberships¶

Listar membresías publicitarias

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingMemberships

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/memberships'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Membresías.	AdvertisingMembershipList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/memberships/{id}¶

Actualizar membresía publicitaria

Edición explícita de política/alcance del vendedor. Aquí se cambia una membresía activa, nunca enviando una segunda invitación. Los cambios de alcance detienen la nueva selección; se preserva el historial financiero.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingMembershipScope
ID de operación: updateAdvertisingMembership

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Campos del cuerpo de la solicitud

Campo	Descripción
política (requerido, cadena)	Permitido: "trusted", "review_required"
screen_ids (requerido, arreglo)
slot_ids (obligatorio, arreglo)

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/memberships/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Membresía actualizada.	AdvertisingMembership (application/json)
412	revision_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/memberships/{id}/revoke¶

Revocar membresía publicitaria

Revoca una membresía. Detiene la nueva selección para esa red; no elimina la bandera de anunciante, otras membresías ni el historial establecido.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: revokeAdvertisingMembership

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/memberships/RESOURCE_ID/revoke'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Membresía revocada.	AdvertisingMembership (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/networks¶

Listar redes publicitarias unidas

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.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingJoinedNetworks

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/networks'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Redes unidas.	AdvertisingJoinedNetworkList (application/json)
403	prohibido: el proyecto carece de la bandera de anunciante.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/networks/{seller_project_id}/inventory¶

Listar inventario publicitario unido

Inventario seleccionado y espacios reutilizables dentro de la membresía del llamante. Nunca expone capturas de pantalla, listas de reproducción o datos de proyecto del vendedor.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingJoinedInventory

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
seller_project_id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/networks/SELLER_PROJECT_ID/inventory'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Inventario y espacios permitidos.	AdvertisingJoinedInventory (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/creatives¶

Listar creatividades publicitarias

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingCreatives

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/creatives'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Creatividades.	AdvertisingCreativeList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/creatives¶

Crear creatividad publicitaria

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.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingCreativeCreate
ID de operación: createAdvertisingCreative

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

Campo	Descripción
media_id (requerido, cadena)
copy (opcional, cadena)	maxLength: 500

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/creatives'

Respuestas

Estado	Significado	Cuerpo y encabezados
201	Creatividad.	AdvertisingCreative (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/creatives/{id}¶

Obtener creatividad publicitaria

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingCreative

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/creatives/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Creatividad.	AdvertisingCreative (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/seller-campaigns¶

Listar campañas publicitarias del vendedor

Las campañas de comprador enviadas del vendedor que llama, incluidas las campañas sin reproducciones y el historial después de revocar el acceso del comprador. Devuelve como máximo 100 campañas en orden de identificador. Los borradores, las otras redes y los presupuestos de todo el comprador son privados. Siga next_after con after hasta que deje de aparecer.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingSellerCampaigns

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
después	consulta	opcional	El next_after de la página anterior.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/seller-campaigns'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campañas de comprador enviadas en la red de este vendedor.	AdvertisingSellerCampaignList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/seller-campaigns/{id}¶

Obtener campaña publicitaria del vendedor

Vista de solo lectura para el vendedor de una campaña de comprador enviada. El inventario y la entrega liquidada de por vida abarcan únicamente al vendedor que llama. Las finanzas de todo el comprador y las otras redes son privadas. Un vendedor sin relación recibe not_found.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingSellerCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/seller-campaigns/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Los detalles de campaña y entrega del vendedor.	AdvertisingSellerCampaignDetail (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/campaigns¶

Listar campañas publicitarias

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingCampaigns

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campañas.	AdvertisingCampaignList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/campaigns¶

Crear campaña publicitaria

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.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingCampaignDraft
ID de operación: createAdvertisingCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Campos del cuerpo de la solicitud

Campo	Descripción
nombre (requerido, cadena)	minLength: 1 maxLength: 120
category (opcional, AdvertisingCategory)	La categoría del anunciante. Dos anuncios de una misma categoría nunca se reproducen en la misma pausa publicitaria de una pantalla; un anuncio sin categoría nunca se separa. Permitido: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"
daily_cap_mcr (requerido, McrString)	Cantidad exacta de milicréditos enteros como cadena decimal canónica. 1 crédito es 1000 mcr. pattern: "^-?[0-9]+$"
lifetime_cap_mcr (requerido, McrString)	Cantidad exacta de milicréditos enteros como cadena decimal canónica. 1 crédito es 1000 mcr. pattern: "^-?[0-9]+$"
image_duration_ms (opcional, entero)	Tiempo de permanencia de imagen en toda la campaña. Los videos mantienen su duración verificada por el servidor. predeterminado: 10000 mínimo: 5000 máximo: 30000
max_play_price_mcr (opcional, en línea)	Precio máximo positivo por reproducción completada. Omitir para no tener límite adicional.
flight_start (requerido, cadena)	formato: "date-time"
flight_end (requerido, cadena)	formato: "date-time"
redes (requerido, arreglo)

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns'

Respuestas

Estado	Significado	Cuerpo y encabezados
201	Campaña en borrador.	AdvertisingCampaign (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/campaigns/{id}¶

Obtener campaña publicitaria

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña.	AdvertisingCampaign (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}¶

Actualizar campaña publicitaria

Actualiza una campaña en borrador. If-Match lleva la revisión de la campaña. Una reducción del presupuesto por debajo de lo ya gastado más las reservas comprometidas se rechaza con el valor mínimo permitido.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingCampaignDraft
ID de operación: updateAdvertisingCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Campos del cuerpo de la solicitud

Campo	Descripción
nombre (requerido, cadena)	minLength: 1 maxLength: 120
category (opcional, AdvertisingCategory)	La categoría del anunciante. Dos anuncios de una misma categoría nunca se reproducen en la misma pausa publicitaria de una pantalla; un anuncio sin categoría nunca se separa. Permitido: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"
daily_cap_mcr (requerido, McrString)	Cantidad exacta de milicréditos enteros como cadena decimal canónica. 1 crédito es 1000 mcr. pattern: "^-?[0-9]+$"
lifetime_cap_mcr (requerido, McrString)	Cantidad exacta de milicréditos enteros como cadena decimal canónica. 1 crédito es 1000 mcr. pattern: "^-?[0-9]+$"
image_duration_ms (opcional, entero)	Tiempo de permanencia de imagen en toda la campaña. Los videos mantienen su duración verificada por el servidor. predeterminado: 10000 mínimo: 5000 máximo: 30000
max_play_price_mcr (opcional, en línea)	Precio máximo positivo por reproducción completada. Omitir para no tener límite adicional.
flight_start (requerido, cadena)	formato: "date-time"
flight_end (requerido, cadena)	formato: "date-time"
redes (requerido, arreglo)

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña actualizada.	AdvertisingCampaign (application/json)
412	revision_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/quote¶

Cotizar campaña publicitaria

Calcula los precios actuales efectivos de la campaña, formatos, duraciones, período y límites antes de la activación. La cotización tiene límite de tiempo y queda obsoleta cuando cambia cualquier generación de precios o tarifa efectiva.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: quoteAdvertisingCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/quote'

Respuestas

Estado	Significado	Cuerpo y encabezados
201	Cotizar.	AdvertisingQuote (application/json)
412	revision_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/activate¶

Activar campaña publicitaria

Acepta explícitamente la cotización actual nombrada y activa la campaña. Verifica atómicamente la propiedad, membresía, expiración de cotización, revisiones de tarifa, alcance aceptado y negación de mismo proyecto, luego registra los términos de compra. No ocurre débito de billetera ni ingreso para el vendedor al aceptar términos. La misma clave con el mismo cuerpo se repite; un cuerpo cambiado es un conflicto.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingQuoteAccept
ID de operación: activateAdvertisingCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

Campo	Descripción
quote_id (requerido, cadena)

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/activate'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña activa o en revisión pendiente.	AdvertisingCampaign (application/json)
409	quote_stale o self_deal o resource_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/pause¶

Pausar campaña publicitaria

Pausa nuevas reservas para esta campaña. Los anuncios válidos ya iniciados terminan normalmente y se cobran al completarse.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: pauseAdvertisingCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/pause'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña pausada.	AdvertisingCampaign (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/resume¶

Reanudar campaña publicitaria

Reanuda una campaña pausada manualmente. No puede eliminar un bloqueo price_change_pending; una recarga, un tick de programación o una acción del vendedor no pueden suministrar ese consentimiento.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: resumeAdvertisingCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/resume'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña reanudada.	AdvertisingCampaign (application/json)
409	price_change_pending - acepte primero las tarifas actuales.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/accept-rates¶

Aceptar tarifas publicitarias

La aceptación explícita del comprador de las tarifas efectivas cambiadas, vinculada al ID de cotización, revisión de campaña y generaciones de precios actuales. Reemplaza atómicamente los términos de entrega futuros, registra al actor y el tiempo, y elimina el bloqueo persistente de cambio de precio. Otro cambio concurrente de tarifa deja la campaña en pausa.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingQuoteAccept
ID de operación: acceptAdvertisingRates

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Campos del cuerpo de la solicitud

Campo	Descripción
quote_id (requerido, cadena)

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/accept-rates'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña reactivada.	AdvertisingCampaign (application/json)
409	price_change_pending o quote_stale.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/reviews¶

Listar reseñas publicitarias

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

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingReviews

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Revisiones.	AdvertisingReviewList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/reviews/{id}/approve¶

Aprobar revisión publicitaria

Aprueba una revisión exacta de creatividades enviadas. La aprobación no elige el presupuesto del comprador ni concede acceso a su biblioteca de medios. Una persona debe poder aprobar revisiones (approver_required). La misma revisión también es accesible como tipo ad_creative bajo /api/reviews.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: approveAdvertisingReview

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/approve'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Revisión aprobada.	AdvertisingReview (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/reviews/{id}/reject¶

Rechazar revisión publicitaria

Rechaza una revisión creativa exacta enviada con una razón que el comprador lee en la creatividad. Una persona debe poder aprobar revisiones (approver_required).

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingReviewRejection
ID de operación: rejectAdvertisingReview

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Campos del cuerpo de la solicitud

Campo	Descripción
razón (requerida, cadena)	minLength: 1 maxLength: 500

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/reject'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Revisión rechazada.	AdvertisingReview (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/reports/spend¶

Obtener gasto publicitario

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.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingSpend

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
formato	consulta	opcional	json (por defecto) devuelve el informe como JSON. csv, xlsx y pdf devuelven las mismas filas como archivo adjunto (cada página de un informe paginado, hasta 50000 filas).
campaign_id	consulta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/spend?campaign_id=CAMPAIGN_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Informe de gastos.	AdvertisingSpendReport (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/reports/delivery¶

Obtener entrega publicitaria

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.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingDelivery

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
formato	consulta	opcional	json (por defecto) devuelve el informe como JSON. csv, xlsx y pdf devuelven las mismas filas como archivo adjunto (cada página de un informe paginado, hasta 50000 filas).
desde	consulta	requerido
a	consulta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/delivery?from=FROM&to=TO'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Informe de entrega.	AdvertisingDeliveryReport (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/direct-campaigns¶

Listar campañas directas de publicidad

Las campañas directas del vendedor que llama, las más recientes primero, con su ritmo.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAdvertisingDirectCampaigns

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campañas directas.	AdvertisingDirectCampaignList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns¶

Crear campaña directa de publicidad

Reserva una campaña directa, un acuerdo que el vendedor cerró con un anunciante externo, sobre su propio inventario publicitario. No mueve dinero; el vendedor factura al anunciante y el precio se registra para el valor del informe. Está activa de inmediato y se llena antes que las campañas del marketplace.

Una campaña con objetivo se reparte de forma uniforme a lo largo de su vigencia y se reproduce primero mientras va por debajo del ritmo; una campaña sin objetivo toma todos los espacios elegibles durante su vigencia. Dos anuncios de una misma categoría nunca se reproducen en la misma pausa publicitaria de una pantalla. Un objetivo superior a la estimación de disponibilidad se rechaza con goal_overbooked, salvo que overbook sea true.

La misma clave con el mismo cuerpo reproduce la respuesta; un cuerpo distinto es un conflicto.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingDirectCampaignDraft
ID de operación: createAdvertisingDirectCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
Idempotency-Key	encabezado	requerido

Campos del cuerpo de la solicitud

Campo	Descripción
nombre (requerido, cadena)	minLength: 1 maxLength: 200
advertiser (requerido, string)	minLength: 1 maxLength: 200
category (opcional, AdvertisingCategory)	La categoría del anunciante. Dos anuncios de una misma categoría nunca se reproducen en la misma pausa publicitaria de una pantalla; un anuncio sin categoría nunca se separa. Permitido: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"
flight_start (requerido, cadena)	formato: "date-time"
flight_end (requerido, cadena)	formato: "date-time"
goal_plays (opcional, integer)	Las reproducciones a entregar, repartidas de forma uniforme a lo largo de la vigencia. Cero u omitido toma todos los espacios elegibles durante la vigencia. mínimo: 0 máximo: 1000000000000
price (opcional, AdvertisingDirectPrice)	El precio del acuerdo que registró el vendedor. screenRIG nunca lo cobra; valora el informe.
media_ids (requerido, array)	Las imágenes y los videos listos del vendedor, cada uno nombrado una vez.
image_duration_ms (opcional, entero)	Tiempo de permanencia de imagen en toda la campaña. Los videos mantienen su duración verificada por el servidor. predeterminado: 10000 mínimo: 5000 máximo: 30000
screen_ids (opcional, array)	Vacío significa todas las pantallas inscritas.
slot_ids (opcional, array)	Vacío significa todos los espacios habilitados.
venue_types (opcional, array)
cities (opcional, array)
tags (opcional, array)
dayparts (opcional, array)
overbook (opcional, boolean)	Reserva un objetivo superior a la estimación de disponibilidad. Sin esto, la solicitud se rechaza con goal_overbooked. predeterminado: false

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/direct-campaigns'

Respuestas

Estado	Significado	Cuerpo y encabezados
201	Campaña directa.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — el plan del proyecto no incluye campañas directas; required_plan nombra el plan que sí las incluye.	Problema (application/problem+json)
409	goal_overbooked o resource_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/direct-campaigns/{id}¶

Obtener campaña directa de publicidad

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingDirectCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña directa.	AdvertisingDirectCampaign (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns/{id}¶

Actualizar campaña directa de publicidad

Reemplaza los campos de borrador de la campaña. If-Match lleva la revisión de la campaña. Las reproducciones entregadas se conservan. Las reproducciones que faltan por entregar se comparan con la estimación de disponibilidad sin contar la reserva propia de la campaña, y overbook las reserva de todos modos.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingDirectCampaignDraft
ID de operación: updateAdvertisingDirectCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Campos del cuerpo de la solicitud

Campo	Descripción
nombre (requerido, cadena)	minLength: 1 maxLength: 200
advertiser (requerido, string)	minLength: 1 maxLength: 200
category (opcional, AdvertisingCategory)	La categoría del anunciante. Dos anuncios de una misma categoría nunca se reproducen en la misma pausa publicitaria de una pantalla; un anuncio sin categoría nunca se separa. Permitido: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"
flight_start (requerido, cadena)	formato: "date-time"
flight_end (requerido, cadena)	formato: "date-time"
goal_plays (opcional, integer)	Las reproducciones a entregar, repartidas de forma uniforme a lo largo de la vigencia. Cero u omitido toma todos los espacios elegibles durante la vigencia. mínimo: 0 máximo: 1000000000000
price (opcional, AdvertisingDirectPrice)	El precio del acuerdo que registró el vendedor. screenRIG nunca lo cobra; valora el informe.
media_ids (requerido, array)	Las imágenes y los videos listos del vendedor, cada uno nombrado una vez.
image_duration_ms (opcional, entero)	Tiempo de permanencia de imagen en toda la campaña. Los videos mantienen su duración verificada por el servidor. predeterminado: 10000 mínimo: 5000 máximo: 30000
screen_ids (opcional, array)	Vacío significa todas las pantallas inscritas.
slot_ids (opcional, array)	Vacío significa todos los espacios habilitados.
venue_types (opcional, array)
cities (opcional, array)
tags (opcional, array)
dayparts (opcional, array)
overbook (opcional, boolean)	Reserva un objetivo superior a la estimación de disponibilidad. Sin esto, la solicitud se rechaza con goal_overbooked. predeterminado: false

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña directa actualizada.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — el plan del proyecto no incluye campañas directas; required_plan nombra el plan que sí las incluye.	Problema (application/problem+json)
409	goal_overbooked o resource_conflict.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns/{id}/pause¶

Pausar campaña directa de publicidad

Detiene las nuevas reproducciones de una campaña activa. Las reproducciones entregadas y la vigencia se conservan. Una campaña en pausa o finalizada es un resource_conflict.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: pauseAdvertisingDirectCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/pause'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña directa en pausa.	AdvertisingDirectCampaign (application/json)
412	revision_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns/{id}/resume¶

Reanudar campaña directa de publicidad

Reanuda una campaña directa en pausa. Una campaña con objetivo que quedó por debajo del ritmo mientras estaba en pausa se reproduce primero hasta volver al ritmo. Una campaña activa o finalizada es un resource_conflict.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: resumeAdvertisingDirectCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/resume'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña directa reanudada.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — el plan del proyecto no incluye campañas directas; required_plan nombra el plan que sí las incluye.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns/{id}/end¶

Finalizar campaña directa de publicidad

Finaliza una campaña activa o en pausa antes de que termine su vigencia. Una campaña finalizada ya no se reproduce y conserva su informe.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: endAdvertisingDirectCampaign

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
If-Match	encabezado	opcional	Revisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/end'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Campaña directa finalizada.	AdvertisingDirectCampaign (application/json)
412	revision_conflict.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/direct-campaigns/{id}/report¶

Obtener informe de campaña directa de publicidad

La entrega de una campaña directa en una ventana, con su ritmo, el valor registrado de las reproducciones entregadas y filas por día UTC, pantalla, espacio y contenido multimedia. Sin from y to, la ventana es toda la vigencia. Cuando la ventana contiene más filas de las que lista el informe, la respuesta establece truncated y los totales siguen cubriendo todas las reproducciones.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingDirectCampaignReport

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
formato	consulta	opcional	json (por defecto) devuelve el informe como JSON. csv, xlsx y pdf devuelven las mismas filas como archivo adjunto (cada página de un informe paginado, hasta 50000 filas).
id	ruta	requerido
desde	consulta	opcional
a	consulta	opcional

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/report'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Informe de campaña directa.	AdvertisingDirectReport (application/json)
402	feature_not_in_plan — el plan del proyecto no incluye campañas directas; required_plan nombra el plan que sí las incluye.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/availability¶

Estimar disponibilidad de publicidad

Estima las reproducciones que un objetivo directo puede reservar en el inventario y la vigencia indicados. Es una lectura y no cambia nada. La estimación son las ocurrencias recientes de espacios publicitarios de las pantallas seleccionadas, proyectadas sobre la vigencia, menos los objetivos que otras campañas directas aún necesitan en las mismas pantallas.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AdvertisingAvailabilityQuery
ID de operación: estimateAdvertisingAvailability

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Campos del cuerpo de la solicitud

Campo	Descripción
screen_ids (opcional, array)	Vacío significa todas las pantallas inscritas.
slot_ids (opcional, array)	Vacío significa todos los espacios habilitados.
venue_types (opcional, array)
cities (opcional, array)
tags (opcional, array)
dayparts (opcional, array)
flight_start (requerido, cadena)	formato: "date-time"
flight_end (requerido, cadena)	formato: "date-time"
exclude_campaign_id (opcional, string)	Excluye de booked_plays la reserva propia de esta campaña directa, para una edición.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/availability'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Estimación de disponibilidad.	AdvertisingAvailability (application/json)
402	feature_not_in_plan — el plan del proyecto no incluye campañas directas; required_plan nombra el plan que sí las incluye.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/reports/fill¶

Obtener estadísticas de llenado de publicidad

Oferta de espacios publicitarios del vendedor solicitante para una ventana, por día UTC y en total. Cada ocurrencia se rellena con una campaña directa, del mercado o una etiqueta VAST, o queda sin rellenar con su motivo. La ventana solicitada es de hasta 35 días y por defecto cubre los últimos 7. La oferta tiene precisión horaria.

Se incluyen completas todas las horas UTC que se solapan con la ventana semiabierta solicitada; from se redondea hacia abajo y to hacia arriba a límites horarios UTC. Un to ya alineado sigue siendo exclusivo. La respuesta devuelve estos límites efectivos, que pueden abarcar hasta 35 días más una hora.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingFillStats

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
formato	consulta	opcional	json (por defecto) devuelve el informe como JSON. csv, xlsx y pdf devuelven las mismas filas como archivo adjunto (cada página de un informe paginado, hasta 50000 filas).
desde	consulta	opcional
a	consulta	opcional

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/fill'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Estadísticas de llenado.	AdvertisingFillStats (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/reviews/{id}¶

Obtener revisión publicitaria

Detalle del vendedor para una revisión de su red. Devuelve la revisión y la versión exacta del creativo enviado. Nunca expone otros medios del comprador.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingReview

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Revisión y su creatividad.	AdvertisingReviewDetail (application/json)
404	not_found - la reseña es desconocida para este vendedor.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/advertising/reviews/{id}/content¶

Obtener contenido de revisión publicitaria

Transmite solo la revisión creativa exacta a la que se refiere la revisión de este vendedor. La propiedad permanece con el proyecto comprador; no se publica ninguna clave de objeto ni ubicación firmada, y no se puede acceder a otros medios del comprador. El ETag es el SHA-256 fuerte del creativo y nunca cambia para una revisión.

La respuesta de una sesión del panel es privada, no-cache, por lo que el navegador mantiene una copia y la revalida; la respuesta de un portador de proyecto permanece privada, no-store.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAdvertisingReviewContent

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
Rango	encabezado	opcional	V1 acepta solo un rango de bytes.
If-None-Match	encabezado	opcional	ETag fuerte creativa SHA-256 devuelta por esta ruta.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/content'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Los bytes exactos creativos de la revisión.	sin cuerpo; encabezados: Accept-Ranges, Content-Length, ETag, Cache-Control
206	Un rango de bytes correcto según el estándar.	sin cuerpo; encabezados: Content-Range, ETag, Cache-Control
304	El ETag de la creatividad coincide con If-None-Match, verificado después de que la revisión se resuelve en el proyecto del vendedor. No se produce cuerpo ni incremento de egreso.	sin cuerpo; encabezados: ETag, Cache-Control
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

HEAD/api/advertising/reviews/{id}/content¶

Encabezado de revisión de publicidad de contenido

Autenticación: projectBearer
Cuerpo de la solicitud: ninguno
ID de operación: headAdvertisingReviewContent

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
Rango	encabezado	opcional	V1 acepta solo un rango de bytes.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request HEAD --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/content'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Solo metadatos.	sin cuerpo; encabezados: Content-Length, ETag
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/advertising/reviews/{id}/request-changes¶

Solicitar cambios en la revisión publicitaria

El vendedor solicita al comprador cambios en una revisión creativa enviada. La revisión pasa a changes_requested con la nota en reason; el comprador la lee en la creatividad, y la siguiente revisión que la campaña abre para este vendedor enlaza previous_review_id. Una persona debe poder aprobar revisiones (approver_required).

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ReviewChangesRequest
ID de operación: requestAdvertisingReviewChanges

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Campos del cuerpo de la solicitud

Campo	Descripción
nota (requerida, cadena)	minLength: 1 maxLength: 500

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/request-changes'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	La revisión, estado changes_requested.	AdvertisingReview (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)