Ooyala Pulse Ad Parameters

Use the following parameters to configure Ooyala Pulse ads in Player V4 using the Ooyala Pulse Ad Plugin. See Integrating Ooyala Pulse Ads for details.
Note: These parameters are specific to Ooyala Pulse ads. You can also set global parameters for Pulse ads. See Configuring Ad Parameters for details.

Ooyala Pulse-specific Embedded Parameters

Name Description Type Required?


The parent parameter for Ooyala Pulse ads embedded parameters.

Required: Yes



host URL: When the SDK is initialised, the host for the Ooyala Pulse account must be provided. This is used to identify which Pulse account to request ads from. The host is derived from the "sub-domain” found in the Pulse UI and is formulated like this:
Note: The Pulse host must be set in the integration with this parameter, or as Custom Metadata on the video asset in Backlot, or as vpDomain in the Backlot Ad Set associated with the video asset.
string See Note


Allow clients to provide callbacks which can be used to provide internal instances not otherwise available from the plugin.

An array of callback functions. The following functions are available:

  • onSessionCreated: argument is the session and the function is called whenever a Pulse session is created. This way you get access to the session object, and can extend the session when needed. See HTML5 Pulse SDK for an example of session extension and further links to the SDK documentation.
  • onAdPlayerCreated: argument is the ad player and the function is called whenever a Pulse ad player is created.
pulse_callbacks: {
  onSessionCreated: function(session){ 
    console.log('> Session created:', session); }
  onAdPlayerCreated: function(adPlayer){ 
    console.log('> Ad player created:', adPlayer); }
array No


category: The category is a string that is used to associate content with a category that has been defined for the client's account in the Ooyala Pulse UI. The value of the category can be the Pulse native ID of the category found in the Pulse UI or a human readable "alias” that has been associated with the category in the Pulse UI. Categories are used for reporting and targeting purposes in Pulse UI. It is also possible to apply individual ad policies to each category, controlling how many and what type of ads are returned.

string No


content form: A piece of video content can be defined as either long form or short form content. Long form content can be the entire episode of a program, a full-length feature movie, or just a piece of content that is more than 10 minutes long. It is up to the client to define the threshold between short and long form. In the Pulse UI it is possible to configure individual ad policies for long and short form, adding an additional ad policy dimension to a category.

Valid Values: "longForm", "shortForm"

string No


content ID: Content ID is used for forwarding the ID of the main content to 3rd-party trackers. This value is not used or tracked by Ooyala Pulse but can be added to request URLs for 3rd-party ad requests or additional tracking URLs via a placeholder macro in the Pulse UI.

string No


content partner: The content partner is used to add an additional reporting dimension to the ads that are displayed. The content partner value can use the Pulse native ID of the content partner found in the Pulse UI or a human readable "alias” that has been associated with the content partner in the Pulse UI.

string No


Any custom parameters you need to set in the integration. An array of key value pairs. Example: {key1: value1, key2: value2}

array No


device container: The device container in Ooyala Pulse is used for targeting and reporting purposes. This device container attribute is only used if you want to override the Pulse device detection algorithm on the Pulse ad server. This should only be set if normal device detection does not work and only after consulting Ooyala personnel. An incorrect device container value can result in no ads being served or incorrect ad delivery and reports.

string No


duration: This is the total duration of the main content.

integer No


cache busting: Enable or disable the addition of the [CACHEBUSTING] macro to tracking URLs in third party VAST 2.0 tickets. The macro adds a randomised number to the tracking URL each time the associated event is triggered to ensure tracking. Without the randomised number, the URL may be cached and not handled properly. By default, cache busting is enabled.

Boolean No


flags: The flags are used to apply special rules and conditions to an ad request. For example, a piece of premium content has been sponsored and no pre-rolls should be displayed. Adding the flag "noprerolls” will prevent pre-rolls from being returned but mid-rolls and post-rolls will be available as normal.

Supported flags are:
  • nocom: No ads are returned at all
  • noprerolls: No pre-rolls are returned
  • nomidrolls: No mid-rolls are returned
  • nopostrolls: No post-rolls are returned
  • nooverlays: No overlays are returned

A string containing a comma-separated list of values.

string No


height: The height of the video player. This is used to determine the best size of the delivered asset.

integer No


insertion point type: This is the point, in relation to the main content, where the ad spot should be inserted. This will determine what type of ads are requested by the SDK. The insertion point types are defined as constants in the SDKs and are as follows:
  • On before content: Linear ads that are played before the main content starts (Pre-rolls).

  • On content end: Linear ads that are played after the main content has ended (Post-rolls).

  • On playback position: Linear ads that are to be displayed at a certain point on the main content's timeline (Mid-rolls). This value requires that you also set the playback position (see playback position).

  • On pause content:Linear ads that are played when the content is paused.

  • On playback time: This is for non-linear ads that should be displayed after the user has viewed the main content for X seconds (Overlays).

A string containing a comma-separated list of valid values.

Valid Values: "onBeforeContent", "playbackPosition", "onContentEnd", "onPause", "playbackTime"

string No


playback position: This is the point on the main content timeline, in seconds, that the "on playback position" (Mid-roll) ad slot should be displayed. A warning may be triggered if this value is higher than the duration of the main content.

A string containing a comma-separated list of positions, in seconds. Example: "10,20,40"

string No


Number of linear ads per slot. This value overrides the value set in Ooyala Pulse. integer No


max bandwidth: The maximum bandwidth in Kbps that your device has access to. You should only set this value if you have a reliable way of determining the actual available bandwidth. If you do not set anything here we will default to 400 Kbps.

The Ooyala Pulse HTML5 and mobile SDKs, by design, do not perform bandwidth tests because there is no reliable generic way to do this on HTML5 and we do not want to consume unnecessary data volume on mobile devices. For this reason it is up to the individual developer to implement bandwidth detection if they choose to.

integer No


max break duration: Set the maximum duration for a linear ad break in seconds. For more information about this feature and its limitations, refer to Time Based Breaks.

integer No


On playback time: This is for non-linear ads that should be displayed after the user has viewed the main content for X seconds (Overlays).

A string containing a comma-separated list of positions, in seconds. Example: "10,20,40"

string No


Set this parameter to true if you want the pulse_flags and pulse_tags to completely override any values coming from the Backlot Ad Set and Backlot Custom Data associated with the video asset. If not set, then all values are merged.

Boolean No


persistent identifier: The persistent identifier is used to identify the end user and is the basis for frequency capping, uniqueness, DMP targeting information and more. Ooyala will normally generate and attempt to save a persistent ID as a cookie on your device. In environments that do not support third party cookies, such as iOS and Android native applications, this automatic id management does not work and it is then up to the integration to provide an id that is consistent for the individual end user and that persists between sessions.

This ID can be any string as long as it is unique to each individual end user, although the GUID or UUID format is recommended. If the application has a login or other user ID that is consistent across devices, this ID can be used to track uniqueness across devices and reuse DMP tracking data across devices and platforms.

string No


referrer URL: To override the URL from where the ad requests originate in the HTTP header's referrer property.

string No


seek mode: Set how the session behaves when a viewer seeks or scrubs past one or more mid-roll ad breaks. The different modes allow you to ignore any scrubbed ad breaks (default), play all scrubbed ad breaks, play only the first scrubbed ad break or play only the last scrubbed ad break.

string No


Show the ad title in the ad marquee. The default value is 'false'.

Boolean No


tags: Tags are freeform keywords that can be used for targeting and reporting purposes. Although the tags keywords are able to handle UTF-8 characters, we recommend refraining from using special characters like quotes (‘ and ") ampersand (&) comma (,) semi-colon (;).

Note: In an integration between Ooyala Player V4 and Ooyala Pulse, no special characters are allowed.

A string containing a comma-separated list of values.

string No


VAST skip offset: This parameter only applies to the HTML5 SDK. Enable or disable using the skip offset defined in third party VAST tickets over using the skip offset defined in the insertion policies in Pulse. By default, the skip offset from Pulse is used.

Boolean No


width: The width of the video player. This is used to determine the best size of the delivered asset.

integer No

Where Parameters Are Read From

The following table lists the parameters you can set in the Ooyala Pulse ad plugin for Player V4, and the relationship between the different locations where these parameters are read from, if not set in the integration.

Note: Consider the following rules when reading the table:
  • In general:
    • Embedded parameters override custom metadata set on individual assets in the Backlot UI.
    • Custom metadata overrides ad set parameters set in the Backlot UI.
    • Ad set parameters override content metadata from assets in the Backlot UI.
  • (1) indicates the location from which the base value for that particular parameter is read.
  • (2) indicates that values set here are merged with the column(s) to right.
  • (3) indicates that values set here override, or are merged with, the column(s) to the right, depending on the value for pulse_override_metadata.
Embedded Parameters Custom Metadata Ad Set Parameters Content Metadata
Pulse Settings
pulse_host pulse_host vpDomain


Pulse Request Settings
pulse_linear_cuepoints pulse_linear_cuepoints

Player level midroll ad breaks

pulse_non_linear_cuepoints pulse_non_linear_cuepoints

Non-Linear ad breaks

pulse_insertion_point_filter pulse_insertion_point_filter

Ad Position

pulse_referrer_url pulse_referrer_url(1)    
pulse_linear_slot_size pulse_linear_slot_size(1)    
pulse_max_linear_break_duration pulse_max_linear_break_duration(1)    
Pulse Content Metadata
pulse_category pulse_category

Player level shares


In the ad set, this parameter contains both the category and the content partner separated by a comma.

pulse_content_form pulse_content_form

Short form content max. length (sec.)


This parameter together with the video asset's duration determine the content form.

pulse_content_partner pulse_content_partner

Player level shares


In the ad set, this parameter contains both the category and the content partner separated by a comma.

pulse_content_id pulse_content_id  

content ID

pulse_duration pulse_duration   length(1)
pulse_flags(3) pulse_flags(2)

Player level Videoplaza flags

pulse_tags(3) pulse_tags(2)

Player level tags


Was this article helpful?