TMS Customer Integration

Welcome to IVA! Tribune Media Services (TMS) 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

When you are ready, please contact our Sales team about an account. Make sure that you get the following information before continuing on:

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

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

Step 2: Get the data

TMS and IVA have worked together to provide a feed that will be updated once daily Monday – Friday and made available to TMS customers. This feed will include all the meta data you will need, including IVA’s Published ID and matching TMS ID. Please contact sales for access to these feeds and read through the TMS Data Dictionary to understand all the fields contained in this feed.

Reference: TMS Data Dictionary

There are different versions of the data feeds on the FTP.  Be sure to use the appropriate one.  The newest version is v4 and is recommended.  If you are unsure of which one to use, please contact our support team.

  • TMSVideoV4 & TMS_Root_v4 – (recommended version) In this newest version of the feed IVA has removed the defaultVideoAsset property and added the following: mezzanine_digitized_date and dateCreated.
  • TMS_Root_v3 – This version includes the GroupPermissionID field.  Any asset where this field appears requires special permissions to access.  You would need to know if your account has permission for these assets. Contact support if you are unsure.
  • TMS_Root – This version uses the TMS Root ID’s as the key value instead of the TMS ID.  Anyone not using the TMS English US data set should use this file with the Root ID’s.
  • TMSVideoV2 – This updated version has some additional fields needed to make appropriate programmatic decisions about the content.
  • TMSVideo – This is our older version and should not be used by any new customers.

Step 3: Video

Now that you have ingested the data, use the Video API to create links to the content for use inside your own player.

VIDEO API

To construct a valid video API call 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
  • Psuedo-code to Generate Hash = MD5(lcase(1234http://video.internetvideoarchive.net/player.aspx?customerId=12345&cmd=6&fmt=4&videokbrate=750&publishedid=1757&e=1171159092))
  • Hash = c13c876ea56c6124cba712c050a7ae69

Finished URL:

http://video.internetvideoarchive.net/player.aspx?customerId=12345&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: 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 Tribune Media Services and IVA!

TMS Data Dictionary

This data dictionary is for TMS data subscribers only.  Please contact our support team for access to this feed.   This feed is used to integrate IVA trailers with TMS data.

Be sure you are using the latest version of the mapping table.  Current version is v4.

Field Name Definition
TMSID (not null)This is the principal TMS identifier for a root level program.  For TV, this will correspond to the TMS 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.
TMSID_V (nullable)The TMS 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 TMSID for and episode.    Note:   This is the same as TMSID if the TMSID_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 TMSID if IVA_AssetID is a root level record.
TMS_SeasonID (nullable)TMS 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 TMSID_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 Televion Seasons (with Television Series parents) or Television Episodes (with Television Season parents).
DefaultVideoAsset (depreciated)This property is removed in 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 Ads (V2 Feed Only)Indicates whether this video must enable ads
Requires IVA Player (V2 Feed Only)Indicates whether this video requires ONLY using the IVA Player.
Region Restrictions (V2 Feed 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 feed 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. (added in the v3 and v4 feeds)
dateCreatedDate the record was created in the IVA database. (added in v4 feeds)
mezzanine_digitized_dateThe date that our mezzanine file was created. Use this field to know if the video has changed or to see what is the newest video. (added in the v4 feeds)

Examples:

Searching for the newest movie trailer :

Search where mediaID = (Movie OR Movie Alternate Version)  AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate) order by the mezzanine_digitized_date

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 TMSID= {Fringe_TMS_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 TMS_SeasonID = {TMS_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 TMSID = {NCIS_TMS_ID)   AND okToEncodeAndServe=1 AND WarningFlag=0 AND (expirationDate = “” OR expirationDate > currentDate)