Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note: Once assigned to a content item, you cannot change the reference ID or use it for another content item in the Roku Search

meta-data

metadata.

FieldRequiredDescription

movies/movie/@id

Required

Your immutable reference ID for that movie.

Warning

... movie/titles/title

Required

Movie title. We use this value for matching. Please don’t include extra information like year, version label, and so forth.

… title/@language

Optional

Default: en

(Roku Search is currently only available in English.)

… movie/images/image

Optional

Although this is optional, we recommend that you include it for items where you unsure about whether we can or cannot match your content.

… image/url

Required

http://your_domain/your_image_path

Image dimensions must be 240 x 360 (W x H) pixels.

… image/@language

Optional

Default: en

(Roku Search is currently only available in English.)

… image/@category

Required

Must one of the following:

  • Poster Art
  • Box Art

… movie/descriptions/description

Required

You must provide a movie description that does not exceed 60 characters. You should (though are not required) to also provide longer descriptions not to exceed 500 characters (the maximum length is set by the description/@length attribute).

… description/@language

Optional

Default: en

(Roku Search is currently only available in English.)

… description/@length

Optional

Maximum character value for the short/long description. Must be one of the following:

  • 60 (default)
  • 100
  • 250
  • 500

… movie/runTime

Required

Runtime in seconds

… movie/releaseYear

Required

Year initially released or first aired

… movie/crew/person,

… movie/cast/person

Optional

Used to provide a list of cast and crew members.

Note: Roku recommends you provide this if there is a chance Roku data cannot match your data.

… cast/person/role

Required if a cast person is provided

Must be one of the following:

  • Actor
  • Anchor
  • Host
  • Narrator
  • Voice

… crew/person/role

Required if a crew person is provided

Must be one of the following:

  • Director
  • Host

… person/firstName

Required if person provided

First Name or abbreviation

… person/middleName

Optional

Middle Name or abbreviation

… person/lastName

Optional

Last Name

… person/birthDate

Optional

YYYY-mm-dd

… person/deathDate

Optional

YYYY-mm-dd

… person/image

Optional

http://your_domain/your_image_path

Image dimensions must be 270 x 360 (W x H) pixels.

… movie/ratings/rating

Optional

Localized parental rating of movie

… rating/rating

Required if rating provided

Must be a value found in Acceptable Parental Ratings

… rating/source

Required if rating provided

Must be either:

  • British Board of Film Classification
  • Canadian Home Video Rating System
  • Canadian Parental Rating
  • Motion Picture Association of America
  • UK Content Provider
  • USA Parental Rating

… movie/keywords/keyword

Optional

Keywords used to describe movie

… keyword/type

Required only if keyword

Must be:

  • Character
  • General
  • Mood
  • Setting
  • Subject
  • Theme
  • Time Period

… keyword/word

Optional

Users cannot search by keyword, however our meta-data structure supports them. For example, here are keywords for the movie Argo by keyword type:

Mood

  • Brutal
  • Tense
  • Suspenseful

Theme

  • Rescue
  • Escape

Subject

  • Iran hostage crisis
  • On the run
  • Political intrigue
  • Schemes

Time Period

  • 1970s

Setting

  • Tehran, Iran
  • CIA office
  • Canada
  • United States

Character

  • CIA agent
  • Specialist
  • Hostage
  • Revolutionary
  • Ambassador
  • Wife

… keyword/@language

Optional

Default: en

(Roku Search is currently only available in English.)

… movie/genres/genre

Optional

Must be found in Acceptable Genres.

… movie/videos/video

Required

The videos element lists all the video content items corresponding to the specific movie identified by the movie/@id attribute. Each child video element must have a unique play ID, and provide meta-data indicating availability, pricing and other specifics about that specific video content item available on your channel.

… video/playId

Required

A value you provide for each title in your XML feed that we will pass back to your channel when a user selects your service as a provider for a specific title (see Play IDs and Deep Linking).

… video/region

Optional

Can be one of the following 2-character ISO codes (can be either uppercase or lowercase):

  • us (default)
  • US (default)
  • gb
  • GB
  • ca
  • CA
  • ie
  • IE

… video/viewOptions/option

Required

Used to provide video viewing options.

… option/quality

Required

The resolution of the video content item. Must be one of the following (can either be uppercase or lowercase):

  • sd
  • SD
  • hd
  • HD
  • hd+
  • HD+
  • UHD

… option/license

Required

The type of licensing terms for the video content item. Must be one of the following (can either be initial capitalization or all lowercase):

  • free
  • Free
  • rental
  • Rental
  • purchase
  • Purchase
  • subscription
  • Subscription

… option/price

Required if option/license is set to purchase or rental, defaults to 0.00 if option/license is set to subscription or free

Price, that must include two decimal point places, such as "1.90", "1.99", or "2.00". If the price is "0.00", set option/license to "subscription" or "free" rather than setting option/price to "0.00", and option/price will be set to "0.00" by default.

… option/currency

Optional

The type of currency denominated by price. Must be one of the following (can be either uppercase or lowercase):

  • usd (default)
  • USD (default)
  • gbp
  • GBP
  • cad
  • CAD

...