Content Variables

BroadSign Core can run content that pulls variables and customizes behaviours on-the-fly.

Our content variables are available for both HTML5 and Flash content.

BroadSign enables HTML5 (or Flash) files to retrieve different variables based on the context in which they play.

Automatic Variables

The following variables will always be automatically injected into all HTML5 (or Flash) files played by Broadsign Player:

    • display_unit_address: The address field of the display unit.
    • display_unit_location_code: The location code field of the display unit.
    • display_unit_resolution: The current resolution of the display unit type (WxH).
    • player_id: The ID of the player resource playing the ad copy.
    • frame_id: The ID of the frame in which the ad copy is playing.
    • frame_resolution: The current resolution of the frame in which the ad copy is playing (WxH).
    • campaign_id: The ID of the campaign that is playing the Flash ad copy.

There are four kinds of content variables:

    • Ad copy variables
    • Display unit variables
    • Player variables
    • Automatic variables (see Overview).

Identically-named variables adhere to the following precedence rules: player variables can override display unit variables, which in turn override ad copy variables. This allows defaults to cascade from the top down.

You can create your own variables in BroadSign Administrator. Three different types of resources can contain variables: ad copies, display units and players.

The process for adding any of these three types is basically the same. To illustrate, we will add an ad copy variable called bgcolor that could vary the image background, for example.

To add an ad copy variable:
  1. In BroadSign Administrator, select an HTML ad copy.
  2. Open the Ad Copy Properties.
  3. Go to Settings > Variables.
  4. Select Add.
  5. Enter the variable information:
      • Variable name: “bgcolour”
      • Value: “red”
  6. Click OK, and then click Apply.

player-api-dynamic-content-variables-adding

For more details about variables by resource type:

Depending on how you preview an HTML5 (or Flash) file in BroadSign Administrator, you will see different content variables. This is due to the context in which they are invoked.

    • Ad Copy Preview: Only content variables from the ad copy are injected. See the “Preview” section in Edit Ad Copy Properties.
    • Display Unit Preview: Content variables from the ad copy and display unit are injected. Also, the following automatic variables are injected: display_unit_address, display_unit_location_code, display_unit_resolution, frame_id, and frame_resolution. See the “Preview” section in Edit Display Unit Properties.