感谢您的访问。此页面目前仅提供英语版本。我们正在开发中文版本。谢谢您的理解。

Catalog Data Format (CDF) Schema

This topic provides a dictionary of the elements available in the Catalog Data Format (CDF) schema, used to construct a catalog of your media content for upload to Amazon Fire TV.

For an overview of the structure of a CDF catalog file and how these elements interact, see Step 1: Create Your Catalog File. The catalog examples in the downloadable cdf-examples.zip file also can be very useful in understanding how a catalog file is put together. Download catalog.xsd to examine the XSD directly.

To use this information, readers should have a good understanding of XML. The following sections list the CDF schema element definitions.

Note the following additional CDF resources:

AdultProduct

Optional Deprecated

Identifies a work as content for adult audiences only.

Property Detail
Use Deprecated — do not use
Added CDF version 1.0
Deprecated CDF version 1.1
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None
Accepted Values true, false

Example:

<Movie>false</Movie>
  ...
  <AdultProduct>false</AdultProduct>
  ...
</Movie>false</Movie>

↑ Back to top

AudioLanguage

Optional

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.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements LaunchDetails
Child Elements None
Attributes None
Accepted Values Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.

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

Optional Conditionally Required

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 Optional
Conditional Requirements Required if no CrewMember element is present, otherwise optional
Added CDF version 1.0
Parent Elements Credits
Child Elements

Required: Name

Optional: ExternalID, Role

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

Always Required

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
Added CDF version 1.0
Parent Elements None
Child Elements

Required: Partner, Works

Attributes
xmlns (required)
  • The XML namespace.
  • Accepted values: http://www.amazon.com/
    FireTv/2014-04-11/ingestion
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, we recommend that you provide the version. This attribute was added in CDF v1.2.
  • Accepted values: FireTv-v1.2, FireTv-v1.3

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

Optional Conditionally Required

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 Optional
Conditional Requirements Required in a ContentRating
Added CDF version 1.0
Parent Elements ContentRating
Child Elements None
Attributes None

Example:

<ContentRating>
  <System>MPAA</System>
  <Certification>PG-13</Certification>
</ContentRating>

↑ Back to top

Color

Optional

Specifies whether the movie is primarily in color or in black-and-white.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None
Accepted Values color, black_and_white

Example:

<Movie>
  ...
  <Color>black_and_white</Color>
  ...
</Movie>

↑ Back to top

ContentRating

Optional Conditionally Required

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.

Property Detail
Use Optional
Conditional Requirements Required if the optional ContentRatings element is present.
Added CDF version 1.0
Parent Elements ContentRatings
Child Elements

Required: System, Certification

Attributes None

Example:

<ContentRatings>
  <ContentRating>
    <System>MPAA</System>
    <Certification>PG-13</Certification>
  </ContentRating>
</ContentRatings>

↑ Back to top

ContentRatings

Optional

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
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements

Required: ContentRating

Note: At least one ContentRating element required.

Attributes None

Example:

<ContentRatings>
  <ContentRating>
    <System>MPAA</System>
    <Certification>PG-13</Certification>
  </ContentRating>
  <ContentRating>
    <System>Eirin</System>
    <Certification>R15+</Certification>
  </ContentRating>
</ContentRatings>

↑ Back to top

Optional

A statement of the work's copyright.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
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.
  • Accepted values: String

Example:

<Copyright locale="en-US">© 2014 Amazon Studios</Copyright>

↑ Back to top

Count

Optional

The number of users that have contributed to a customer rating Score. Only one Count is allowed per CustomerRating.

Property Detail
Use Optional
Added CDF version 1.2
Parent Elements CustomerRating
Child Elements None
Attributes None
Accepted Values Any non-negative whole number.

Example:

<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>

↑ Back to top

Country

Always Required

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.

Property Detail
Use Required
Added CDF version 1.0
Parent Elements Regions
Child Elements None
Attributes None
Accepted Values The following subset of ISO 3166-1 country codes: 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

Credits

Optional

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
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements

Required: CastMember, CrewMember

Note: At least one of these two child elements is required

Attributes None

Example:

<Credits>
  <CastMember>
    <Name locale="en-US">Alan Smithee</Name>
    <Role locale="en-US">Self</Role>
  </CastMember>
</Credits>

↑ Back to top

CrewMember

Optional Conditionally Required

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 Optional
Conditional Requirements Required if no CastMember element is present, otherwise optional.
Added CDF version 1.0
Parent Elements Credits
Child Elements

Required: Name, Job

Optional: ExternalID

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

Optional

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
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements

Required: Score, MaxValue

Optional: Count

Note: 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

Duration

Always Required

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

Property Detail
Use Required
Added CDF version 1.0
Parent Elements RentalOffer
Child Elements None
Attributes None

Example:

<RentalOffer>
  ...
  <Duration>120</Duration>
</RentalOffer>

↑ Back to top

EpisodeInSeason

Optional Conditionally Required

A TV episode's sequence number within its season. Each TvEpisode can contain only one EpisodeInSeason element.

Property Detail
Use Optional
Conditional Requirements Required if using TvEpisode
Added CDF version 1.0
Parent Elements TvEpisode
Child Elements None
Attributes None

Example:

<TvEpisode>
  ...
  <EpisodeInSeason>6</EpisodeInSeason>
  ...
</TvEpisode>

↑ Back to top

EpisodeInSeries

Optional Conditionally Required

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

Property Detail
Use Optional
Conditional Requirements Requried if using MiniSeriesEpisode
Added CDF version 1.3
Parent Elements MiniSeriesEpisode
Child Elements None
Attributes None

Example:

<MiniSeriesEpisode>
  ...
  <EpisodeInSeries>13</EpisodeInSeries>
  ...
</MiniSeriesEpisode>

↑ Back to top

ExternalID

Optional

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 Optional
Added CDF version 1.0
Parent Elements CastMember, CrewMember, Extra, MiniSeries, MiniSeriesEpisode, Movie, TvEpisode, TvSeason, TvShow, TvSpecial
Child Elements None
Attributes
scheme (required)
  • The external source that provided this ID.
  • Accepted values:
    • imdb: The Internet Movie Database (IMDb). IDs can be found as part of the URL of a given page.
    • tms: The ID used in the GracenoteTM database.
    • isan: The International Standard Audiovisual Number (ISAN), an alphanumeric strings of 26 characters, usually presented broken by dashes.
    • ean: The International Article Number (EAN), a barcode normally expressed in 13-digits.
    • upc: The Universal Product Code (UPC), a barcode normally expressed in 12-digits.

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

Optional

One of the basic work types, Extra represents a clip or trailer 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 Optional
Added CDF version 1.3
Parent Elements Catalog
Child Elements

Required: ID, Offers, Title

Optional: AdultProduct, Color, ContentRatings, JP_Require18PlusAgeConfirmation, Copyright, Credits, CustomerRating, ExternalID, Genres, ImageUrl, Language, Rank, ReleaseInfo, ShortDescription, ReleaseYear, RuntimeMinutes, Source, Studios, Synopsis

Child Elements Specific to This Element Only

Required: Type, RelatesToID, RelatesToExternalID

Note: Either RelatesToID or RelatesToExternalID, but not both

Attributes None

Example:

<Extra>
  <ID>EXTRA-11111</ID>
  <Title locale="en-US">Wishenpoof! Trailer</Title>
  <Offers>
    <FreeOffer>
      <Regions>
        <Country>US</Country>
      </Regions>
    </FreeOffer>
  </Offers>
  <Type>trailer</Type>
</Extra>

↑ Back to top

FreeOffer

Optional Conditionally Required

One of the four offer types. Under this offer, the work is free to view at any time, optionally only during a given window. If necessary, you can have multiple FreeOffer elements under Offers.

Property Detail
Use Optional
Conditional Requirements Optional, though at least one offer type is required under Offers
Added CDF version 1.0
Parent Elements Offers
Child Elements

Required: Regions

Optional: LaunchDetails, Quality, WindowStart, WindowEnd

Attributes None

Example:

<FreeOffer>
  <Regions>
    <Country>US</Country>
    <Country>CA</Country>
  </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

Optional Conditionally Required

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 Optional
Conditional Requirements Required if the optional Genres element is present
Added CDF version 1.0
Parent Elements Movie
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
pronunciation (required)
  • 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.
  • Accepted values: String

Example:

<Genres>
  <Genre locale="en-US">horror</Genre>
  <Genre locale="en-US">sci-fi</Genre>
</Genres>

↑ Back to top

Genres

Optional

Contains one or more Genre tags used to describe the category of the work, such as comedy, horror, or documentary.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements

Optional: Genre

Note: At least one <a href='../catalog/data-format-schema-reference.html#Genre'Genre</a> element is required when Genres is present

Attributes None

Example:

<Genres>
  <Genre locale="en-US">horror</Genre>
  <Genre locale="en-US">sci-fi</Genre>
</Genres>

↑ Back to top

ID

Always Required

An identifier string for a work. This value must be at least one character long and 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.

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 remove it from our index.

Property Detail
Use Required
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None

Example:

<Movie>
  <ID>AmazonStudios_Movie_01152ce2-de7e-44c1-9736-e8f3b15a1ddf</ID>
  ...
</Movie>

↑ Back to top

ImageUrl

Optional Conditionally Required

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.

Property Detail
Use Optional
Conditional Requirements Any one given ImageUrl element is optional, but at least 50% of your entries must include it and the image it points to must be valid. If more than 50% of the images in your file are determined to be invalid (and simply not having an image is considered an invalidity), your uploaded catalog will be rejected by the ingestion system.

An image also helps us in matching this work with the same work from other providers, which improves the customer search experience by bundling all offers for the work into a single search result. That, in turn, improves the discoverability of your particular offer. See Requirements for Box Art Images (ImageUrl) for image size and height-to-width ratio requirements.

Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None

Example:

<TvShow>
  ...
  <ImageUrl>http://amazon.com/images/01152ce2de7e44c1/image.jpg</ImageUrl>
  ...
</TvShow>

↑ Back to top

Job

Conditionally Required

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 Optional
Conditional Requirements Required if CastMember element is present.
Added CDF version 1.0
Parent Elements CrewMember
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
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.
  • Accepted values: 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

JP_Require18PlusAgeConfirmation

Optional

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
Added CDF version 1.2
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None
Accepted Values true, false

Example:

<Movie>
  ...
  <JP_Require18PlusAgeConfirmation>true</JP_Require18PlusAgeConfirmation>
</Movie>

↑ Back to top

Language

Optional

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.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None
Accepted Values Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.

Example:

<Movie>
  ...
  <Language>ja</Language>
  ...
</Movie>

↑ Back to top

LaunchDetails

Optional

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
Added CDF version 1.2
Parent Elements SubscriptionOffer, FreeOffer, PurchaseOffer, RentalOffer
Child Elements

Optional: Quality, AudioLanguage, Subtitle, LaunchId

Attributes None

Example:

<FreeOffer>
  <Regions>
    <Country>US</Country>
  </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

Optional

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
Added CDF version 1.2
Parent Elements LaunchDetails
Child Elements None
Attributes None

Example:

<SubscriptionOffer>
  <Regions>
    <Country>US</Country>
  </Regions>
  <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

MaxValue

Optional Conditionally Required

The highest possible value for a work's customer rating. Each CustomerRating can contain only one MaxValue.

Property Detail
Use Optional
Conditional Requirements Required when the optional CustomerRating element is present
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None

Example:

<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>

↑ Back to top

MiniSeries

Optional

One of the basic work types, a MiniSeries is 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
Added CDF version 1.3
Parent Elements Catalog
Child Elements

Required: ID, Offers, Title

Optional: AdultProduct, Color, ContentRatings, JP_Require18PlusAgeConfirmation, Copyright, Credits, CustomerRating, ExternalID, Genres, ImageUrl, Language, Rank, ReleaseInfo, ShortDescription, ReleaseYear, RuntimeMinutes, Source, Studios, Synopsis

Child Elements Specific to This Element Only

Optional: ReleaseDate

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

Optional

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
Added CDF version 1.3
Parent Elements Catalog
Child Elements

Required: ID, Offers, Title

Optional: AdultProduct, Color, ContentRatings, JP_Require18PlusAgeConfirmation, Copyright, Credits, CustomerRating, ExternalID, Genres, ImageUrl, Language, Rank, ReleaseInfo, ShortDescription, ReleaseYear, RuntimeMinutes, Source, Studios, Synopsis

Note: Either MiniSeriesID or MiniSeriesTitle,

Child Elements Specific to This Element Only

Required: EpisodeInSeries, MiniSeriesID, MiniSeriesTitle

Optional: OriginalAirDate

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

Optional Conditionally Required

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 Optional
Conditional Requirements Required if no MiniSeriesTitle element is present
Added CDF version 1.3
Parent Elements MiniSeriesEpisode
Child Elements None
Attributes None

Example:

<MiniSeries>
  <ID>MS-2329880</ID>
  ...
</MiniSeries>
</MiniSeriesEpisode>
  ...
  <MiniSeriesID>MS-2329880</MiniSeriesID>
  <EpisodeInSeries>3</EpisodeInSeries>
</MiniSeriesEpisode>

↑ Back to top

MiniSeriesTitle

Conditionally Required

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 Optional
Conditional Requirements Required if no MiniSeriesID element is present
Added CDF version 1.3
Parent Elements MiniSeriesEpisode
Child Elements None
Attributes None

Example:

<MiniSeriesEpisode>
  ...
  <MiniSeriesTitle>Cats, The Most Beautiful Creature</MiniSeriesTitle>
  <EpisodeInSeries>3</EpisodeInSeries>
</MiniSeriesEpisode>

↑ Back to top

Movie

Optional

One of the basic work types, Movie generally represents a feature-length film, though it can also be used for short films. This work can be a theatrical release or a made-for-TV movie.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Catalog
Child Elements

Required: ID, Offers, Title

Optional: AdultProduct, Color, ContentRatings, JP_Require18PlusAgeConfirmation, Copyright, Credits, CustomerRating, ExternalID, Genres, ImageUrl, Language, Rank, ReleaseInfo, ShortDescription, ReleaseYear, RuntimeMinutes, Source, Studios, Synopsis

Child Elements Specific to This Element Only

Optional: ReleaseDate

Attributes None

Example:

<Movie>
  <ID>MV-123456</ID>
  <Title locale="en-US">Chase the Prawns</Title>
  <Offers>
    <SubscriptionOffer>
      <Regions>
        <Country>US</Country>
      </Regions>
    </SubscriptionOffer>
  </Offers>
  <ReleaseDate>2013-10-04T00:00:00</ReleaseDate>
</Movie>

↑ Back to top

Name

Conditionally Required

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 Optional
Conditional Requirements Required in a CastMember or CrewMember element
Added CDF version 1.0
Parent Elements CastMember, CrewMember
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
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.
  • Accepted values: String

Example:

<CastMember>
  <Name locale="en-US">Alan Smithee</Name>
  ...
</CastMember>

↑ Back to top

Offers

Always Required

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 Required
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements

Optional: SubscriptionOffer, FreeOffer, PurchaseOffer, RentalOffer

Attributes None

Example:

<Offers>
  <FreeOffer>
    <Regions>
      <Country>CA</Country>
    </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>
      <Country>CA</Country>
    </Regions>
    <LaunchDetails>
      <Quality>HD</Quality>
    </LaunchDetails>
  </SubscriptionOffer>
</Offers>

↑ Back to top

OriginalAirDate

Optional

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
Added CDF version 1.3
Parent Elements TvEpisode, TvSpecial, MiniSeriesEpisode
Child Elements None
Attributes None
Accepted Values An XML dateTime value. This value takes the form YYYY-MM-DDThh:mm:ss where YYYY-MM-DD is the year, month, and date and hh:mm:ss is the hour, minute, and second. The T separates the two portions. The entire value is required, from the year down to the second. If the time value is unknown to you, simply use 00:00:00. You can also add an offset from UTC to the end of the value to account for a particular time zone.

Example:

<TvSpecial>
  ...
  <OriginalAirDate>2012-05-13T00:00:00</OriginalAirDate>
</TvSpecial>

↑ Back to top

Partner

Always Required

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
Added CDF version 1.0
Parent Elements Catalog
Child Elements None
Attributes None

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

Price

Optional Conditionally Required

The cost to rent or purchase a work.

Property Detail
Use Optional
Conditional Requirements Required in PurchaseOffer and RentalOffer
Added CDF version 1.0
Parent Elements PurchaseOffer, RentalOffer
Child Elements None
Attributes
currency (required)
  • The currency in which the price is given. Only one currency can be specified per offer type: dollar, pound, yen, or euro.
  • Accepted values: USD, GBP, JPY, EUR

Example:

<PurchaseOffer>
  <Regions>
    <Country>US</Country>
  </Regions>
  <Price currency="USD">1.99</Price>
</PurchaseOffer>

↑ Back to top

PurchaseOffer

Conditionally Required

One of the four offer types. Under this offer, 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. Note that currently Fire TV does not do anything with PurchaseOffer information in the display.

Property Detail
Use Optional
Conditional Requirements Optional, though at least one offer type is required under Offers
Added CDF version 1.0
Parent Elements Offers
Child Elements

Required: Regions, Price

Optional: LaunchDetails, Quality, WindowStart, WindowEnd

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

Quality

Optional

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
Added CDF version 1.2
Parent Elements LaunchDetails
Child Elements None
Attributes None
Accepted Values SD, HD, UHD

Example:

<FreeOffer>
  <Regions>
    <Country>US</Country>
  </Regions>
  <LaunchDetails>
    <Quality>HD</Quality>
    <Quality>UHD</Quality>
  </LaunchDetails>
</FreeOffer>

↑ Back to top

Rank

Optional Highly Recommended

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
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None

Example:

<TvShow>
  ...
  <Rank>36</Rank>
  ...
</TvShow>

↑ Back to top

Regions

Always Required

Contains the countries in which a given offer is available. Each offer type can contain only a single Regions element.

Property Detail
Use Required
Added CDF version 1.0
Parent Elements SubscriptionOffer, FreeOffer, PurchaseOffer, RentalOffer
Child Elements

Required: Country

Note: At least one Country required

Attributes None

Example:

<FreeOffer>
  <Regions>
    <Country>US</Country>
    <Country>CA</Country>
    <Country>MX</Country>
  </Regions>
</FreeOffer>

↑ Back to top

RelatesToExternalID

Optional

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 Optional
Added CDF version 1.3
Parent Elements Extra
Child Elements None
Attributes
scheme (required)
  • The external source that provided this ID.
  • Accepted values:
    • imdb: The Internet Movie Database (IMDb). IDs can be found as part of the URL of a given page.
    • tms: The ID used in the GracenoteTM database.
    • isan: The International Standard Audiovisual Number (ISAN), an alphanumeric strings of 26 characters, usually presented broken by dashes.
    • ean: The International Article Number (EAN), a barcode normally expressed in 13-digits.
    • upc: The Universal Product Code (UPC), a barcode normally expressed in 12-digits.

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

Optional

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
Added CDF version 1.3
Parent Elements Extra
Child Elements None
Attributes None

Example:

<TvShow>
  <ID>TV123456</ID>
  ...
</TvShow>
<Extra>
  ...
  <Type>trailer</Type>
  <RelatesToID>TV123456</RelatesToID>
</Extra>

↑ Back to top

ReleaseCountry

Optional Deprecated

Deprecated, do not use. This element has no replacement. Deprecated in CDF version 1.3.

Property Detail
Use Deprecated — do not use
Added CDF version 1.0
Deprecated true
Parent Elements ReleaseInfo
Child Elements None
Attributes None
Accepted Values The following subset of ISO 3166 country codes: 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

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
Added CDF version 1.3
Parent Elements Movie, TvShow, MiniSeries
Child Elements None
Attributes None
Accepted Values An XML dateTime value. This value takes the form YYYY-MM-DDThh:mm:ss where YYYY-MM-DD is the year, month, and date and hh:mm:ss is the hour, minute, and second. The T separates the two portions. The entire value is required, from the year down to the second. If the time value is unknown to you, simply use 00:00:00. You can also add an offset from UTC to the end of the value to account for a particular time zone.

Example:

<TvShow>
  ...
  <ReleaseDate>2012-05-13T00:00:00</ReleaseDate>
</TvShow>

↑ Back to top

ReleaseDate

Deprecated

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 Deprecated — do not use
Added CDF version 1.0
Deprecated true
Parent Elements ReleaseInfo
Child Elements None
Attributes None
Accepted Values An XML date value. This value takes the form YYYY-MM-DD (year, month, and date).

Example:

<TvShow>
  ...
  <ReleaseInfo>
    <ReleaseDate>2012-05-13</ReleaseDate>
  </ReleaseInfo>
</TvShow>

↑ Back to top

ReleaseInfo

Optional Deprecated

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

Property Detail
Use Deprecated — do not use
Added CDF version 1.0
Deprecated true
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Attributes None

Example:

<TvEpisode>
  ...
  <ReleaseInfo>
    <ReleaseDate>2002-02-20</ReleaseDate>
    <ReleaseCountry>BT</ReleaseCountry>
  </ReleaseInfo>
  ...
</TvEpisode>

↑ Back to top

ReleaseYear

Optional Highly Recommended

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
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None

Example:

<TvEpisode>
  ...
  <ReleaseYear>1959</Releaseyear>
  ...
</TvEpisode>

↑ Back to top

RentalOffer

Optional Conditionally Required

One of the four offer types. Under this offer, 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. Note that currently Fire TV does not do anything with RentalOffer information in the display.

Property Detail
Use Optional
Conditional Requirements Optional, though at least one offer type is required under Offers
Added CDF version 1.0
Parent Elements Offers
Child Elements

Required: Regions, Price, Duration

Optional: LaunchDetails, Quality, WindowStart, WindowEnd

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

Role

Optional

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
Added CDF version 1.0
Parent Elements CastMember
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
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.
  • Accepted values: 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

Optional

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
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None

Example:

<TvEpisode>
  ...
  <RuntimeMinutes>37</RuntimeMinutes>
  ...
</TvEpisode>

↑ Back to top

Score

Optional Conditionally Required

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 Optional
Conditional Requirements Required in CustomerRating
Added CDF version 1.0
Parent Elements CustomerRating
Child Elements None
Attributes None

Example:

<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>

↑ Back to top

SeasonID

Optional Conditionally Required

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 Optional
Conditional Requirements Required if no SeasonInShow element is present
Added CDF version 1.0
Parent Elements TvEpisode
Child Elements None
Attributes None

Example:

<TvSeason>
  <ID>SEA-2329880</ID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <SeasonID>SEA-2329880</SeasonID>
  ...
</TvEpisode>

↑ Back to top

SeasonInShow

Optional Conditionally Required

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 Optional
Conditional Requirements Required if no SeasonID element is present
Added CDF version 1.0
Parent Elements TvEpisode
Child Elements None
Attributes None

Example:

<TvEpisode>
  ...
  <SeasonInShow>2</SeasonInShow>
  ...
</TvEpisode>

↑ Back to top

SeasonTitle

Optional

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
Added CDF version 1.0
Parent Elements TvEpisode
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
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.
  • Accepted values: String

Example:

<TvEpisode>
  ...
  <SeasonInShow>2</SeasonInShow>
  <SeasonTitle locale="en-US">Season 2</SeasonTitle>
  ...
</TvEpisode>

↑ Back to top

ShortDescription

Optional

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
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
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.
  • Accepted values: String

Example:

<TvSpecial>
  ...
  <ShortDescription locale="en-US">Alan shows us some trees and sings songs about them.</ShortDescription>
  ...
</TvSpecial>

↑ Back to top

ShowID

Optional Conditionally Required

Used to tie a TvEpisode, TvSeason, or TvSpecial 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 Optional
Conditional Requirements Required in the absence of ShowTitle for TvEpisode and TvSeason. Optional for TvSpecial.
Added CDF version 1.0
Parent Elements TvSeason, TvEpisode, TvSpecial
Child Elements None
Attributes None

Example:

<TvShow>
  <ID>TV-2329880</ID>
  ...
</TvShow>
<TvSeason>
  ...
  <ShowID>TV-2329880</ShowID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <ShowID>TV-2329880</ShowID>
  ...
</TvEpisode>

↑ Back to top

ShowTitle

Optional Conditionally Required

Used to tie a TvEpisode, TvSeason, or TvSpecial 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 Optional
Conditional Requirements Required in the absence of ShowID for TvEpisode and TvSeason. Optional for TvSpecial.
Added CDF version 1.0
Parent Elements TvSeason, TvEpisode, TvSpecial
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
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.
  • Accepted values: String

Example:

<TvSeason>
  ...
  <ShowTitle locale="en-US">Depth of Field</ShowTitle>
  ...
</TvSeason>

↑ Back to top

Source

Optional Highly Recommended

Where the work originated. Each work can have only one Source.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes None
Accepted Values
  • 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.

Example:

<MiniSeriesEpisode>
  ...
  <Source>licensed</Source>
  ...
</MiniSeriesEpisode>

↑ Back to top

Studio

Optional Conditionally Required

The studio that produced the work. A work can have multiple Studio entries.

Property Detail
Use Optional
Conditional Requirements Required in the optional Studios element
Added CDF version 1.0
Parent Elements Studios
Child Elements None
Attributes None

Example:

<TvEpisode>
  ...
  <Studios>
    <Studio>Amazon Studios</Studio>
    <Studio>Another Production Company</Studio>
  </Studios>
  ...
</TvEpisode>

↑ Back to top

Studios

Optional

Contains one or more Studio elements that identify the studio(s) that produced the work.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements

Required: Studio

Note: At least one required

Attributes None

Example:

<TvEpisode>
  ...
  <Studios>
    <Studio>Amazon Studios</Studio>
    <Studio>Another Production Company</Studio>
  </Studios>
  ...
</TvEpisode>

↑ Back to top

SubscriptionOffer

Optional Conditionally Required

One of the four offer types. Under this offer, the work can be watched by subscribers to the provider's service. If necessary, you can have multiple SubscriptionOffer elements under Offers.

Property Detail
Use Optional
Conditional Requirements Optional, though at least one offer type is required under Offers.
Added CDF version 1.0
Parent Elements Offers
Child Elements

Required: Regions

Optional: LaunchDetails, Quality, WindowStart, WindowEnd

Attributes None

Example:

<SubscriptionOffer>
  <Regions>
    <Country>US</Country>
    <Country>CA</Country>
  </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
Added CDF version 1.2
Parent Elements LaunchDetails
Child Elements None
Attributes None
Accepted Values Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.

Example:

<SubscriptionOffer>
  <Regions>
    <Country>US</Country>
  </Regions>
  <LaunchDetails>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
  </LaunchDetails>
</SubscriptionOffer>

↑ Back to top

Synopsis

Optional

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
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
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.
  • Accepted values: 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

System

Optional Conditionally Required

The rating system, normally an official organization, that determined a work's rating. Each rating can have only one System.

Property Detail
Use Optional
Conditional Requirements Required in ContentRating
Added CDF version 1.0
Parent Elements ContentRating
Child Elements None
Attributes None

Example:

<ContentRatings>
  <ContentRating>
    <System>MPAA</System>
    <Certification>G</Certification>
  </ContentRating>
</ContentRatings>

↑ 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 Optional
Added CDF version 1.0
Parent Elements Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra
Child Elements None
Attributes
locale (required)
  • The device or software's language setting under which to use this string.
  • Accepted values: Standard XML/HTML language codes, such as en, en-US, fr, or fr-FR.
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.
  • Accepted values: String

Example:

<TvShow>
  <ID>TV123456</ID>
  <Title locale="en-US">Office Factor</Title>
  ...
</TvShow>

↑ Back to top

TvEpisode

Optional

One of the basic work types, a TvEpisode is a single episode of a TvShow, normally also associated with a TvSeason.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Catalog
Child Elements

Required: ID, Offers, Title

Optional: AdultProduct, Color, ContentRatings, JP_Require18PlusAgeConfirmation, Copyright, Credits, CustomerRating, ExternalID, Genres, ImageUrl, Language, Rank, ReleaseInfo, ShortDescription, ReleaseYear, RuntimeMinutes, Source, Studios, Synopsis

Child Elements Specific to This Element Only

Required: ShowID, ShowTitle, SeasonID, SeasonInShow, EpisodeInSeason

Optional: SeasonTitle, OriginalAirDate

Note: Either ShowID or ShowTitle, but not both. Also, either SeasonID or SeasonInShow, but not both.

Attributes None

Example:

<TvShow>
  <ID>ABC-123457</ID>
  ...
</TvShow>
<TvSeason>
  <ID>TVS-987654</ID>
  ...
</TvSeason>
<TvEpisode>
  <ID>TVE2329880</ID>
  <Title locale="en-US">What's in a Name?</Title>
  <Offers>
    <SubscriptionOffer>
      <Regions>
        <Country>US</Country>
      </Regions>
    </SubscriptionOffer>
  </Offers>
  <ShowID>ABC-123457</ShowID>
  <SeasonID>TVS-987654</SeasonInShow>
  <EpisodeInSeason>5</EpisodeInSeason>
</TvEpisode>

↑ Back to top

TvSeason

Optional

One of the basic work types, a TvSeason is a single season of a TvShow. When a TvEpisode's SeasonID value is the same as the TvSeason's ID, that episode declares itself part of the season.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Catalog
Child Elements

Required: ID, Offers, Title

Optional: AdultProduct, Color, ContentRatings, JP_Require18PlusAgeConfirmation, Copyright, Credits, CustomerRating, ExternalID, Genres, ImageUrl, Language, Rank, ReleaseInfo, ShortDescription, ReleaseYear, RuntimeMinutes, Source, Studios, Synopsis

Child Elements Specific to This Element Only

Required: ShowID, ShowTitle, SeasonInShow

Note: Either ShowID or ShowTitle, but not both

Attributes None

Example:

<TvShow>
  <ID>ABC-123457</ID>
  ...
</TvShow>
<TvSeason>
  <ID>TVS2329880</ID>
  <Title locale="en-US">Season Five</Title>
  <Offers>
    <SubscriptionOffer>
      <Regions>
        <Country>US</Country>
      </Regions>
    </SubscriptionOffer>
  </Offers>
  <ShowID>ABC-123457</ShowID>
  <SeasonInShow>5</SeasonInShow>
</TvSeason>
<TvEpisode>
  ...
  <ShowID>ABC-123457</ShowID>
  <SeasonID>TVS2329880</SeasonID>
  ...
</TvEpisode>

↑ Back to top

TvShow

Optional

One of the basic work types, a TvShow is a televised series made up of seasons and episodes. It can also have associated specials outside of the regular sequence of episodes. When a TvSeason, TvEpisode, or TvSpecial's ShowID value is the same as the TvShow's ID, that season, episode, or special declares itself part of the show.

Property Detail
Use Optional
Added CDF version 1.0
Parent Elements Catalog
Child Elements

Required: ID, Offers, Title

Optional: AdultProduct, Color, ContentRatings, JP_Require18PlusAgeConfirmation, Copyright, Credits, CustomerRating, ExternalID, Genres, ImageUrl, Language, Rank, ReleaseInfo, ShortDescription, ReleaseYear, RuntimeMinutes, Source, Studios, Synopsis

Child Elements Specific to This Element Only

Optional: ReleaseDate

Attributes None

Example:

<TvShow>
  <ID>RS-2329880</ID>
  <Title locale="en-US">Office Factor</Title>
  <Offers>
    <SubscriptionOffer>
      <Regions>
        <Country>US</Country>
      </Regions>
    </SubscriptionOffer>
  </Offers>
</TvShow>
<TvSeason>
  <ID>TVS2329880</ID>
  ...
  <ShowID>RS-2329880</ShowID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <ShowID>RS-2329880</ShowID>
  <SeasonID>TVS2329880</SeasonID>
  ...
</TvEpisode>

↑ Back to top

TvSpecial

Optional

One of the basic work types, TvSpecial is used for 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
Added CDF version 1.0
Parent Elements Catalog
Child Elements

Required: ID, Offers, Title

Optional: AdultProduct, Color, ContentRatings, JP_Require18PlusAgeConfirmation, Copyright, Credits, CustomerRating, ExternalID, Genres, ImageUrl, Language, Rank, ReleaseInfo, ShortDescription, ReleaseYear, RuntimeMinutes, Source, Studios, Synopsis

Child Elements Specific to This Element Only

Required: OriginalAirDate

Optional: ShowID, ShowTitle

Note: OriginalAirDate was added in CDF v1.3. Either ShowID or ShowTitle, but not both.

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

Type

Always Required

Specifies an Extra as a trailer (preview) or a clip. You can regard anything that isn't a trailer as a clip, though it might be something as extensive as a making-of documentary about the Extra's associated Movie. Each Extra can have only one Type.

Property Detail
Use Required
Added CDF version 1.3
Parent Elements Extra
Child Elements None
Attributes None
Accepted Values clip, trailer

Example:

<Extra>
  ..
  <Type>trailer</Type>
  ...
</Extra>

↑ Back to top

WindowEnd

Optional

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
Added CDF version 1.0
Parent Elements SubscriptionOffer, FreeOffer, PurchaseOffer, RentalOffer
Child Elements None
Attributes None
Accepted Values An XML dateTime value. This value takes the form YYYY-MM-DDThh:mm:ss where YYYY-MM-DD is the year, month, and date and hh:mm:ss is the hour, minute, and second. The T separates the two portions. The entire value is required, from the year down to the second. If the time value is unknown to you, simply use 00:00:00. You can also add an offset from UTC to the end of the value to account for a particular time zone.

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

Optional

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
Added CDF version 1.0
Parent Elements SubscriptionOffer, FreeOffer, PurchaseOffer, RentalOffer
Child Elements None
Attributes None
Accepted Values An XML dateTime value. This value takes the form YYYY-MM-DDThh:mm:ss where YYYY-MM-DD is the year, month, and date and hh:mm:ss is the hour, minute, and second. The T separates the two portions. The entire value is required, from the year down to the second. If the time value is unknown to you, simply use 00:00:00. You can also add an offset from UTC to the end of the value to account for a particular time zone.

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

Always Required

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
Added CDF version 1.0
Parent Elements Catalog
Child Elements

Optional: Movie, TvShow, TvSeason, TvEpisode, TvSpecial, MiniSeries, MiniSeriesEpisode, Extra

Attributes None

Example:

<Catalog>
  <Partner>Everything Ever Made Filmworks</Partner>
  <Works>
    ...
  </Works>
</Catalog>

↑ Back to top