Rovi Customer Integration

Welcome to IVA! Rovi and IVA have partnered to make integrating trailers into your site as easy as 1,2,3. This page will walk you through making a link to a video.

Step 1: Get your credentials

Please contact Michael Eitelman or your customer service representative at Rovi for your credentials. IVA does not have access to Rovi customers credentials. Make sure that you get the following:

  • Customer ID ( this is your comany’s account number)
  • Security Token ( do not share this with anyone outside your organization)
  • Access to data feeds

Note: Please keep this information in a safe place as you will need it to access content at IVA.

Step 2: Get the data

Rovi and IVA have worked together to provide 2 feeds that will be updated once daily Monday – Friday and made available to Rovi customers. These feeds will include all the meta data you will need, including IVA’s Published ID and matching Rovi Program ID. The first feed is single XML file with all the data you need to do your matching and update your records. The second feed is broken up into two flat files. One file contains the data about the program and the other contains the available encodes for the video. Both feeds contain the same data so you only have to get one or the other. Please contact Rovi for access to these feeds and read through the Rovi Feed Data Dictionary to understand all the fields contained in these feeds.  Be sure to use the latest version of the feed (v4 or above).

Rovi Feed Data Dictionary
AMG Feed Data Dictionary

Step 3: Make a link to the video

Now that you have ingested all the data you can build the links to the video. To do so you will need the following information:

  • Customer number
  • Secret token
  • Videokbrate – chosen from the available encodes
  • Published ID of the video

In the example below we will assume that you will be using the cmd=6 and fmt=4 parameters. For more information on those please see the full Video API documentation. This example shows how to properly join your secret token along with your URL to be hashed. Customers are required to do an MD5 hash of the Secret Token + URL as a security measure to prevent deep linking to the content. The e parameter is a time to live for the link and is the Unix time for when the link should expire. IVA recommends that you generate these links on the fly and keep the time to live as short as possible ( 10 – 30 min). It is important to note that you need to append the secret token to the front of the URL and lower case the whole string.

Secret Token = 1234
Pseudo-code to Generate Hash = MD5(lcase(1234http://video.internetvideoarchive.net/player.aspx?customerId=18088&cmd=6&fmt=4&videokbrate=750&publishedid=1757&e=1171159092))
Hash = c13c876ea56c6124cba712c050a7ae69

Finished URL:

http://video.internetvideoarchive.net/player.aspx?customerId=18088&cmd=6&fmt=4&videokbrate=750&publishedid=1757&e=1171159092&h=c13c876ea56c6124cba712c050a7ae69

For more information, including a full description of all the parameters and creating the hash code please see this page: http://www.internetvideoarchive.com/documentation/video-api/

We look forward to working with you! Should you have any questions please feel free to email our Support Team. Thanks for choosing Rovi and IVA!

Rovi 1.0/2.0 mapping table data dictionary

This is a data dictionary for Rovi customers only.  Please contact your Rovi Representative for access to this feed.   This feed is used to integrate IVA trailers with Rovi data. Please refer to the Rovi getting started page for more information.

Be sure that you are getting the latest version of the feed (v4).  If you are not using v4 please update now.

Field Name Definition
ReferenceIDUnique mapping ID: This is only found in the FLAT FILES FEED not in the XML FEED.  It is used to map records in the Full Flat file to the Full Flat Encodes file.
ProgramID (not null) This is the Rovi unique program identifier, or Program ID.  For TV, this will correspond to the Rovi Series ID.   This ID will always correspond to the is_group_language_primary = Y and record_language = en program record.
IVAID_MAIN  (not null)The Root level record unique identifier.Commonly referred to as the Entertainment Program. This will always correspond to the root level record.. For Tv, this corresponds to the Series root level record.
Program_ID_V (nullable)The Rovi unique program identifier.  This corresponds to any record that is NOT a is_group_language_primary = Y .  This will be the same as RoviID_Main if the RoviId_Variant has the following properties:is_group_language_primary = Y and  record_language  = en.
IVA_AssetID (not null)Child record  unique identifier. Commonly referred to as an VideoAsset. This corresponds to any record which promotes an Entertainment Program. For Tv, this corresponds to all children under a series.
NOTE: This is the same as the IVAID_MAIN if IVA_AssetID is a root level record.
SeasonProgramId (nullable)Rovi Season program id if applicable.(Only used for season level or children of seasons)
MediaTypeThe MediaType determines the type of entertainment  the VideoAsset belongs to. For example: Movie , Song , TV Series ,Movie Clip, etc
TitleThe title of the Artistic Work. Ex: “Green Lantern, The” or title of the VideoAsset. Titles have their articles placed at the end of the string.
Modified DateThe last time the Video Asset or any of it’s related data has been modified. This includes but is not limited to adding alternate Ids, new encodes, new VideoAssets added, cast changes, etc.
ExpirationDate (nullable) Some video content is provided to IVA with an expiration date where a video asset is no longer allowed to be viewed online.  This field will contain a date for the Default VideoAsset if an expiration date is set. Otherwise, the expiration date will be NULL.
 OkToEncodeAndServeFrom time to time, content owners need to restrict a video from being displayed. This boolean property is used to disable content from being served from IVA servers. Default = True.
LanguageSpokenReference to Language entity. This property describes the primary language spoken in the VideoAsset which is not particularly the same as the Language as the IVAID_MAIN record.. This property is especially useful for localizing video content in other countries in combination with TargetCountry property.  Default = en NOTE: These values are based off of the ISO 639-1 language codes.
Language SubtitleReference to Language entity. This property describes the primary language subtitled in the Video Asset which is not particularly the same as the Language as the IVAID_MAIN record. This property is especially useful for localizing video content in other countries in combination with TargetCountry property.  When the video asset does not have subtitles, this property is set to a blank string.   NOTE: These values are based off of the ISO 639-1 language codes.
Sequence  (nullable) This element is only for RoviID_Variants or IVA Video Assets.. This property is used primarily used for Television Seasons and Television Episodes to order child elements. For an episode Video Asset, this will be an episode number, for a season Video Asset this field represents a season number. This is NOT to be confused with overall sequence numbers, which this field is not.  Default = NULL
TargetCountryReference to Country entity. This denotes whether the VideoAsset was made for a specific country. This property is rarely used.NOTE: These values are based off of the Alpha 2 Country Codes
PromotesPublishedid When a Video Asset is a child of another Video Asset, it’s PromotesPublishedId will contain the IVAID_AssetID of it’s parent. This is particularly useful for Televion Seasons (with Television Series parents) or Television Episodes (with Television Season parents).
DefaultVideoAsset (removed from V4 feed)Determines if the VideoAsset is the default video played for the EntertainmentProgram denoted by the PromotesPublishedId property. A true value indicates this is a default video asset.
WarningFlag  (mature)  This denotes a red band trailer or explicit content.  For most content this is set to false.
HdSourceThis will be set to True if the digital master’s width is greater than 1260 pixels wide (720p HD). 
SourceWidthThe width of the digital master.  Default = -1 when information is not available.
SourceHeightThe height of the digital master. Default = -1 when information is not available.
isIvaContentOn rare occasions studios provide links to video content rather than high quality source materials.  Content that points to studio links usually has limited formats and IVA cannot guarantee the quality of delivery.  This property denotes whether IVA is delivering the video for the Default VideoAsset for the program. Default = True.
StreamlengthinSecondsThe length is seconds of the VideoAsset for the Entertainment Program. This is useful to distinguish whether IVA has a VideoAsset for the particular Entertainment Program.  Default = -1.
ImageUrlA 320×240 photo still captured from the Video Asset.
EncodingsStreamingFlavor: ID for the type of encode.
Rate: The Kbps target for the encode.  EX: 450 = 450Kbps of the combined audio and video tracks bitrate.
DateDigitized: The date in which the video was last encoded.
FileType: The video format of the encode. Ex: MP4
Width: Max width for this particular video.
Allow Ads (V2, V3, V4 Feeds Only) Indicates whether this video must enable ads
Requires IVA Player (V2, V3, V4 Feeds Only) Indicates whether this video requires ONLY using the IVA Player.
Region Restrictions (V2, V3, V4 Feeds Only) Country – Name of the Country for this restriction.
Country Code – ISO_3166-1 Alpha 2 digit code for this country.
Allowed – Indicates whether this country is allowed to display this video. If false, this content CAN NOT be played for this country.
Group Permission ID (v3, v4 feeds only)Indicates the group id a customer is required to belong to in order to access this content. Please contact Support@internetvideoarchive.com for more information.
dateCreated (v4 feed)Date the record was created in the IVA database.
mezzanine_digitized_date (v4 feed)Use this field to know what is the newest video asset. This is the date our mezzanine video asset for the record was encoded.

Rovi Examples

Searching the newest movie trailer for a movie:

Search where mediaID = (Movie OR Movie Alternate Version)  AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate) order by mezzanine_digitized_date.  Be sure to check the language spoken and language subtitled of the video assets.

Searching for all foreign movie trailers:

Search where MediaId=movie and (languagespoken is not = en OR languagesubtitle is not = en) AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate)

Searching for all Seasons under Fringe:

Search where RoviId_Main= Fringe programId AND mediaid=Tv Season  AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate)

Searching for all Foreign content for episodes of Season 4  Fringe (includes clips,etc):

Search where RoviSeasonProgramId = 19556425 AND (languagespoken is not = en OR languagesubtitle not = en) AND (mediaid is not = Tv Season) AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate)

Searching for NCIS: Season 9 Episode 3 :

Search where mediaId = Tv Episode AND  Sequence=3  AND (SeasonProgramId = 19568763     OR RoviID_MainId = 3899298)   AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate)

AMG mapping table data dictionary

This data dictionary is for Rovi customers using the AMG data set. IVA recommends updating to the Rovi 2.0 ID’s and using the Rovi 2.0 mapping table. For access to either mapping table please contact your Rovi client services team. This mapping table is used to integrate IVA trailers with the AMG data set. The information in the mapping table should be used to connect the IVA video assets and information to your AMD ID’s. Be sure to ingest all information about the video assets so that you can use the information to make programmatic decisions on how and when to use the video. Once you have the video asset ID’s you can then use IVA’s Video API to make links to the video.

Field Name Definition
AMGID (not null)This is the principal AMG identifier for a root level program.  For TV, this will correspond to the AMG series record.   
IVAID_MAIN  (not null)The Root level record unique identifier.This will always correspond to the root level record. For Tv, this corresponds to the Series root level record.
AMGID_V (nullable)The AMG ID for a work of a program.  This corresponds to any International or work of a movie.  For TV, this will also correspond to the AMGID for and episode.    Note:   This is the same as AMGID if the AMGID_V is the root program ID.
IVA_AssetID (not null)Child record  unique identifier. Commonly referred to as an VideoAsset. This corresponds to any record which promotes an Entertainment Program. For TV, this corresponds to all children under a series.
NOTE: This is the same as the IVAID_Main if the IVAID_main is a root level record.
AMG_SeasonID (nullable)AMG identifier for the season of a program. (Only used for season level or children of seasons.)
MediaTypeThe MediaType determines the type of entertainment  the VideoAsset belongs to. For example: Movie , Song , TV Series ,Movie Clip, etc
TitleThe title of the Artistic Work. Ex: “Green Lantern, The” or title of the VideoAsset. Titles have their articles placed at the end of the string.
DisplayTitleThis property is a user friendly formatted version of the Title property. Ex: ROCK, THE would have a DisplayTitle of The Rock.  Default is ”.
Modified DateThe last time the Video Asset or any of it’s related data has been modified. This includes but is not limited to adding alternate Ids, new encodes, new VideoAssets added, cast changes, etc.
ExpirationDate (nullable)Some video content is provided to IVA with an expiration date where a video asset is no longer allowed to be viewed online.  This field will contain a date for the Default VideoAsset if an expiration date is set. Otherwise, the expiration date will be NULL.
  OkToEncodeAndServeFrom time to time, content owners need to restrict a video from being displayed. This boolean property is used to disable content from being served from IVA servers. Default = True.
LanguageSpokenReference to Language entity. This property describes the primary language spoken in the VideoAsset which is not particularly the same as the Language as the IVAID_MAIN record.. This property is especially useful for localizing video content in other countries in combination with TargetCountry property.  Default = en NOTE: These values are based off of the ISO 639-1 language codes.
Language SubtitleReference to Language entity. This property describes the primary language subtitled in the Video Asset which is not particularly the same as the Language as the IVAID_MAIN record. This property is especially useful for localizing video content in other countries in combination with TargetCountry property.  When the video asset does not have subtitles, this property is set to a blank string.   NOTE: These values are based off of the ISO 639-1 language codes.
Sequence  (nullable)This element is only for AMGID_V or IVA Video Assets.. This property is used primarily used for Television Seasons and Television Episodes to order child elements. For an episode Video Asset, this will be an episode number, for a season Video Asset this field represents a season number. This is NOT to be confused with overall sequence numbers, which this field is not.  Default = NULL
TargetCountryReference to Country entity. This denotes whether the VideoAsset was made for a specific country. This property is rarely used.NOTE: These values are based off of the Alpha 2 Country Codes
PromotesPublishedidWhen a Video Asset is a child of another Video Asset, it’s PromotesPublishedId will contain the IVAID_AssetID of it’s parent. This is particularly useful for Television Seasons (with Television Series parents) or Television Episodes (with Television Season parents).
DefaultVideoAsset (removed from v4)Determines if the VideoAsset is the default video played for the EntertainmentProgram denoted by the PromotesPublishedId property. A true value indicates this is a default video asset.
WarningFlag  (mature)  This denotes a red band trailer or explicit content.  For most content this is set to false.
HdSourceThis will be set to True if the digital master’s width is greater than 1260 pixels wide (720p HD). 
SourceWidthThe width of the digital master.  Default = -1 when information is not available.
SourceHeightThe height of the digital master. Default = -1 when information is not available.
isIvaContentOn rare occasions studios provide links to video content rather than high quality source materials.  Content that points to studio links usually has limited formats and IVA cannot guarantee the quality of delivery.  This property denotes whether IVA is delivering the video for the Default VideoAsset for the program. Default = True.
StreamlengthinSecondsThe length is seconds of the VideoAsset for the Entertainment Program. This is useful to distinguish whether IVA has a VideoAsset for the particular Entertainment Program.  Default = -1.
ImageUrlA 320×240 photo still captured from the Video Asset.
EncodingsStreamingFlavor:  ID for the type of encode.
Rate: The Kbps targe for the encode. EX: 450 = 450Kbps of the combined audio and video tracks bitrate.
DateDigitized: The date in which the video was last encoded.
FileType: The video format of the encode. Ex: MP4
Width: Max width for this particular video.
Allow AdsIndicates whether this video must enable ads
Requires IVA PlayerIndicates whether this video requires ONLY using the IVA Player.
Region RestrictionsCountry  – Name of the Country for this restriction.
Country Code – ISO_3166-1 Alpha 2 digit code for this country.
Allowed – Indicates whether this country is allowed to display this video. If false, this content CAN NOT be played for this country.
Group Permission ID (v3, v4 feeds only)Indicates the group id a customer is required to belong to in order to access this content. Please contact Support@internetvideoarchive.com for more information.
dateCreated (v4 feeds)Date the record was created in the IVA database.
mezzanine_digitized_date (v4 feeds)Use to find newest video asset. Date the mezzanine file was encoded.

AMG Examples


Searching for all foreign movie trailers:

Search where mediaid=movie and (languagespoken is not = en OR languagesubtitle is not = en) AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate)

Searching for all Seasons under Fringe:

Search where AMGID= {Fringe_AMG_ID} AND mediaid=TV Season  AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate)

Searching for all Foreign content for episodes of Season 4  Fringe (includes clips,etc):

Search where AMG_SeasonID = {AMG_Season_ID} AND (languagespoken is not = en OR languagesubtitle not = en)     AND (mediaid is not = TV Season) ANDokToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate)

Searching for NCIS: Season 9 Episode 3 :

Search where mediaId = Tv Episode AND  Sequence=3  AND (SeasonProgramId = 19568763 OR AMGID = {NCIS_AMG_ID)   AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate)