Action POP personnalisée

Votre contenu dynamique peut invoquer l’action custom_pop à tout moment du cycle de lecture. Vous aurez besoin du frame_id et de l'ad_copy_id de votre contenu (voir Propriétés de la copie publicitaire- L'onglet General et Modifier les propriétés du cadre). Transmettez ces valeurs à tout le contenu dynamique à l'aide de notre fonctionnalité de variables de contenu (voir Variables de contenu).

Broadsign Control Player enregistrera le contenu external1, external2 et custom-field qui apparaîtront dans vos rapports de preuve de diffusion. Voir API POP en temps réel et Broadsign POP Log.

Note : Si vous utilisez Broadsign Reach, les champs de valeur externes sont peut-être déjà utilisés. Le cas échéant, Broadsign Control Player ignorera toutes les valeurs POP personnalisées que vous fournissez.

Appelez l'action custom_pop en utilisant l'une des options suivantes :

Serveur WebSocket :

• JSON – Vous pouvez transmettre des paramètres depuis votre fichier HTML5 à l’aide de JSON.

  Note : Assurez-vous de sélectionner Enable Remote Control dans l’onglet Remote Control du profil de configuration. Voir L'onglet «Remote Control».

  Note : Si vous utilisez JSON via le serveur WebSocket, tout pare-feu présent sur Broadsign Control Player doit être configuré pour accéder directement au port 2326 pour utilisation.

Port 2324 :

• remote_action – Une application fournie avec Broadsign Control Player qui utilise la ligne de commande.
• XML – Si vous souhaitez développer vos propres applications, vous pouvez communiquer directement avec Broadsign Control Player API en utilisant XML.

Note : Assurez-vous de sélectionner Enable Remote Control dans l’onglet Remote Control du profil de configuration. Voir L'onglet «Remote Control».

Note : Tout pare-feu présent sur Broadsign Control Player doit être configuré pour permettre à bsp.exe d'ouvrir des ports, ou pour configurer directement le port 2324 ou le port 2326 pour l'utiliser.

Note : L'action Déclencheurs est la seule exception à cette règle. Elle utilise le port 2325. Voir Action Triggers.

Vous pouvez appeler cette action sur Windows et Ubuntu Linux, et la trouver via les chemins suivants :

• Windows (64 bits) :

C:\Program Files\BroadSign\bsp\bin

• Ubuntu Linux :

  /opt/broadsign/suite/bsp/bin/

Votre contenu dynamique peut invoquer l’action custom_pop à tout moment du cycle de lecture.

Par exemple, pour appeler custom_pop, tapez :

remote_action custom_pop -f <frame_id> --content-id <ad_copy_id> --external1 "ANY_STRING_1" --external2 "ANY_STRING_2" --custom-field '{<custom_json>}'

ou si vous souhaitez utiliser custom-field sans external1 et external2 :

remote_action custom_pop -f <frame_id> --content-id <ad_copy_id> --custom-field '{<custom_json>}'

Où:

• custom_pop est le type d'action
• -f est pour l'identifiant du cadre (voir Cadres)
• content-id est pour l'identifiant de la copie publicitaire (voir Copies publicitaires)
• external1, external2 et custom-field sont les noms des champs personnalisés
• custom_json contient des paires clé-valeur personnalisées écrites au format JSON, par exemple, {"key1": "value1", "key2":value2"}

Broadsign Control Player enregistrera le contenu external1, external2 et custom-field qui apparaîtront dans vos rapports de preuve de diffusion. Voir API POP en temps réel et Broadsign POP Log.

Une application peut injecter des champs de preuve de diffusion personnalisés sur Broadsign Control Player en envoyant un message XML au port monitor_remote (2324).

<rc version="1" id="1" action="custom_pop" frame_id="1234" content_id="4567" external_value_1="my_custom_dynamic_content" external_value_2="ANY STRING" custom_field '<custom_json>'/>\r\n\r\n

Note : Vous devez terminer la requête avec \r\n\r\n.

Le lecteur répondra avec le document suivant :

<rc id="1" version="1" action="custom_pop" status="1"/>

Note : Chaque commande envoyée nécessite un identifiant unique (id). L'application peut utiliser ici une valeur d'incrémentation simple.

Action POP personnalisée - Paramètres XML

Note : Tout pare-feu présent sur Broadsign Control Player doit être configuré pour permettre à bsp.exe d'ouvrir des ports, ou pour configurer directement le port 2324 ou le port 2326 pour l'utiliser.

Une application peut injecter des champs de preuve de diffusion personnalisés sur Broadsign Control Player en envoyant un message JSON au port 2326. Vous devrez activer le serveur WebSocket. Pour plus d'informations, voir L'onglet «Remote Control».

{
    "rc": {
        "version": "1",
        "id": "1",
        "action": "custom_pop",
        "frame_id": "12343",
        "content_id": "456738",
        "external_value_1": "my_custom_dynamic_content",
        "custom_field": "<custom_json>",
        "name": "ANY STRING"
    }
}

Le lecteur répondra avec le document suivant :

{
    "rc": {
        "id": "1",
        "version": "1",
        "action": "custom_pop",
        "status": "1"
    }
}

Action POP personnalisée - Paramètres JSON

Note : Si vous utilisez JSON via le serveur WebSocket, tout pare-feu présent sur Broadsign Control Player doit être configuré pour accéder directement au port 2326 pour utilisation.