generate_long

Description

generate_long Endpoint

The generate_long endpoint allows Players to fetch offline playlists that are available for up to 14 days, compared to 48 hours for the generate endpoint. This is helpful in case a Player experiences a prolonged outage.

After the generate_long playlist has expired, it will fall back on filler content.

Note: Any timestamps included in the playlists will use the timezone configured in Broadsign Control Administrator for the related Display Units. It is essential to ensure that the correct timezone is configured. If no timezone is set, the server will default to GMT+0 for the start and end date of campaigns, schedules, and opening hours under that Display Unit. Different Display Units can be set to different timezones if needed. For more information, see Timezone.

Features

  • Offline Playlist Retrieval: Players can fetch offline playlists that are available for up to 14 days. The default value for Domains is 14 days, but this can be reduced to to manage disk space by contacting Broadsign Services.
  • Synchronized Playback: Players with multiple screens must retrieve the same playlists. If several Players want to use the same playlist, they must fetch it with the same player_id, but with a different screen_id.
  • Frame Support: The endpoint supports up to 3 frames for content display. To configure more than 1 frame, contact Broadsign Services.

Limitations

  • Programmatic Content: Programmatic content cannot be retrieved from offline playlists. Any Broadsign Reach slot will be replaced by preemptible content directly, if available. Use the generate calls when online to get programmatic content.
  • Synchronization Not Guaranteed: Synchronization across players is not guaranteed between regular and offline playlists. When a single player has multiple screens, it's recommended to implement a synchronization mechanism to ensure they transition from regular to offline playlists simultaneously. Failure to do so may lead to incomplete proof-of-play recording, depending on the threshold.
  • Day Part Changes: The endpoint does not support playlists with items that are expected to play across a day part change if the frame layout is different in each day part.
  • Cross-Player Sync: The endpoint does not support cross-player sync.
  • Scheduled Conditions: The endpoint does not support scheduled conditions.

See also:

Endpoint

https://air.broadsign.com/playlist/v2/generate_long

HTTP Method

POST

Request Body Parameters

Parameter Description Type Required (R) or Optional (O)
player_identifier

A user-defined Custom Unique ID identifier within the Broadsign Control Player system. It is intended to uniquely represent a single physical location or venue where the player is deployed.

 string R
screen_identifier

Uniquely identifies individual screens within a venue that are connected to the same Broadsign Control Player. It is a customer-provided opaque value.

The screen_identifier helps accurately track how many screens have confirmed playback of content, which is crucial for providing accurate proof of plays in Broadsign Air.

Tip: Using clear and consistent screen identifiers is essential for generating accurate proof of play reports in Broadsign Air.

The same screen_identifier (for example, "screen-00", "screen-01") can be used across multiple venues, that is, they can be reused throughout different player_identifiers.

This field is not mandatory but is highly recommended for precise playback tracking.

For more information, see Reporting Players POPs with Broadsign Air.

 string O
date

Date for which the playlist is requested. The format is:

"date": { "year": "[year]", "month": "[month]", "day": "[day]" }

For example: "date": { "year": "2024", "month": "10", "day": "20" }

 JSON R
force

Enabling this option will result in the following:

  • Broadsign Air immediately polls, no matter when the last poll was.
  • Broadsign Air deletes the stored playlist and forces a regeneration.

When enabled, you can poll up to 6 times every hour. After that, Broadsign Air sends a 429 Too Many Requests error message.

Note: This parameter is designed for development or debugging purposes. It should not be enabled in a live production environment.

 boolean O

Response

Refer to Response for complete information about the Broadsign Air Response parameters.