Description
confirm_playback Endpoint
The confirm_playback endpoint is used as a Proof-of-Play (POP) in Broadsign Air.
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.
Note: For the most efficient delivery of tokens, we recommend limiting confirm_playback calls to 1,000 tokens and sending multiple confirm_playback requests if you have more than 1,000 tokens.
See also:
Endpoint
https://air.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. Note: For the most efficient delivery of tokens, we recommend limiting confirm_playback calls to 1,000 tokens and sending multiple confirm_playback requests if you have more than 1,000 tokens. |
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:
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": "" }
}
]
}'