generate

Description

Les points de terminaison generate sont utilisés pour générer des listes de lecture coté serveur dans Broadsign Air. Les points de terminaison suivants sont disponibles :

Note : Tous les horodatages inclus dans les listes de lecture utiliseront le fuseau horaire configuré dans Broadsign Control Administrator pour les unités d'affichage associées. Il est essentiel de s'assurer que le bon fuseau horaire est configuré. Si aucun fuseau horaire n'est configuré, le serveur utilisera par défaut GMT+0 pour la date de début et de fin des campagnes, des horaires et des heures d'ouverture sous cette unité d'affichage. Différentes unités d'affichage peuvent être configurées sur des fuseaux horaires différents si nécessaire. Pour plus d'informations, consultez Timezone.

generate v1

Point de terminaison generate v1

La version 1 de generate offre un support de base pour générer des listes de lecture.

Fonctionnalités

  • Lecture synchronisée : les lecteurs avec plusieurs écrans doivent récupérer les mêmes playlists. Si plusieurs lecteurs souhaitent utiliser la même playlist, ils doivent la récupérer avec le même player_id, mais avec un screen_id différent.
  • Prise en charge de la lecture hors ligne pendant 48 heures : Broadsign Air générera une liste de lecture pouvant durer jusqu'à 48 heures à utiliser si le lecteur perd la connectivité ou se déconnecte. Si le lecteur est hors ligne pendant plus de 48 heures et que la liste de lecture est épuisée, la liste de lecture reviendra au contenu de remplissage. Pour générer une playlist hors ligne de plus de 48 heures, utilisez le point de terminaison generate_long.
  • Contenu préemptif : Broadsign Air prend en charge le concept de campagne préemptive pour le contenu programmatique afin d'optimiser la diffusion de la campagne. Pour plus d'informations, voir Contenu préemptif (Broadsign Air).
  • Conditions planifiées : le point de terminaison vous permet de définir quand une condition doit être activée ou désactivée sur toutes les unités d'affichage associées. Voir L'onglet «Condition Schedule».

Limites

  • Synchronisation non garantie : la synchronisation entre les lecteurs n'est pas garantie entre les listes de lecture régulières et hors ligne. Lorsqu'un seul lecteur dispose de plusieurs écrans, il est recommandé de mettre en œuvre un mécanisme de synchronisation pour garantir la transition simultanée des listes de lecture normales vers les listes de lecture hors ligne. Le non-respect de cette consigne peut entraîner un enregistrement incomplet de la preuve de diffusion, en fonction du seuil. Voir Lecteurs synchronisés.
  • Broadsign Publish Contenu : Le point de terminaison ne prend pas en charge les listes de lecture contenant du contenu Broadsign Publish.

generate v2

Point de terminaison generate v2

La version 2 de generate ajoute la prise en charge jusqu'à 3 cadres.

Fonctionnalités

  • Lecture synchronisée : les lecteurs avec plusieurs écrans doivent récupérer les mêmes playlists. Si plusieurs lecteurs souhaitent utiliser la même playlist, ils doivent la récupérer avec le même player_id, mais avec un screen_id différent.
  • Prise en charge des cadres : le point de terminaison prend en charge jusqu'à 3 cadres pour l'affichage du contenu. Pour configurer plus d'un cadre, contactez Broadsign Services.
  • Prise en charge de la lecture hors ligne pendant 48 heures : Broadsign Air générera une liste de lecture pouvant durer jusqu'à 48 heures à utiliser si le lecteur perd la connectivité ou se déconnecte. Si le lecteur est hors ligne pendant plus de 48 heures et que la liste de lecture est épuisée, la liste de lecture reviendra au contenu de remplissage. Pour générer une playlist hors ligne de plus de 48 heures, utilisez le point de terminaison generate_long.
  • Synchronisation entre lecteurs : le point de terminaison prend en charge la synchronisation entre lecteurs sur une seule image.
  • Contenu préemptif : Broadsign Air prend en charge le concept de campagne préemptive pour le contenu programmatique afin d'optimiser la diffusion de la campagne. Pour plus d'informations, voir Contenu préemptif (Broadsign Air).
  • Conditions planifiées : le point de terminaison vous permet de définir quand une condition doit être activée ou désactivée sur toutes les unités d'affichage associées. Voir L'onglet «Condition Schedule».

Limites

  • Synchronisation non garantie : la synchronisation entre les lecteurs n'est pas garantie entre les listes de lecture régulières et hors ligne. Lorsqu'un seul lecteur dispose de plusieurs écrans, il est recommandé de mettre en œuvre un mécanisme de synchronisation pour garantir la transition simultanée des listes de lecture normales vers les listes de lecture hors ligne. Le non-respect de cette consigne peut entraîner un enregistrement incomplet de la preuve de diffusion, en fonction du seuil. Voir Lecteurs synchronisés.
  • Modifications de partie de la journée : le point de terminaison ne prend pas en charge les listes de lecture avec des éléments qui doivent être lus lors d'un changement de partie de la journée si la disposition du cadre est différente dans chaque partie de la journée.

Points de terminaison

https://air.broadsign.com/playlist/v1/generate

https://air.broadsign.com/playlist/v2/generate

Méthode HTTP

POST

Paramètres du corps de la requête

Paramètre Description Type Obligatoire (O) ou facultatif (F)

player_identifier

Un identifiant Custom Unique ID défini par l'utilisateur au sein du système Broadsign Control Player. Il est destiné à représenter de manière unique un seul emplacement physique ou lieu où le lecteur est déployé.

 string O
active_conditions

Utilise des conditions actives pour générer des listes de lecture spécifiques à ces conditions. Transmet un tableau d'objets Condition.

Pour plus d'informations, voir Critères et conditions.

 Tableau de conditions F
Condition.name Nom de la condition. Si active_conditions est utilisé, cela est obligatoire. string O
Condition.exclusive Si défini sur « true », après avoir généré la boucle, le lecteur supprimera tous les emplacements qui ne remplissent pas cette condition.
  • Si un créneau n'a aucune condition, le lecteur l'interprète comme s'il n'avait PAS de condition exclusive. Le lecteur le retire ensuite.
  • Si plusieurs conditions sont définies comme exclusives, le lecteur suppose une condition OU. Par conséquent, un lecteur bénéficiant de l'une des conditions exclusives appliquées restera dans la boucle.
 boolean F
screen_identifier

Identifie de manière unique les écrans individuels d'un lieu qui sont connectés au même Broadsign Control Player. C'est une valeur opaque fournie par le client.

Le screen_identifier permet de suivre avec précision le nombre d'écrans qui ont confirmé la lecture du contenu, ce qui est crucial pour fournir une preuve de lecture précise dans Broadsign Air.

Conseil : L'utilisation d'identifiants d'écran clairs et cohérents est essentielle pour générer des rapports de preuve de diffusion précis dans Broadsign Air.

Le même screen_identifier (par exemple, « screen-00 », « screen-01 ») peut être utilisé dans plusieurs lieux, c'est-à-dire qu'il peut être réutilisé dans différents player_identifiers.

Ce champ n'est pas obligatoire mais est fortement recommandé pour un suivi précis de la lecture.

Pour plus d'informations, voir Signaler les POP des lecteurs avec Broadsign Air.

 string F
duration

La durée, en secondes, couverte par la liste de lecture générée. La valeur par défaut est de 48 heures (172 800 secondes), ce qui est également la valeur maximale prise en charge.

Par exemple, si la durée est définie sur 48 heures, la playlist renvoyée couvrira les deux jours suivants. La durée totale des articles retournés peut être plus courte que la durée couverte, par exemple s'il y a des moments où rien n'est prévu à jouer.

Note : La définition d'une durée plus courte augmente le risque de manquer des éléments de la liste de lecture ou d'obtenir des écrans noirs en raison de temps d'arrêt ou de problèmes de réseau. Pour minimiser le risque de problèmes de lecture, il est recommandé d'utiliser les durées par défaut ou plus longues lorsque cela est possible.

Voir api.proto pour une définition.

 google.protobuf.Duration F
next_expected_poll

La prochaine fois que ce lecteur est censé demander une nouvelle liste de lecture. Si ce paramètre n'est pas spécifié dans la requête, le lecteur est considéré comme hors ligne. Broadsign Control utilise ce paramètre pour déterminer quand les lecteurs sont portés disparus. Pour plus d'informations, voir Incidents impliquant des lecteurs.

Le format <année>-<mois>-<jour>T<heure>:<minute>:<secondes>.<millisecondes>Z est pris en charge. Par exemple : 2021-09-23T20:00:00.000Z.

Note : Si la valeur next_expected_poll est inférieure à 20 minutes, elle est automatiquement réglée sur 20 minutes.

Voir api.proto pour une définition.

 google.protobuf.Timestamp F
exclude_programmatic_precaching_info

Active ou désactive la pré-mise en cache de Broadsign Reach.

Si défini sur True, renvoie uniquement l'information sur le contenu Broadsign Reach qui est réellement dans la playlist.

Ne pas définir ce paramètre ou le définir sur False renverra toutes les créations publicitaires Broadsign Reach approuvées.

 boolean F
force

L'activation de cette option entraînera les effets suivants :

  • Broadsign Air fera immédiatement une interrogation, peu importe quand la dernière interrogation a eu lieu.
  • Broadsign Air supprime la playlist stockée et force une régénération.

Lorsque cette option est activée, vous pouvez interroger jusqu'à 6 fois par heure. Après cela, Broadsign Air envoie un message d'erreur 429 Too Many Requests.

Note : Ce paramètre est conçu à des fins de développement ou de débogage. Il ne doit pas être activé dans un environnement de production en direct.

 boolean F

Réponse

Se référer à Réponse pour des informations complètes sur les paramètres de Réponse de Broadsign Air.