Overview: Below is information pertaining to how IRIS.TV’s Contextual Video Marketplace integrates with a publishers publisher's content management system (CMS) via a content feed or API.
Feed Format Information
Supported Feed Types
Setting up the Import
IRIS.TV supports a wide range of feed formats and data types. Below are lists of accepted importing methods and metadata requirements for adding contextual segments to your content.
Accepted Methods for Import
IRIS.TV supports the following feed formatsmethods for importing:
MRSS
RSS
XML
JSON
API (If publishers have an API, they can provide an API route for IRIS.TV to evaluate the level of effort to utilize)
Meta Data Field Information
...
Once you have sent details on how to access your content, IRIS.TV will evaluate and follow-up with questions and a timeline for the initial import. Most initial imports take under one week.
Recommendations for feed pagination
If you are providing a feed for import, IRIS.TV recommends using pagination so that your full library can be imported for contextual segmentation. IRIS.TV supports the following pagination methods
Offset parameter: Feed parameters that allow for calling a specific number of assets and an offset for how far to go into the feed.
Next Link pagination: a link for the next page is included in the current page.
Recommendations for asset ordering
IRIS.TV recommends that feeds are ordered by a "updated_at" field on the assets. That ensures that all asset updates are imported into the system.
Metadata Requirements
IRIS.TV has ranked metadata requirements in three sections:
Required – these are necessary to create contextual segments on your content.
Preferred – this data will improve the contextual segments on your content.
Optional – this data will help IRIS.TV parse your feed and understand the state of your content.
Excerpt |
---|
Required Meta Data
Preferred Meta Data
Optional Meta Data
|
Sample Video Asset from a Publisher
...
Code Block |
---|
{
| ||
{ "id": 5331690110001, |
...
"name": "Lorem ipsum dolor sit amet, consectetur adipiscing elit", |
...
"shortDescription": "Donec congue orci vel ante posuere consectetur. Vestibulum vel eros velit. In suscipit arcu nec lectus posuere sagittis.", |
...
"creationDate": 1487717574502, |
...
"publishedDate": 1487717955852, |
...
"lastModifiedDate": 1487717955969, |
...
"startDate": 1487717955969, |
...
"endDate": null, |
...
"tags": [ |
...
"alex rodriguez", |
...
"new york yankees", |
...
"mlb" |
...
], |
...
"videoStillURL": "http://xxx/2157889318001_5331738223001_5331690110001-vs.jpg?pubId=2157889318001", |
...
"thumbnailURL": "http://xxx/2157889318001_5331738224001_5331690110001-th.jpg?pubId=2157889318001", |
...
"length": 30805, |
...
"economics": "AD_SUPPORTED", |
...
"categories": [ |
...
"Baseball" |
...
], |
...
"itemState": "ACTIVE", |
...
"SourceURL": "http://xxx/2157889318001_5331740038001_5331690110001.mp4" |
...
}, |
Supported Feed Pagination
IRIS.TV prefers that clients use pagination for asset feeds. This allows IRIS.TV to import the client's full library instead of a set of most recent assets. IRIS.TV supports the following pagination methods:
Offset parameter: Feed parameters that allow for calling a specific number of assets and an offset for how far to go into the feed.
Next Link pagination: link for next page is included in the current page.
Recommended Video Asset Ordering
...
After the Initial Import
Once the initial import is complete, IRIS.TV will provide you with credentials to start the Context Script or Context API integration. These credentials include:
Client Token: used to authenticate your content library. Required for both the Context Script and Context API integrations.
Access Token: used to authenticate with the API. Required for the Context API integration.
The integration will also require the use of a “platform_id”. The platform_id is mapped in from the unique ID field during the import.