confirm_playback

Description

The confirm_playback endpoint is used as a Proof-of-Play (POP).

The output of the confirm_playback request is returned in the Broadsign POP Log, Real-Time POP API and Campaign Performance Report of Broadsign Control.

See also:

Endpoint

https://air.control-prod.broadsign.com/playlist/v1/confirm_playback

HTTP Method

POST

Request Body Parameters

Parameter Description Type Required (R) or Optional (O)
player_identifier Unique Broadsign Control Player identifier, expected to represent a unique venue. string R
screen_identifier Identifier for one screen within a venue. See Reporting Players POPs with Broadsign Air for more details. string O
confirmed_items See api.proto for definition. Array of ConfirmedItem R
ConfirmedItem.playlist_item_token The PlaylistItem token that played. bytes R
ConfirmedItem.custom_data Pass-back of custom POP data (e.g for dynamic content ). Map<string, string> O

Example

The following is an example of ConfirmPlayback:

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