Integration with Ooyala Pulse on iOS

What You Need

With the Ooyala SDK for integrating Ooyala Pulse, the same advertising experience you have created on the desktop can be created on mobile devices when supported.

To get started with the integration between your Ooyala Player V4 and ad serving from Ooyala Pulse on iOS, you will need the following:

For the Ooyala Mobile SDK for iOS, Ooyala Skin SDK for iOS, and Ooyala SDK for Ooyala Pulse iOS, you must use versions with the same number. For the Ooyala Video Advertising iOS 2.x SDK, always use the latest version.

Sample Application

The Ooyala Pulse sample app is available for download at the Ooyala Sample app Git Hub. The location also contains information on how to set up your project and how the sample app works.

Getting Started

A simple Getting Started tutorial is included in the SDK reference documentation for the iOS SDK: Ooyala Player v4 Pulse Integration.

Essential Parameters, Custom Metadata and Videoplaza Ad Set

To make use of Ooyala Pulse ad serving in the Mobile SDK, you must create an ad set of type Videoplaza in Backlot. See the Backlot User Guide for details. Ooyala allows you to store Ooyala Pulse related parameters in a variety of locations. In order of precedence, Pulse parameters and their values can be defined in:

  1. Your app itself.
  2. In the Backlot MANAGE tab, for each video asset as custom metadata defined in the Custom Metadata tab.
  3. In the Backlot MONETIZE tab, Ad Sets subtab for the Videoplaza type of ad set.
Note: When setting parameters directly in your app, you have to set them before the Ooyala Pulse Session is created.
The following parameter has to be set either directly in your app, in Backlot as custom metadata on the asset, or in the Videoplaza ad set (recommended) associated with the asset:
  • Pulse host: the URL to your Ooyala Pulse account. In the app, you would set this parameter with the setPulseHost method, where you can also set the deviceContainer and the persistentId. It is recommended to set deviceContainer to nil. For example:
    [OOPulse setPulseHost:@""
Other significant parameters are set through the following objects:
  • Request settings object: information about the ad positions and quality of ads you want to request from Ooyala Pulse. The properties of this object are listed on VPRequestSettings.
  • Content metadata object: information about the video content chosen for playback in the app, which helps in requesting targeted ads from Ooyala Pulse. The properties of this object are listed on VPContentMetadata.
For an overview of each parameter, where it can be set, and where the base values are located, see Parameters for Ooyala Pulse on iOS.