Global

Type Definitions


ContentMetadata

Type:
  • Object
Properties:
Name Type Description
category string

Content category is used by Ooyala Pulse to target ads and determine
the ad insertion policy. The content category can be represented by either its unique id or one
of its aliases set in Ooyala Pulse.

contentForm OO.adrequest.AdRequester.ContentForm

Content form is used to determine the ad insertion policy.

id string

Ooyala Pulse content id. Id is used to identify the content to 3rd parties.

contentPartner string

Ooyala Pulse content partner. Content partners can be used by
Ooyala Pulse to target ads. The content partner can be represented by either its unique id or one of its
aliases set in Ooyala Pulse.

duration number

This value can not be negative.

flags Array.<string>

Ooyala Pulse flags. Since flags overrides Ooyala Pulse's ad insertion policy they
should be used with caution. For more information please talk to your contact at Ooyala. Supported flags:
nocom, noprerolls, nomidrolls, nopostrolls, nooverlays, noskins.

tags Array.<string>

Ooyala Pulse content tags, used to target specific ads.

customparameters object

The Custom parameters to add to the
session request. Parameters with names containing invalid characters will be omitted.
These custom parameters are added to the adserver request URL in the style
of "cp.[parameter_name]=[parameter_value]".


RequestSettings

Type:
  • Object
Properties:
Name Type Description
height number

Height in pixels of the video area where ads should be shown.

width number

Width in pixels of the video area where ads should be shown.

maxBitRate number

The maximum bitrate (in kbps) of the media files in the ad response.

linearPlaybackPositions Array.<number>

An Array of numbers which define at what points in time linear ads should be shown.

nonlinearPlaybackPositions Array.<number>

An Array of numbers which define at what points in time non-linear ads should be shown.

insertionPointFilter videoplaza.adrequest.AdRequester.InsertionPointType

If not set, the request is for every kind of insertion point. If set, only the types provided are requested.

referrerUrl string

Overrides the HTTP header's referrer property.

linearSlotSize number

Overrides the number of linear ads per slot.

NOTE! Using this affects the predictability of the Ooyala Pulse forecast functionality. Use with caution.

maxLinearBreakDuration number

The maximum duration in seconds of linear ad breaks.

enforceCacheBusting bool

If set to false, a randomized cache busting parameter is not added to VAST 2.0 tracking URLs which are missing the [CACHEBUSTING] macro. If not set, or set to true (default), the parameter is added.

useVASTSkipOffset bool

If set to true, skip offset information provided in third party VAST tickets determines the skip behaviour of third party ads. If not set, or set to false (default), the insertion policy configured in Pulse determines the skip behaviour instead.