API POP en temps réel

Broadsign Control peut exporter les données de preuve de diffusion (POP) vers un emplacement externe pour les importer dans des plates-formes d'analyse tierces. Vous pouvez personnaliser les systèmes d'analyse et de reporting avec des informations de preuve de diffusion à la minute.

Vous contrôlez la fréquence à laquelle vous recevez les journaux de preuve de diffusion. La mise en cache des informations protège contre les pannes de réseau. Broadsign téléchargera les données dès que la connexion réseau sera rétablie, protégeant ainsi l'intégrité de vos statistiques.

Note : Le POP en temps réel est différent de Broadsign POP Log. Tandis que le POP en temps réel fournit des données quasi en temps réel, Broadsign POP Log exporte les journaux bruts de preuve de diffusion toutes les 24 heures. Voir Broadsign POP Log.

Prérequis

Le POP en temps réel est une fonctionnalité intermédiaire à avancée de Broadsign Control.

Avant de configurer cette fonctionnalité, assurez-vous d’être familiarisé avec les éléments suivants :

Comportement du cache

Le mécanisme de rapport de preuve de diffusion de l'API POP externe en temps réel est basé sur le comportement actuel de mise en cache POP du lecteur. Cela signifie que, en cas de panne de réseau, toutes les requêtes POP sont stockées localement de manière indéfinie et réessayées dès que le réseau est de nouveau disponible.

Note : L'API POP en temps réel soumet les requêtes POP à une URL différente de celle de l'URL Broadsign Server. Il est donc possible que Broadsign Server soit joignable et ingère correctement le POP, mais le serveur POP en temps réel configuré ne l'est pas. Dans ce cas, un enregistrement POP donné qui a été soumis avec succès au Broadsign Server, mais pas à l'API POP en temps réel, seront conservés et réessayés pendant environ 30 jours (300 000 enregistrements POP).

Pour plus d'informations, consultez L'onglet «Disk».

Prise en charge d'un proxy

Vos soumissions de preuves de diffusion externes doivent respecter tous les paramètres de proxy que vous avez configurés dans Broadsign Control Player. Pour plus d'informations, consultez L'onglet «Proxy».

Pour recevoir des données de preuve de diffusion en temps réel, vous devrez activer cette fonctionnalité dans un profil de configuration de votre lecteur.

Pour configurer le POP en temps réel :

  1. Créez une configuration.
  2. Créez un profil de configuration de lecteur.

  3. Ouvrez les propriétés du profil de configuration et accédez à Integrations > POP.

  4. Configurer les paramètres POP en temps réel :
    • Enable External POP reporting – Par défaut = faux. Lorsqu'il est activé, Broadsign Control Player va essayer de soumettre une preuve de diffusion à l'emplacement externe.
    • External URL – Une URL HTTP/HTTPS valide à laquelle la preuve de diffusion sera envoyée par la méthode HTTP POST. Obligatoire si la preuve de diffusion externe est activée.
    • API Key – Facultatif. Si spécifiée, Broadsign Control Player enverra cette chaîne de caractères avec chaque requête HTTP POST, renforçant ainsi la sécurité du service de preuve de diffusion externe.
    • Report POP immediately – S'il est activé, Broadsign soumettra une preuve de diffusion immédiatement après chaque enregistrement.
    • Report POP every X seconds – Si activé, Broadsign mettra en mémoire tampon la preuve de diffusion côté client et la soumettra toutes les X secondes. Plage valide : 1 à 65 535 secondes. Broadsign applique une randomisation de +/- 10 % côté client pour éviter la synchronisation de la soumission de la preuve de diffusion.
    • Max POPs per request – Valeur par défaut : 1000. Plage valide : 1-65 535. Ce paramètre contrôle le nombre maximal de preuves de diffusion à envoyer dans une seule requête HTTP POST.
    • Verbose mode – Par défaut : désactivé. Lorsqu'elle est activée, la preuve de diffusion au format JSON sera plus détaillée, c'est-à-dire qu'elle utilisera des dictionnaires au lieu de tableaux. Voir Interpréter le document JSON (protocole).
  5. Cliquez sur OK ou Apply.

Vous recevrez désormais les preuves de vos enregistrements de diffusion à un emplacement externe, à la fréquence de votre choix.

Ensuite, nous allons interpréter le document JSON.

Broadsign génère la preuve de diffusion sous forme de document JSON via HTTP/HTTP POST. L'encodage est UTF-8.

Les en-têtes HTTP sont :

  • Content-Type: application/json
  • Broadsign-Api-Key: api_key, où api_key a la même valeur que le paramètre api_key dans la charge utile, comme décrit dans le tableau ci-dessous.

Voici un exemple de document JSON (utilisant des tableaux) :

Copier 
{
        "api_key": "api_key",
        "player_id": 12345,
        "pop": [
            [display_unit_id, frame_id, n_screens, ad_copy_id, campaign_id, schedule_id, impressions, interactions, “end_time”, duration, “ext1”, “ext2”, "extra_data"],
            [display_unit_id, frame_id, n_screens, ad_copy_id, campaign_id, schedule_id, impressions, interactions, “end_time”, duration, “ext1”, “ext2”, "extra_data"]
        ]
        }

Voici un exemple de document JSON en mode verbeux (utilisant des dictionnaires) :

Copier 
{
        "api_key": "aabbccddeeff",
        "player_id": 12345,
        "pop": [
            {
            “display_unit_id” : 4456,
            “frame_id”: 4457,
            “n_screens” : 1,
            “ad_copy_id” : 5001,
            “campaign_id” :  5002,
            “schedule_id” :  5003,
            “impressions” : 2, 
            “interactions” : 0,
            “end_time” : “2016-05-31T10:14:50.000”,
            “duration” : 5000,
            “ext1” : “bmb”,
            “ext2” : “1234543”,
            "extra_data" : "custom_json"
            },
            {
            “display_unit_id” : 4456,
            “frame_id”: 4457,
            “n_screens” : 1,
            “ad_copy_id” : 5005,
            “campaign_id” :  5006,
            “schedule_id” :  5007,
            “impressions” : 5, 
            “interactions” : 0,
            “end_time” : “2016-05-31T10:14:55.000”,
            “duration” : 15000,
            “ext1” : “”,
            “ext2” : “”,
            "extra_data" : "custom_json"
        }

Les paramètres invariants sont :

Paramètre Description
api_key Il s'agit de la clé API telle que définie dans le profil de configuration. Voir Modifier les propriétés du lecteur.
player_id Il s'agit de l'identifiant du Broadsign Control Player (entier non signé 64 bits). Voir Modifier les propriétés du lecteur.

Les paramètres qui peuvent varier (à chaque partie) sont définis dans un tableau répétitif dans la section « pop » :

Paramètre Description
display_unit_id L'identifiant de l'unité d'affichage au moment de la lecture (entier non signé 64 bits). Voir Modifier les propriétés de l'unité d'affichage.
frame_id L'identifiant du cadre au moment de la lecture (entier non signé 64 bits). Voir Cadres.
n_screens Le nombre d'écrans actifs au moment de la lecture (entier non signé 32 bits). Voir Modifier les propriétés du lecteur.
ad_copy_id L'identifiant de la copie publicitaire diffusée (entier non signé 64 bits). Voir Modifier les propriétés de la copie publicitaire.
campaign_id L'identifiant de la campagne diffusée (entier non signé 64 bits). Voir La section General.
schedule_id L'identifiant de l'horaire diffusé (entier non signé 64 bits). Voir Modifier un horaire.
impressions Le nombre d'impressions générées par le contenu diffusé (entier non signé 32 bits). Voir Propriétés des partie de jour.
interactions Le nombre d'interactions générées par le contenu diffusé (entier non signé 32 bits). Voir Campagnes interactives.
end_time Horodatage ISO 8601 dans l'heure locale du lecteur qui indique l'heure à laquelle la lecture s'est terminée. Chaîne. Voir Modifier un horaire.
duration Durée de la lecture en millisecondes. entier non signé 32 bits. Voir Pages par défaut dans l'assistant Add Campaign Wizard.
ext1 Un champ de données supplémentaire qui identifie le nom d'un service externe, par exemple, pour Broadsign Publish, ce champ est défini sur bmb. Chaîne. Voir Broadsign Publish.
ext2

Un deuxième champ de données supplémentaire pouvant être enregistré sur une preuve de diffusion. En règle générale, il s'agit d'un champ personnalisé dépendant du service, par exemple, pour Broadsign Publish, ce champ est le creator_msg_id. Chaîne. Voir Broadsign Publish. Voir Action POP personnalisée.
extra_data

Données issues du champ custom_field de la fonctionnalité d'action distante custom_pop. Chaîne. Voir Action POP personnalisée.

Note : Si vous avez configuré l'action Custom POP, les paramètres ext1, ext2 et extra_data contiendront les détails de votre contenu dynamique, à savoir les informations external_value_1, external_value_2 et custom_field. Voir Action POP personnalisée.

Toute requête aboutissant à un code d'état HTTP de la classe 2xx est considérée comme réussie.

Broadsign considérera tout autre code de réponse comme un échec. Broadsign Control Player tentera ensuite de soumettre à nouveau les données.

Aussi, Broadsign ouvrira un incident externe qui comprendra :

  • le code de réponse HTTP ; et,
  • le point de terminaison de l'API.

Les erreurs possibles incluent :

  • Aucune réponse HTTP du serveur
  • Erreur SSL
  • Erreur d'envoi POP/URL

Note : Les incidents externes sont masqués par défaut dans Broadsign Control Administrator mais apparaîtront lorsque vous cocherez « Show External Incidents » dans le rapport d’incident. N'oubliez pas d'activer le signalement des incidents .