Developer Console
Sign In
Sign In
Developer Console

All CDF Elements

AudioLanguage

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 ElementsNone
Data Type language
Example: 
<LaunchDetails>
  <Quality>SD</Quality>
  <Quality>HD</Quality>
  <AudioLanguage>en-US</AudioLanguage>
  <AudioLanguage>es-MX</AudioLanguage>
  <Subtitle>en-US</Subtitle>
  <Subtitle>es-MX</Subtitle>
  <LaunchId>MV123456_HD_es-MX_en</LaunchId>
</LaunchDetails>
↑ Back to top
CastMember

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 Name (required, unlimited)
ExternalID (optional, unlimited)
Role (optional, unlimited)
Attributes None
Example: 
<Credits>
  <CastMember>
    <Name locale="en-US">Alan Smithee</Name>
    <ExternalID scheme="imdb">tt0000000</ExternalID>
    <Role locale="en-US">Self</Role>
  </CastMember>
</Credits>
↑ Back to top
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 Partner (required, one allowed)
Works (required, one allowed)
Attributes

xmlns: Required. The XML namespace.

version: Optional. 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 is optional for compatibility reasons, Amazon recommends that you provide the version.

Data Type: Enum.

Enum Values: FireTv-v1.2, FireTv-v1.3, FireTv-v1.4, FireTv-v1.5, FireTv-v1.6, FireTv-v1.7, FireTv-v1.8, FireTv-v1.9, FireTv-v1.10, FireTv-v1.11, FireTv-v2.0
Example: 
<xml version="1.0" encoding="utf-8" ?>
<Catalog xmlns="http://www.amazon.com/FireTv/2014-04-11/ingestion" version="FireTv-v1.3">
  <Partner>Everything Ever Made Filmworks</Partner>
  <Works>
    ...
  </Works>
<Catalog>
↑ Back to top
Certification

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 ElementsNone
Data Type string
Example: 
<ContentRatings>
  <ContentRating territories="US,PR,VI">
    <System>MPAA</System>
    <Certification>PG-13</Certification>
  </ContentRating>
<ContentRating>
↑ Back to top
Color

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 ElementsNone
Data Type Enum: color, black_and_white
Example: 
<Movie>
  ...
  <Color>black_and_white</Color>
  ...
</Movie>
↑ Back to top
ContentRating

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 System (required, one allowed)
Certification (required, one allowed)
Attributes

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<ContentRatings>
  <ContentRating territories="US,PR,VI">
    <System>MPAA</System>
    <Certification>PG-13</Certification>
  </ContentRating>
  <ContentRating>
    <System>Eirin</System>
    <Certification>R15+</Certification>
  </ContentRating>
</ContentRatings>
↑ Back to top
ContentRatings

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 ContentRating (required, unlimited)
Attributes None
Example: 
<ContentRatings>
  <ContentRating territories="US,PR,VI">
    <System>MPAA</System>
    <Certification>PG-13</Certification>
  </ContentRating>
  <ContentRating>
    <System>Eirin</System>
    <Certification>R15+</Certification>
  </ContentRating>
</ContentRatings>
↑ Back to top

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 ElementsNone
Attributes

locale: Required. The device or software's language setting under which to use this string.

Data Type: language

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string
Data Type Localized string
Example: 
<Copyright locale="en-US">© 2014 Amazon Studios</Copyright>
↑ Back to top
Count

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 ElementsNone
Data Type Non-negative long
Example: 
<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>
↑ Back to top
Credits

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 CastMember (required, one allowed)
CrewMember (required, one allowed)
Attributes None
Example: 
<Credits>
  <CastMember>
    <Name locale="en-US">Alan Smithee</Name>
    <Role locale="en-US">Self</Role>
  </CastMember>
</Credits>
↑ Back to top
CrewMember

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 Name (required, unlimited)
ExternalID (optional, unlimited)
Job (required, unlimited)
Attributes None
Example: 
<Credits>
  <CrewMember>
    <Name locale="en-US">Alan Smithee</Name>
    <ExternalID scheme="imdb">tt0000000</ExternalID>
    <Job locale="en-US">Director</Job>
  </CrewMember>
</Credits>
↑ Back to top
CustomerRating

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 Score (required, one allowed)
MaxValue (required, one allowed)
Count (optional, one allowed)
Child Elements Notes Count is only available in CDF v1.2 and later.
Attributes None
Example: 
<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>
↑ Back to top
EpisodeInSeason

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 ElementsNone
Data Type int
Example: 
<TvEpisode>
  ...
  <EpisodeInSeason>6</EpisodeInSeason>
  ...
</TvEpisode>
↑ Back to top
ExternalID

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 ElementsNone
Attributes

scheme: Required. The external source that provided this ID.

Data Type: Enum.

Enum Values:

  • imdb: The Internet Movie Database (IMDb). IDs can be found as part of the URL of a given page.
  • tms: An OnTV domain — used to be Tribune Media Service, but it is essentially one of the older Gracenote ID spaces.
  • isan: The International Standard Audiovisual Number (ISAN), an alphanumeric strings of 26 characters, usually presented broken by dashes.
  • ean: The European Article Number (EAN) is a barcode standard, a 12- or 13-digit product identification code. Each EAN uniquely identifies the product, manufacturer, and its attributes.
  • upc: Universal Product Code (UPC) is a 12-digit bar code used extensively for retail packaging in United States.
  • asin: Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items.
  • gvd: Gracenote Video Data — the Gracenote ID provides "unique identifiers for TV programs and movies [to] enable linking to TV schedule data and on-demand catalogs".

region: Optional. Region for which the externalId is relevant, such as marketplace for Amazon ASINS or country for a TMS ID. For example, US for a TMS scheme.

Data Type: string
Example: 
<Movie>
  <ID>MV123456</ID>
  <ExternalID scheme="imdb">tt0000000</ExternalID>
  <ExternalID scheme="tms">MV000000000000</ExternalID>
  <ExternalID scheme="isan">0000-0000-0F00-0000-X-0000-0000-Y</ExternalID>
  <ExternalID scheme="ean">0011559514120</ExternalID>
  <ExternalID scheme="upc">123456789990</ExternalID>
  ...
</Movie>
↑ Back to top
Extra

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 ID (required, one allowed)
ExternalID (optional, unlimited)
Titles (required, unlimited)
Copyright (optional, one allowed)
Offers (optional, one allowed)
IsAdultProducts (optional, one allowed)
ReleaseYear (optional, one allowed)
ShortDescriptions (optional, one allowed)
Synopses (optional, one allowed)
MetadataAvailabilityDates (optional, one allowed)
Images (required, one allowed)
Runtimes (optional, one allowed)
Color (optional, one allowed)
Credits (optional, one allowed)
Studios (optional, one allowed)
Language (optional, one allowed)
CustomerRating (optional, one allowed)
Rank (optional, one allowed)
IsOriginals (optional, one allowed)
Genres (optional, one allowed)
ContentRatings (optional, one allowed)
Type (required, one allowed)
RelatesToID (required, unlimited)
RelatesToExternalID (required, unlimited)
Attributes None
Example: 
<Extra>
  <ID>EXTRA-11111</ID>
  ...
  <Type>clip</Type>
</Extra>
↑ Back to top
FreeOffer

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 Regions (required, unlimited)
LaunchDetails (optional, unlimited)
WindowStart (optional, one allowed)
WindowEnd (optional, one allowed)
Attributes None
Example: 
<FreeOffer>
  <Regions>
    <Territories>US, GB, DE</Territories>
  </Regions>
  <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
  <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
  <LaunchDetails>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
    <LaunchId>EXTRA-11113_HD_en-US</LaunchId>
  </LaunchDetails>
</FreeOffer>
↑ Back to top
Genre

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 ElementsNone
Attributes

locale: Required. The device or software's language setting under which to use this string.

Data Type: language

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string
Data Type Localized string
Example: 
<Genres>
  <Genre locale="en-US">horror</Genre>
  <Genre locale="en-US">sci-fi</Genre>
</Genres>
↑ Back to top
Genres

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 Genre (required, unlimited)
Attributes None
Example: 
<Genres>
  <Genre locale="en-US">horror</Genre>
  <Genre locale="en-US">sci-fi</Genre>
</Genres>
↑ Back to top
Image

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 Url (required, one allowed)
Locale (optional, unlimited)
Attributes

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<Movie>
  ...
    <Images>
      <Image territories="VI,GU,PR,GB">
        <Url>http://amzf.tmsimg.com/assets/28873/p28873_k_h2_aa.jpg</Url>
        <Locale>en</Locale>
      </Image>
      <Image territories="US">
        <Url>http://amzf.tmsimg.com/assets/28873/p28873_k_h2_haa.jpg</Url>
        <Locale>en</Locale>
      </Image>
    </Images>
  ...
</Movie>
↑ Back to top
Images

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 Image (required, unlimited)
Attributes None
Example: 
<Movie>
  ...
  <Images>
    <Image>
      ...
    </Image>
  </Images>
  ...
 </Movie>
↑ Back to top
ID

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 ElementsNone
Data Type NonEmptyToken
Example: 
<Movie>
  <ID>AmazonStudios_Movie_01152ce2-de7e-44c1-9736-e8f3b15a1ddf</ID>
  ...
</Movie>
↑ Back to top
IsAdultProduct

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 ElementsNone
Attributes

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<IsAdultProducts>
  <!-- if no territory is provided, then the field value is applicable worldwide. -->
  <IsAdultProduct>false</IsAdultProduct>
  <IsAdultProduct territories="IN,DE">true</IsAdultProduct>
</IsAdultProducts>
↑ Back to top
IsAdultProducts

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 IsAdultProduct (required, unlimited)
Attributes None
Example: 
<IsAdultProducts>
  <!-- if no territory is provided, then the field value is applicable worldwide. -->
  <IsAdultProduct>false</IsAdultProduct>
  <IsAdultProduct territories="IN,DE">true</IsAdultProduct>
</IsAdultProducts>
↑ Back to top
IsOriginal

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 ElementsNone
Attributes

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<IsOriginals>
  <!-- For worldwide originality of an item, use the IsOriginal child element without the territories attribute. -->
  <IsOriginal>true</IsOriginal>
  <!-- If the same content shouldn't be a provider original in US and CA, then add the additional element, below  -->
  <IsOrignal territories="US,CA">false</IsOrignal>
</IsOriginals>
↑ Back to top
IsOriginals

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 IsOriginal (required, unlimited)
Attributes None
Example: 
<IsOriginals>
  <!-- For worldwide originality of an item, use the IsOriginal child element without the territories attribute. -->
  <IsOriginal>true</IsOriginal>
  <!-- If the same content shouldn't be a provider original in US and CA, then add the additional element, below  -->
  <IsOrignal territories="US,CA">false</IsOrignal>
</IsOriginals>
↑ Back to top
Job

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 ElementsNone
Attributes

locale: Required. The device or software's language setting under which to use this string.

Data Type: language

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string
Data Type Localized string
Example: 
<CrewMember>
  <Name locale="en-US">Alan Smithee</Name>
  <ExternalID scheme="imdb">tt0000000</ExternalID>
  <Job locale="en-US">Grip</Job>
</CrewMember>
↑ Back to top
Language

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 ElementsNone
Data Type language
Example: 
<Movie>
  ...
  <Language>ja</Language>
  ...
</Movie>
↑ Back to top
LaunchDetails

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 Quality (optional, unlimited)
AudioLanguage (optional, unlimited)
Subtitle (optional, unlimited)
LaunchId (optional, one allowed)
Attributes None
Example: 
<FreeOffer>
  <Regions>
    <Territories>US, CA</Territories>
  </Regions>
  <LaunchDetails>
    <Quality>SD</Quality>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <AudioLanguage>fr-FR</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
    <LaunchId>EXTRA-11113_HD_en-US</LaunchId>
  </LaunchDetails>
</FreeOffer>
↑ Back to top
LaunchId

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 ElementsNone
Data Type token
Example: 
<SubscriptionOffer>
  ...
  <LaunchDetails>
    <Quality>SD</Quality>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <AudioLanguage>fr-FR</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <LaunchId>EXTRA-11113_HD_en-US</LaunchId>
  </LaunchDetails>
  <LaunchDetails>
    <Quality>SD</Quality>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <AudioLanguage>fr-FR</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <LaunchId>EXTRA-11113_SD_fr-FR_en-US</LaunchId>
  </LaunchDetails>
</SubscriptionOffer>
↑ Back to top
Locale

The language for the image. See Image for details on image size and dimensions.

Property Detail
Use Optional
How Many Allowed Unlimited
Parent Elements Image
Content Model simpleType (no children)
Child ElementsNone
Data Type language
Example: 
<Image>
   <Url>http://sample-server.net/cds/1.0/image/B23R/FJK8/9FAR/39RTE_992.png</Url>
   <Locale>es</Locale>
</Image>
↑ Back to top
MaxValue

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 ElementsNone
Data Type decimal (positive value)
Example: 
<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>
↑ Back to top
MetadataAvailabilityDate

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 ElementsNone
Attributes

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<Movie>
  <ID>MV-123456</ID>
  ...
  <MetadataAvailabilityDates>
    // Movie available in US, CA and GB on Sep 1, while rest of the territories
    // on Sep 15
    <MetadataAvailabilityDate>2021-09-15T12:00:00Z</MetadataAvailabilityDate>
    <MetadataAvailabilityDate territories="US,CA,GB">2021-09-01T12:00:00Z</MetadataAvailabilityDate>
  </MetadataAvailabilityDates>
  ...
</Movie>
↑ Back to top
MetadataAvailabilityDates

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 MetadataAvailabilityDate (required, one allowed)
Attributes None
Example: 
<Movie>
  <ID>MV-123456</ID>
  ...
  <MetadataAvailabilityDates>
    ...
  </MetadataAvailabilityDates>
  ...
</Movie>
↑ Back to top
Movie

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 ID (required, one allowed)
ExternalID (optional, unlimited)
Titles (required, unlimited)
Copyright (optional, one allowed)
Offers (optional, one allowed)
IsAdultProducts (optional, one allowed)
ReleaseYear (optional, one allowed)
ShortDescriptions (optional, one allowed)
Synopses (optional, one allowed)
MetadataAvailabilityDates (optional, one allowed)
Images (required, one allowed)
Runtimes (optional, one allowed)
Color (optional, one allowed)
Credits (optional, one allowed)
Studios (optional, one allowed)
Language (optional, one allowed)
CustomerRating (optional, one allowed)
Rank (optional, one allowed)
IsOriginals (optional, one allowed)
Genres (optional, one allowed)
ContentRatings (optional, one allowed)
ReleaseDates (optional, one allowed)
Attributes None
Example: 
<Movie>
    <ID>AMZN-0011</ID>
    <ExternalID scheme="imdb">tt0000008</ExternalID>
    <Titles>
        <!-- If the territories attribite is omitted, then the title is available globally, as shown below -->
        <Title locale="en-US">Global English Movie Title</Title>
        <!-- The below title is available only in the US -->
        <Title locale="es" territories="US">Spanish US Movie Title</Title>
    </Titles>
    <Copyright locale="en-US">Amazon 2021</Copyright>
    <Offers>
        <FreeOffer>
            <Regions>
                <Territories>GB, DE</Territories>
            </Regions>
            <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
            <WindowEnd>2030-01-01T07:00:00-07:00</WindowEnd>
            <LaunchDetails>
                <Quality>SD</Quality>
                <AudioLanguage>en-US</AudioLanguage>
                <Subtitle>en-US</Subtitle>
                <Subtitle>es</Subtitle>
                <LaunchId>AMZN-0011-enUS-SD</LaunchId>
            </LaunchDetails>
        </FreeOffer>
        <SubscriptionOffer>
            <Regions>
                <Territories>US, CA</Territories>
            </Regions>
            <WindowStart>2021-02-06T12:00:00-07:00</WindowStart>
            <WindowEnd>2022-01-01T07:00:00-07:00</WindowEnd>
            <LaunchDetails>
                <Quality>HD</Quality>
                <AudioLanguage>en-US</AudioLanguage>
                <Subtitle>en-US</Subtitle>
                <Subtitle>es</Subtitle>
                <LaunchId>AMZN-0011-enUS-HD</LaunchId>
            </LaunchDetails>
        </SubscriptionOffer>
    </Offers>
    <IsAdultProducts>
        <!-- if no territory is provided, then the field value is applicable worldwide. -->
        <IsAdultProduct>false</IsAdultProduct>
        <IsAdultProduct territories="IN,DE">true</IsAdultProduct>
    </IsAdultProducts>
    <ReleaseYear>1959</Releaseyear>
    <ShortDescriptions>
        <ShortDescription locale="en-US" territories="US">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</ShortDescription>
    </ShortDescriptions>
    <Synopses>
        <Synopsis locale="en-US" territories="US, GB">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</Synopsis>
        <Synopsis locale="es" territories="MX">Nulla pellentesque dignissim enim sit amet venenatis urna cursus. Metus vulputate eu scelerisque felis imperdiet. Ullamcorper a lacus vestibulum sed. Sed ullamcorper morbi tincidunt ornare. Odio aenean sed adipiscing diam donec adipiscing tristique risus. Sed vulputate mi sit amet mauris commodo quis. Ac tortor dignissim convallis aenean et tortor at risus. Turpis tincidunt id aliquet risus feugiat in. A scelerisque purus semper eget duis at tellus at. Volutpat ac tincidunt vitae semper.</Synopsis>
        <Synopsis locale="en">Arcu odio ut sem nulla pharetra. Lobortis scelerisque fermentum dui faucibus in. Netus et malesuada fames ac turpis. Aenean sed adipiscing diam donec adipiscing. Egestas egestas fringilla phasellus faucibus scelerisque eleifend donec. Lectus magna fringilla urna porttitor rhoncus dolor purus non. Nibh ipsum consequat nisl vel pretium lectus quam id. Eu consequat ac felis donec et odio pellentesque diam. Lorem ipsum dolor sit amet consectetur adipiscing elit. Quisque egestas diam in arcu cursus. Tristique sollicitudin nibh sit amet. Eleifend quam adipiscing vitae proin sagittis nisl rhoncus mattis rhoncus.</Synopsis>
    </Synopses>
    <MetadataAvailabilityDates>
        <MetadataAvailabilityDate>2021-08-01T12:00:00Z</MetadataAvailabilityDate>
        <MetadataAvailabilityDate territories="US,CA,GB">2021-09-01T12:00:00Z</MetadataAvailabilityDate>
    </MetadataAvailabilityDates>
    ...
    ...
</Movie>
↑ Back to top
Name

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 ElementsNone
Attributes

locale: Required. The device or software's language setting under which to use this string.

Data Type: language

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string
Data Type Localized string
Example: 
<CastMember>
  <Name locale="en-US">Alan Smithee</Name>
  ...
</CastMember>
↑ Back to top
Offers

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 SubscriptionOffer (required, one allowed)
FreeOffer (required, one allowed)
Attributes None
Example: 
<Offers>
  <FreeOffer>
    <Regions>
      <Territories>US, PR, VI, GB, DE</Territories>
    </Regions>
    <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
    <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
    <LaunchDetails>
      <Quality>SD</Quality>
    </LaunchDetails>
  </FreeOffer>
  <SubscriptionOffer>
    <Regions>
      <Territories>CA</Territories>
    </Regions>
    <LaunchDetails>
      <Quality>HD</Quality>
    </LaunchDetails>
  </SubscriptionOffer>
</Offers>
↑ Back to top
OriginalAirDate

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 ElementsNone
Attributes

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<Movie>
...
  <OriginalAirDates>
    <OriginalAirDate territories="US,CA">2014-01-01T11:30:00+08:00</OriginalAirDate>
  </OriginalAirDates>
</Movie>
↑ Back to top
OriginalAirDates

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 OriginalAirDate (required, unlimited)
Attributes None
Example: 
<Movie>
  ...
  <OriginalAirDates>
    ...
  </OriginalAirDate>
</Movie>
↑ Back to top
Partner

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 ElementsNone
Data Type string
Example: 
<Catalog xmlns="http://www.amazon.com/FireTv/2014-04-11/ingestion" version="FireTv-v1.3">
  <Partner>Everything Ever Made Filmworks</Partner>
  ...
<Catalog>
↑ Back to top
Quality

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.

Property Detail
Use Optional
How Many Allowed Unlimited
Parent Elements LaunchDetails
Content Model simpleType (no children)
Child ElementsNone
Data Type Enum: SD, HD, UHD
Example: 
<FreeOffer>
  ...
  <LaunchDetails>
    <Quality>HD</Quality>
    <Quality>UHD</Quality>
    <Quality>SD</Quality>
  </LaunchDetails>
  ...
</FreeOffer>
↑ Back to top
Rank

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 ElementsNone
Data Type int
Example: 
<TvShow>
  ...
  <Rank>36</Rank>
  ...
</TvShow>
↑ Back to top
Regions

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 Territories (required, one allowed)
Attributes None
Example: 
<FreeOffer>
  <Regions>
    <Territories>US, PR, VI, GB, DE, AT</Territories>
  </Regions>
  ...
</FreeOffer>
↑ Back to top
RelatesToExternalID

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 ElementsNone
Attributes

scheme: Required. The external source that provided this ID.

Data Type: Enum.

Enum Values:

  • imdb: The Internet Movie Database (IMDb). IDs can be found as part of the URL of a given page.
  • tms: An OnTV domain — used to be Tribune Media Service, but it is essentially one of the older Gracenote ID spaces.
  • isan: The International Standard Audiovisual Number (ISAN), an alphanumeric strings of 26 characters, usually presented broken by dashes.
  • ean: The European Article Number (EAN) is a barcode standard, a 12- or 13-digit product identification code. Each EAN uniquely identifies the product, manufacturer, and its attributes.
  • upc: Universal Product Code (UPC) is a 12-digit bar code used extensively for retail packaging in United States.
  • asin: Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items.
  • gvd: Gracenote Video Data — the Gracenote ID provides "unique identifiers for TV programs and movies [to] enable linking to TV schedule data and on-demand catalogs".

region: Optional. Region for which the externalId is relevant, such as marketplace for Amazon ASINS or country for a TMS ID. For example, US for a TMS scheme.

Data Type: string
Data Type token
Example: 
<Extra>
  ...
  <Type>trailer</Type>
  <RelatesToExternalID scheme="imdb">tt0000000</RelatesToExternalID>
  <RelatesToExternalID scheme="tms">MV000000000000</RelatesToExternalID>
  <RelatesToExternalID scheme="isan">0000-0000-0F00-0000-X-0000-0000-Y</RelatesToExternalID>
  <RelatesToExternalID scheme="ean">0011559514120</RelatesToExternalID>
  <RelatesToExternalID scheme="upc">123456789990</RelatesToExternalID>
</Extra>
↑ Back to top
RelatesToID

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 ElementsNone
Data Type token
Example: 
<TvShow>
  <ID>TV123456</ID>
  ...
</TvShow>
<Extra>
  ...
  <Type>trailer</Type>
  <RelatesToID>TV123456</RelatesToID>
</Extra>
↑ Back to top
ReleaseDate

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 ElementsNone
Attributes

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<TvShow>
  ...
  <ReleaseDates>
    <ReleaseDate territories="US,CA">2012-05-13T00:00:00</ReleaseDate>
  </ReleaseDates>
</TvShow>
↑ Back to top
ReleaseDates

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 ReleaseDate (required, unlimited)
Attributes None
Example: 
<TvShow>
  ...
  <ReleaseDates>
  ...
  </ReleaseDates>
</TvShow>
↑ Back to top
ReleaseYear

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 ElementsNone
Data Type int
Example: 
<TvEpisode>
  ...
  <ReleaseYear>1959</ReleaseYear>
  ...
</TvEpisode>
↑ Back to top
Role

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 ElementsNone
Attributes

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string

locale: Required. The device or software's language setting under which to use this string.

Data Type: language
Data Type Localized string
Example: 
<Credits>
  <CastMember>
    <Name locale="en-US">Alan Smithee</Name>
    <ExternalID scheme="imdb">tt0000000</ExternalID>
    <Role locale="en-US">Robin Hood</Role>
    <Role locale="en-US">Self</Role>
  </CastMember>
</Credits>
↑ Back to top
RuntimeMinutes

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 ElementsNone
Attributes

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<TvEpisode>
  ...
  <Runtimes>
    <RuntimeMinutes territories="VI,GU,PR,GB">37</RuntimeMinutes>
    <RuntimeMinutes territories="US">46</RuntimeMinutes>
  </Runtimes>
  ...
</TvEpisode>
↑ Back to top
Runtimes

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 RuntimeMinutes (required, unlimited)
Attributes None
Example: 
<TvEpisode>
  ...
  <Runtimes>
    <RuntimeMinutes territories="VI,GU,PR,GB">37</RuntimeMinutes>
    <RuntimeMinutes territories="US">46</RuntimeMinutes>
  </Runtimes>
  ...
</TvEpisode>
↑ Back to top
Score

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 ElementsNone
Data Type decimal (positive value)
Example: 
<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>
↑ Back to top
SeasonID

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 ElementsNone
Data Type token
Example: 
<TvSeason>
  <ID>SEA-2329880</ID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <SeasonID>SEA-2329880</SeasonID>
  ...
</TvEpisode>
↑ Back to top
SeasonInShow

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 ElementsNone
Data Type int
Example: 
<TvEpisode>
  ...
  <SeasonInShow>2</SeasonInShow>
  ...
</TvEpisode>
↑ Back to top
SeasonTitle

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 ElementsNone
Attributes

locale: Required. The device or software's language setting under which to use this string.

Data Type: language

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string
Data Type Localized string
Example: 
<TvEpisode>
  ...
  <SeasonInShow>2</SeasonInShow>
  <SeasonTitle locale="en-US">Season 2</SeasonTitle>
  ...
</TvEpisode>
↑ Back to top
ShortDescription

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 ElementsNone
Attributes

locale: Required. The device or software's language setting under which to use this string.

Data Type: language

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<Movie>
...
  <ShortDescriptions>
    <ShortDescription locale="en-US" territories="US">Alan shows us some trees and sings songs about them.</ShortDescription>
  </ShortDescriptions>
...
</Movie>
↑ Back to top
ShortDescriptions

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 ShortDescription (required, unlimited)
Attributes None
Example: 
<Movie>
  ...
  <ShortDescriptions>
    ...
  </ShortDescriptions>
  ...
</Movie>
↑ Back to top
ShowID

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 ElementsNone
Data Type token
Example: 
<TvShow>
  <ID>TV-2329880</ID>
  ...
</TvShow>
<TvSeason>
  ...
  <ShowID>TV-2329880</ShowID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <ShowID>TV-2329880</ShowID>
  ...
</TvEpisode>
↑ Back to top
ShowTitle

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 ElementsNone
Attributes

locale: Required. The device or software's language setting under which to use this string.

Data Type: language

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string
Data Type Localized string
Example: 
<TvSeason>
  ...
  <ShowTitle locale="en-US">Depth of Field</ShowTitle>
  ...
</TvSeason>
↑ Back to top
Studio

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 ElementsNone
Data Type string
Example: 
<TvEpisode>
  ...
  <Studios>
    <Studio>Amazon Studios</Studio>
    <Studio>Another Production Company</Studio>
  </Studios>
  ...
</TvEpisode>
↑ Back to top
Studios

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 Studio (optional, unlimited)
Attributes None
Example: 
<TvEpisode>
  ...
  <Studios>
    <Studio>Amazon Studios</Studio>
    <Studio>Another Production Company</Studio>
  </Studios>
  ...
</TvEpisode>
↑ Back to top
SubscriptionOffer

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 Regions (required, unlimited)
LaunchDetails (optional, unlimited)
WindowStart (optional, one allowed)
WindowEnd (optional, one allowed)
Attributes None
Example: 
<SubscriptionOffer>
  <Regions>
    <Territories>US, CA</Territories>
  </Regions>
  <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
  <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
  <LaunchDetails>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
    <LaunchId>EXTRA-11113_HD_en-US</LaunchId>
  </LaunchDetails>
</SubscriptionOffer>
↑ Back to top
Subtitle

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 ElementsNone
Data Type language
Example: 
<SubscriptionOffer>
  ...
  <LaunchDetails>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
  </LaunchDetails>
</SubscriptionOffer>
↑ Back to top
Synopses

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 Synopsis (required, unlimited)
Attributes None
Example: 
<Movie>
...
  <Synopses>
    ...
  </Synopses>
...
</Movie>
↑ Back to top
Synopsis

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 ElementsNone
Attributes

locale: Required. The device or software's language setting under which to use this string.

Data Type: language

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string
Data Type TerritoryStringType - Same as string with the addition of the locale, pronunciation, and territories attributes.
Example: 
<Movie>
...
  <Synopses>
    <Synopsis locale="en-US" territories="US, CA">Alan Smithee, man about town and fervent urban arborist, takes us on a musical journey around his home town, stopping by some favorite trees to sing about them. As expected from Mr. Smithee, no path runs straight and his plans meander as he encounters guest stars and battles a lumberjack with a literal ax to grind.</Synopsis>
  </Synopses>
...
</Movie>
↑ Back to top
System

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 ElementsNone
Data Type string
Example: 
<ContentRatings>
  <ContentRating>
    <System>MPAA</System>
    <Certification>G</Certification>
  </ContentRating>
</ContentRatings>
↑ Back to top
Territories

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 ElementsNone
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.
Example: 
<SubscriptionOffer>
  <Regions>
    <Territories>US, PR, VI, GB, DE, AT</Territories>
  </Regions>
  ...
</SubscriptionOffer>
↑ Back to top
Title

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 ElementsNone
Attributes

locale: Required. The device or software's language setting under which to use this string.

Data Type: language

pronunciation: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana.

Data Type: string

territories: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide.

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.
Example: 
<TvShow>
  <ID>TV123456</ID>
  <Titles>
    <!-- If the territories attribite is omitted, then the title is available globally, as shown below -->
    <Title locale="en-US">Global English Movie Title</Title>
    <!-- The below title is available only in the US -->
    <Title locale="es" territories="US">Spanish US Movie Title</Title>
  </Titles>
  ...
</TvShow>
↑ Back to top
Titles

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 Title (required, unlimited)
Data Type Localized string
Example: 
<TvShow>
  <ID>TV123456</ID>
  <Titles>
    ...
  </Titles>
  ...
</TvShow>
↑ Back to top
TvEpisode

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 ID (required, one allowed)
ExternalID (optional, unlimited)
Titles (required, unlimited)
Copyright (optional, one allowed)
Offers (optional, one allowed)
IsAdultProducts (optional, one allowed)
ReleaseYear (optional, one allowed)
ShortDescriptions (optional, one allowed)
Synopses (optional, one allowed)
MetadataAvailabilityDates (optional, one allowed)
Images (required, one allowed)
Runtimes (optional, one allowed)
Color (optional, one allowed)
Credits (optional, one allowed)
Studios (optional, one allowed)
Language (optional, one allowed)
CustomerRating (optional, one allowed)
Rank (optional, one allowed)
IsOriginals (optional, one allowed)
Genres (optional, one allowed)
ContentRatings (optional, one allowed)
ShowID (required, one allowed)
ShowTitle (required, one allowed)
SeasonID (required, one allowed)
SeasonInShow (required, one allowed)
SeasonTitle (optional, one allowed)
EpisodeInSeason (required, one allowed)
OriginalAirDates (optional, one allowed)
Attributes None
Example: 
<TvShow>
  <ID>ABC-123457</ID>
  ...
</TvShow>
<TvSeason>
  <ID>TVS-987654</ID>
  ...
</TvSeason>
<TvEpisode>
  <ID>TVE2329880</ID>
  ...
  <ShowID>ABC-123457</ShowID>
  <SeasonID>TVS-987654</SeasonInShow>
  <EpisodeInSeason>5</EpisodeInSeason>
</TvEpisode>
↑ Back to top
TvSeason

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 ID (required, one allowed)
ExternalID (optional, unlimited)
Titles (required, unlimited)
Copyright (optional, one allowed)
Offers (optional, one allowed)
IsAdultProducts (optional, one allowed)
ReleaseYear (optional, one allowed)
ShortDescriptions (optional, one allowed)
Synopses (optional, one allowed)
MetadataAvailabilityDates (optional, one allowed)
Images (required, one allowed)
Runtimes (optional, one allowed)
Color (optional, one allowed)
Credits (optional, one allowed)
Studios (optional, one allowed)
Language (optional, one allowed)
CustomerRating (optional, one allowed)
Rank (optional, one allowed)
IsOriginals (optional, one allowed)
Genres (optional, one allowed)
ContentRatings (optional, one allowed)
ShowID (required, one allowed)
ShowTitle (required, one allowed)
SeasonInShow (required, one allowed)
Attributes None
Example: 
<TvShow>
  <ID>ABC-123457</ID>
  ...
</TvShow>
<TvSeason>
  <ID>TVS2329880</ID>
  <ShowID>ABC-123457</ShowID>
  <SeasonInShow>5</SeasonInShow>
</TvSeason>
<TvEpisode>
  ...
  <ShowID>ABC-123457</ShowID>
  <SeasonID>TVS2329880</SeasonID>
  ...
</TvEpisode>
↑ Back to top
TvShow

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 ID (required, one allowed)
ExternalID (optional, unlimited)
Titles (required, unlimited)
Copyright (optional, one allowed)
Offers (optional, one allowed)
IsAdultProducts (optional, one allowed)
ReleaseYear (optional, one allowed)
ShortDescriptions (optional, one allowed)
Synopses (optional, one allowed)
MetadataAvailabilityDates (optional, one allowed)
Images (required, one allowed)
Runtimes (optional, one allowed)
Color (optional, one allowed)
Credits (optional, one allowed)
Studios (optional, one allowed)
Language (optional, one allowed)
CustomerRating (optional, one allowed)
Rank (optional, one allowed)
IsOriginals (optional, one allowed)
Genres (optional, one allowed)
ContentRatings (optional, one allowed)
ReleaseDates (optional, one allowed)
Attributes None
Example: 
<TvShow>
  <ID>RS-2329880</ID>
  ...
</TvShow>
<TvSeason>
  <ID>TVS2329880</ID>
  ...
  <ShowID>RS-2329880</ShowID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <ShowID>RS-2329880</ShowID>
  <SeasonID>TVS2329880</SeasonID>
  ...
</TvEpisode>
↑ Back to top
Type

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 ElementsNone
Data Type Enum: clip
Example: 
<Extra>
  ...
  <Type>clip</Type>
  ...
</Extra>
↑ Back to top
Url

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 ElementsNone
Data Type anyURI
Example: 
<Movie>
  ...
    <Images>
      <Image>
        <Url>http://sample-server.net/cds/1.0/image/B23R/FJK8/9FAR/39RTE_992.png</Url>
        <Locale>es</Locale>
      </Image>
    </Images>
    ...
  </Movie>
↑ Back to top
WindowEnd

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 nor WindowEnd: 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 ElementsNone
Data Type dateTime
Example: 
<FreeOffer>
  ...
  <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
  <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
  ...
</FreeOffer>
↑ Back to top
WindowStart

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 nor WindowEnd: 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 ElementsNone
Data Type dateTime
Example: 
<FreeOffer>
  ...
  <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
  <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
  ...
</FreeOffer>
↑ Back to top
Works

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 Movie (optional, unlimited)
TvEpisode (optional, unlimited)
TvSeason (optional, unlimited)
TvShow (optional, unlimited)
Extra (optional, unlimited)
Attributes None
Example: 
<Catalog>
  <Partner>Everything Ever Made Filmworks</Partner>
  <Works>
    ...
  </Works>
</Catalog>
↑ Back to top

Deprecated Elements

These elements have been deprecated. Note that if your catalog data file has deprecated elements, your catalog won't be rejected. However, you should work to remove these elements from your catalog file to improve matching.

AdultProduct

Identifies a work as content for adult audiences only. In Japan, you can also use JP_Require18PlusAgeConfirmation.

Property Detail
Use Optional
How Many Allowed One
Parent Elements Movie
TvShow
TvSeason
TvEpisode
TvSpecial
Extra
Content Model simpleType (no children)
Child ElementsNone
Data Type boolean
Example: 
<Movie>false</Movie>
  ...
  <AdultProduct>false</AdultProduct>
  ...
</Movie>false</Movie>
↑ Back to top
Country

A country or region in which a particular offer (subscription, free, purchase, or rental) is available. Each offer can contain as many Country elements as needed.

⚠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 Regions
Content Model simpleType (no children)
Child ElementsNone
Data Type Enum. The following subset of ISO 3166-1 country codes are allowed: AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BQ BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW BL SH KN LC MF PM VC WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS SS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW
Example: 
<SubscriptionOffer>
  <Regions>
    <Country>US</Country>
    <Country>CA</Country>
  </Regions>
  ...
</SubscriptionOffer>
↑ Back to top
Duration

Defines how long a work's rental lasts, measured in hours. A RentalOffer can contain only one Duration element.

Property Detail
Use Required
How Many Allowed One
Parent Elements RentalOffer
Content Model simpleType (no children)
Child ElementsNone
Data Type int
Example: 
<RentalOffer>
  ...
  <Duration>120</Duration>
</RentalOffer>
↑ Back to top
EpisodeInSeries

A mini-series episode's sequence number within its series. Each MiniSeriesEpisode can contain only one EpisodeInSeries element.

Property Detail
Use Required
How Many Allowed One
Parent Elements MiniSeriesEpisode
Content Model simpleType (no children)
Child ElementsNone
Data Type int
Example: 
<MiniSeriesEpisode>
  ...
  <EpisodeInSeries>13</EpisodeInSeries>
  ...
</MiniSeriesEpisode>
↑ Back to top
ImageUrl

The URL of an image that represents the work, sometimes called the "box art." Each work can contain only a single ImageUrl element. If you don't include ImageUrl, we attempt to use available art from other sources such as IMDb, or we might use a generic placeholder image. See Requirements for Box Art Images (ImageUrl) for image requirements. Note: Provide a unique image for each work that applies to the work's content. Do not use a generic placeholder image, such as a logo.

Property Detail
Use Required
How Many Allowed One
Parent Elements Movie
TvShow
TvSeason
TvEpisode
TvSpecial
Extra
Content Model simpleType (no children)
Child ElementsNone
Data Type anyURI
Example: 
<TvShow>
  ...
  <ImageUrl>http://amazon.com/images/01152ce2de7e44c1/image.jpg</ImageUrl>
  ...
</TvShow>
↑ Back to top
JP_Require18PlusAgeConfirmation

Marks content for the Japanese marketplace intended to be viewed only by persons 18 years of age or older. In compliance with Japan's legal requirements, setting this flag to true requires viewers of this content in Japan to confirm that their age is above 18.

Property Detail
Use Optional
How Many Allowed One
Parent Elements Movie
TvShow
TvSeason
TvEpisode
Extra
Content Model simpleType (no children)
Child ElementsNone
Data Type boolean
Example: 
<Movie>
  ...
  <JP_Require18PlusAgeConfirmation>true</JP_Require18PlusAgeConfirmation>
</Movie>
↑ Back to top
MetadataAvailabilityDate - Deprecated

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 Optional
How Many Allowed One
Parent Elements Movie
TvShow
TvSeason
TvEpisode
TvSpecial
Extra
Content Model simpleType (no children)
Child ElementsNone
Data Type dateTime
Example: 
<Movie>
  <ID>MV-123456</ID>
  <Title locale="en-US">Chase the Prawns</Title>
  <Offers>
    <SubscriptionOffer>
      <Regions>
        <Country>US</Country>
      </Regions>
    </SubscriptionOffer>
  </Offers>
  <MetadataAvailabilityDate>2000-01-01T12:00:00Z</MetadataAvailabilityDate>
  <ReleaseDate>2013-10-04T00:00:00</ReleaseDate>
</Movie>
↑ Back to top
MiniSeries

Loosely defined as a television show that collects a small number of ordered episodes not presented in seasons. There is no explicit limit on the number of episodes a MiniSeries can contain, but it should be reasonably low.

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 ID (required, one allowed)
ExternalID (optional, unlimited)
Title (required, unlimited)
Copyright (optional, one allowed)
Offers (optional, one allowed)
ReleaseYear (optional, one allowed)
ShortDescription (optional, unlimited)
Synopsis (optional, unlimited)
MetadataAvailabilityDate (optional, one allowed)
Images (required, one allowed)
RuntimeMinutes (optional, one allowed)
Color (optional, one allowed)
Credits (optional, one allowed)
Studios (optional, one allowed)
Language (optional, one allowed)
CustomerRating (optional, one allowed)
Rank (optional, one allowed)
Source (optional, one allowed)
Genres (optional, one allowed)
ContentRatings (optional, one allowed)
JP_Require18PlusAgeConfirmation (optional, one allowed)
ReleaseDate (optional, one allowed)
Attributes None
Example: 
<MiniSeries>
  <ID>MS-2329880</ID>
  <Title locale="en-US">All the Best People</Title>
  <Offers>
    <SubscriptionOffer>
      <Regions>
        <Country>US</Country>
      </Regions>
    </SubscriptionOffer>
  </Offers>
  <ReleaseDate>2005-04-29T20:00:00</ReleaseDate>
</MiniSeries>
↑ Back to top
MiniSeriesEpisode

One of the basic work types, a MiniSeriesEpisode is a single episode in a MiniSeries. This content is not associated with a season and is sequenced in the context of the MiniSeries.

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. And either MiniSeriesID or MiniSeriesTitle.
Child Elements ID (required, one allowed)
ExternalID (optional, unlimited)
Title (required, unlimited)
Copyright (optional, one allowed)
Offers (optional, one allowed)
ReleaseYear (optional, one allowed)
ShortDescription (optional, unlimited)
Synopsis (optional, unlimited)
MetadataAvailabilityDate (optional, one allowed)
Images (required, one allowed)
RuntimeMinutes (optional, one allowed)
Color (optional, one allowed)
Credits (optional, one allowed)
Studios (optional, one allowed)
Language (optional, one allowed)
CustomerRating (optional, one allowed)
Rank (optional, one allowed)
Source (optional, one allowed)
Genres (optional, one allowed)
ContentRatings (optional, one allowed)
JP_Require18PlusAgeConfirmation (optional, one allowed)
MiniSeriesID (required, one allowed)
MiniSeriesTitle (required, one allowed)
OriginalAirDate (optional, one allowed)
Attributes None
Example: 
<MiniSeries>
  <ID>MS-123456789</ID>
  ...
</MiniSeries>
<MiniSeriesEpisode>
  <ID>MSE-2329880</ID>
  <Title locale="en-US">The First Steps on a New Planet</Title>
  <Offers>
    <SubscriptionOffer>
      <Regions>
        <Country>US</Country>
      </Regions>
    </SubscriptionOffer>
  </Offers>
  <MiniSeriesID>MS-123456789</MiniSeriesID>
  <EpisodeInSeries>1</EpisodeInSeries>
  <OriginalAirDate>2012-07-02T20:00:00</OriginalAirDate>
</MiniSeriesEpisode>
↑ Back to top
MiniSeriesID

Used to specify the mini-series that an episode is a part of. The MiniSeries with this ID must be present in the same catalog as this MiniSeriesEpisode. You have the option of using MiniSeriesID or MiniSeriesTitle to specify the mini-series, but not both. MiniSeriesID should always be used when the mini-series is in your catalog. If it is not in your catalog, we advise you to create a MiniSeries entry to use.

Property Detail
Use Required
How Many Allowed One
Parent Elements MiniSeriesEpisode
Content Model simpleType (no children)
Child ElementsNone
Data Type token
Example: 
<MiniSeries>
  <ID>MS-2329880</ID>
  ...
</MiniSeries>
</MiniSeriesEpisode>
  ...
  <MiniSeriesID>MS-2329880</MiniSeriesID>
  <EpisodeInSeries>3</EpisodeInSeries>
</MiniSeriesEpisode>
↑ Back to top
MiniSeriesTitle

Specifies which mini-series an episode is part of when that mini-series is not part of your catalog. MiniSeriesTitle is simply a string for use in the UI and is not required to match any existing title in your catalog. You have the option of using MiniSeriesID or MiniSeriesTitle to specify the mini-series, but not both. Use MiniSeriesTitle only in the absence of MiniSeriesID, which should be a rare occurrance.

Property Detail
Use Required
How Many Allowed One
Parent Elements MiniSeriesEpisode
Content Model simpleType (no children)
Child ElementsNone
Data Type Localized string
Example: 
<MiniSeriesEpisode>
  ...
  <MiniSeriesTitle>Cats, The Most Beautiful Creature</MiniSeriesTitle>
  <EpisodeInSeries>3</EpisodeInSeries>
</MiniSeriesEpisode>
↑ Back to top
OriginalAirDate - Deprecated

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 TvEpisode
Content Model simpleType (no children)
Child ElementsNone
Data Type dateTime
Example: 
<TvEpisode>
  ...
  <OriginalAirDate>2012-05-13T00:00:00</OriginalAirDate>
</TvEpisode>
↑ Back to top
Price

The cost to rent or purchase a work.

Property Detail
Use Required
How Many Allowed One
Parent Elements PurchaseOffer
RentalOffer
Content Model simpleType (no children)
Child ElementsNone
Data Type xsd:float
Example: 
<PurchaseOffer>
  <Regions>
    <Country>US</Country>
  </Regions>
  <Price currency="USD">1.99</Price>
</PurchaseOffer>
↑ Back to top
PurchaseOffer

The work can be purchased for a one-time payment to own and watch anytime. If necessary, you can have multiple PurchaseOffer elements under Offers. PurchaseOffer is one of the two offer types. Important: The PurchaseOffer element is optional, but at least one offer type is required under Offers. (Note that currently Fire TV does not do anything with PurchaseOffer information in the display.)

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 Regions (required, unlimited)
LaunchDetails (optional, unlimited)
WindowStart (optional, one allowed)
WindowEnd (optional, one allowed)
Price (required, one allowed)
Attributes None
Example: 
<PurchaseOffer>
  <Regions>
    <Country>US</Country>
  </Regions>
  <LaunchDetails>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
  </LaunchDetails>
  <Price currency="USD">1.99</Price>
</PurchaseOffer>
↑ Back to top
ReleaseCountry

Property Detail
Use Optional
How Many Allowed One
Parent Elements ReleaseInfo
Content Model simpleType (no children)
Child ElementsNone
Data Type Enum. The following subset of ISO 3166-1 country codes are allowed: AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BQ BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW BL SH KN LC MF PM VC WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS SS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW
Example: 
<TvEpisode>
  ...
  <ReleaseInfo>
    <ReleaseDate>2002-02-20</ReleaseDate>
    <ReleaseCountry>BT</ReleaseCountry>
  </ReleaseInfo>
  ...
</TvEpisode>
↑ Back to top
ReleaseDate - Deprecated

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 Optional
How Many Allowed One
Parent Elements Movie
TvShow
Content Model simpleType (no children)
Child ElementsNone
Data Type dateTime
Example: 
<TvShow>
  ...
  <ReleaseDate>2012-05-13T00:00:00</ReleaseDate>
</TvShow>
↑ Back to top
ReleaseDate - Release Info

The date 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 Optional
How Many Allowed One
Parent Elements ReleaseInfo
Content Model simpleType (no children)
Child ElementsNone
Data Type dateTime
Example: 
<TvShow>
  ...
  <ReleaseInfo>
    <ReleaseDate>2012-05-13</ReleaseDate>
  </ReleaseInfo>
</TvShow>
↑ Back to top
ReleaseInfo

Contains elements that specify a work's country or region of release and release date.

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 ReleaseDate (required, one allowed)
ReleaseCountry (optional, one allowed)
Attributes None
Example: 
<TvEpisode>
  ...
  <ReleaseInfo>
    <ReleaseDate>2002-02-20</ReleaseDate>
    <ReleaseCountry>BT</ReleaseCountry>
  </ReleaseInfo>
  ...
</TvEpisode>
↑ Back to top
RentalOffer

The work can be viewed for a limited amount of time for a one-time payment. If necessary, you can have multiple RentalOffer elements under Offers. RentalOffer is one of the two offer types. Important: The RentalOffer element is optional, but at least one offer type is required under Offers. (Note that currently Fire TV does not do anything with RentalOffer information in the display.)

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 Regions (required, unlimited)
LaunchDetails (optional, unlimited)
WindowStart (optional, one allowed)
WindowEnd (optional, one allowed)
Price (required, one allowed)
Duration (required, one allowed)
Attributes None
Example: 
<RentalOffer>
  <Regions>
    <Country>US</Country>
  </Regions>
  <LaunchDetails>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
  </LaunchDetails>
  <Price currency="USD">1.99</Price>
  <Duration>120</Duration>
</RentalOffer>
↑ Back to top
RuntimeMinutes - Deprecated

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. Each work can have only one RuntimeMinutes element.

Property Detail
Use Optional
How Many Allowed One
Parent Elements Movie
TvShow
TvSeason
TvEpisode
Extra
Content Model simpleType (no children)
Child ElementsNone
Data Type int
Example: 
<TvEpisode>
  ...
  <RuntimeMinutes>37</RuntimeMinutes>
  ...
</TvEpisode>
↑ Back to top
ShortDescription - Deprecated

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 Optional
How Many Allowed Unlimited
Parent Elements Movie
TvShow
TvSeason
TvEpisode
TvSpecial
Extra
Content Model simpleType (no children)
Child ElementsNone
Data Type Localized string
Example: 
<TvSpecial>
  ...
  <ShortDescription locale="en-US">Alan shows us some trees and sings songs about them.</ShortDescription>
  ...
</TvSpecial>
↑ Back to top
Source

Where the work originated. Each work can have only one Source. Options are as follows:
  • original: The provider of this catalog produced or created this content.
  • licensed: The provider of this catalog has licensed the work from another party.
  • unknown: The source of this content is unknown.
  • other: The source of the work is known but is neither original nor licensed.

Property Detail
Use Optional
How Many Allowed One
Parent Elements Movie
TvShow
TvSeason
TvEpisode
Extra
Content Model simpleType (no children)
Child ElementsNone
Data Type Enum: original, licensed, unknown, other
Example: 
<TvEpisode>
  ...
  <Source>licensed</Source>
  ...
</TvEpisode>
↑ Back to top
Synopsis - Deprecated

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 Optional
How Many Allowed One
Parent Elements Movie
TvShow
TvSeason
TvEpisode
TvSpecial
Extra
Content Model simpleType (no children)
Child ElementsNone
Data Type Localized string
Example: 
<TvSpecial>
  ...
  <ShortDescription locale="en-US">Alan shows us some trees and sings songs about them.</ShortDescription>
  <Synopsis locale="en-US">Alan Smithee, man about town and fervent urban arborist, takes us on a musical journey around his home town, stopping by some favorite trees to sing about them. As expected from Mr. Smithee, no path runs straight and his plans meander as he encounters guest stars and battles a lumberjack with a literal ax to grind.</Synopsis>
  ...
</TvSpecial>
↑ Back to top
Title - Deprecated

A work's title. Each work can contain multiple Title elements for the purpose of providing localized titles. added: CDF 1.0

Property Detail
Use Required
How Many Allowed Unlimited
Parent Elements Movie
TvShow
TvSeason
TvEpisode
TvSpecial
Extra
Content Model simpleType (no children)
Child ElementsNone
Data Type Localized string
Example: 
<TvShow>
  <ID>TV123456</ID>
  <Title locale="en-US">Office Factor</Title>
  ...
</TvShow>
↑ Back to top
TvSpecial

Televised events that don't belong to the traditional show-season-episode television hierarchy. These can be one-time events such as a holiday special, or they can account for programs in which each episode has a unique airdate rather than an episode number (news programs, for instance). A TvSpecial can be associated with a TvShow (though not a TvSeason) or it can be a standalone event. Some other examples are awards programs, televised concerts, and retrospectives.

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 ID (required, one allowed)
ExternalID (optional, unlimited)
Title (required, unlimited)
Copyright (optional, one allowed)
Offers (optional, one allowed)
ReleaseYear (optional, one allowed)
ShortDescription (optional, unlimited)
Synopsis (optional, unlimited)
MetadataAvailabilityDate (optional, one allowed)
Images (required, one allowed)
RuntimeMinutes (optional, one allowed)
Color (optional, one allowed)
Credits (optional, one allowed)
Studios (optional, one allowed)
Language (optional, one allowed)
CustomerRating (optional, one allowed)
Rank (optional, one allowed)
Source (optional, one allowed)
Genres (optional, one allowed)
ContentRatings (optional, one allowed)
JP_Require18PlusAgeConfirmation (optional, one allowed)
ShowID (optional, one allowed)
ShowTitle (optional, one allowed)
OriginalAirDate (required, one allowed)
Attributes None
Example: 
<TvSpecial>
  <ID>SP-2329880</ID>
  <Title locale="en-US">Cheese -- Friend or Enemy?</Title>
  <Offers>
    <SubscriptionOffer>
      <Regions>
        <Country>US</Country>
      </Regions>
    </SubscriptionOffer>
  </Offers>
  <OriginalAirDate>2005-04-29T20:00:00</OriginalAirDate>
</TvSpecial>
↑ Back to top

Last updated: Feb 23, 2024