Content Variables

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

Example: Suppose a network operator wants to offer a "branded news" product to its customers. In this product, the customer could display their own logo beside the news. With content variables, the operator would need only a single HTML5 (or Flash) file. Each display unit or player would have a unique content variable defining the URL of the customer's logo. When the customer's player displays the HTML5 (or Flash) file, it can read the logo's URL from the content variables. Then, the content displays correctly.

Automatic Variables

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

Note: The impressions_per_hour and expected_impressions variables are not calculated for synchronized Campaigns on a Slave Frame.

Note: You are unable to override automatic variables.

Here are the different kinds of content variables used in Broadsign Control:

• Ad copy variables
• Display unit variables
• Player variables
• Automatic variables (see Automatic Variables)

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.

Note: You are unable to override automatic variables.

You can create your own variables in Broadsign Control 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 Control Administrator, select an HTML ad copy (see HTML Package Ad Copy).
2. Open the Ad Copy Properties (see Edit 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.

For more details about variables by resource type:

• Ad copy variables – In the Ad Copy Properties, go to Settings > Variables. See Variables Tab.
• Loop policy variables – In the Loop Policy Properties, go to Settings > Variables. See Variables Tab.
• Display unit variables – In the Display Unit Properties, go to Settings > Variables. See Variables Tab.
• Player variables – In the Player Properties, go to Settings > Variables. See The Variables Tab.

Depending on how you preview an HTML5 (or Flash) file in Broadsign Control 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. In the Ad Copy Properties, go to Preview. See The Preview Section.
• 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

  • frame_resolution

  In the Display Unit Properties, go to Preview. See The Preview Section.

Note: To view player content variables or the automatic variable player_id, you need to schedule the HTML file and run it on an active player system.

The following JavaScript code will add a table to an HTML page that lists available variables:

<script>
var table = document.createElement("TABLE");
table.border = "1";
document.body.appendChild(table);
 
var headerRow = document.createElement("TR");
table.appendChild(headerRow);
 
var headerVariable = document.createElement("TH");
headerVariable.innerHTML = "Variable";
headerRow.appendChild(headerVariable);
 
var headerValue = document.createElement("TH");
headerValue.innerHTML = "Value";
headerRow.appendChild(headerValue);
 
for (var propertyName in BroadSignObject) {
    var row = document.createElement("TR");
    table.appendChild(row);

    var variable = document.createElement("TD");
    variable.innerHTML = propertyName;
    row.appendChild(variable);
 
    var value = document.createElement("TD");
    value.innerHTML = BroadSignObject[propertyName];
    row.appendChild(value);
}
</script>

Note: To view player Flash variables or the automatic variable player_id, you need to schedule the Flash file and run it on an active player system.

The following ActionScript code will iterate through all the available Flash variables and print them out to the debug console. It is meant as an example only.

var myFlashvars:Object = new Object();
var vars:String = new String();
myFlashvars = this.loaderInfo.parameters;
for (var item:String in myFlashvars) {
    trace(item + ":t" + myFlashvars[item]);
}