Movie Elements
Note: After clicking a link in the diagram, the element scrolls into focus below the diagram.
├── Partner └── Works ├── Movie │ ├── ID │ ├── ExternalID │ ├── Titles │ │ └── Title │ ├── Copyright │ ├── Offers │ │ ├── SubscriptionOffer │ │ │ ├── Regions │ │ │ │ └── Territories │ │ │ ├── WindowStart │ │ │ ├── WindowEnd │ │ │ └── LaunchDetails │ │ │ ├── Quality │ │ │ ├── AudioLanguage │ │ │ ├── Subtitle │ │ │ └── LaunchId │ │ └── FreeOffer │ │ ├── Regions │ │ │ └── Territories │ │ ├── WindowStart │ │ ├── WindowEnd │ │ └── LaunchDetails │ │ ├── Quality │ │ ├── AudioLanguage │ │ ├── Subtitle │ │ └── LaunchId │ ├── IsAdultProducts │ │ └── IsAdultProduct │ ├── ReleaseYear │ ├── ShortDescriptions │ │ └── ShortDescription │ ├── Synopses │ │ └── Synopsis │ ├── MetadataAvailabilityDates │ │ └── MetadataAvailabilityDate │ ├── Images │ │ └── Image │ │ ├── Url │ │ └── Locale │ ├── Runtimes │ │ └── RuntimeMinutes │ ├── Color │ ├── Credits │ │ ├── CastMember │ │ │ ├── Name │ │ │ ├── ExternalID │ │ │ └── Role │ │ └── CrewMember │ │ ├── Name │ │ ├── ExternalID │ │ └── Job │ ├── Studios │ │ └── Studio │ ├── Language │ ├── CustomerRating │ │ ├── Score │ │ ├── MaxValue │ │ └── Count │ ├── Rank │ ├── IsOriginals │ │ └── IsOriginal │ ├── Genres │ │ └── Genre │ ├── ContentRatings │ │ └── ContentRating │ │ ├── System │ │ └── Certification │ └── ReleaseDates │ └── ReleaseDate ├── TvEpisode ├── TvSeason ├── TvShow └── Extra
<Catalog xmlns="http://www.amazon.com/FireTv/2014-04-11/ingestion" version="FireTv-v1.11"> <Partner>ACME</Partner> <Works> <Movie> <ID>GN46PVTF92VXV30</ID> <ExternalID scheme="tms">28873</ExternalID> <Title locale="it">Falcão Negro em Perigo</Title> <ReleaseYear>2001</ReleaseYear> <ShortDescription locale="it">U.S. soldiers (Josh Hartnett, Ewan McGregor, Tom Sizemore) take heavy fire while trying to capture a warlord's associates in Mogadishu, Somalia.</ShortDescription> <Synopsis locale="it">The film takes place in 1993 when the U.S. sent special forces into Somalia to destabilize the government and bring food and humanitarian aid to the starving population. Using Black Hawk helicopters to lower the soldiers onto the ground, an unexpected attack by Somalian forces brings two of the helicopters down immediately. From there, the U.S. soldiers must struggle to regain their balance while enduring heavy gunfire.</Synopsis> <Images> <Image> <Url>http://amzf.tmsimg.com/assets/28873/p28873_k_h2_aa.jpg</Url> </Image> </Images> <RuntimeMinutes>144</RuntimeMinutes> <Credits> <CastMember> <Name locale="it">Sam Shepard</Name> <ExternalID scheme="tms">57668</ExternalID> <Role locale="it">Garrison</Role> </CastMember> </Credits> <Language>en</Language> <Genres> <Genre locale="it">Drama</Genre> <Genre locale="it">War</Genre> </Genres> </Movie> </Works> </Catalog>
The root element of a CDF file. Each catalog file must contain a single Catalog
element which contains the rest of the file.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements | none |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, one allowed) (required, one allowed) |
Attributes |
Data Type: Enum. Enum Values: |
Identifies you as the provider of this catalog. There is no required format, but it should be human-readable. As a good convention, use your app's name as it is seen in the Amazon Appstore. You might also use your full provider name. Each catalog file must contain a single Partner element.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Catalog |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | string |
Contains all of the individual entries in your catalog: movies, TV shows, seasons, specials, mini-series, episodes, and extras. Each catalog file must contain a single Works
element. The Works
element can contain as many work entries as needed, and as many of each type as needed.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Catalog |
Content Model | contentType — sequence and choice. You can optionally include any of the child elements under a Works element, and that child element can appear multiple times, in whatever order you want them in.
|
Child Elements | (optional, unlimited) (optional, unlimited) (optional, unlimited) (optional, unlimited) (optional, unlimited) |
Attributes | None |
Represents a feature-length film, but can also be used for short films. This work can be a theatrical release or a made-for-TV movie.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
Works |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, one allowed) (optional, unlimited) (required, unlimited) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (required, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) |
Attributes | None |
A single episode of a TvShow
, normally also associated with a TvSeason
.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
Works |
Content Model | complexType – sequence with some choice. Must contain required child elements in specified order. However, either ShowID or ShowTitle , but not both. Also, either SeasonID or SeasonInShow , but not both.
|
Child Elements | (required, one allowed) (optional, unlimited) (required, unlimited) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (required, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (required, one allowed) (required, one allowed) (required, one allowed) (required, one allowed) (optional, one allowed) (required, one allowed) (optional, one allowed) |
Attributes | None |
One of the basic work types, a TvSeason
is a single season of a TvShow
. When the SeasonID
of a TvEpisode
has the same value as the ID
of a TvSeason
, that episode declares itself part of the season.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
Works |
Content Model | complexType – sequence with some choice. Must contain required child elements in specified order. However, either ShowID or ShowTitle , but not both.
|
Child Elements | (required, one allowed) (optional, unlimited) (required, unlimited) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (required, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (required, one allowed) (required, one allowed) (required, one allowed) |
Attributes | None |
A televised series made up of seasons and episodes. When the ShowID
of a TvSeason
or a TvEpisode
has the same value as the ID of a TvShow
, that season or episode declares itself part of the show.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
Works |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, one allowed) (optional, unlimited) (required, unlimited) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (required, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) |
Attributes | None |
A clip that can be a standalone work or, more commonly, can be associated with another work (either external or in your catalog). Generally think of these as the equivalent of an extra feature included on a DVD.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Works |
Content Model | complexType – sequence with some choice. Must contain required child elements in specified order. However, either RelatesToID or RelatesToExternalID , but not both.
|
Child Elements | (required, one allowed) (optional, unlimited) (required, unlimited) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (required, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (optional, one allowed) (required, one allowed) (required, unlimited) (required, unlimited) |
Attributes | None |
An identifier string for a work. This value must be at least one character long and must be unique among all other IDs in your catalog. Two works with the same ID will cause your catalog to be rejected by the ingestion system. Devise an ID scheme and use it unfailingly to avoid duplicate IDs. For instance, you could use your Partner ID + the work type + a long identifier such as a GUID, for an ID such as AmazonStudios_ Movie_01152ce2-de7e-44c1-9736-e8f3b15a1ddf
. Any scheme that assures unique IDs within your catalog is valid.
Two things to keep in mind when constructing IDs:
- When you update an existing catalog, the IDs for your works should not change. If an ID disappears from your catalog, we assume that work is no longer available on your service and it is removed from our index. If it returns later, it should have the same ID as before. If you change ID schemes after ingestion, it can negatively affect the customer experience.
- IDs should only contain the following characters: . , -, +, 0-9, A-Z, a-z. If you wish to launch your app with a URI, use LaunchID inside of a LaunchDetails block (a property of offers).
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | NonEmptyToken |
An identifier for a work under an external classification, such as IMDb. This value is used in content matching, to compare a work or person against that in another catalog to determine whether they're the same work or person. It can also be used as the source of external content such as images. Each element that contains an ExternalID
can contain as many as needed.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
CastMember CrewMember Extra Movie TvEpisode TvSeason TvShow |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: Enum. Enum Values:
Data Type: string |
Contains a work's title. Each work can contain one Titles
element.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | simpleType (no children) |
Child Elements | (required, unlimited) |
Data Type | Localized string |
A work's title. Each work can contain multiple Title
elements for the purpose of providing localized titles.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
Titles |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
Data Type | TerritoryStringType - Same as string with the addition of the locale , pronunciation , and territories attributes. |
A statement of the work's copyright.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string |
Data Type | Localized string |
Contains the offers through which a viewer can play a given work: for free, by having a subscription to the service, through rental, or through purchase. Each work type can contain only one Offers
element, and that Offers
element must contain at least one offer type.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – choice. Either one child element or another required, but not both. |
Child Elements | (required, one allowed) (required, one allowed) |
Attributes | None |
The work can be watched by subscribers to the provider's service. If necessary, you can have multiple SubscriptionOffer
elements under Offers
. SubscriptionOffer
is one of the two offer types. Important: The SubscriptionOffer
element is optional, but at least one offer type is required under Offers.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Offers |
Content Model | complexType – sequence with some choice. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) (optional, unlimited) (optional, one allowed) (optional, one allowed) |
Attributes | None |
Contains the countries in which a given offer is available. Each offer type can contain only a single Regions
element.
⚠Important! After Aug 31, 2021, "US" in this field will no longer include the US Territories. In order to include offers in these territories, explicitly add the region. See Example below for implementation.
US territory codes for reference:
USVI = VI, Guam = GU, Puerto Rico = PR, Mariana Islands = MP.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
SubscriptionOffer FreeOffer |
Content Model | complexType – choice. Either one child element or another required, but not both. |
Child Elements | (required, one allowed) |
Attributes | None |
A comma separated list of countries, regions, or territories in which a particular offer is available.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Regions |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
The date and time after which the work becomes available under a particular offer. Using WindowStart
and WindowEnd
, you can declare an offer to be available only for a specific window of time. Before and after that window, that offer is not shown to the viewer. If no offer is available at the time, the work itself is not shown to the viewer. Each offer can have only one WindowStart. WindowStart
and WindowEnd
can be used together or separately to control a work's availablility under an offer.
WindowStart
only: The work is available indefinitely from that time forward unless it is removed from the catalog.WindowEnd
only: The work is available immediately, but only until that time.WindowStart
+WindowsEnd
: The work is available only in that window of time.- Neither
WindowStart
norWindowEnd
: The work is immediately available and always will be unless it is removed from the catalog.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
SubscriptionOffer FreeOffer |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | dateTime |
The date and time after which the work will no longer be available under a particular offer. Each offer can have only one WindowEnd
. Using WindowStart
and WindowEnd
, you can declare an offer to be available only for a specific window of time. After the time specified by WindowEnd
, the offer is no longer presented to the viewer. If all offers have expired, the work itself is not shown to the viewer. WindowStart
and WindowEnd
can be used together or separately to control a work's availablility under an offer.
WindowStart
only: The work is available indefinitely from that time forward unless it is removed from the catalog.WindowEnd
only: The work is available immediately, but only until that time.WindowStart
+WindowsEnd
: The work is available only in that window of time.- Neither
WindowStart
norWindowEnd
: The work is immediately available and always will be unless it is removed from the catalog.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
SubscriptionOffer FreeOffer |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | dateTime |
Contains elements that specify a work's available video quality, audio language, and subtitle options under a particular offer. LaunchDetails
also contains an optional LaunchId
which allows a direct launch of the work in a specific configuration of quality, language, and subtitle.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
SubscriptionOffer FreeOffer |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (optional, unlimited) (optional, unlimited) (optional, unlimited) (optional, one allowed) |
Attributes | None |
The visual quality of the work: standard definition (SD
), high definition (HD
), and ultra high definition (UHD
). A work can be offered with multiple visual quality options.
Quality
. The first, a direct child of each offer type, was deprecated in CDF v1.2. The second is a child of LaunchDetails
, and therefore a grandchild of each offer type. This newer, non-deprecated Quality
element is the one we discuss here, although other than their parent elements, the two are identical in form and content.Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
LaunchDetails |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | Enum: SD , HD , UHD |
An audio option for the work when that work has been dubbed into additional languages. You can include as many AudioLanguage
elements as needed to specify the work's available alternatives. AudioLanguage
is optional but strongly recommended for dubbed content. AudioLanguage
ensures your content displays the correct subtitle languages.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
LaunchDetails |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | language |
A language option for the work's subtitles. A work can have multiple subtitle options.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
LaunchDetails |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | language |
An identifier that allows you to launch a work with a specific configuration of video quality, audio language, and subtitles (or any subset of those three). A LaunchId
does not have a given format — the format must only be understood by your app's logic. Each LaunchDetails
element can contain only a single LaunchId
, so to specify more than one LaunchId
, you must include multiple LaunchDetails
elements.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
LaunchDetails |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | token |
Property | Detail |
---|---|
Use | |
How Many Allowed | |
Parent Elements | |
Content Model | |
Child Elements | |
Attributes | |
Data Type |
The work is free to view at any time, or optionally is free only during a given window. If necessary, you can have multiple FreeOffer
elements under Offers
. Important: The FreeOffer
element is optional, but at least one offer type is required under Offers
. FreeOffer
is one of the two offer types.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Offers |
Content Model | complexType – sequence with some choice. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) (optional, unlimited) (optional, one allowed) (optional, one allowed) |
Attributes | None |
Contains identification of a work as content for adult audiences only.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
Identifies a work as content for adult audiences only.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
IsAdultProducts |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
Data Type | TerritoryBooleanType - Same as boolean with the addition of the territories attribute. |
Optional, but highly recommended. The year in which the work was originally released to the public, or the first air date in the case of television. Note that this value should match the year given in the same work's ReleaseDate
or OriginalAirDate
element.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | int |
A two- or three-line description of a work's content for locales and territories.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
Contains a two- or three-line description of a work's content. Do not use information included elsewhere, such as the work's title, for the ShortDescription
. Each work can contain multiple ShortDescription
elements for the purpose of providing localized descriptions. To provide a longer, more detailed description, use the Synopsis
element.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
ShortDescriptions |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
Data Type | TerritoryStringType - Same as string with the addition of the locale , pronunciation , and territories attributes. |
Contains a full description of the content varying by locale and territory.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
A description of a work's content. Synopsis
is intended to give more detail than ShortDescription
. Do not use the ShortDescription
or the work's Title
as the Synopsis
. Each work can contain multiple Synopsis
elements for the purpose of providing localized descriptions.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
Synopses |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string |
Data Type | TerritoryStringType - Same as string with the addition of the locale , pronunciation , and territories attributes. |
Contains MetadataAvailabilityDate that vary by territories. Any field without a territory value is assumed to be applicable worldwide.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, one allowed) |
Attributes | None |
Date after which metadata information should be available to viewers. Including this information improves matching. Note that MetadataAvailabilityDate
is the same as WindowStart
; however, in addition to hiding the Play button, including MetadataAvailabilityDate
hides the metadata associated with the content until the date indicated. Combining MetadataAvailabilityDate
with WindowStart
will show information at the time of premiere (for example, The Man in the High Castle premiere).
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
MetadataAvailabilityDates |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
Data Type | TerritoryDateTimeType - Same as dateTime with the addition of the territories attribute. |
Images to represent the TV or movie content. See Image
for image size details.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
An image to represent the TV or movie content. Images should be in JPG or PNG format (JPG preferred). Use a 16:9 aspect ratio, with dimensions at least 853px wide x 480px high for TV shows/seasons/episodes. Larger sizes are better (1920px wide x 1080px high is ideal); Amazon will scale images as needed. Images smaller than 853px wide x 480px, or images following other aspect ratios, will not be used. In those cases, another image source (for example, IMDb) or a placeholder image will be used instead.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
Images |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, one allowed) (optional, unlimited) |
Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
A URL for the image. See Image
for details on image size and dimensions.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Image |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | anyURI |
The language for the image. See Image
for details on image size and dimensions.
locale
element ensures your content is matched correctly across languages and regions. Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
Image |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | language |
Contains overall running time of the content varying by locale and territory.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
The overall running time of the content, in minutes. This is a non-negative number and is expected to be less than 2880, though there may be instances that legitimately exceed that value.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
Runtimes |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
Data Type | TerritoryInteger - Same as int with the addition of the territories attribute. |
Specifies whether the movie is primarily in color or in black-and-white.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | Enum: color , black_and_white |
Contains elements that represent a work's cast and crew members. The same person can appear as both cast or crew multiple times. Each work can contain only one Credits
element. If present, Credits
must contain at least one CastMember
or CrewMember
, though it can contain as many of each of those elements as needed.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – choice. Either one child element or another required, but not both. |
Child Elements | (required, one allowed) (required, one allowed) |
Attributes | None |
Provides information about a person in the work's cast, such as an actor, host, narrator, or voice talent. When present, the optional Credits
element must include at least one entry, either a CastMember
or a CrewMember
. You can include as many CastMember
elements as needed.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
Credits |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) (optional, unlimited) (optional, unlimited) |
Attributes | None |
Relates to works. The name of a work's cast or crew member. For a cast member, this is the person's name and not their character's name.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
CastMember CrewMember |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string |
Data Type | Localized string |
An identifier for a work under an external classification, such as IMDb. This value is used in content matching, to compare a work or person against that in another catalog to determine whether they're the same work or person. It can also be used as the source of external content such as images. Each element that contains an ExternalID
can contain as many as needed.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
CastMember CrewMember Extra Movie TvEpisode TvSeason TvShow |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: Enum. Enum Values:
Data Type: string |
The character's name in a work, as played by a CastMember
. Examples are Robin Hood, Sir Lancelot du Lac, Athena, or Self. Do not use "actor" (all CastMember
entries are actors) or "unknown" for this value. A CastMember
element can contain multiple Role
elements if that person played multiple roles.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
CastMember |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: string
Data Type: language |
Data Type | Localized string |
Contains elements that provide information about a person in the work's off-screen crew, such as a director, writer, cinematographer, best boy, animator, or grip. When present, the optional Credits
must include at least one entry, either a CastMember
or a CrewMember
. You can include as many CrewMember
elements as needed.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Credits |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) (optional, unlimited) (required, unlimited) |
Attributes | None |
The position held by a work's CrewMember
, such as director, cinematographer, writer, or animator. A CrewMember
can have as many Job
elements as needed.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
CrewMember |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string |
Data Type | Localized string |
Contains one or more Studio
elements that identify the studio(s) that produced the work.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode TvSpecial Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (optional, unlimited) |
Attributes | None |
The studio that produced the work. A work can have multiple Studio
entries.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
Studios |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | string |
The language in which the work was originally produced, which can refer to either the audio or, in the case of a silent work, on-screen text. A work can contain only one Language
element. Also use AudioLanguage
to specify any dubbed options. While it is possible to submit your catalog without a language, it's strongly recommended to add the content's language as a best practice, particularly if you have content available in multiple languages. You need to specify the language for each version of your content to ensure Amazon matches your content to the correct language.
If you want to provide your content in multiple regions with different languages, you need to provide localized content in the respective language. For example, if you want to provide an English film in Japan, you need to provide a Japanese version of the film.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | language |
Contains elements that provide the average customer rating for a work, the maximum rating value, and the number of ratings that contributed to the score. Each work can contain only one CustomerRating
element.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, one allowed) (required, one allowed) (optional, one allowed) |
Child Elements Notes | Count is only available in CDF v1.2 and later. |
Attributes | None |
An average score (rating) for a work based on customer feedback. How you gather that information is up to you, as well as setting the MaxValue
to give a scale to the rating system. You can add an optional Count
of how many votes contributed to the Score. A CustomerRating
can contain only a single Score
.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
CustomerRating |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | decimal (positive value) |
The highest possible value for a work's customer rating. Each CustomerRating
can contain only one MaxValue
.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | decimal (positive value) |
The number of users that have contributed to a customer rating Score
. Only one Count
is allowed per CustomerRating
.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
CustomerRating |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | Non-negative long |
A numerical popularity score relative to the other items in your catalog. The highest rank is defined as 1. How you determine the rankings is up to you, but it is acceptable for multiple items to have the same rank. A work can have only a single Rank
element.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | int |
Contains whether the item is a provider original. Content originality can vary for different countries and territories. For example, a movie could be a Prime Video original worldwide except for Japan and Canada. This element allows you to indicate which territories have a different originality from the worldwide setting.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
Describes whether the item is a provider original. Content originality can vary for different countries and territories. For example, a movie could be a Prime Video original worldwide except for Japan and Canada. This element allows you to indicate which territories have a different originality from the worldwide setting.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
IsOriginals |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
Data Type | TerritoryBooleanType - Same as boolean with the addition of the territories attribute. |
Contains one or more Genre
tags used to describe the category of the work, such as comedy, horror, or documentary.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
The genre of the work, such as comedy, horror, drama, or documentary. A work can be described through multiple Genre
elements if necessary. For optimized search and matching, attempt to use standard genre descriptions. Use multiple Genre
tags rather than combine several descriptions into a single string.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
Movie |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string |
Data Type | Localized string |
Contains one or more official ratings for the work, as determined by a specified certifying agency. Only one ContentRatings
element is allowed per work.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow TvSeason TvEpisode Extra |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
Contains elements that specify a rating system or organization and the rating they gave the work. When present, the optional ContentRatings
must contain at least one ContentRating
. You can have as many ContentRating
elements as you need, one for each system/rating pair. ContentRatings
is required for the following countries: US, Brazil, Australia, Japan. For all other countries, ContentRatings
is strongly recommended.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
ContentRatings |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, one allowed) (required, one allowed) |
Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
The rating system, normally an official organization, that determined a work's rating. Each rating can have only one System
.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
ContentRating |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | string |
The certification or rating given to the work under a specified certification System
. Only one Certification
element is allowed for each ContentRating
.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
ContentRating |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | string |
Used to tie a TvEpisode
or a TvSeason
to a TvShow
in your catalog. This value must match the ID value in a TvShow
element. You have the option of using ShowID
or ShowTitle
to specify the show, but not both. Always use ShowID
when the TvShow
is in your catalog.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
TvSeason TvEpisode |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | token |
Used to tie a TvEpisode
or a TvSeason
to a TvShow
in your catalog. This value is simply a string for use in the UI and is not required to match any title in your catalog. You have the option of using ShowID
or ShowTitle
to specify the show, but not both. Use ShowTitle
only in the absence of ShowID
.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
TvSeason TvEpisode |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string |
Data Type | Localized string |
The number of a season that a TVEpisode
is a part of, when that season is not part of your catalog. SeasonInShow
is simply a number for use in the UI and is not required to match anything. You have the option of using SeasonID
or SeasonInShow
to specify the season, but not both. Use SeasonInShow
only in the absence of SeasonID
, which should be a rare occurrance.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
TvEpisode |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | int |
Used to tie a TvEpisode
or a TvSeason
to a TvShow
in your catalog. This value must match the ID value in a TvShow
element. You have the option of using ShowID
or ShowTitle
to specify the show, but not both. Always use ShowID
when the TvShow
is in your catalog.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
TvSeason TvEpisode |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | token |
Used to tie a TvEpisode
or a TvSeason
to a TvShow
in your catalog. This value is simply a string for use in the UI and is not required to match any title in your catalog. You have the option of using ShowID
or ShowTitle
to specify the show, but not both. Use ShowTitle
only in the absence of ShowID
.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
TvSeason TvEpisode |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string |
Data Type | Localized string |
The ID of the season of which a TvEpisode
is a part. The TvSeason
with this ID
must be present in the same catalog as this TvEpisode
. You have the option of using SeasonID
or SeasonInShow
to specify the season, but not both. SeasonID
should always be used when the season is in your catalog. If is not in your catalog, consider creating a TvSeason
entry.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
TvEpisode |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | token |
The number of a season that a TVEpisode
is a part of, when that season is not part of your catalog. SeasonInShow
is simply a number for use in the UI and is not required to match anything. You have the option of using SeasonID
or SeasonInShow
to specify the season, but not both. Use SeasonInShow
only in the absence of SeasonID
, which should be a rare occurrance.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
TvEpisode |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | int |
A title for the season in which a TvEpisode
appeared, such as "Season 2". Note that if the corresponding TvSeason
element is included in your catalog, this value is not required to match its Title
, though it should. Each TvEpisode
can have only one SeasonTitle
.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
TvEpisode |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: language
Data Type: string |
Data Type | Localized string |
A TV episode's sequence number within its season. Each TvEpisode
can contain only one EpisodeInSeason
element.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | One |
Parent Elements |
TvEpisode |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | int |
Set of Original Air Dates when the Episode or Specials was originally televised.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
TvEpisode |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
The date and time when a work was originally televised. The year portion of this value should match the ReleaseYear
, if that optional element is present. This information is useful in matching this work to content in other catalogs. A match allows us to show a single listing for a work that shows all of its available sources rather than having multiple search results for same thing.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
OriginalAirDates |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
Data Type | TerritoryDateTimeType - Same as dateTime with the addition of the territories attribute. |
Contains Release Dates of the content in various territories.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | One |
Parent Elements |
Movie TvShow |
Content Model | complexType – sequence. Must contain required child elements in specified order. |
Child Elements | (required, unlimited) |
Attributes | None |
The date and time when the work was originally released to the public, or the first air date in the case of television. The year portion of this value should match the ReleaseYear
, if that optional element is present. This information is particularly useful in matching this work to content in other catalogs. A match allows us to show a single listing for a work that shows all of its available sources rather than having multiple search results for same thing.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
ReleaseDates |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
Data Type | TerritoryDateTimeType - Same as dateTime with the addition of the territories attribute. |
Specifies an Extra
as a clip. A clip can be a trailer or be as extensive as a making-of documentary about the associated Movie
of the Extra
. Each Extra
can have only one Type
.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
Extra |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | Enum: clip |
Used to specify another work (such as a movie) with which an Extra
(such as a trailer for that movie) is associated. The work with this ID
must be present in the same catalog as this Extra
. You have the option of using RelatesToID
or RelatesToExternalID
to specify the associated work, but not both. RelatesToID
should always be used when the associated work is in your catalog.
Property | Detail |
---|---|
Use | Optional |
How Many Allowed | Unlimited |
Parent Elements |
Extra |
Content Model | simpleType (no children) |
Child Elements | None |
Data Type | token |
Used to specify another work (such as a movie) with which an Extra
(such as a trailer for that movie) is associated. RelatesToExternalID
specifies an identifier by which that other work (such as the movie) is known in an external classificiation such as IMDb. RelatesToExternalID
is used when the associated work is not a part of your catalog. You have the option of using RelatesToID
or RelatesToExternalID
to specify the association, but not both. Use RelatesToExternalID
only in the absence of RelatesToID
.
Do not confuse RelatesToExternalID
with ExternalID
. ExternalID
refers to the Extra
itself, while RelatesToExternalID
refers to the work that it's associated with.
Property | Detail |
---|---|
Use | Required |
How Many Allowed | Unlimited |
Parent Elements |
Extra |
Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
Child Elements | None |
Attributes |
Data Type: Enum. Enum Values:
Data Type: string |
Data Type | token |
Last updated: Feb 23, 2024