Server-Side Ad Insertion Pre-Integration API

THEOplayer pre-integrates with the best-of-class Server-Side Ad Insertion(SSAI) providers. Setting the integration attribute on your ServerSideAdInsertionConfiguration allows you to quickly set up an integration with one of our SSAI partners of your choice. Depending on your preferred vendor, the integration attribute should have a specific value.

This functionality is available from version 2.12 onwards.

Yospace

Code samples of how to integrate Yospace with THEOplayer can be found here.

YospaceServerSideAdInsertionConfiguration

Setting a ServerSideAdInsertionConfiguration's integration property to 'yospace' makes it a YospaceServerSideAdInsertionConfiguration. This interface has the following properties:

Method Type Optional Version Description
integration string no ≥ 2.12 The value should be 'yospace'.

Google SSAI DFP/DAI

GoogleDAIAdInsertionConfiguration

Setting a ServerSideAdInsertionConfiguration's integration property to 'google-ima' makes it a GoogleDAIAdInsertionConfiguration. This interface has the following properties:

Method Type Optional Version Description
integration string no ≥ 2.33.1 The value should be 'google-ima'.

contentSourceID

string yes, for live ≥ 2.33.1 Unique identifier for the publisher content, from a CMS. Required for on-demand streams.

videoID

string yes, for live ≥ 2.33.1 Identifier for the video content source. Required for on-demand streams.
assetKey string yes, for VOD ≥ 2.33.1 Identifier for the video content source. Required for live streams.
The asset key can be found in the DFP UI.
apiKey string no ≥ 2.33.1 The stream request API key.
It's configured through the DFP Admin UI and provided to the publisher to unlock their content.
It verifies the applications that are attempting to access the content.
availabilityType 'vod' | 'live' no ≥ 2.33.1 Whether the content is live or on-demand.