Excel - shortForm clip metadata fields
Field-by-field reference for the Clip Excel template.
Overview
This reference describes the fields in the Clip Excel metadata template. For template downloads and rules on formatting, structure, row limits, and file format, see the Excel Metadata Overview.
Deliver the workbook and its referenced files using the Aspera or S3 delivery method approved during onboarding.
Each row represents a single clip. The optional sub_type and parent_* fields describe the clip and its parent program. Sports metadata (sport_type, sport_league, sport_teams) is optional for clips overall, but required for sports clips. These groups are not in the Film and TV templates; the Clip XML Reference includes the same groups.
Fields are grouped into: Package Info, Content Descriptors, Cast & Crew, Assets, Artwork, Availability, Parent Info, and Sports Metadata.
Package Info
provider
Name of the content owner, studio, or network.
| Excel Column | Accepted Values | Required |
|---|---|---|
provider | Example: Roku Originals | Required |
contentType
Content type of the package.
| Excel Column | Accepted Values | Required |
|---|---|---|
contentType | clip | Required |
sub_type
Content sub-type of the package. Use one of the values below to identify ancillary or related content. Roku does not support native parent/child connections, so this field does not create a system-level link between the two assets. The Parent Info fields let you describe the parent program without creating a link.
| Excel Column | Accepted Values | Required |
|---|---|---|
sub_type | trailer, highlight, making_of, behind_scenes, interview, related, recap, extra | Optional |
language
Language of the title, synopses, video, captions, subtitles, audio dubs, and artwork listed in the row. The value must use a supported language code. A region code is recommended to distinguish variants such as es-MX and es-ES.
| Excel Column | Accepted Values | Required |
|---|---|---|
language | Valid language value | Required |
original_spoken_language
Original production language of the clip. The value must use a supported language code. A region code is recommended.
| Excel Column | Accepted Values | Required |
|---|---|---|
original_spoken_language | Valid language value | Required |
country_of_origin
The primary country where the clip was produced, and where the main creators, crew, and producers are established. Must conform to a supported ISO 3166-1 alpha-2 code.
| Excel Column | Accepted Values | Required |
|---|---|---|
country_of_origin | Valid 2-character country code per ISO 3166-1 alpha-2 | Preferred |
asset_id
Immutable, unique identifier for a clip. The partner generates or supplies this ID. It must match the Title ID in the Avails document so Roku can track the title through processing. 50-character limit.
| Excel Column | Accepted Values | Required |
|---|---|---|
asset_id | Alphanumeric characters, hyphens, and underscores only. 50 characters maximum. | Required |
eidr
EIDR ID, if one exists.
| Excel Column | Accepted Values | Required |
|---|---|---|
eidr | Any valid EIDR ID | Optional |
tms_id
Gracenote ID, if one exists.
| Excel Column | Accepted Values | Required |
|---|---|---|
tms_id | Any valid TMS ID | Optional |
Content Descriptors
title
Title of the clip, in the language defined in the language column. Include only the name as it should appear on the platform. Do not add parenthetical information that is not part of the title (e.g., (Classic), (1987), (Season 1), (HD)).
| Excel Column | Accepted Values | Required |
|---|---|---|
title | Example: Clip Title | Required |
genres
Genre classification of the content. Each clip must be delivered with at least one supported genre. See the enumerated genre list.
| Excel Column | Accepted Values | Required |
|---|---|---|
genres | See enumerated list. No more than 10 genres per title. | Required |
tags
Freeform tags that describe the content beyond its genre. Roku's editorial team and recommendations engine use these tags to help viewers find content. There is no limit on the number of tags and no predefined tag list. Tags are case-sensitive, so use consistent capitalization (e.g., "Rom-Com" and "rom-com" are two distinct tags).
| Excel Column | Accepted Values | Required |
|---|---|---|
tags | Any string under 50 characters | Highly recommended |
runtime
Total runtime of the content, in whole minutes.
| Excel Column | Accepted Values | Required |
|---|---|---|
runtime | Integers only. Example: 90 | Required |
release_date
Original date the content was first made available in any presentation. Must include an accurate year of release at minimum.
| Excel Column | Accepted Values | Required |
|---|---|---|
release_date | ISO 8601 format: YYYY-MM-DD | Required |
rating_system and ratings
rating_system holds the rating authority (e.g., MPAA), and ratings holds the corresponding rating value (e.g., PG-13) for that authority. A valid movie or TV rating from the rating authority of the territory where the content will be available must be provided for each clip. If not rated by that territory's official authority, use a valid USA_PR rating instead, per tvguidelines.org guidelines.
| Excel Column | Accepted Values | Required |
|---|---|---|
rating_system | See rating values by system and country | Required |
ratings | See rating values by system and country | Required |
brief_synopsis
A brief synopsis of the clip, in the language defined in the language column. 100-character limit. Required for Linear OTT distribution.
| Excel Column | Accepted Values | Required |
|---|---|---|
brief_synopsis | Up to 100 characters | Required for Linear OTT distribution |
short_synopsis
A short synopsis of the content, in the language defined in the language column. 250-character limit.
| Excel Column | Accepted Values | Required |
|---|---|---|
short_synopsis | 250-character synopsis | Required |
long_synopsis
An optional long synopsis of the content, in the language defined in the language column. 500-character limit.
| Excel Column | Accepted Values | Required |
|---|---|---|
long_synopsis | 500-character synopsis | Optional |
localized_brief_synopsis
A localized brief synopsis of the clip, in the language defined in the localized_language column. 100-character limit. Required for Linear OTT distribution.
| Excel Column | Accepted Values | Required |
|---|---|---|
localized_brief_synopsis | Up to 100 characters | Required for Linear OTT distribution |
closed_captions
Indicates whether the delivered title contains closed captions. The Y/N flag is required for all content intended for Roku Channel in the US. Providing this flag does not by itself require a caption file; the partner determines whether captions are required for that delivery.
| Excel Column | Accepted Values | Required |
|---|---|---|
closed_captions | Y or N | Required |
closed_captions_exemption
FCC exemption code for the closed caption requirement. Required in the US if closed_captions = N.
| Code | Definition |
|---|---|
| 1 | The content has never aired on television in the United States. |
| 2 | The content has only aired on television in the United States without captions. |
| 3 | The content has not aired on television in the United States with captions since September 30, 2012. |
| 4 | The content does not consist of full-length video programming. |
| 5 | The content does not fall within a category of online programming that requires captions under FCC regulations (47 C.F.R. § 79.4(b)). |
| 6 | The FCC and/or U.S. Congress has granted an exemption from caption requirements for this content. |
| Excel Column | Accepted Values | Required |
|---|---|---|
closed_captions_exemption | 1, 2, 3, 4, 5, 6 | Required in US if closed_captions = N |
Cast & Crew
cast
Names of cast members.
| Excel Column | Accepted Values | Required |
|---|---|---|
cast | Comma-separated list of Firstname Lastname | Preferred |
director
Name of the clip's director or directors.
Excel metadata currently supports only the director role for crew credits.
| Excel Column | Accepted Values | Required |
|---|---|---|
director | Comma-separated list of Firstname Lastname | Preferred |
Assets
video_file_name
File name of the video, in the language defined in the language column, delivered using the approved method. Only one video is allowed per asset_id. The file name must exactly match the delivered file, including capitalization, and must not contain whitespace or special characters.
| Excel Column | Accepted Values | Required |
|---|---|---|
video_file_name | Example: movieVideoFile.mov | Required |
video_file_language
Primary language of the video file's spoken dialogue, visible text, or both. If there is no dialogue or visible text, use the language spoken by the intended audience. Also applies to caption_file_name and forced_subtitle_file_name. Only one language is allowed.
| Excel Column | Accepted Values | Required |
|---|---|---|
video_file_language | One valid language value | Required |
audio_layout
Audio layout descriptor for the delivered video file.
| Excel Column | Accepted Values | Required |
|---|---|---|
audio_layout | stereoOnly, surroundOnly, stereoPlusSurround, surroundPlusStereo | Optional |
descriptive_audio_file_name
For audio description files only. File name of the descriptive audio file, in the language defined in descriptive_audio_language, delivered using the approved method. The file name must exactly match the delivered file, including capitalization, and must not contain whitespace or special characters.
| Excel Column | Accepted Values | Required |
|---|---|---|
descriptive_audio_file_name | Example: movieDubFile.wav | Required when providing a sidecar descriptive audio file for accessibility purposes |
descriptive_audio_language
For audio description files only. Primary language of the audio file's spoken dialogue track. Only one language is allowed.
| Excel Column | Accepted Values | Required |
|---|---|---|
descriptive_audio_language | One valid language value | Required when providing descriptive audio files |
caption_file_name
Roku strongly prefers closed captions. The partner is responsible for determining whether captions are required for a specific delivery.
If supplied, enter the name of the closed caption file delivered using the approved method, in the language defined in the language column. The file name must exactly match the delivered file, including capitalization, and must not contain whitespace or special characters. Its language is derived from video_file_language.
| Excel Column | Accepted Values | Required |
|---|---|---|
caption_file_name | Example: movieCaptions.srt | Strongly preferred |
forced_subtitle_file_name
File name of the forced narrative subtitle, in the language defined in video_file_language, delivered using the approved method. The file name must exactly match the delivered file, including capitalization, and must not contain whitespace or special characters. Its language is derived from video_file_language.
| Excel Column | Accepted Values | Required |
|---|---|---|
forced_subtitle_file_name | Example: movieForcedSubtitle.srt | Required when providing forced narrative subtitles |
Artwork
The Clip template includes one artwork field: a 16:9 Key Art image, as described in the Artwork Specification.
keyart_file_name
File name of the texted key art image, in the language defined in the language column, delivered using the approved method. The file name must exactly match the delivered file, including capitalization, and must not contain whitespace or special characters.
| Excel Column | Accepted Values | Required |
|---|---|---|
keyart_file_name | Example: movieKeyArt.jpg | Required |
Availability
territory
Country codes for the territories where the content is available. You may enter multiple country codes separated by commas, provided vod_type, license_start_date, and license_end_date are identical across them.
| Excel Column | Accepted Values | Required |
|---|---|---|
territory | US, CA, GB, MX | Preferred |
vod_type
Monetization type of the clip. You may enter multiple values separated by commas, provided territory, license_start_date, and license_end_date are identical across them.
| Excel Column | Accepted Values | Required |
|---|---|---|
vod_type | Example: avod, svod, avod,svod | Preferred |
license_start_date
Start date of content availability. The date must be before license_end_date; the dates must not be the same.
| Excel Column | Accepted Values | Required |
|---|---|---|
license_start_date | ISO 8601 format: YYYY-MM-DDTHH:MM:SS | Preferred |
license_end_date
End date of content availability. The date must be after license_start_date; the dates must not be the same.
| Excel Column | Accepted Values | Required |
|---|---|---|
license_end_date | ISO 8601 format: YYYY-MM-DDTHH:MM:SS | Preferred |
Parent Info
These fields describe the program a clip comes from or relates to. Use them with a valid sub_type value. They do not create a navigable link or an on-platform relationship between the clip and its parent program.
parent_type
Content type of the parent the clip is derived from or describes.
| Excel Column | Accepted Values | Required |
|---|---|---|
parent_type | episode, movie, series | Optional |
parent_title
Title of the parent program, if the parent is a movie or series.
| Excel Column | Accepted Values | Required |
|---|---|---|
parent_title | Example: Title of Parent Movie or Series | Optional |
parent_runtime
Runtime of the parent program, if the parent is a movie or episode.
| Excel Column | Accepted Values | Required |
|---|---|---|
parent_runtime | Integer | Optional |
parent_release_date
Release date of the parent movie, episode, or series.
| Excel Column | Accepted Values | Required |
|---|---|---|
parent_release_date | ISO 8601 format: YYYY-MM-DD | Optional |
parent_tms_id
TMS ID of the parent movie, episode, or series.
| Excel Column | Accepted Values | Required |
|---|---|---|
parent_tms_id | Any valid TMS ID | Optional |
parent_series
Series title of the parent program, if the parent is an episode.
| Excel Column | Accepted Values | Required |
|---|---|---|
parent_series | Example: Parent Series Title | Optional |
parent_season
Season number of the parent program, if the parent is an episode.
| Excel Column | Accepted Values | Required |
|---|---|---|
parent_season | Integer greater than 0 | Optional |
parent_episode
Episode number of the parent program, if the parent is an episode.
| Excel Column | Accepted Values | Required |
|---|---|---|
parent_episode | Integer | Optional |
Sports Metadata
The following fields are optional for clips overall, but required for sports clips.
sport_type
Name of the sport featured in the clip or highlight.
| Excel Column | Accepted Values | Required |
|---|---|---|
sport_type | Name of the sport | Required for sports clips |
sport_league
Name of the sports league featured in the clip or highlight.
| Excel Column | Accepted Values | Required |
|---|---|---|
sport_league | Name of the sport league | Required for sports clips |
sport_teams
Teams featured in the sports clip or highlight. You may enter multiple team names separated by commas.
| Excel Column | Accepted Values | Required |
|---|---|---|
sport_teams | Comma-separated list. Example: Chicago Cubs,St. Louis Cardinals | Required for sports clips |
Updated about 5 hours ago