Utiliser l'API d'allocation d'écran
Cet exemple illustre comment obtenir des informations sur l'occupation ou la disponibilité de l'inventaire d'un mois dans le passé jusqu'à 18 mois dans le futur.
Broadsign propose les options de stockage suivantes pour le rapport :
- Stockage hébergé par Broadsign – Il n'est pas nécessaire de configurer un stockage de votre côté ni de fournir des identifiants. Le service générera le rapport et renverra une URL de téléchargement présignée directement dans la réponse. Le lien reste valide pendant 24 heures.
- Stockage AWS S3 – La réponse de l'API est un fichier
.csvqui peut être stocké sur le service de stockage AWS S3 pris en charge. - Stockage Azure – La réponse de l'API est un fichier
.csvqui peut être stocké sur le service de stockage Azure pris en charge. - Stockage Azure avec jeton SAS – La réponse de l'API est un fichier
.csvqui peut être stocké sur le service de stockage Azure pris en charge.
Les points de terminaison et les paramètres de l'API REST Guaranteed Campaigns sont décrits dans la Référence de la méthode REST.
Note : Les numéros d'identification que nous utilisons dans ces échantillons sont fournis à titre d'illustration. Ils ne sont pas valides. Assurez-vous d’utiliser vos propres numéros d’identification pour vos intégrations.
Note : Tous les exemples de corps de requête dans ce document sont des fichiers JSON bruts.
Méthode de requête: POST
URL de requête: https://direct.broadsign.com/api/v1/reporting/screen_allocation
URL de documentation: Swagger /api/v1/reporting/screen_allocation
Vous pouvez vérifier les informations d'occupation ou de disponibilité des écrans numériques ou des faces statiques. La charge utile de la requête doit contenir les identifiants de stockage où vous souhaitez stocker la réponse de l'API.
Vous pouvez utiliser une option de stockage hébergée par Broadsign en utilisant le type BROADSIGN. Le service générera le rapport et renverra une URL de téléchargement présignée directement dans la réponse. Le lien reste valide pendant 24 heures.
Exemple de requête
curl --location 'https://direct.broadsign.net/api/v1/reporting/screen_allocation' \
--header 'Content-Type: application/json' \
--data '{
"storage": {
"type": "BROADSIGN"
}
}'
Exemple de réponse
{
"transaction_id": "9f8b1c61-4d4a-4b7d-bcb4-2a8d8feec445",
"url": "https://broadsign-storage.s3.amazonaws.com/screens/allocation/Allocation_2025-01-12T15-22-09Z_9f8b1c61-4d4a-4b7d-bcb4-2a8d8feec445.csv.gz?X-Amz-Expires=86400&X-Amz-Signature=..."
}
La charge utile de la requête diffère selon le service de stockage utilisé.
Requête (S3)
{
"storage":{
"type":"s3",
"credentials": {
"cloud_access_id":"id",
"cloud_access_key": "key",
"bucket_name":"demo-bucket-testing"
}
}
}
Requête (Azure)
{
"storage":{
"type":"AZURE",
"credentials": {
"Connection_string": "DefaultEndpointsProtocol=https;AccountName=demotestbroadsign;AccountKey=KEY;EndpointSuffix=core.windows.net",
"container_name":"testdemocci"
}
}
}
Requête (Azure avec jeton SAS)
Note : Les autorisations minimales suivantes sont requises dans le jeton SAS pour exécuter le point de terminaison : Écriture et Suppression.
{
"storage": {
"type": "AZURE",
"credentials": {
"account_endpoint": "https://zdlsneurdcpstg.blob.core.windows.net",
"container_name": "datalake",
"file_directory": "raw/broadsign/bsd/allocations/2023/04/04/Norway",
"shared_access_signature_token": "se=2023-04-06T13%3A27%3A48Z&sp=racwd&sv=2021-12-02&sr=d&sdd=8&sig=CleT81TTD/22EpkTznoqh4HG%2BZoUY3KWk9Kk7Zoab6A%3D"
}
}
}
Le format du fichier de réponse est un fichier .csv compressé stocké dans le service de stockage préféré spécifié par l'utilisateur.
Voici un exemple de fichier de réponse :
Voici les détails des champs du fichier de réponse :
| Nom du champ | Description |
|---|---|
| screen_id | Unité d'identification unique pour un écran ou une face. |
| running_date | Date à laquelle l'écran ou la face est actif. |
| running_times | Heures d'ouverture de l'écran. |
| dow_mask |
Jours de la semaine pendant lesquels l'écran est actif. Exemple: Mon - 1, Tue - 2, Wed - 4, Thu - 8, Fri - 16, Sat - 32, Sun - 64 |
| audience_calculation _method | Méthode de calcul de l'audience de l'écran (Prorated ou Dwell). |
| sum_slot_duration |
Somme de tous les créneaux réservés ou en attente dans la boucle (en secondes). Exemple: si |
| sum_slot_duration_held |
Somme de tous les créneaux retenus dans la boucle (en secondes). Le temps (en secondes) de toutes les lignes de diffusion retenues dans la boucle contribuera à ce nombre. |
| sum_slot_duration_takeover | Somme de tous les créneaux réservés ou retenus par des Prises de contrôle dans la boucle (en secondes). |
| impressions | Nombre d'impressions par heure. |
| cpm | Coût pour 1000 impressions dérivé des Cartes de tarif. |
| proposal_item_pressure | Tableau d'informations sur l'espace occupé par chaque ligne de diffusion sur l'écran (temps réservé et retenu en secondes par boucle). |
| fixed_slot_duration | Durée dans une boucle qui est fixée pour le contenu éditorial et non disponible pour la réservation. |
| loop_duration | Durée totale de la boucle ou longueur de la boucle. |
| real_loop_duration |
Durée dans une boucle qui est disponible pour la réservation. Ceci est défini dans la solution Content and Network Management. Pour plus d'informations, voir Part de boucle dans la documentation de Content and Network Management. |
minutes de lecture