Core SDK API Documentation

Global

Type Definitions

ContentMetadata

Type:
  • Object
Properties:
Name Type Description
category string

Content category is used by 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 Pulse.
contentForm OO.adrequest.AdRequester.ContentForm

Content form is used to determine the ad insertion policy.
id string

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

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

This value can not be negative.
flags Array.<string>

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

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.
enableGdpr bool

Set to true if the ad request is subject to GDPR regulations. See https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/v1.1%20Implementation%20Guidelines.md for implementation guidelines.
gdprConsentString string

Pass in the user's URL safe and base64 encoded consent string related to GDPR regulations, which may be obtained through the Consent Management Provider (CMP) JS API. This string is built up according to the data structure developed by the GDPR Consent Working Group under the auspices of IAB Europe. The data structure specification can be found at https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/Consent%20string%20and%20vendor%20list%20formats%20v1.1%20Final.md. For more information on the API, refer to https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/CMP%20JS%20API%20v1.1%20Final.md.
gdprPersonalDataIncluded bool

Set to true if you are passing in personal information when creating the ad request to Pulse. The only location where it is possible to pass in personal information is in the customParameters of OO.Pulse.ContentMetadata.
startAdTimeout number

Overrides The maximum amount of time the player or integration should wait for the ad to start playback before reporting inventory.
thirdPartyTimeout number

Overrides The maximum amount of time the player or integration should wait to unwrap and load a third party ad before reporting inventory.
totalPassbackTimeout number

Overrides The maximum amount of time the passback player should wait to find a working ad in the passback chain before moving to the last ad in the chain or reporting inventory.
breakNumber number

Overrides the break number detected in Pulse in order to request ads for a specific ad break.
linearSlotSize number

Overrides the number of linear ads per slot.

NOTE! Using this affects the predictability of the 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.