Pubblicità: riferimento API, endpoint ed esempi

OpenAPI YAML OpenAPI JSON problemi YAML Panoramica dell’API

Questo gruppo ha 46 operazioni, generate da api/openapi.yaml. Filtra per percorso, azione o autenticazione. Ogni endpoint elenca i suoi input; espandilo per vedere un modello di richiesta e i codici di risposta. I modelli richiedono i tuoi valori e un corpo valido secondo lo schema.

Sostituisci i segnaposto maiuscoli con i tuoi valori. Per una richiesta JSON, salva un corpo che corrisponde allo schema in request.json. Gli esempi di cookie usano un cookie jar locale da una sessione autenticata.

Reti e campagne pubblicitarie private

GET/api/advertising/network¶

Ottieni rete pubblicitaria

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingNetwork

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Rete.	AdvertisingNetwork (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

POST/api/advertising/network¶

Crea rete pubblicitaria

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingNetworkCreate
ID operazione: createAdvertisingNetwork

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Campi del corpo della richiesta

Campo	Descrizione
nome (obbligatorio, stringa)	maxLength: 120

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Rete.	AdvertisingNetwork (application/json)
403	vietato - il progetto non dispone della capacità schermo o ha un piano sconosciuto.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

POST/api/advertising/network/rate¶

Imposta la tariffa pubblicitaria predefinita

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingRate
ID operazione: setAdvertisingDefaultRate

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Campi del corpo della richiesta

Campo	Descrizione
rate_mcr_per_15s (obbligatorio, McrString)	Importo esatto in millicrediti come stringa decimale canonica. 1 credito è 1000 mcr. pattern: "^-?[0-9]+$"

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Rete aggiornata.	AdvertisingNetwork (application/json)
412	revision_conflict - If-Match è obsoleto.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/inventory¶

Elenca inventario pubblicitario

L’inventario a cui il venditore chiamante ha aderito.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingInventory

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Inventario.	AdvertisingInventoryList (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Inserisci inventario pubblicitario

Aggiorna o inserisce l’inventario di uno schermo di proprietà. Verifica la proprietà dello schermo. Un override della tariffa a null ripristina l’ereditarietà, non zero. Una modifica che altera la tariffa effettiva di una campagna accettata mette in pausa quella campagna. Uno schermo in una cartella di schermi protetta è protected_target (409).

Autenticazione: projectBearer
Corpo della richiesta: AdvertisingInventoryWrite
ID operazione: putAdvertisingInventory

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
screen_id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.
Idempotency-Key	intestazione	opzionale	Ometti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.

Campi del corpo della richiesta

Campo	Descrizione
impressions_per_hour (opzionale, inline)	La stima del venditore delle impression che questo schermo genera in un’ora. Ogni riproduzione completata conta questo valore per i suoi secondi diviso 3600 come impression stimate nei report. Null o assente significa nessuna stima.
ads_enabled (obbligatorio, booleano)
site_name (opzionale, stringa)	maxLength: 120
città (opzionale, stringa)	maxLength: 120
regione (opzionale, stringa)	maxLength: 120
venue_type (opzionale, stringa)	maxLength: 64
audience_tags (opzionale, array)
posizionamento (opzionale, stringa)	maxLength: 120
public_description (opzionale, stringa)	maxLength: 500
rate_override_mcr_per_15s (opzionale, inline)	Null ripristina l’ereditarietà dal valore predefinito del progetto; non significa mai zero.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Inventario archiviato.	AdvertisingInventory (application/json)
403	forbidden - lo schermo non appartiene a questo progetto; outside_screen_scope o approver_required per un chiamante limitato agli schermi.	Problema (application/problem+json)
409	protected_target - lo schermo è in una cartella di schermi protetta e la modifica non ha una forma di revisione (docs/screen-scope.md); rimuovi la protezione della cartella tramite una revisione, fai la modifica e proteggi di nuovo la cartella.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/slots¶

Elenca slot pubblicitari

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingSlots

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Slot.	AdvertisingSlotList (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

POST/api/advertising/slots¶

Crea slot pubblicitario

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingSlotWrite
ID operazione: createAdvertisingSlot

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Campi del corpo della richiesta

Campo	Descrizione
nome (obbligatorio, stringa)	minLength: 1 maxLength: 120
abilitato (opzionale, booleano)
accepted_media (obbligatorio, array)
max_image_duration_ms (obbligatorio, intero)	minimo: 5000 massimo: 30000
max_video_duration_ms (obbligatorio, intero)	minimo: 1000 massimo: 120000
rate_override_mcr_per_15s (opzionale, inline)
vast_tag_url (opzionale, inline)	Il tag pubblicitario VAST 2-4 del venditore, provato quando nessuna campagna invitata riempie questo slot sugli schermi del venditore. Solo HTTPS su porta 443 o 8443 verso un host pubblico. Il backend lo recupera, segue fino a cinque Wrapper, importa il MediaFile MP4 o WebM progressivo scelto nei media del progetto e attiva Impression, creativeView e start su inizio accettato, complete su completamento accettato ed Error su errore. I tracker quartile non vengono attivati. Le macro [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] e [SCREENRIG_PAGE_ID] vengono espanse. Lo slot deve accettare video. Null, assente o vuoto cancella il tag. I compratori non lo vedono mai.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
201	Slotslot.	AdvertisingSlot (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Aggiorna slot pubblicitario

Aggiorna uno spazio del venditore. If-Match contiene la revisione. Una modifica della tariffa verifica di nuovo il vincolo di prezzo. Un Idempotency-Key facoltativo riproduce per 24 ore il risultato originale confermato con gli stessi spazio, corpo e If-Match, anche dopo modifiche successive. Un riutilizzo modificato restituisce idempotency_mismatch. Una nuova scrittura obsoleta restituisce revision_conflict.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingSlotWrite
ID operazione: updateAdvertisingSlot

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.
Idempotency-Key	intestazione	opzionale	Ometti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.

Campi del corpo della richiesta

Campo	Descrizione
nome (obbligatorio, stringa)	minLength: 1 maxLength: 120
abilitato (opzionale, booleano)
accepted_media (obbligatorio, array)
max_image_duration_ms (obbligatorio, intero)	minimo: 5000 massimo: 30000
max_video_duration_ms (obbligatorio, intero)	minimo: 1000 massimo: 120000
rate_override_mcr_per_15s (opzionale, inline)
vast_tag_url (opzionale, inline)	Il tag pubblicitario VAST 2-4 del venditore, provato quando nessuna campagna invitata riempie questo slot sugli schermi del venditore. Solo HTTPS su porta 443 o 8443 verso un host pubblico. Il backend lo recupera, segue fino a cinque Wrapper, importa il MediaFile MP4 o WebM progressivo scelto nei media del progetto e attiva Impression, creativeView e start su inizio accettato, complete su completamento accettato ed Error su errore. I tracker quartile non vengono attivati. Le macro [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] e [SCREENRIG_PAGE_ID] vengono espanse. Lo slot deve accettare video. Null, assente o vuoto cancella il tag. I compratori non lo vedono mai.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Slot aggiornato.	AdvertisingSlot (application/json)
409	idempotency_mismatch.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/memberships¶

Elenca iscrizioni pubblicitarie

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingMemberships

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Membri.	AdvertisingMembershipList (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Aggiorna adesione pubblicitaria

Modifica esplicita politica/ambito venditore. Un’iscrizione attiva si modifica qui, mai inviando un secondo invito. Le modifiche ambito bloccano nuova selezione; la storia finanziaria resta.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingMembershipScope
ID operazione: updateAdvertisingMembership

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Campi del corpo della richiesta

Campo	Descrizione
policy (obbligatoria, stringa)	Consentito: "trusted", "review_required"
screen_ids (obbligatorio, array)
slot_ids (obbligatorio, array)

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Adesione aggiornata.	AdvertisingMembership (application/json)
412	revision_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Revoca iscrizione pubblicitaria

Revoca un’iscrizione. Interrompe la nuova selezione per quella rete; non cancella il flag inserzionista, altre iscrizioni o la cronologia consolidata.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: revokeAdvertisingMembership

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Iscrizione revocata.	AdvertisingMembership (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/networks¶

Elenca reti pubblicitarie unite

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingJoinedNetworks

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Reti unite.	AdvertisingJoinedNetworkList (application/json)
403	vietato - il progetto non ha il flag inserzionista.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Elenca inventario pubblicitario unito

Inventario selezionato e slot riutilizzabili all’interno dell’appartenenza del chiamante. Non espone mai screenshot, playlist o dati a livello di progetto del venditore.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingJoinedInventory

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
seller_project_id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Inventario e slot consentiti.	AdvertisingJoinedInventory (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/creatives¶

Elenca creatività pubblicitarie

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingCreatives

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Creatività.	AdvertisingCreativeList (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

POST/api/advertising/creatives¶

Crea creatività pubblicitaria

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingCreativeCreate
ID operazione: createAdvertisingCreative

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
Idempotency-Key	intestazione	opzionale	Ometti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.

Campi del corpo della richiesta

Campo	Descrizione
media_id (obbligatorio, stringa)
copy (opzionale, stringa)	maxLength: 500

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
201	Creatività.	AdvertisingCreative (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Ottieni creatività pubblicitaria

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingCreative

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Creatività.	AdvertisingCreative (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/seller-campaigns¶

Elenca campagne pubblicitarie del venditore

Le campagne inviate dagli acquirenti al venditore chiamante, incluse le campagne senza riproduzioni e la cronologia dopo la revoca dell’accesso dell’acquirente. Restituisce al massimo 100 campagne in ordine di identificatore. Le bozze, le altre reti e i budget a livello di acquirente sono privati. Segui next_after con after finché non è assente.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingSellerCampaigns

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
dopo	query	opzionale	Il next_after della pagina precedente.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagne inviate dagli acquirenti sulla rete di questo venditore.	AdvertisingSellerCampaignList (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Ottieni campagna pubblicitaria del venditore

La vista di sola lettura per il venditore di una campagna inviata da un acquirente. Inventario e consegna consolidata complessiva riguardano solo il venditore chiamante. Le finanze a livello di acquirente e le altre reti sono private. Un venditore non correlato riceve not_found.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingSellerCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	I dettagli di campagna e consegna del venditore.	AdvertisingSellerCampaignDetail (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/campaigns¶

Elenca campagne pubblicitarie

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingCampaigns

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagne.	AdvertisingCampaignList (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

POST/api/advertising/campaigns¶

Crea campagna pubblicitaria

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingCampaignDraft
ID operazione: createAdvertisingCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Campi del corpo della richiesta

Campo	Descrizione
nome (obbligatorio, stringa)	minLength: 1 maxLength: 120
category (opzionale, AdvertisingCategory)	La categoria dell’inserzionista. Due annunci della stessa categoria non vanno mai in onda nella stessa pausa pubblicitaria su uno schermo; un annuncio senza categoria non viene mai separato. Consentito: "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 (obbligatorio, McrString)	Importo esatto in millicrediti come stringa decimale canonica. 1 credito è 1000 mcr. pattern: "^-?[0-9]+$"
lifetime_cap_mcr (obbligatorio, McrString)	Importo esatto in millicrediti come stringa decimale canonica. 1 credito è 1000 mcr. pattern: "^-?[0-9]+$"
image_duration_ms (opzionale, intero)	Durata di visualizzazione immagine per tutta la campagna. I video mantengono la loro durata verificata dal server. predefinito: 10000 minimo: 5000 massimo: 30000
max_play_price_mcr (opzionale, inline)	Prezzo massimo positivo per riproduzione completata. Ometti per nessun tetto aggiuntivo.
flight_start (obbligatorio, stringa)	formato: "date-time"
flight_end (obbligatorio, stringa)	formato: "date-time"
reti (obbligatorio, array)

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
201	Bozza campagna.	AdvertisingCampaign (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Ottieni campagna pubblicitaria

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna.	AdvertisingCampaign (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Aggiorna campagna pubblicitaria

Aggiorna una bozza di campagna. If-Match riporta la revisione della campagna. Una riduzione del budget sotto la somma già spesa più le prenotazioni impegnate è rifiutata con il valore minimo consentito.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingCampaignDraft
ID operazione: updateAdvertisingCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Campi del corpo della richiesta

Campo	Descrizione
nome (obbligatorio, stringa)	minLength: 1 maxLength: 120
category (opzionale, AdvertisingCategory)	La categoria dell’inserzionista. Due annunci della stessa categoria non vanno mai in onda nella stessa pausa pubblicitaria su uno schermo; un annuncio senza categoria non viene mai separato. Consentito: "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 (obbligatorio, McrString)	Importo esatto in millicrediti come stringa decimale canonica. 1 credito è 1000 mcr. pattern: "^-?[0-9]+$"
lifetime_cap_mcr (obbligatorio, McrString)	Importo esatto in millicrediti come stringa decimale canonica. 1 credito è 1000 mcr. pattern: "^-?[0-9]+$"
image_duration_ms (opzionale, intero)	Durata di visualizzazione immagine per tutta la campagna. I video mantengono la loro durata verificata dal server. predefinito: 10000 minimo: 5000 massimo: 30000
max_play_price_mcr (opzionale, inline)	Prezzo massimo positivo per riproduzione completata. Ometti per nessun tetto aggiuntivo.
flight_start (obbligatorio, stringa)	formato: "date-time"
flight_end (obbligatorio, stringa)	formato: "date-time"
reti (obbligatorio, array)

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna aggiornata.	AdvertisingCampaign (application/json)
412	revision_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Preventivo campagna pubblicitaria

Prezzi le tariffe effettive correnti della campagna, formati, durate, periodo di pubblicazione e limiti prima dell’attivazione. Il preventivo è limitato nel tempo e diventa obsoleto quando cambia la generazione dei prezzi o la tariffa effettiva.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: quoteAdvertisingCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
201	Preventivo.	AdvertisingQuote (application/json)
412	revision_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Attiva campagna pubblicitaria

Accetta esplicitamente il preventivo corrente nominato e attiva la campagna. Controlla atomica proprietà, iscrizione, scadenza preventivo, revisioni tariffe, ambito accettato e negazione stesso progetto, quindi registra termini acquisto. Nessun addebito wallet e nessun ricavo venditore da accettare termini. La stessa chiave con lo stesso corpo ripete; corpo modificato è conflitto.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingQuoteAccept
ID operazione: activateAdvertisingCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.
Idempotency-Key	intestazione	opzionale	Ometti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.

Campi del corpo della richiesta

Campo	Descrizione
quote_id (obbligatorio, stringa)

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna attiva o in revisione.	AdvertisingCampaign (application/json)
409	quote_stale o self_deal o resource_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Pausa campagna pubblicitaria

Sospende nuove prenotazioni per questa campagna. Gli annunci validi già iniziati terminano normalmente e vengono addebitati al completamento.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: pauseAdvertisingCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna in pausa.	AdvertisingCampaign (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Riprendi campagna pubblicitaria

Riprende una campagna messa in pausa manualmente. Non può rimuovere un blocco price_change_pending; una ricarica, un tick di programmazione o un’azione venditore non possono fornire quel consenso.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: resumeAdvertisingCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna ripresa.	AdvertisingCampaign (application/json)
409	price_change_pending - accettare prima le tariffe correnti.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Accetta tariffe pubblicitarie

L’accettazione esplicita da parte dell’acquirente delle tariffe effettive modificate, legata a ID preventivo, revisione campagna e generazioni di prezzo correnti. Sostituisce atomica i termini di consegna futuri, registra attore e ora, e rimuove il blocco sticky di modifica prezzo. Un’altra modifica tariffaria concorrente mette in pausa la campagna.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingQuoteAccept
ID operazione: acceptAdvertisingRates

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Campi del corpo della richiesta

Campo	Descrizione
quote_id (obbligatorio, stringa)

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna riattivata.	AdvertisingCampaign (application/json)
409	price_change_pending o quote_stale.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/reviews¶

Elenca recensioni pubblicitarie

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingReviews

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Revisioni.	AdvertisingReviewList (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Approva revisione pubblicitaria

Approva una revisione creativa esatta inviata. L’approvazione non sceglie il budget dell’acquirente né concede accesso alla sua libreria media. Una persona deve poter approvare revisioni (approver_required). La stessa revisione è raggiungibile anche come tipo ad_creative sotto /api/reviews.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: approveAdvertisingReview

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Revisione approvata.	AdvertisingReview (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Rifiuta revisione pubblicitaria

Rifiuta una revisione creativa esatta inviata con una motivazione che l’acquirente legge sulla creatività. Una persona deve poter approvare revisioni (approver_required).

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingReviewRejection
ID operazione: rejectAdvertisingReview

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio

Campi del corpo della richiesta

Campo	Descrizione
motivo (obbligatorio, stringa)	minLength: 1 maxLength: 500

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Revisione rifiutata.	AdvertisingReview (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/reports/spend¶

Ottieni spesa pubblicitaria

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingSpend

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
formato	query	opzionale	json (predefinito) restituisce il report come JSON. csv, xlsx e pdf restituiscono le stesse righe come allegato (ogni pagina di un report a pagine, fino a 50000 righe).
campaign_id	query	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Rapporto spese.	AdvertisingSpendReport (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/reports/delivery¶

Ottieni consegna pubblicitaria

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

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

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingDelivery

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
formato	query	opzionale	json (predefinito) restituisce il report come JSON. csv, xlsx e pdf restituiscono le stesse righe come allegato (ogni pagina di un report a pagine, fino a 50000 righe).
da	query	obbligatorio
a	query	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Rapporto di consegna.	AdvertisingDeliveryReport (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/direct-campaigns¶

Elenca campagne pubblicitarie dirette

Le campagne dirette del venditore chiamante, dalla più recente, con il loro ritmo.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: listAdvertisingDirectCampaigns

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagne dirette.	AdvertisingDirectCampaignList (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns¶

Crea campagna pubblicitaria diretta

Prenota una campagna diretta, un accordo del venditore con un inserzionista esterno, sul proprio inventario pubblicitario. Non sposta denaro; il venditore fattura l’inserzionista e il prezzo è registrato per il valore del report. È attiva subito e riempie prima delle campagne marketplace.

Una campagna con obiettivo è distribuita in modo uniforme sul suo periodo e va in onda per prima quando è in ritardo sul ritmo; una campagna senza obiettivo occupa ogni slot idoneo durante il suo periodo. Due annunci della stessa categoria non vanno mai in onda nella stessa pausa pubblicitaria su uno schermo. Un obiettivo superiore alla stima di disponibilità è rifiutato con goal_overbooked a meno che overbook sia true.

La stessa chiave con lo stesso corpo riproduce la risposta; un corpo modificato è un conflitto.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingDirectCampaignDraft
ID operazione: createAdvertisingDirectCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
Idempotency-Key	intestazione	obbligatorio

Campi del corpo della richiesta

Campo	Descrizione
nome (obbligatorio, stringa)	minLength: 1 maxLength: 200
advertiser (obbligatorio, string)	minLength: 1 maxLength: 200
category (opzionale, AdvertisingCategory)	La categoria dell’inserzionista. Due annunci della stessa categoria non vanno mai in onda nella stessa pausa pubblicitaria su uno schermo; un annuncio senza categoria non viene mai separato. Consentito: "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 (obbligatorio, stringa)	formato: "date-time"
flight_end (obbligatorio, stringa)	formato: "date-time"
goal_plays (opzionale, integer)	Le riproduzioni da consegnare, distribuite in modo uniforme sul periodo. Zero o omesso occupa ogni slot idoneo durante il periodo. minimo: 0 massimo: 1000000000000
price (opzionale, AdvertisingDirectPrice)	Il prezzo dell’accordo registrato dal venditore. screenRIG non lo addebita mai; valorizza il report.
media_ids (obbligatorio, array)	Le immagini e i video pronti del venditore, ciascuno nominato una volta.
image_duration_ms (opzionale, intero)	Durata di visualizzazione immagine per tutta la campagna. I video mantengono la loro durata verificata dal server. predefinito: 10000 minimo: 5000 massimo: 30000
screen_ids (opzionale, array)	Vuoto significa ogni schermo aderente.
slot_ids (opzionale, array)	Vuoto significa ogni slot abilitato.
venue_types (opzionale, array)
cities (opzionale, array)
tags (opzionale, array)
dayparts (opzionale, array)
overbook (opzionale, boolean)	Prenota un obiettivo superiore alla stima di disponibilità. Senza di esso la richiesta è rifiutata con goal_overbooked. predefinito: false

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
201	Campagna diretta.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — il piano del progetto non include le campagne dirette; required_plan indica il piano che le include.	Problema (application/problem+json)
409	goal_overbooked o resource_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Ottieni campagna pubblicitaria diretta

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingDirectCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna diretta.	AdvertisingDirectCampaign (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Aggiorna campagna pubblicitaria diretta

Sostituisce i campi bozza della campagna. If-Match porta la revisione della campagna. Le riproduzioni consegnate sono conservate. Le riproduzioni ancora da consegnare sono confrontate con la stima di disponibilità escludendo la prenotazione della campagna stessa, e overbook le prenota comunque.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingDirectCampaignDraft
ID operazione: updateAdvertisingDirectCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Campi del corpo della richiesta

Campo	Descrizione
nome (obbligatorio, stringa)	minLength: 1 maxLength: 200
advertiser (obbligatorio, string)	minLength: 1 maxLength: 200
category (opzionale, AdvertisingCategory)	La categoria dell’inserzionista. Due annunci della stessa categoria non vanno mai in onda nella stessa pausa pubblicitaria su uno schermo; un annuncio senza categoria non viene mai separato. Consentito: "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 (obbligatorio, stringa)	formato: "date-time"
flight_end (obbligatorio, stringa)	formato: "date-time"
goal_plays (opzionale, integer)	Le riproduzioni da consegnare, distribuite in modo uniforme sul periodo. Zero o omesso occupa ogni slot idoneo durante il periodo. minimo: 0 massimo: 1000000000000
price (opzionale, AdvertisingDirectPrice)	Il prezzo dell’accordo registrato dal venditore. screenRIG non lo addebita mai; valorizza il report.
media_ids (obbligatorio, array)	Le immagini e i video pronti del venditore, ciascuno nominato una volta.
image_duration_ms (opzionale, intero)	Durata di visualizzazione immagine per tutta la campagna. I video mantengono la loro durata verificata dal server. predefinito: 10000 minimo: 5000 massimo: 30000
screen_ids (opzionale, array)	Vuoto significa ogni schermo aderente.
slot_ids (opzionale, array)	Vuoto significa ogni slot abilitato.
venue_types (opzionale, array)
cities (opzionale, array)
tags (opzionale, array)
dayparts (opzionale, array)
overbook (opzionale, boolean)	Prenota un obiettivo superiore alla stima di disponibilità. Senza di esso la richiesta è rifiutata con goal_overbooked. predefinito: false

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna diretta aggiornata.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — il piano del progetto non include le campagne dirette; required_plan indica il piano che le include.	Problema (application/problem+json)
409	goal_overbooked o resource_conflict.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Metti in pausa campagna pubblicitaria diretta

Ferma le nuove riproduzioni di una campagna attiva. Le riproduzioni consegnate e il periodo sono conservati. Una campagna in pausa o terminata è un resource_conflict.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: pauseAdvertisingDirectCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna diretta in pausa.	AdvertisingDirectCampaign (application/json)
412	revision_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Riprendi campagna pubblicitaria diretta

Riprende una campagna diretta in pausa. Una campagna con obiettivo rimasta indietro sul ritmo durante la pausa va in onda per prima finché non torna in linea con il ritmo. Una campagna attiva o terminata è un resource_conflict.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: resumeAdvertisingDirectCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna diretta ripresa.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — il piano del progetto non include le campagne dirette; required_plan indica il piano che le include.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Termina campagna pubblicitaria diretta

Termina una campagna attiva o in pausa prima del suo periodo. Una campagna terminata non va più in onda e conserva il suo report.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: endAdvertisingDirectCampaign

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Campagna diretta terminata.	AdvertisingDirectCampaign (application/json)
412	revision_conflict.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Ottieni report campagna pubblicitaria diretta

La consegna di una campagna diretta per una finestra, con il suo ritmo, il valore registrato delle riproduzioni consegnate e righe per giorno UTC, schermo, slot e media. Senza from e to la finestra è l’intero periodo. Quando la finestra contiene più righe di quelle elencate dal report, la risposta imposta truncated e i totali coprono comunque ogni riproduzione.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingDirectCampaignReport

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
formato	query	opzionale	json (predefinito) restituisce il report come JSON. csv, xlsx e pdf restituiscono le stesse righe come allegato (ogni pagina di un report a pagine, fino a 50000 righe).
id	path	obbligatorio
da	query	opzionale
a	query	opzionale

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Report della campagna diretta.	AdvertisingDirectReport (application/json)
402	feature_not_in_plan — il piano del progetto non include le campagne dirette; required_plan indica il piano che le include.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

POST/api/advertising/availability¶

Stima disponibilità pubblicitaria

Stima le riproduzioni che un obiettivo diretto può prenotare sull’inventario e sul periodo indicati. È una lettura e non modifica nulla. La stima è data dalle recenti occorrenze di slot pubblicitari degli schermi mirati proiettate sul periodo, meno gli obiettivi di cui hanno ancora bisogno le altre campagne dirette sugli stessi schermi.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: AdvertisingAvailabilityQuery
ID operazione: estimateAdvertisingAvailability

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.

Campi del corpo della richiesta

Campo	Descrizione
screen_ids (opzionale, array)	Vuoto significa ogni schermo aderente.
slot_ids (opzionale, array)	Vuoto significa ogni slot abilitato.
venue_types (opzionale, array)
cities (opzionale, array)
tags (opzionale, array)
dayparts (opzionale, array)
flight_start (obbligatorio, stringa)	formato: "date-time"
flight_end (obbligatorio, stringa)	formato: "date-time"
exclude_campaign_id (opzionale, string)	Esclude da booked_plays la prenotazione di questa campagna diretta, per una modifica.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Stima di disponibilità.	AdvertisingAvailability (application/json)
402	feature_not_in_plan — il piano del progetto non include le campagne dirette; required_plan indica il piano che le include.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

GET/api/advertising/reports/fill¶

Ottieni statistiche di riempimento pubblicitario

Offerta di spazi pubblicitari del venditore chiamante per una finestra, per giorno UTC e in totale. Ogni occorrenza è riempita da una campagna diretta, del mercato o dal tag VAST, oppure resta vuota con il relativo motivo. La finestra richiesta copre al massimo 35 giorni, per impostazione predefinita gli ultimi 7. L’offerta ha precisione oraria.

Tutte le ore UTC che si sovrappongono alla finestra semiaperta richiesta sono incluse per intero; from viene arrotondato per difetto e to per eccesso ai limiti orari UTC. Un to già allineato resta esclusivo. La risposta restituisce questi limiti effettivi, che possono coprire fino a 35 giorni più un’ora.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingFillStats

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
formato	query	opzionale	json (predefinito) restituisce il report come JSON. csv, xlsx e pdf restituiscono le stesse righe come allegato (ogni pagina di un report a pagine, fino a 50000 righe).
da	query	opzionale
a	query	opzionale

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Statistiche di riempimento.	AdvertisingFillStats (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Ottieni revisione pubblicitaria

Dettaglio venditore per una recensione della sua rete. Restituisce la recensione e la versione creativa esatta inviata. Non espone mai gli altri media dell’acquirente.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingReview

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Revisione e la sua creatività.	AdvertisingReviewDetail (application/json)
404	not_found - la recensione è sconosciuta a questo venditore.	Problema (application/problem+json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Ottieni contenuto revisione pubblicitaria

Flussi solo la revisione creativa esatta a cui si riferisce la recensione di questo venditore. La proprietà resta al progetto acquirente; nessuna chiave oggetto o posizione firmata è pubblicata, e nessun altro media acquirente è raggiungibile. L’ETag è lo SHA-256 forte della creatività e non cambia mai per una recensione.

Una risposta di sessione dashboard è privata, no-cache, quindi il browser ne conserva una copia e la convalida; una risposta bearer progetto resta privata, no-store.

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: nessuno
ID operazione: getAdvertisingReviewContent

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
Intervallo	intestazione	opzionale	V1 accetta solo un intervallo di byte.
If-None-Match	intestazione	opzionale	ETag SHA-256 forte creatività restituito da questa rotta.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	I byte esatti della creatività della revisione.	nessun corpo; intestazioni: Accept-Ranges, Content-Length, ETag, Cache-Control
206	Un intervallo di byte conforme agli standard.	nessun corpo; intestazioni: Content-Range, ETag, Cache-Control
304	L’ETag della creatività corrisponde a If-None-Match, verificato dopo la risoluzione della revisione nel progetto venditore. Non viene prodotto corpo o incremento di uscita.	nessun corpo; intestazioni: ETag, Cache-Control
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Contenuto revisione pubblicità principale

Autenticazione: projectBearer
Corpo della richiesta: nessuno
ID operazione: headAdvertisingReviewContent

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio
Intervallo	intestazione	opzionale	V1 accetta solo un intervallo di byte.

Modello richiesta e risposte

shell · modello richiesta

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

Risposte

Stato	Significato	Corpo e intestazioni
200	Solo metadati.	nessun corpo; intestazioni: Content-Length, ETag
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)

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

Richiedi modifiche alla revisione pubblicitaria

Il venditore chiede all’acquirente modifiche a una revisione creativa inviata. La revisione diventa changes_requested con la nota in reason; l’acquirente la legge sulla creatività, e la revisione successiva che la campagna apre per questo venditore collega previous_review_id. Una persona deve poter approvare le revisioni (approver_required).

Autenticazione: projectBearer O dashboardSession
Corpo della richiesta: ReviewChangesRequest
ID operazione: requestAdvertisingReviewChanges

Parametri

Nome	Invia	Obbligatorio?	Descrizione
ScreenRig-Project	intestazione	opzionale	Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
id	path	obbligatorio

Campi del corpo della richiesta

Campo	Descrizione
nota (obbligatoria, stringa)	minLength: 1 maxLength: 500

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	La revisione, stato changes_requested.	AdvertisingReview (application/json)
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)