confirm_playback

Description

Point de terminaison confirm_playback

Le point de terminaison confirm_playback est utilisé comme preuve de diffusion (POP) dans Broadsign Air.

La sortie de la requête confirm_playback est renvoyée dans le Broadsign POP Log, l'API POP en temps réel et le rapport sur les performances de la campagne de Broadsign Control.

Note : Pour une livraison plus efficace des jetons, nous vous recommandons de limiter les appels confirm_playback à 1 000 jetons et d'envoyer plusieurs requêtes confirm_playback si vous avez plus de 1 000 jetons.

Voir aussi :

Point de terminaison

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

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
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
confirmed_items Voir api.proto pour une définition. Tableau de ConfirmedItem O
ConfirmedItem.playlist_item_token

Le jeton PlaylistItem qui a été joué.

Note : Pour une livraison plus efficace des jetons, nous vous recommandons de limiter les appels confirm_playback à 1 000 jetons et d'envoyer plusieurs requêtes confirm_playback si vous avez plus de 1 000 jetons.

bytes O
ConfirmedItem.custom_data Retour de données POP personnalisées (par exemple pour le contenu dynamique). Map<string, string> F

Exemple

Voici un exemple de ConfirmPlayback :

Copier
curl -X POST https://air.broadsign.com/playlist/v1/confirm_playback \
-H 'Authorization: Bearer cbdbc369a063de6c0f458557f1456602' \
-d '{
"player_identifier": "abcd1234",
"screen_identifier" : "1",
"confirmed_items": [
  {
    "playlist_item_token":"CgphbGV4YW5kcmVjEgNVVEMaDAj22I7oBRCAhLjZASICCAUoAToDCNMBQgMIlRtKAwiSG2IDVVUwcgMI4BE=",
    "custom_data": { "ext1":"", "ext2": "" }
  }
]
}'