Publicité : référence de l’API, points de terminaison et exemples

OpenAPI YAML OpenAPI JSON problèmes YAML Vue d’ensemble de l’API

Ce groupe compte 46 opérations, générées à partir de api/openapi.yaml. Filtrez par chemin, action ou authentification. Chaque point de terminaison liste ses entrées ; développez-le pour voir un modèle de requête et les codes de réponse. Les modèles demandent vos propres valeurs et un corps conforme au schéma.

Remplacez les espaces réservés en majuscules par vos valeurs. Pour une requête JSON, enregistrez un corps correspondant au schéma dans request.json. Les exemples de cookies utilisent un pot à cookies local issu d’une session authentifiée.

Réseaux et campagnes publicitaires privés

GET/api/advertising/network¶

Obtenir le réseau publicitaire

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingNetwork

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Réseau.	AdvertisingNetwork (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

POST/api/advertising/network¶

Créer un réseau publicitaire

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingNetworkCreate
ID d’opération: createAdvertisingNetwork

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Champs du corps de la requête

Champ	Description
nom (obligatoire, chaîne)	maxLength : 120

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Réseau.	AdvertisingNetwork (application/json)
403	interdit - le projet ne dispose pas de la capacité écran ou a un forfait inconnu.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

POST/api/advertising/network/rate¶

Définir le taux publicitaire par défaut

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingRate
ID d’opération: setAdvertisingDefaultRate

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Champs du corps de la requête

Champ	Description
rate_mcr_per_15s (obligatoire, McrString)	Montant exact en millicrédits sous forme de chaîne décimale canonique. 1 crédit équivaut à 1000 mcr. motif : "^-?[0-9]+$"

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Réseau mis à jour.	AdvertisingNetwork (application/json)
412	revision_conflict - If-Match est périmé.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/inventory¶

Lister l’inventaire publicitaire

L’inventaire auquel le vendeur appelant a souscrit.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingInventory

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Inventaire.	AdvertisingInventoryList (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Mettre l’inventaire publicitaire

Met à jour ou crée l’inventaire d’un écran possédé. Vérifie la propriété de l’écran. Un remplacement de tarif à null rétablit l’héritage, pas zéro. Une modification qui change le tarif effectif d’une campagne acceptée met cette campagne en pause. Un écran dans un dossier d’écrans protégé donne protected_target (409).

Authentification: projectBearer
Corps de la requête: AdvertisingInventoryWrite
ID d’opération: putAdvertisingInventory

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
screen_id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.
Idempotency-Key	en-tête	optionnel	Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement.

Champs du corps de la requête

Champ	Description
impressions_per_hour (optionnel, en ligne)	L’estimation du vendeur des impressions que cet écran diffuse en une heure. Chaque diffusion terminée compte cette valeur multipliée par ses secondes, divisée par 3600, comme impressions estimées dans les rapports. Null ou absent signifie aucune estimation.
ads_enabled (obligatoire, booléen)
site_name (optionnel, chaîne)	maxLength : 120
ville (facultatif, chaîne)	maxLength : 120
région (optionnelle, chaîne)	maxLength : 120
venue_type (optionnel, chaîne)	maxLength : 64
audience_tags (optionnel, tableau)
emplacement (optionnel, chaîne)	maxLength : 120
public_description (optionnelle, chaîne)	maxLength : 500
rate_override_mcr_per_15s (optionnel, en ligne)	Null restaure l’héritage de la valeur par défaut du projet ; cela ne signifie jamais zéro.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Inventaire stocké.	AdvertisingInventory (application/json)
403	forbidden - l’écran n’appartient pas à ce projet ; outside_screen_scope ou approver_required pour un appelant limité aux écrans.	Problème (application/problem+json)
409	protected_target - l’écran est dans un dossier d’écrans protégé et la modification n’a aucune forme de révision (docs/screen-scope.md) ; levez la protection du dossier au moyen d’une révision, effectuez la modification, puis protégez de nouveau le dossier.	Problème (application/problem+json)
412	revision_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/slots¶

Lister les emplacements publicitaires

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingSlots

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Emplacements.	AdvertisingSlotList (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

POST/api/advertising/slots¶

Créer un emplacement publicitaire

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingSlotWrite
ID d’opération: createAdvertisingSlot

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Champs du corps de la requête

Champ	Description
nom (obligatoire, chaîne)	minLength : 1 maxLength : 120
activé (optionnel, booléen)
accepted_media (obligatoire, tableau)
max_image_duration_ms (obligatoire, entier)	minimum : 5 000 maximum : 30 000
max_video_duration_ms (obligatoire, entier)	minimum : 1 000 maximum : 120 000
rate_override_mcr_per_15s (optionnel, en ligne)
vast_tag_url (optionnel, en ligne)	La balise publicitaire VAST 2-4 propre au vendeur, testée quand aucune campagne invitée ne remplit ce créneau sur les écrans du vendeur. HTTPS sur port 443 ou 8443 vers un hôte public uniquement. Le backend le récupère, suit jusqu’à cinq Wrappers, ingère le MediaFile MP4 ou WebM progressif choisi dans les médias du projet, et déclenche Impression, creativeView et start à un début accepté, complete à une fin acceptée, et Error en cas d’échec. Les traceurs de quartiles ne sont pas déclenchés. Les macros [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] et [SCREENRIG_PAGE_ID] sont développées. Le slot doit accepter la vidéo. Null, absent ou vide efface la balise. Les acheteurs ne la voient jamais.

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
201	Emplacements.	AdvertisingSlot (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Mettre à jour l’emplacement publicitaire

Met à jour un emplacement vendeur. If-Match porte la révision de l’emplacement. Un changement de dépassement de tarif relance la barrière tarifaire. Un Idempotency-Key facultatif rejoue le résultat initial enregistré pendant 24 heures pour le même emplacement, corps et If-Match, même après d’autres modifications. Une réutilisation modifiée renvoie idempotency_mismatch. Une nouvelle écriture périmée renvoie revision_conflict.

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingSlotWrite
ID d’opération: updateAdvertisingSlot

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.
Idempotency-Key	en-tête	optionnel	Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement.

Champs du corps de la requête

Champ	Description
nom (obligatoire, chaîne)	minLength : 1 maxLength : 120
activé (optionnel, booléen)
accepted_media (obligatoire, tableau)
max_image_duration_ms (obligatoire, entier)	minimum : 5 000 maximum : 30 000
max_video_duration_ms (obligatoire, entier)	minimum : 1 000 maximum : 120 000
rate_override_mcr_per_15s (optionnel, en ligne)
vast_tag_url (optionnel, en ligne)	La balise publicitaire VAST 2-4 propre au vendeur, testée quand aucune campagne invitée ne remplit ce créneau sur les écrans du vendeur. HTTPS sur port 443 ou 8443 vers un hôte public uniquement. Le backend le récupère, suit jusqu’à cinq Wrappers, ingère le MediaFile MP4 ou WebM progressif choisi dans les médias du projet, et déclenche Impression, creativeView et start à un début accepté, complete à une fin acceptée, et Error en cas d’échec. Les traceurs de quartiles ne sont pas déclenchés. Les macros [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] et [SCREENRIG_PAGE_ID] sont développées. Le slot doit accepter la vidéo. Null, absent ou vide efface la balise. Les acheteurs ne la voient jamais.

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Emplacement mis à jour.	AdvertisingSlot (application/json)
409	idempotency_mismatch.	Problème (application/problem+json)
412	revision_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/memberships¶

Lister les adhésions publicitaires

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingMemberships

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Adhésions.	AdvertisingMembershipList (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Mettre à jour l’adhésion publicitaire

Modification explicite de la politique/portée du vendeur. Une adhésion active est modifiée ici, jamais par l’envoi d’une seconde invitation. Les changements de portée arrêtent la nouvelle sélection ; l’historique financier est conservé.

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingMembershipScope
ID d’opération: updateAdvertisingMembership

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Champs du corps de la requête

Champ	Description
politique (obligatoire, chaîne)	Autorisé : « trusted », « review_required »
screen_ids (obligatoire, tableau)
slot_ids (obligatoire, tableau)

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Adhésion mise à jour.	AdvertisingMembership (application/json)
412	revision_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Révoquer l’adhésion publicitaire

Révoque une adhésion. Empêche toute nouvelle sélection pour ce réseau ; cela ne supprime pas le drapeau annonceur, les autres adhésions ni l’historique réglé.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: revokeAdvertisingMembership

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Adhésion révoquée.	AdvertisingMembership (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/networks¶

Lister les réseaux publicitaires joints

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingJoinedNetworks

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Réseaux rejoints.	AdvertisingJoinedNetworkList (application/json)
403	interdit - le projet ne possède pas le drapeau annonceur.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Lister l’inventaire publicitaire joint

Inventaire opté et plages réutilisables à l’intérieur de l’adhésion de l’appelant. Ne révèle jamais les captures d’écran, listes de lecture ou données à l’échelle du projet du vendeur.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingJoinedInventory

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
seller_project_id	chemin	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Inventaire et emplacements autorisés.	AdvertisingJoinedInventory (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/creatives¶

Lister les créations publicitaires

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingCreatives

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Créations publicitaires.	AdvertisingCreativeList (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

POST/api/advertising/creatives¶

Créer une création publicitaire

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingCreativeCreate
ID d’opération: createAdvertisingCreative

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
Idempotency-Key	en-tête	optionnel	Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement.

Champs du corps de la requête

Champ	Description
media_id (obligatoire, chaîne)
copy (optionnel, chaîne)	maxLength : 500

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
201	Création publicitaire.	AdvertisingCreative (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Obtenir la création publicitaire

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingCreative

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Création publicitaire.	AdvertisingCreative (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/seller-campaigns¶

Lister les campagnes publicitaires du vendeur

Les campagnes d’acheteurs soumises du vendeur appelant, y compris les campagnes sans lecture et l’historique après la révocation de l’accès de l’acheteur. Retourne au maximum 100 campagnes, par ordre d’identifiant. Les brouillons, les autres réseaux et les budgets globaux de l’acheteur sont privés. Suivez next_after avec after jusqu’à ce qu’il soit absent.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingSellerCampaigns

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
après	requête	optionnel	Le next_after de la page précédente.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Campagnes d’acheteurs soumises sur le réseau de ce vendeur.	AdvertisingSellerCampaignList (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Obtenir la campagne publicitaire du vendeur

Vue en lecture seule du vendeur pour une campagne d’acheteur soumise. L’inventaire et la diffusion réglée cumulée depuis l’origine ne couvrent que le vendeur appelant. Les finances globales de l’acheteur et les autres réseaux sont privés. Un vendeur étranger à la campagne obtient not_found.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingSellerCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Les détails de la campagne et de la diffusion du vendeur.	AdvertisingSellerCampaignDetail (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/campaigns¶

Lister les campagnes publicitaires

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingCampaigns

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Campagnes.	AdvertisingCampaignList (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

POST/api/advertising/campaigns¶

Créer une campagne publicitaire

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingCampaignDraft
ID d’opération: createAdvertisingCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Champs du corps de la requête

Champ	Description
nom (obligatoire, chaîne)	minLength : 1 maxLength : 120
category (optionnel, AdvertisingCategory)	La catégorie de l’annonceur. Deux publicités d’une même catégorie ne jouent jamais dans la même pause publicitaire sur un écran ; une publicité sans catégorie n’est jamais séparée. Autorisés : « 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 (obligatoire, McrString)	Montant exact en millicrédits sous forme de chaîne décimale canonique. 1 crédit équivaut à 1000 mcr. motif : "^-?[0-9]+$"
lifetime_cap_mcr (obligatoire, McrString)	Montant exact en millicrédits sous forme de chaîne décimale canonique. 1 crédit équivaut à 1000 mcr. motif : "^-?[0-9]+$"
image_duration_ms (optionnel, entier)	Durée d’affichage de l’image pour toute la campagne. Les vidéos conservent leur durée vérifiée par le serveur. par défaut : 10000 minimum : 5000 maximum : 30000
max_play_price_mcr (optionnel, en ligne)	Prix maximum positif de lecture terminée. Omettre pour aucun plafond supplémentaire.
flight_start (obligatoire, chaîne)	format : « date-time »
flight_end (obligatoire, chaîne)	format : « date-time »
réseaux (obligatoire, tableau)

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
201	Campagne brouillon.	AdvertisingCampaign (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Obtenir la campagne publicitaire

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne.	AdvertisingCampaign (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Mettre à jour la campagne publicitaire

Met à jour une campagne brouillon. If-Match porte la révision de la campagne. Une réduction de budget en dessous des dépenses déjà engagées plus les réservations engagées est rejetée avec la valeur minimale permise.

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingCampaignDraft
ID d’opération: updateAdvertisingCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Champs du corps de la requête

Champ	Description
nom (obligatoire, chaîne)	minLength : 1 maxLength : 120
category (optionnel, AdvertisingCategory)	La catégorie de l’annonceur. Deux publicités d’une même catégorie ne jouent jamais dans la même pause publicitaire sur un écran ; une publicité sans catégorie n’est jamais séparée. Autorisés : « 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 (obligatoire, McrString)	Montant exact en millicrédits sous forme de chaîne décimale canonique. 1 crédit équivaut à 1000 mcr. motif : "^-?[0-9]+$"
lifetime_cap_mcr (obligatoire, McrString)	Montant exact en millicrédits sous forme de chaîne décimale canonique. 1 crédit équivaut à 1000 mcr. motif : "^-?[0-9]+$"
image_duration_ms (optionnel, entier)	Durée d’affichage de l’image pour toute la campagne. Les vidéos conservent leur durée vérifiée par le serveur. par défaut : 10000 minimum : 5000 maximum : 30000
max_play_price_mcr (optionnel, en ligne)	Prix maximum positif de lecture terminée. Omettre pour aucun plafond supplémentaire.
flight_start (obligatoire, chaîne)	format : « date-time »
flight_end (obligatoire, chaîne)	format : « date-time »
réseaux (obligatoire, tableau)

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne mise à jour.	AdvertisingCampaign (application/json)
412	revision_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Devis campagne publicitaire

Tarifie les taux effectifs actuels de la campagne, les formats, durées, période de diffusion et plafonds avant activation. Le devis est limité dans le temps et devient périmé dès qu’une génération de tarification ou un taux effectif change.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: quoteAdvertisingCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
201	Devis.	AdvertisingQuote (application/json)
412	revision_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Activer la campagne publicitaire

Accepte explicitement le devis actuel nommé et active la campagne. Vérifie atomiquement la propriété, l’adhésion, l’expiration du devis, les révisions tarifaires, la portée acceptée et le refus de même projet, puis enregistre les conditions d’achat. Aucun débit de portefeuille ni revenu vendeur ne survient lors de l’acceptation des conditions. La même clé avec le même corps rejoue ; un corps modifié est un conflit.

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingQuoteAccept
ID d’opération: activateAdvertisingCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.
Idempotency-Key	en-tête	optionnel	Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement.

Champs du corps de la requête

Champ	Description
quote_id (obligatoire, chaîne)

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne active ou en attente d’examen.	AdvertisingCampaign (application/json)
409	quote_stale ou self_deal ou resource_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Mettre la campagne publicitaire en pause

Met en pause les nouvelles réservations pour cette campagne. Les publicités valides déjà commencées se terminent normalement et sont facturées à la fin.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: pauseAdvertisingCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne en pause.	AdvertisingCampaign (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Reprendre la campagne publicitaire

Reprend une campagne mise en pause manuellement. Elle ne peut pas lever un blocage price_change_pending ; une recharge, un tick d’horaire ou une action du vendeur ne peut fournir ce consentement.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: resumeAdvertisingCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne reprise.	AdvertisingCampaign (application/json)
409	price_change_pending - acceptez d’abord les tarifs actuels.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Accepter les tarifs publicitaires

L’acceptation explicite de l’acheteur des tarifs effectifs modifiés, liée à l’ID du devis, à la révision de la campagne et aux générations de tarification actuelles. Elle remplace atomiquement les conditions de livraison futures, enregistre l’acteur et l’heure, et supprime le blocage persistant de changement de prix. Un autre changement de tarif simultané met la campagne en pause.

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingQuoteAccept
ID d’opération: acceptAdvertisingRates

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Champs du corps de la requête

Champ	Description
quote_id (obligatoire, chaîne)

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne réactivée.	AdvertisingCampaign (application/json)
409	price_change_pending ou quote_stale.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/reviews¶

Lister les revues publicitaires

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingReviews

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Révisions.	AdvertisingReviewList (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Approuver la révision publicitaire

Approuve une révision créative soumise exacte. L’approbation ne choisit pas le budget de l’acheteur ni n’accorde l’accès à sa bibliothèque de médias. Une personne doit pouvoir approuver les révisions (approver_required). La même révision est aussi accessible comme type ad_creative sous /api/reviews.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: approveAdvertisingReview

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Révision approuvée.	AdvertisingReview (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Rejeter la révision publicitaire

Rejette une révision exacte soumise d’une création avec une raison que l’acheteur lit sur la création. Une personne doit pouvoir approuver les révisions (approver_required).

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingReviewRejection
ID d’opération: rejectAdvertisingReview

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Champs du corps de la requête

Champ	Description
raison (obligatoire, chaîne)	minLength : 1 maxLength : 500

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Révision rejetée.	AdvertisingReview (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/reports/spend¶

Obtenir les dépenses publicitaires

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingSpend

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
format	requête	optionnel	json (par défaut) renvoie le rapport en JSON. csv, xlsx et pdf renvoient les mêmes lignes en pièce jointe (chaque page d'un rapport paginé, jusqu'à 50000 lignes).
campaign_id	requête	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Rapport de dépenses.	AdvertisingSpendReport (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/reports/delivery¶

Obtenir la diffusion publicitaire

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

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

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingDelivery

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
format	requête	optionnel	json (par défaut) renvoie le rapport en JSON. csv, xlsx et pdf renvoient les mêmes lignes en pièce jointe (chaque page d'un rapport paginé, jusqu'à 50000 lignes).
de	requête	obligatoire
à	requête	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Rapport de livraison.	AdvertisingDeliveryReport (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/direct-campaigns¶

Lister les campagnes publicitaires directes

Les campagnes directes du vendeur appelant, la plus récente en premier, avec leur rythme.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listAdvertisingDirectCampaigns

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Campagnes directes.	AdvertisingDirectCampaignList (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

POST/api/advertising/direct-campaigns¶

Créer une campagne publicitaire directe

Réserve une campagne directe, une entente conclue par le vendeur avec un annonceur externe, sur son propre inventaire publicitaire. Elle ne déplace aucun fonds ; le vendeur facture l’annonceur et le prix est enregistré pour la valeur du rapport. Elle est active immédiatement et remplit les emplacements avant les campagnes de la place de marché.

Une campagne avec objectif est cadencée uniformément sur sa période de diffusion et joue en premier tant qu’elle est en retard sur le rythme ; une campagne sans objectif prend tous les emplacements admissibles pendant sa période de diffusion. Deux publicités d’une même catégorie ne jouent jamais dans la même pause publicitaire sur un écran. Un objectif supérieur à l’estimation de disponibilité est refusé avec goal_overbooked, sauf si overbook est true.

La même clé avec le même corps rejoue la réponse ; un corps modifié est un conflit.

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingDirectCampaignDraft
ID d’opération: createAdvertisingDirectCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
Idempotency-Key	en-tête	obligatoire

Champs du corps de la requête

Champ	Description
nom (obligatoire, chaîne)	minLength : 1 maxLength : 200
advertiser (obligatoire, string)	minLength : 1 maxLength : 200
category (optionnel, AdvertisingCategory)	La catégorie de l’annonceur. Deux publicités d’une même catégorie ne jouent jamais dans la même pause publicitaire sur un écran ; une publicité sans catégorie n’est jamais séparée. Autorisés : « 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 (obligatoire, chaîne)	format : « date-time »
flight_end (obligatoire, chaîne)	format : « date-time »
goal_plays (optionnel, integer)	Les lectures à livrer, cadencées uniformément sur la période de diffusion. Zéro ou omis prend tous les emplacements admissibles pendant la période de diffusion. minimum : 0 maximum : 1000000000000
price (optionnel, AdvertisingDirectPrice)	Le prix de l’entente enregistré par le vendeur. screenRIG ne le facture jamais ; il sert à valoriser le rapport.
media_ids (obligatoire, array)	Les images et vidéos prêtes du vendeur, chacune nommée une seule fois.
image_duration_ms (optionnel, entier)	Durée d’affichage de l’image pour toute la campagne. Les vidéos conservent leur durée vérifiée par le serveur. par défaut : 10000 minimum : 5000 maximum : 30000
screen_ids (optionnel, array)	Vide signifie tous les écrans inscrits.
slot_ids (optionnel, array)	Vide signifie tous les emplacements activés.
venue_types (optionnel, array)
cities (optionnel, array)
tags (optionnel, array)
dayparts (optionnel, array)
overbook (optionnel, boolean)	Réserve un objectif supérieur à l’estimation de disponibilité. Sans cela, la requête est refusée avec goal_overbooked. par défaut : false

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
201	Campagne directe.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — le forfait du projet n’inclut pas les campagnes directes ; required_plan nomme le forfait qui les inclut.	Problème (application/problem+json)
409	goal_overbooked ou resource_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Obtenir une campagne publicitaire directe

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingDirectCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne directe.	AdvertisingDirectCampaign (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Mettre à jour une campagne publicitaire directe

Remplace les champs du brouillon de la campagne. If-Match porte la révision de la campagne. Les lectures livrées sont conservées. Les lectures restant à livrer sont vérifiées par rapport à l’estimation de disponibilité sans compter la propre réservation de la campagne, et overbook les réserve quand même.

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingDirectCampaignDraft
ID d’opération: updateAdvertisingDirectCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Champs du corps de la requête

Champ	Description
nom (obligatoire, chaîne)	minLength : 1 maxLength : 200
advertiser (obligatoire, string)	minLength : 1 maxLength : 200
category (optionnel, AdvertisingCategory)	La catégorie de l’annonceur. Deux publicités d’une même catégorie ne jouent jamais dans la même pause publicitaire sur un écran ; une publicité sans catégorie n’est jamais séparée. Autorisés : « 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 (obligatoire, chaîne)	format : « date-time »
flight_end (obligatoire, chaîne)	format : « date-time »
goal_plays (optionnel, integer)	Les lectures à livrer, cadencées uniformément sur la période de diffusion. Zéro ou omis prend tous les emplacements admissibles pendant la période de diffusion. minimum : 0 maximum : 1000000000000
price (optionnel, AdvertisingDirectPrice)	Le prix de l’entente enregistré par le vendeur. screenRIG ne le facture jamais ; il sert à valoriser le rapport.
media_ids (obligatoire, array)	Les images et vidéos prêtes du vendeur, chacune nommée une seule fois.
image_duration_ms (optionnel, entier)	Durée d’affichage de l’image pour toute la campagne. Les vidéos conservent leur durée vérifiée par le serveur. par défaut : 10000 minimum : 5000 maximum : 30000
screen_ids (optionnel, array)	Vide signifie tous les écrans inscrits.
slot_ids (optionnel, array)	Vide signifie tous les emplacements activés.
venue_types (optionnel, array)
cities (optionnel, array)
tags (optionnel, array)
dayparts (optionnel, array)
overbook (optionnel, boolean)	Réserve un objectif supérieur à l’estimation de disponibilité. Sans cela, la requête est refusée avec goal_overbooked. par défaut : false

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne directe mise à jour.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — le forfait du projet n’inclut pas les campagnes directes ; required_plan nomme le forfait qui les inclut.	Problème (application/problem+json)
409	goal_overbooked ou resource_conflict.	Problème (application/problem+json)
412	revision_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Mettre en pause une campagne publicitaire directe

Arrête les nouvelles lectures d’une campagne active. Les lectures livrées et la période de diffusion sont conservées. Une campagne en pause ou terminée est un resource_conflict.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: pauseAdvertisingDirectCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne directe en pause.	AdvertisingDirectCampaign (application/json)
412	revision_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Reprendre une campagne publicitaire directe

Reprend une campagne directe en pause. Une campagne avec objectif qui a pris du retard sur le rythme pendant la pause joue en premier jusqu’à ce qu’elle l’ait rattrapé. Une campagne active ou terminée est un resource_conflict.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: resumeAdvertisingDirectCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne directe reprise.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — le forfait du projet n’inclut pas les campagnes directes ; required_plan nomme le forfait qui les inclut.	Problème (application/problem+json)
412	revision_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Terminer une campagne publicitaire directe

Termine une campagne active ou en pause avant la fin de sa période de diffusion. Une campagne terminée ne joue plus et conserve son rapport.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: endAdvertisingDirectCampaign

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
If-Match	en-tête	optionnel	Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict.

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Campagne directe terminée.	AdvertisingDirectCampaign (application/json)
412	revision_conflict.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Obtenir le rapport d’une campagne publicitaire directe

La livraison d’une campagne directe pour une fenêtre, avec son rythme, la valeur enregistrée des lectures livrées et des lignes par jour UTC, écran, emplacement et média. Sans from et to, la fenêtre est toute la période de diffusion. Quand la fenêtre contient plus de lignes que le rapport n’en liste, la réponse définit truncated et les totaux couvrent toujours chaque lecture.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingDirectCampaignReport

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
format	requête	optionnel	json (par défaut) renvoie le rapport en JSON. csv, xlsx et pdf renvoient les mêmes lignes en pièce jointe (chaque page d'un rapport paginé, jusqu'à 50000 lignes).
id	chemin	obligatoire
de	requête	optionnel
à	requête	optionnel

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Rapport de campagne directe.	AdvertisingDirectReport (application/json)
402	feature_not_in_plan — le forfait du projet n’inclut pas les campagnes directes ; required_plan nomme le forfait qui les inclut.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

POST/api/advertising/availability¶

Estimer la disponibilité publicitaire

Estime les lectures qu’un objectif direct peut réserver sur l’inventaire et la période de diffusion donnés. Il s’agit d’une consultation qui ne change rien. L’estimation correspond aux occurrences récentes d’emplacement publicitaire des écrans ciblés, projetées sur la période de diffusion, moins les objectifs dont d’autres campagnes directes ont encore besoin sur les mêmes écrans.

Authentification: projectBearer OU dashboardSession
Corps de la requête: AdvertisingAvailabilityQuery
ID d’opération: estimateAdvertisingAvailability

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Champs du corps de la requête

Champ	Description
screen_ids (optionnel, array)	Vide signifie tous les écrans inscrits.
slot_ids (optionnel, array)	Vide signifie tous les emplacements activés.
venue_types (optionnel, array)
cities (optionnel, array)
tags (optionnel, array)
dayparts (optionnel, array)
flight_start (obligatoire, chaîne)	format : « date-time »
flight_end (obligatoire, chaîne)	format : « date-time »
exclude_campaign_id (optionnel, string)	Exclut la propre réservation de cette campagne directe de booked_plays, pour une modification.

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Estimation de disponibilité.	AdvertisingAvailability (application/json)
402	feature_not_in_plan — le forfait du projet n’inclut pas les campagnes directes ; required_plan nomme le forfait qui les inclut.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/advertising/reports/fill¶

Obtenir les statistiques de remplissage publicitaire

L’offre d’emplacements publicitaires du vendeur appelant pour une fenêtre, par jour UTC et au total. Chaque occurrence est remplie par une campagne directe, une campagne de marché ou la balise VAST, ou reste non remplie avec sa raison. La fenêtre demandée est de 35 jours au plus et couvre par défaut les 7 derniers jours. L’offre a une précision horaire.

Toutes les heures UTC chevauchant la fenêtre semi-ouverte demandée sont incluses au complet; from est arrondi vers le bas et to vers le haut aux limites horaires UTC. Un to déjà aligné reste exclusif. La réponse renvoie ces bornes effectives, qui peuvent couvrir jusqu’à 35 jours plus une heure.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingFillStats

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
format	requête	optionnel	json (par défaut) renvoie le rapport en JSON. csv, xlsx et pdf renvoient les mêmes lignes en pièce jointe (chaque page d'un rapport paginé, jusqu'à 50000 lignes).
de	requête	optionnel
à	requête	optionnel

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Statistiques de remplissage.	AdvertisingFillStats (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Obtenir la revue publicitaire

Détail du vendeur pour un avis de son réseau. Retourne l’avis et la version exacte de la création soumise. Ne révèle jamais les autres médias de l’acheteur.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingReview

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Révision et sa création publicitaire.	AdvertisingReviewDetail (application/json)
404	not_found - l’évaluation est inconnue de ce vendeur.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Obtenir le contenu de la revue publicitaire

Diffuse uniquement la révision créative exacte à laquelle la propre révision de cet acheteur fait référence. La propriété reste au projet acheteur ; aucune clé d’objet ni emplacement signé n’est publié, et aucun autre média acheteur n’est accessible. L’ETag est le SHA-256 fort de la création et ne change jamais pour une révision.

Une réponse de session de tableau de bord est privée, no-cache, donc le navigateur garde une copie et la revalide ; une réponse de porteur de projet reste privée, no-store.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getAdvertisingReviewContent

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
Plage	en-tête	optionnel	V1 accepte une seule plage d’octets.
If-None-Match	en-tête	optionnel	ETag fort créatif SHA-256 renvoyé par cette route.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Les octets exacts de la création publicitaire de l’examen.	pas de corps; en-têtes : Accept-Ranges, Content-Length, ETag, Cache-Control
206	Une plage d’octets conforme aux normes.	pas de corps; en-têtes : Content-Range, ETag, Cache-Control
304	L’ETag de la création correspond à If-None-Match, vérifié après résolution de la revue dans le projet vendeur. Aucun corps ni incrément d’export n’est produit.	pas de corps; en-têtes : ETag, Cache-Control
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Contenu de revue publicitaire principale

Authentification: projectBearer
Corps de la requête: aucun
ID d’opération: headAdvertisingReviewContent

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
Plage	en-tête	optionnel	V1 accepte une seule plage d’octets.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Métadonnées uniquement.	pas de corps; en-têtes : Content-Length, ETag
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Demander des modifications de révision publicitaire

Le vendeur demande à l’acheteur des modifications à une révision de création soumise. La revue devient changes_requested avec la note dans reason ; l’acheteur la lit sur la création, et la revue suivante que la campagne ouvre pour ce vendeur lie previous_review_id. Une personne doit pouvoir approuver les revues (approver_required).

Authentification: projectBearer OU dashboardSession
Corps de la requête: ReviewChangesRequest
ID d’opération: requestAdvertisingReviewChanges

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Champs du corps de la requête

Champ	Description
note (obligatoire, chaîne)	minLength : 1 maxLength : 500

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	L’examen, état changes_requested.	AdvertisingReview (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)