2016-05-26 Release

New Ad REST API, Time Based Break setting available in Pulse SDKs, full passback behaviour in HTML5 Pulse SDK, default skin for HTML5 ad player.

Ad REST API to Upload Assets and Create Ads

New REST API end points are available to interact with Ooyala Pulse. The Booking API provides you with end points to manipulate campaigns, goals, client records, and so on, but it did not have end points for assets and ads. The new REST API, called the Ad API, now enables you to:
  • upload assets into Ooyala Pulse,
  • get metadata from uploaded assets,
  • create and update ads,
  • and get information about ads.

The Ad API is currently not part of the Booking API, because it uses a different base URL, authentication and format.

Note: To use the Ad API, request an API key from your Account Manager. If you are already using the Booking API, you must still request a new key, because the key for the Booking API is not compatible with the Ad API.

Time Based Break Setting Available in Pulse SDKs

The time based break functionality in Ooyala Pulse enables you to set a maximum duration for pre-, mid- and post-roll ad breaks. Setting the maximum duration in seconds for a break is now also available in the Pulse SDKs and is done through adding the parameter when you request an ad session from Pulse:

  • HTML5 (from v2.1.16.10.3): OO.Pulse.RequestSettings.maxLinearBreakDuration
  • Android (from v2.2.16.10.0): RequestSettings.setMaxLinearBreakDuration()
  • iOS & tvOS (from v2.2.16.10.0): VPRequestSettings.maxLinearBreakDuration
Warning: Adding the maximum linear break duration in an ad session request to Pulse sets the maximum duration for each linear break requested, even if no maximum duration was previously defined in the applicable ad insertion policy in Pulse.

Refer to Time Based Breaks for more information regarding time based breaks, where to set it and its limitations.

Full Passback Behaviour in HTML5 Pulse SDK

From version 2.1.16.10.3, the HTML5 Pulse SDK automatically takes care of all passback handling, if passbacks are available for the failed or unreachable ad. This also applies to all integrations between your web based video player and Ooyala Pulse, which use any of the following plugins or ad players:

Default Skin Available for HTML5 Ad Player

A default skin is available for any integration using the HTML5 ad player. The skin provides the following functionality:
  • A spinning animation to indicate an ad is being loaded.
  • Mute and unmute buttons.
  • A progress bar for the ad.
  • A top banner with information about the ads, like the ad name and number of ads.
  • A play button, when you return to the player page after a clickthrough page was opened.

The skin is available on GitHub: HTML5 Ad Player Skins. To add the skin, clone the repository, build the project and include the minified version from the dist folder to the page containing the HTML5 ad player.

Documentation Releases

This release includes the following documentation updates:

Subscribe to Ooyala Release Notes

See Subscribe to Ooyala Release Notes for instructions on how to subscribe for automated notifications of Ooyala release notes.

Was this article helpful?