Versions Compared

Old Version 22

changes.mady.by.user Zachary Stockton

Saved on

compared with

New Version 23

changes.mady.by.user Zachary Stockton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 21

Overview: Below is information regarding pertaining to how publishers can integrate with the IRIS.TV Context Script for the Contextual Video Marketplace. The Context Script gives publishers the ability to retrieve contextual information for a given video asset. This is meant to be used as a part of your existing ad workflow to send contextual data through your ad server. This documentation will walk through how to add the Context Script and workflows for adding the data to your ad tags.

See an example implementation page here: https://ovp.iris.tv/demos/context/iris-context-api.html

...

Before adding the Context Script the following needs to be completed:

Excerpt

  • A feed with video URLs needs to be provided for IRIS.TV to import and add context to assets. These URLs need to link to either MP4 or m3u8 files.

  • An ad tag that can be appended with context custom key-value pair.

  • Ad targeting on the context category needs to be set up through the ad server, supply side, and demand side.

Please speak to your IRIS.TV representative for details on these requirements.

This workflow requires two values:

  • client_token: Authentication string associated with each client. This will be provided by IRIS.TV once the content feed is imported.

  • platform_id: The reference ID for the asset video from the publisher’s CMS.

...

  1. IRIS.TV Context Script is loaded with the page.

  2. The Context Script is initialized.

  3. Call the Context Script with the platform_id for the asset video that is about to play to receive the asset’s videos contextual segments.

  4. Add the contextual segments to the pre-roll ad tag.

This process should be repeated as you iterate through the video playlist.

Excerpt

Installing the Script

NOTE: The script should be loaded as a high priority to ensure you can receive context information for the pre-roll of the initial assetvideo.

An example of adding the script to your page HTML:

Code Block
languagehtml
<script src=”https://ovp.iris.tv/libs/context/iris-context.min.js” type=”text/javascript”></script>

If you do not want to load the script as a high-priority, there is an event that you can listen to at the global changes to ensure that the context methods are available. An example of setting up that event listener:

Code Block
window.addEventListener(‘IrisContextAPI’, function() {
    // window.IrisContextAPI is ready to be used
});

Initializing the Script

  • To initialize the script, provide your client token to the IrisContextAPI Object

Code Block
languagejs
   var IrisContext = window.IrisContextAPI({
      client_token: '<your client token here>'
   });

...

Once the script is initialized, you can send in a platform_id video ID to receive the context segment on the assetvideo. These methods are:

  • getContext – requests the context information for the platform_idvideo ID.

  • getVideoInfo – requests context category information for the platform_idvideo ID.

Parameters for these methods:

  • platform_id: the CMS reference ID of the assetvideo. Required.

Please confirm with your IRIS.TV representative

...

Code Block
{
  platform_id: '6026440620001',
  context: ["segment_1", "segment_2", "segment_3e883d22ce29c85f9e910281d2a410c5bad77a098"]
}