An identifier for the partner providing the titles in this document. If you don't know your partner ID, contact your Amazon representative.
A list of works provided by this partner. May contain Movies, TV Special, TV Shows, TV Seasons, or TV Episodes.
[Added in version 1.2]
The version of the schema this catalog uses. Refer to the schema "id" to figure out which schema version you are using.
Although this attribute was made optional for compatibility reasons, we recommend that you provide the version.
e.g. FireTv-v1.2
[Added in version 1.3]
Use this type for clips or trailers.
The token which identifies the common-work item this extra belongs to. The item with
this ID should also appear in this document.
External identifier (e.g., IMDb) which identifies the item this extra belongs to.
Date and time when this item was FIRST released.
Use the SpecialType for one-off episodes that don't belong to traditional television hierarchies (show->season->episode) and news like episodes (for instance, Daily Shows that have a unique air-date per episode).
You can also use this type to represent special tv content like oscars, concerts shown on tv, or christmas special for a tv-show that doesn't belong to any season.
[Added in version 1.3]
If this TV Special belongs to a show, please provide the show information (ID or Title). In addition, you will need to provide the date-time this special was originally aired. The time portion of this field is specially valuable if multiple episodes originally aired on the same day.
We recommend you provide an original air date even if this item doesn't belong to any show. It will help us to match the content and make it searchable.
Date and time when this item was FIRST released.
[Added in version 1.3]
A mini series type in CDF is essentially a tv show that collects a small number of ORDERED episodes without any seasonal representation. There is no explicit limit on the number of episodes mini-series type can contain, although we generally expect it to be reasonably low.
Date and time when this item was FIRST released.
[Added in version 1.3]
An episodic content that belongs to a MiniSeriesType. This content is not associated to any seasons, and is sequenced in the context of the mini series.
In order to identify the series for a mini-series episode, we must have either a MiniSeriesID or MiniSeriesTitle.
The token which identifies the mini-series where this episode appears. The mini-series with
this ID should also appear in this document.
Provide the mini-series title ONLY if you don't have a mini-series ID that this episode is associated with. It is generally advised to create a mini-series object with a unique id for this title, and associate all episodes of the series with that MiniSeriesID.
The number of the episode in the context of the overall Mini Series.
In order to identify a show for a season, we must have either a ShowID or ShowTitle.
The token which identifies the show where this season appears. The show with
this ID should also appear in this document.
The number of the season in the context of the overall TV show.
In order to identify a show for an episode, we must have either a ShowID or ShowTitle.
The token which identifies the show where this episode appears. The show with
this ID should also appear in this document.
In order to identify the season for an episode, we must have either a ShowID or ShowTitle.
The token which identifies the season where this episode appears. The season with
this ID should also appear in this document.
The number of the season in the context of the overall TV show.
The number of the episode in the context of the season.
An identifier for a title. This field is required, and CAN NOT be left blank. The ID must be unique amongst all content for each partner.
External identifier (e.g., IMDb) for content matching.
A list of playback offers. This can include: Free, Subscription, Paid, or Rental.
DEPRECATED. Whether the item is rated as adult-only content.
The year in which the item was first released to the public, or the first airdate in the case of television.
DEPRECATED. The full date when the item was first released to the public, or the first airdate in the case of television.
Optionally includes a country of first release.
A short (2-3 line) description of the content. If you do not have a short description do not include this tag or substitute other information such as the title.
A description of the content. Intended to give more detail than ShortDescription. If you do not have a synopsis do not include this tag.
A URL that specifies an image to represent the TV or movie content ("box art"). Images should be in JPG or PNG format (JPG preferred) and a minimum of 240 pixels in height (at least 480 pixels preferred). Larger is better; we will scale as needed. Images smaller than 240px in height will not be used. Although not enforced, please use a 3:4 aspect ratio for movie art and 16:9 or 16:10 for TV shows/seasons/episodes. Images that exceed a 2:1 or 1:2 aspect ratio up to a 3:1 or 1:3 aspect ratio will be cropped to 2:1 or 1:2. Images that exceed a 3:1 or 1:3 aspect ratio will not be used. If the provided image is rejected, we will use another image source (for example, IMDb) or display a placeholder.
The overall running time of the content, in minutes.
The human contributors to the work; actors, crew, etc... The same person may appear as both cast or crew multiple times.
The studio or studios that produced the content.
An average customer rating for the content (e.g. 6.6/10.0).
A score relative to every other item in the catalog. Lower value means that the item is ranked higher than other items that have a higher value. The highest rank an item can have is 1. It is acceptable for multiple items to have the same rank.
A List of content ratings or certifications. Each item consists of a certifying system (e.g, MPAA) and a certification (e.g. R).
[Added in version 1.2]
An optional boolean flag to mark 18+ content for the Japanese marketplace. Setting this flag to true will require viewers of this content in Japan to confirm that their age is above 18. This is based on Japan's legal requirements.
[Added in version 1.1]
An enumerated value that specifies the source of content. The following types are valid:
1. original: Partner produced/created this content.
2. licensed: Partner did not create this content, and they license it from another studio.
3. unknown: Source is unknown.
4. other: Source is known but can not be classified into any of the other types in this enumeration.
One or more strings that states what the actor's role in the content is. This could either be the name of the character they played, or "self" if they played as themselves. This field should NOT be used to specify their job, for instance "actor" or "actress".
e.g.
Tom Hanks as "Forrest Gump" in Forrest Gump (1994)
John Malkovich as "self" in Being John Malkovich (1999)
[Added in version 1.2]
An optional value indicating number of users that have contributed to the score.
Length, in hours, of rental period.
DEPRECATED. The quality (SD, HD, UHD, etc) of this offer. This has been deprecated in favor of LaunchDetails::LaunchQuality.
[Added in version 1.2]
Group of attributes that you can launch a piece of content with, optionally including an identifier that does not need to be the same as the common work identifier.
The video qualities that the content can be launched with.
e.g. HD, SD, UHD, etc.
The Audio Languages (original language or dubbed languages) that the content can be launched with.
e.g. en-us, en-ca, etc.
The Subtitles that the content can be launched with.
e.g. en, es, etc.
An identifier that the Fire TV will use to launch this content with the quality, audio, subtitle combination specified in this group. If no value is specified, the common work's ID will be used to launch this content. This field is provided so that you can use a single identifier for content(s) that have the same metadata but differ in encoding audio (dubbed), quality, and subtitles. Using this field, you can specify the actual identifier that launches content with any combination.
e.g.
tt0499549 is the identifier for Avatar (2009). To launch it with Spanish audio and Spanish subtitles in HD, you could use an LaunchId like this: tt0499549:en-us:en:HD