2017-02-21 Release

Pulse Ad REST API updates.

New Ad REST API endpoints

New Ad REST API endpoints are available to interact with Ooyala Pulse. These endpoints enable you to upload assets to Pulse, based on asset type, by providing either:
  • a URL to the asset in the request body, or
  • the asset itself as an octet-stream in the request body.
The new Ad REST API endpoints are:
  • POST v1/assets/video - to upload video assets to Ooyala Pulse. Transcoding starts when the video asset is linked to an ad.
  • POST v1/assets/resource - to upload other asset types, like ad images and flash files, to Ooyala Pulse. Assets uploaded through this endpoint are never transcoded, which means retrieving asset metadata always returns "transcondingStatus": NOT_AVAILABLE.

Deprecated Ad REST API endpoints

Using the following endpoints for uploading any asset type to Ooyala Pulse is now deprecated, but still supported:
  • POST v1/assets/file
  • POST v1/assets/uri

Now, we recommend using POST v1/assets/video to upload video assets to Ooyala Pulse, or POST v1/assets/resource to upload other asset types to Ooyala Pulse.

Handle Pause Ads through the Ad REST API

Note: Pause ads need to be enabled for your Ooyala Pulse account.

Pause ad is an ad that is displayed in the video player when the viewer pauses the video content. It is automatically hidden when the content is resumed and can also be closed while content is paused.

Previously, you could handle pause ads only through the Pulse user interface. Now, support for pause ads has been added in the Ad REST API, which means you can retrieve (GET), create (POST), update (PUT), and modify (PATCH) pause ads using the API.

There are two ways to create Pause ads, which require passing in a different creative type in the request body:
  1. Create a pause ad by providing the assetId (id of the asset uploaded previously through POST v1/assets/resource) in the request body:
    "creative": {
      "type": "pause",
      "assetId": "<assetId>",
      "clickDestionationUri": "http://click-destination-uri.com" (Optional, to set the clickthrough URI)
    }
  2. Create a pausePlaceholder ad and pass in the asset later:
    "creative": {
      "type": "pausePlaceholder"
    }

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?