LiveRail Ads Embedded Parameters in Player V3

You can pass LiveRail ad-service-related tags to the Player with the embedded parameters described in the following table.

liverail-ads-manager Parameter

liverail-ads-manager - Use this parameter to pass certain LiveRail parameters (LR_ parameters) to communicate with LiveRail. liverail-ads-manager is supported for Flash and HTML5. A direct translation of the LiveRail parameters from Backlot to Dynamic params would be:
Backlot LiveRail Required Details
Publisher ID LR_PUBLISHER_ID Yes

Unique identifier for your LiveRail account.

Partner IDs LR_PARTNERS No

Revenue-sharing partner ID that has been created in the LiveRail system.

Tags LR_TAGS No

Keywords or content tags to pass to LiveRail's system for campaign targeting or reporting.

Ad Map LR_ADMAP No The standard way for defining when ads should play in video stream. Full details on the format for this key/value pair are available in LiveRail's Support Center.

By default the Ad Map configured in your LiveRail account will be applied, however if you specify an Ad Map for your Ad Set it will over-ride the default Ad Map configured in the LiveRail system. The table below explains the syntax and valid values for LR_ADMAP.

LR_ADMAP

The syntax for LR_ADMAP is LR_ADMAP=Type:Inventory_scenario_id:Time.

Table 1. LR_ADMAP Valid Values
Variable Input Based on Use Case
Type

For in-stream ads, set to "in".

For overlay ads, set to "ov".

Inventory_scenario_id The id value associated with a specific scenario.
Time

For in-stream ads, set to "n", where n is either the number of seconds or the percentage of time into the content. Ex: LR_ADMAP=in:test_scenario:100%. Ex: LR_ADMAP=in::0

For overlay ads, set to "n;m", where n is either the number of seconds into the content or percentage of time to start into content and m is either the number of seconds or percentage of time into content to stop the overlay. Ex: LR_ADMAP=ov::10%;ov::100%

  • The following JavaScript code example shows how the use of the liverail-ads-manager as a parameter of the OO.Player.create function. The only required parameter to display LiveRail ads is the Publisher ID, or LR_PUBLISHER_ID. The rest of the supported parameters are for targeting purposes.

    var videoPlayer = OO.Player.create('playerwrapper', 'embed_code', {
      height: '100%',
      width: '100%',
      'liverail-ads-manager': {
        'LR_PUBLISHER_ID': '13517',
        ...
      }
    });

    There is no integration of LiveRail ad manager and our Mobile SDKs. There is also no LiveRail mid-roll support for iOS.

Was this article helpful?