Extra Elements
Tree diagram
Note: After clicking a link in the diagram, the element scrolls into focus below the diagram.
├── Partner ├── Works │ ├── Movie │ ├── TvEpisode │ ├── TvSeason │ ├── TvShow │ └── Extra │ ├── ID │ ├── ExternalID │ ├── Titles │ │ └── Title │ ├── Copyright │ ├── Offers │ │ ├── SubscriptionOffer │ │ │ ├── Regions │ │ │ │ └── Territories │ │ │ ├── WindowStart │ │ │ ├── WindowEnd │ │ │ └── LaunchDetails │ │ │ ├── Quality │ │ │ ├── AudioLanguage │ │ │ ├── Subtitle │ │ │ └── LaunchId │ │ └── FreeOffer │ │ ├── Regions │ │ │ └── Territories │ │ ├── WindowStart │ │ ├── WindowEnd │ │ └── LaunchDetails │ │ ├── Quality │ │ ├── AudioLanguage │ │ ├── Subtitle │ │ └── LaunchId │ ├── IsAdultProducts │ │ └── IsAdultProduct │ ├── ReleaseYear │ ├── ShortDescriptions │ │ └── ShortDescription │ ├── Synopses │ │ └── Synopsis │ ├── MetadataAvailabilityDates │ │ └── MetadataAvailabilityDate │ ├── Images │ │ └── Image │ │ ├── Url │ │ └── Locale │ ├── Runtimes │ │ └── RuntimeMinutes │ ├── Color │ ├── Credits │ │ ├── CastMember │ │ │ ├── Name │ │ │ ├── ExternalID │ │ │ └── Role │ │ └── CrewMember │ │ ├── Name │ │ ├── ExternalID │ │ └── Job │ ├── Studios │ │ └── Studio │ ├── Language │ ├── CustomerRating │ │ ├── Score │ │ ├── MaxValue │ │ └── Count │ ├── Rank │ ├── IsOriginals │ │ └── IsOriginal │ ├── Genres │ │ └── Genre │ ├── ContentRatings │ │ └── ContentRating │ │ ├── System │ │ └── Certification │ ├── Type │ ├── RelatesToID │ └── RelatesToExternalID ├── LinearData └── StationMappingData
<?xml version="1.0" encoding="utf-8" ?> <Catalog xmlns="http://www.amazon.com/FireTv/2014-04-11/ingestion" version="FireTv-v1.11"> <!-- This sample Amazon Fire TV catalog shows you how to use the Extra work type. Examples use various tagging, from the minimum information required to the inclusion of all optional elements. The final example contains information on which elements are required and which are optional. --> <!-- Note that most elements are the same in all work types, with only the last 1-3 elements changing from type to type. The majority of what applies here also applies to other work types. --> <Partner>Everything Ever Made Filmworks</Partner> <Works> <!-- This example provides the minimal information for a valid entry. While valid, it will be difficult for a user to locate this work through search or browse. The more metadata you can provide, the better. --> <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> <!-- This entry adds some optional information that gives the work more visibility. For instance, the work can now be found through a search for the show or the star's name. Also, once the user locates the work, they can read more about it. --> <Extra> <ID>EXTRA-11112</ID> <!-- Optional --> <ExternalID scheme="imdb">tt3502172</ExternalID> <Title locale="en-US">Wishenpoof! Season One: The Official Trailer</Title> <Offers> <SubscriptionOffer> <Regions> <Country>US</Country> <Country>FR</Country> <Country>BE</Country> </Regions> <!-- Optional --> <LaunchDetails> <Quality>HD</Quality> </LaunchDetails> </SubscriptionOffer> </Offers> <!-- Optional --> <ShortDescription locale="en-US">Bianca is just like any girl...well, kind of. She has one teeny ability, "wish magic" - the power to make wishes come true.</ShortDescription> <!-- Optional --> <Credits> <CastMember> <Name locale="en-US">Addison Holley</Name> <ExternalID scheme="imdb">nm3204147</ExternalID> <Role locale="en-US">Bianca</Role> </CastMember> </Credits> <Type>trailer</Type> <!-- Optional --> <RelatesToID>TV-12345</RelatesToID> </Extra> <!-- This entry provides all of the possible information. We've included comments to tell you about whether each element is required or optional, valid values for certain entries, and some usage notes. --> <Extra> <!-- Required. ID must be at least one character long and unique in catalog. --> <ID>EXTRA-11113</ID> <!-- Optional. Multiple instances allowed. If present, scheme attribute is required (accepted values imdb, tms, isan, ean, and upc). In practice, an Extra will often not have an ExternalID. --> <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> <!-- Required (locale attribute also required). Multiple instances allowed, but only one for each locale. --> <Title locale="en-US">Wishenpoof! Season One: The Official Trailer</Title> <!-- Optional. One instance only. If present, locale attribute required. --> <Copyright locale="en-US">© 2014 Amazon Studios</Copyright> <!-- Required. One instance only. --> <Offers> <!-- You have a choice of 2 offer types: FreeOffer or SubscriptionOffer. --> <!-- Many extras will only have a FreeOffer or SubscriptionOffer, particularly trailers. The other offer types are present here for completeness. --> <!-- You must include at least one offer. --> <FreeOffer> <!-- Required. One instance only. --> <Regions> <!-- At least one Country required. --> <Country>US</Country> <Country>GB</Country> <Country>CA</Country> <Country>MX</Country> </Regions> <!-- Optional. One instance only. --> <WindowStart>2014-02-06T12:00:00-07:00</WindowStart> <!-- Optional. One instance only. --> <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd> <!-- Optional. Multiple instances allowed for different LaunchIds. --> <LaunchDetails> <!-- Optional. Accepted values SD, HD, and UHD. Multiple instances allowed for different qualities. --> <Quality>SD</Quality> <Quality>HD</Quality> <!-- Optional. Multiple instances allowed for different audio languages. --> <AudioLanguage>en-US</AudioLanguage> <AudioLanguage>es-MX</AudioLanguage> <!-- Optional. Multiple instances allowed for different subtitle languages. --> <Subtitle>es</Subtitle> <Subtitle>fr</Subtitle> <!-- Optional. Only one LaunchId is allowed under each LaunchDetails element --> <LaunchId>EXTRA-11113_HD_en-US</LaunchId> </LaunchDetails> </FreeOffer> <SubscriptionOffer> <!-- Required. One instance only. --> <Regions> <!-- At least one Country required. --> <Country>US</Country> <Country>GB</Country> </Regions> <!-- Optional. One instance only. --> <WindowStart>2014-02-06T12:00:00-07:00</WindowStart> <!-- Optional. One instance only. --> <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd> <!-- Optional. Multiple instances allowed for different LaunchIds. --> <LaunchDetails> <!-- Optional. Accepted values SD, HD, and UHD. Multiple instances allowed for different qualities. --> <Quality>SD</Quality> <Quality>HD</Quality> <!-- Optional. Multiple instances allowed for different audio languages. --> <AudioLanguage>en-US</AudioLanguage> <AudioLanguage>es-MX</AudioLanguage> <!-- Optional. Multiple instances allowed for different subtitle languages. --> <Subtitle>es</Subtitle> <Subtitle>fr</Subtitle> <!-- Optional. Only one LaunchId is allowed under each LaunchDetails element --> <LaunchId>EXTRA-11113_HD_en-US</LaunchId> </LaunchDetails> </SubscriptionOffer> </Offers> <!-- Optional, but highly recommended. One instance only. Should match the year in the ReleaseDate element, if present. While this element is optional, we recommend that you include it. This value is used in matching this work with the same work from other providers to bundle all offers into a single search result. --> <ReleaseYear>2014</ReleaseYear> <!-- Optional. If present, the locale attribute is required. Multiple instances allowed, but only one for each locale. --> <ShortDescription locale="en-US">Bianca is just like any girl...well, kind of. She has one teeny ability, "wish magic" - the power to make wishes come true.</ShortDescription> <!-- Optional. If present, the locale attribute is required. Multiple instances allowed, but only one for each locale. --> <Synopsis locale="en-US">Bianca is a normal little girl - she goes to school, she plays with her best friend Penelope, she loves her parents, and she loves her teddy bear, Bob. But Bianca also has "wish magic", which can make wishes come true. Adventures ensue and valuable life lessons are learned.</Synopsis> <!-- Optional, but recommended. One instance only. At least 50% of your entries must include this element and the image it points to must be valid. --> <Images> <Image> <Url>http://amzf.tmsimg.com/assets/28873/p28873_k_h2_aa.jpg</Url> </Image> </Images> <!-- Optional. One instance only. Value should be 2880 or less to avoid a warning in the ingestion report. --> <RuntimeMinutes>1</RuntimeMinutes> <!-- Optional. One instance only. Accepted values color and black_and_white. --> <Color>color</Color> <!-- Optional. One instance only. Must include at least one cast member or crew member. --> <Credits> <!-- Optional if at least one CrewMember element is present, otherwise required. Multiple instances allowed. --> <CastMember> <!-- Required, locale attribute also required. Multiple instances allowed. --> <Name locale="en-US">Addison Holley</Name> <!-- Optional. Multiple instances allowed. If present, scheme attribute is required (accepted values imdb, tms, isan, ean, and upc). --> <ExternalID scheme="imdb">nm3204147</ExternalID> <!-- Required, locale attribute also required. Multiple instances allowed. --> <Role locale="en-US">Bianca</Role> </CastMember> <!-- Optional if at least one CastMember element is present, otherwise required. Multiple instances allowed. --> <CrewMember> <!-- Required, locale attribute also required. Multiple instances allowed. --> <Name locale="en-US">Angela Santomero</Name> <!-- Optional. Multiple instances allowed. If present, scheme attribute is required (accepted values imdb, tms, isan, ean, and upc). --> <ExternalID scheme="imdb">nm0996022</ExternalID> <!-- Required, locale attribute also required. Multiple instances allowed. --> <Job locale="en-US">Creator</Job> <Job locale="en-US">Writer</Job> </CrewMember> <CrewMember> <Name locale="en-US">Derek Sunderland</Name> <ExternalID scheme="imdb">nm1437712</ExternalID> <Job locale="en-US">Rigger</Job> </CrewMember> </Credits> <!-- Optional. One instance only. --> <Studios> <!-- When present, Studios must include at least one Studio. Multiple instances allowed. --> <Studio>Amazon Studios</Studio> </Studios> <!-- Optional. One instance only. --> <Language>en</Language> <!-- Optional. One instance only. --> <CustomerRating> <!-- Required. One instance only. --> <Score>7.1</Score> <!-- Required. One instance only. --> <MaxValue>10.0</MaxValue> <!-- Optional. One instance only. --> <Count>42</Count> </CustomerRating> <!-- Optional. One instance only. 1 is the top rank. --> <Rank>102</Rank> <!-- Optional. One instance only. Accepted values are original, licensed, unknown, and other. --> <Source>original</Source> <!-- Optional. One instance only. --> <Genres> <!-- When present, Genres must include at least one Genre. Multiple instances allowed. The locale attribute is required. --> <Genre locale="en-US">Trailer</Genre> <Genre locale="en-US">Family</Genre> </Genres> <!-- Optional. One instance only. --> <ContentRatings> <!-- When present, ContentRatings must include at least one ContentRating. Multiple instances allowed.--> <ContentRating> <!-- Required. One instance only. --> <System>MPAA</System> <!-- Required. One instance only. --> <Certification>Not Rated</Certification> </ContentRating> <ContentRating> <System>Comisión Asesora de Exhibición Cinematográfica</System> <Certification>ATP</Certification> </ContentRating> </ContentRatings> <!-- Optional. One instance only. For use in Japan only. --> <JP_Require18PlusAgeConfirmation>false</JP_Require18PlusAgeConfirmation> <!-- Required. One instance only. Accepted values are clip and trailer. --> <Type>trailer</Type> <!-- Optional. One instance only. This element ties the extra to another work. You have the choice of RelatesToID or RelatesToExternalID. When using RelatesToID, the work with this ID must be in the same catalog; otherwise use RelatesToExternalID. An extra can also be standalone, in which case omit this element. --> <RelatesToID>TV-12345</RelatesToID> </Extra> </Works> </Catalog>
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 | |
| Attributes |
Data Type: Enum. Enum Values: |
<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>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 Elements | None |
| Data Type | string |
<Catalog xmlns="http://www.amazon.com/FireTv/2014-04-11/ingestion" version="FireTv-v1.3">
<Partner>Everything Ever Made Filmworks</Partner>
...
<Catalog>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 | |
| Attributes | None |
<Catalog>
<Partner>Everything Ever Made Filmworks</Partner>
<Works>
...
</Works>
</Catalog>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 | |
| Attributes | None |
<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>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 | |
| Attributes | None |
<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>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 | |
| Attributes | None |
<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>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 | |
| Attributes | None |
<TvShow>
<ID>RS-2329880</ID>
...
</TvShow>
<TvSeason>
<ID>TVS2329880</ID>
...
<ShowID>RS-2329880</ShowID>
...
</TvSeason>
<TvEpisode>
...
<ShowID>RS-2329880</ShowID>
<SeasonID>TVS2329880</SeasonID>
...
</TvEpisode>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 | |
| Attributes | None |
<Extra>
<ID>EXTRA-11111</ID>
...
<Type>clip</Type>
</Extra>LinearData
A list of linear data you provide. Might contain schedules, stations, regions, lineups, or geographical regions.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Catalog |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<LinearData>
<Station>
<ID>station-example1</ID>
<Titles>
<Title locale="en">Example 1</Title>
</Titles>
<BroadcastLanguage>en</BroadcastLanguage>
<StationType>Network</StationType>
<StationAttributes>
<StationAttribute>HDTV</StationAttribute>
</StationAttributes>
<TimeZone>America/Los Angeles</TimeZone>
<Images>
<Image>
<Url>https://firetv-cdf-documents.s3.amazonaws.com/imageexamples/station_cover.jpg</Url>
<Tag>stationCover</Tag>
<Locale>en-US</Locale>
</Image>
<Image>
<Url>https://firetv-cdf-documents.s3.amazonaws.com/imageexamples/station_hb.jpg</Url>
<Tag>stationHB</Tag>
<Locale>en-US</Locale>
</Image>
</Images>
</Station>
...
<Lineup>
<ID>national-us1</ID>
<Name>ExampleTV Lineup US</Name>
<LocationInfo>
<Region>
<PostalCodes>
<PostalCode>
<AssociatedCountry>US</AssociatedCountry>
</PostalCode>
</PostalCodes>
</Region>
<FilterType>EXCLUDE</FilterType>
</LocationInfo>
<BroadcastType>IP</BroadcastType>
<MSO>Example</MSO>
<Broadcasts>
<Broadcast>
<ID>broadcast-example1</ID>
<StationReference>station-example1</StationReference>
<Channel>3</Channel>
<Transports>
<Transport subsystem="DVB_T">
<ONID>12339</ONID>
<TSID>8197</TSID>
<SID>8261</SID>
<Country>US</Country>
</Transport>
</Transports>
</Broadcast>
...
</Broadcasts>
</Lineup>
<ScheduleDay>
<ID>station-example1-2023-04-25</ID>
<Date>2023-04-25</Date>
<AssociatedStationId>station-example1</AssociatedStationId>
<Schedules>
<Schedule>
<ContentReference>abc123</ContentReference>
<StartTime>2023-04-25T01:05:00Z</StartTime>
<Duration>PT25M</Duration>
<PreferredLocale>en-US</PreferredLocale>
<SubtitleLanguage>en-US</SubtitleLanguage>
</Schedule>
...
</Schedules>
</ScheduleDay>
...
</LinearData>Station
Coming from a conventional broadcasting model, a station is an entity that has scheduled programming. For broadcasting TV stations this can include some broadcast-specific attributes, and for virtual (IP-based) stations less attributes are appropriate. You must have at least one station in a linear data catalog.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
LinearData |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Station>
<ID>station-example1</ID>
<Titles>
<Title locale="en">Example 1</Title>
</Titles>
<BroadcastLanguage>en</BroadcastLanguage>
<StationType>Network</StationType>
<StationAttributes>
<StationAttribute>HDTV</StationAttribute>
</StationAttributes>
<TimeZone>America/Los Angeles</TimeZone>
<Images>
<Image>
<Url>https://firetv-cdf-documents.s3.amazonaws.com/imageexamples/station_cover.jpg</Url>
<Tag>stationCover</Tag>
<Locale>en-US</Locale>
</Image>
<Image>
<Url>https://firetv-cdf-documents.s3.amazonaws.com/imageexamples/station_hb.jpg</Url>
<Tag>stationHB</Tag>
<Locale>en-US</Locale>
</Image>
</Images>
</Station>Lineup
With lineups you can scope your broadcasts and stations to a specific country. You must declare a lineup with a region to make sure your data shows only in the countries they are meant to show in.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
LinearData |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Lineup>
<ID>national-us1</ID>
<Name>ExampleTV Lineup US</Name>
<LocationInfo>
<Region>
<PostalCodes>
<PostalCode>
<AssociatedCountry>US</AssociatedCountry>
</PostalCode>
</PostalCodes>
</Region>
<FilterType>EXCLUDE</FilterType>
</LocationInfo>
<BroadcastType>IP</BroadcastType>
<MSO>Example</MSO>
<Broadcasts>
<Broadcast>
<ID>broadcast-example1</ID>
<StationReference>station-example1</StationReference>
<Channel>3</Channel>
<Transports>
<Transport subsystem="DVB_T">
<ONID>12339</ONID>
<TSID>8197</TSID>
<SID>8261</SID>
<Country>US</Country>
</Transport>
</Transports>
</Broadcast>
...
</Broadcasts>
</Lineup>ScheduleDay
The schedules for a specific source and a specific day.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
LinearData |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<ScheduleDay>
<ID>station-example-2024-10-01</ID>
<Date>2024-10-01</Date>
<AssociatedStationId>station123</AssociatedStationId>
<Schedules>
<Schedule>
<ContentReference>movie123</ContentReference>
<StartTime>2024-10-01T18:00:00</StartTime>
<Duration>PT120M</Duration>
<PreferredLocale>en-US</PreferredLocale>
<SubtitleLanguage>en-US</SubtitleLanguage>
</Schedule>
</Schedules>
</ScheduleDay>StationMappingData
A list of station references for your stations.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Catalog |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
ID
An identifier string for a work, station, lineup, broadcast, or schedule day. 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 |
MovieTvShowTvSeasonTvEpisodeExtraStationLineupBroadcastScheduleDayStationRef |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | NonEmptyToken |
<Movie>
<ID>AmazonStudios_Movie_01152ce2-de7e-44c1-9736-e8f3b15a1ddf</ID>
...
</Movie>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 |
CastMemberCrewMemberExtraMovieTvEpisodeTvSeasonTvShowExternalIdsStationRef |
| Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
| Child Elements | None |
| Attributes |
Data Type: Enum. Enum Values:
Data Type: string |
<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>Titles
Contains a work's title. Each work can contain one Titles element.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
MovieTvShowTvSeasonTvEpisodeExtraStation |
| Content Model | simpleType (no children) |
| Child Elements | |
| Data Type | Localized string |
<TvShow>
<ID>TV123456</ID>
<Titles>
...
</Titles>
...
</TvShow>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 Elements | None |
| Attributes |
Data Type: language
Data Type: string
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
| Data Type | TerritoryStringType - Same as string with the addition of the locale, pronunciation, and territories attributes. |
<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>Copyright
A statement of the work's copyright.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
| Child Elements | None |
| Attributes |
Data Type: language
Data Type: string |
| Data Type | Localized string |
<Copyright locale="en-US">© 2014 Amazon Studios</Copyright>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 |
MovieTvShowTvSeasonTvEpisodeExtraStationStationRef |
| Content Model | complexType – choice. Either one child element or another required, but not both. |
| Child Elements | |
| Attributes | None |
<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>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 | |
| Attributes | None |
<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>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 |
SubscriptionOfferFreeOffer |
| Content Model | complexType – choice. Either one child element or another required, but not both. |
| Child Elements | |
| Attributes | None |
<FreeOffer>
<Regions>
<Territories>US, PR, VI, GB, DE, AT</Territories>
</Regions>
...
</FreeOffer>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 Elements | None |
| Data Type | TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
<SubscriptionOffer>
<Regions>
<Territories>US, PR, VI, GB, DE, AT</Territories>
</Regions>
...
</SubscriptionOffer>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.
WindowStartonly: The work is available indefinitely from that time forward unless it is removed from the catalog.WindowEndonly: The work is available immediately, but only until that time.WindowStart+WindowsEnd: The work is available only in that window of time.- Neither
WindowStartnorWindowEnd: 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 |
SubscriptionOfferFreeOffer |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | dateTime |
<FreeOffer>
...
<WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
<WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
...
</FreeOffer>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.
WindowStartonly: The work is available indefinitely from that time forward unless it is removed from the catalog.WindowEndonly: The work is available immediately, but only until that time.WindowStart+WindowsEnd: The work is available only in that window of time.- Neither
WindowStartnorWindowEnd: 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 |
SubscriptionOfferFreeOffer |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | dateTime |
<FreeOffer>
...
<WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
<WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
...
</FreeOffer>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 |
SubscriptionOfferFreeOffer |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<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>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.
Quality. The first, a direct child of each offer type, was deprecated. The second is a child of LaunchDetails, and therefore a grandchild of each offer type. This newer, non-deprecated Quality element is the one we discuss here, although other than their parent elements, the two are identical in form and content.| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | Unlimited |
| Parent Elements |
LaunchDetails |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Enum: SD, HD, UHD |
<FreeOffer>
...
<LaunchDetails>
<Quality>HD</Quality>
<Quality>UHD</Quality>
<Quality>SD</Quality>
</LaunchDetails>
...
</FreeOffer>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 Elements | None |
| Data Type | language |
<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>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 Elements | None |
| Data Type | language |
<SubscriptionOffer>
...
<LaunchDetails>
<Quality>HD</Quality>
<AudioLanguage>en-US</AudioLanguage>
<Subtitle>fr</Subtitle>
<Subtitle>es</Subtitle>
</LaunchDetails>
</SubscriptionOffer>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 Elements | None |
| Data Type | token |
<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>| Property | Detail |
|---|---|
| Use | |
| How Many Allowed | |
| Parent Elements | |
| Content Model | |
| Child Elements | |
| Attributes | |
| Data Type |
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 | |
| Attributes | None |
<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>IsAdultProducts
Contains identification of a work as content for adult audiences only.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<IsAdultProducts>
<!-- if no territory is provided, then the field value is applicable worldwide. -->
<IsAdultProduct>false</IsAdultProduct>
<IsAdultProduct territories="IN,DE">true</IsAdultProduct>
</IsAdultProducts>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 Elements | None |
| Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
| Data Type | TerritoryBooleanType - Same as boolean with the addition of the territories attribute. |
<IsAdultProducts>
<!-- if no territory is provided, then the field value is applicable worldwide. -->
<IsAdultProduct>false</IsAdultProduct>
<IsAdultProduct territories="IN,DE">true</IsAdultProduct>
</IsAdultProducts>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | int |
<TvEpisode>
...
<ReleaseYear>1959</ReleaseYear>
...
</TvEpisode>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Movie>
...
<ShortDescriptions>
...
</ShortDescriptions>
...
</Movie>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 Elements | None |
| Attributes |
Data Type: language
Data Type: string
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
| Data Type | TerritoryStringType - Same as string with the addition of the locale, pronunciation, and territories attributes. |
<Movie>
...
<ShortDescriptions>
<ShortDescription locale="en-US" territories="US">Alan shows us some trees and sings songs about them.</ShortDescription>
</ShortDescriptions>
...
</Movie>Synopses
Contains a full description of the content varying by locale and territory.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Movie>
...
<Synopses>
...
</Synopses>
...
</Movie>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 Elements | None |
| Attributes |
Data Type: language
Data Type: string |
| Data Type | TerritoryStringType - Same as string with the addition of the locale, pronunciation, and territories attributes. |
<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>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Movie>
<ID>MV-123456</ID>
...
<MetadataAvailabilityDates>
...
</MetadataAvailabilityDates>
...
</Movie>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 Elements | None |
| Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
| Data Type | TerritoryDateTimeType - Same as dateTime with the addition of the territories attribute. |
<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>Images
Images to represent the TV, movie, or station content. See Image for image size details.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
MovieTvShowTvSeasonTvEpisodeExtraStationStationRef |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Movie>
...
<Images>
<Image>
...
</Image>
</Images>
...
</Movie>Image
An image to represent the TV, movie, or station 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.
For details about station images in a linear catalog, see Requirements for station images in a linear catalog.
⚠Important! When you specify territory or locale tags for an image, that image becomes restricted to only those territories and locales. If your content is available in multiple territories and locales, you must provide territory and locale-specific images for each region. Failing to do so might result in missing images for some users.
| 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 | |
| Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
<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>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 Elements | None |
| Data Type | anyURI |
<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>Locale
The language for the image. See Image for details on image size and dimensions.
locale element ensures your content is matched correctly across languages and regions. | Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | Unlimited |
| Parent Elements |
Image |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | language |
<Image>
<Url>http://sample-server.net/cds/1.0/image/B23R/FJK8/9FAR/39RTE_992.png</Url>
<Locale>es</Locale>
</Image>Runtimes
Contains overall running time of the content varying by locale and territory.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<TvEpisode>
...
<Runtimes>
<RuntimeMinutes territories="VI,GU,PR,GB">37</RuntimeMinutes>
<RuntimeMinutes territories="US">46</RuntimeMinutes>
</Runtimes>
...
</TvEpisode>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 Elements | None |
| Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
| Data Type | TerritoryInteger - Same as int with the addition of the territories attribute. |
<TvEpisode>
...
<Runtimes>
<RuntimeMinutes territories="VI,GU,PR,GB">37</RuntimeMinutes>
<RuntimeMinutes territories="US">46</RuntimeMinutes>
</Runtimes>
...
</TvEpisode>Color
Specifies whether the movie is primarily in color or in black-and-white.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Enum: color, black_and_white |
<Movie>
...
<Color>black_and_white</Color>
...
</Movie>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – choice. Either one child element or another required, but not both. |
| Child Elements | |
| Attributes | None |
<Credits>
<CastMember>
<Name locale="en-US">Alan Smithee</Name>
<Role locale="en-US">Self</Role>
</CastMember>
</Credits>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 | |
| Attributes | None |
<Credits>
<CastMember>
<Name locale="en-US">Alan Smithee</Name>
<ExternalID scheme="imdb">tt0000000</ExternalID>
<Role locale="en-US">Self</Role>
</CastMember>
</Credits>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 |
CastMemberCrewMember |
| Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
| Child Elements | None |
| Attributes |
Data Type: language
Data Type: string |
| Data Type | Localized string |
<CastMember>
<Name locale="en-US">Alan Smithee</Name>
...
</CastMember>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 |
CastMemberCrewMemberExtraMovieTvEpisodeTvSeasonTvShowExternalIdsStationRef |
| Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
| Child Elements | None |
| Attributes |
Data Type: Enum. Enum Values:
Data Type: string |
<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>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 Elements | None |
| Attributes |
Data Type: string
Data Type: language |
| Data Type | Localized string |
<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>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 | |
| Attributes | None |
<Credits>
<CrewMember>
<Name locale="en-US">Alan Smithee</Name>
<ExternalID scheme="imdb">tt0000000</ExternalID>
<Job locale="en-US">Director</Job>
</CrewMember>
</Credits>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 Elements | None |
| Attributes |
Data Type: language
Data Type: string |
| Data Type | Localized string |
<CrewMember>
<Name locale="en-US">Alan Smithee</Name>
<ExternalID scheme="imdb">tt0000000</ExternalID>
<Job locale="en-US">Grip</Job>
</CrewMember>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 |
MovieTvShowTvSeasonTvEpisodeTvSpecialExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<TvEpisode>
...
<Studios>
<Studio>Amazon Studios</Studio>
<Studio>Another Production Company</Studio>
</Studios>
...
</TvEpisode>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 Elements | None |
| Data Type | string |
<TvEpisode>
...
<Studios>
<Studio>Amazon Studios</Studio>
<Studio>Another Production Company</Studio>
</Studios>
...
</TvEpisode>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | language |
<Movie>
...
<Language>ja</Language>
...
</Movie>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<CustomerRating>
<Score>8.2</Score>
<MaxValue>10</MaxValue>
<Count>512</Count>
</CustomerRating>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 Elements | None |
| Data Type | decimal (positive value) |
<CustomerRating>
<Score>8.2</Score>
<MaxValue>10</MaxValue>
<Count>512</Count>
</CustomerRating>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | decimal (positive value) |
<CustomerRating>
<Score>8.2</Score>
<MaxValue>10</MaxValue>
<Count>512</Count>
</CustomerRating>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 Elements | None |
| Data Type | Non-negative long |
<CustomerRating>
<Score>8.2</Score>
<MaxValue>10</MaxValue>
<Count>512</Count>
</CustomerRating>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | int |
<TvShow>
...
<Rank>36</Rank>
...
</TvShow>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<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>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 Elements | None |
| Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
| Data Type | TerritoryBooleanType - Same as boolean with the addition of the territories attribute. |
<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>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Genres>
<Genre locale="en-US">horror</Genre>
<Genre locale="en-US">sci-fi</Genre>
</Genres>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 Elements | None |
| Attributes |
Data Type: language
Data Type: string |
| Data Type | Localized string |
<Genres>
<Genre locale="en-US">horror</Genre>
<Genre locale="en-US">sci-fi</Genre>
</Genres>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 |
MovieTvShowTvSeasonTvEpisodeExtra |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<ContentRatings>
<ContentRating territories="US,PR,VI">
<System>MPAA</System>
<Certification>PG-13</Certification>
</ContentRating>
<ContentRating>
<System>Eirin</System>
<Certification>R15+</Certification>
</ContentRating>
</ContentRatings>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 |
ContentRatingsTvRating |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
<ContentRatings>
<ContentRating territories="US,PR,VI">
<System>MPAA</System>
<Certification>PG-13</Certification>
</ContentRating>
<ContentRating>
<System>Eirin</System>
<Certification>R15+</Certification>
</ContentRating>
</ContentRatings>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 Elements | None |
| Data Type | string |
<ContentRatings>
<ContentRating>
<System>MPAA</System>
<Certification>G</Certification>
</ContentRating>
</ContentRatings>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 Elements | None |
| Data Type | string |
<ContentRatings>
<ContentRating territories="US,PR,VI">
<System>MPAA</System>
<Certification>PG-13</Certification>
</ContentRating>
<ContentRating>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 |
TvSeasonTvEpisode |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | token |
<TvShow>
<ID>TV-2329880</ID>
...
</TvShow>
<TvSeason>
...
<ShowID>TV-2329880</ShowID>
...
</TvSeason>
<TvEpisode>
...
<ShowID>TV-2329880</ShowID>
...
</TvEpisode>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 |
TvSeasonTvEpisode |
| Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
| Child Elements | None |
| Attributes |
Data Type: language
Data Type: string |
| Data Type | Localized string |
<TvSeason>
...
<ShowTitle locale="en-US">Depth of Field</ShowTitle>
...
</TvSeason>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 Elements | None |
| Data Type | int |
<TvEpisode>
...
<SeasonInShow>2</SeasonInShow>
...
</TvEpisode>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 |
TvSeasonTvEpisode |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | token |
<TvShow>
<ID>TV-2329880</ID>
...
</TvShow>
<TvSeason>
...
<ShowID>TV-2329880</ShowID>
...
</TvSeason>
<TvEpisode>
...
<ShowID>TV-2329880</ShowID>
...
</TvEpisode>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 |
TvSeasonTvEpisode |
| Content Model | complexType – attributes only. No child elements, but element does allow attributes. |
| Child Elements | None |
| Attributes |
Data Type: language
Data Type: string |
| Data Type | Localized string |
<TvSeason>
...
<ShowTitle locale="en-US">Depth of Field</ShowTitle>
...
</TvSeason>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 Elements | None |
| Data Type | token |
<TvSeason>
<ID>SEA-2329880</ID>
...
</TvSeason>
<TvEpisode>
...
<SeasonID>SEA-2329880</SeasonID>
...
</TvEpisode>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 Elements | None |
| Data Type | int |
<TvEpisode>
...
<SeasonInShow>2</SeasonInShow>
...
</TvEpisode>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 Elements | None |
| Attributes |
Data Type: language
Data Type: string |
| Data Type | Localized string |
<TvEpisode>
...
<SeasonInShow>2</SeasonInShow>
<SeasonTitle locale="en-US">Season 2</SeasonTitle>
...
</TvEpisode>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 Elements | None |
| Data Type | int |
<TvEpisode>
...
<EpisodeInSeason>6</EpisodeInSeason>
...
</TvEpisode>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 | |
| Attributes | None |
<Movie>
...
<OriginalAirDates>
...
</OriginalAirDate>
</Movie>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 Elements | None |
| Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
| Data Type | TerritoryDateTimeType - Same as dateTime with the addition of the territories attribute. |
<Movie>
...
<OriginalAirDates>
<OriginalAirDate territories="US,CA">2014-01-01T11:30:00+08:00</OriginalAirDate>
</OriginalAirDates>
</Movie>ReleaseDates
Contains Release Dates of the content in various territories.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
MovieTvShow |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<TvShow>
...
<ReleaseDates>
...
</ReleaseDates>
</TvShow>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 Elements | None |
| Attributes |
Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE. |
| Data Type | TerritoryDateTimeType - Same as dateTime with the addition of the territories attribute. |
<TvShow>
...
<ReleaseDates>
<ReleaseDate territories="US,CA">2012-05-13T00:00:00</ReleaseDate>
</ReleaseDates>
</TvShow>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 Elements | None |
| Data Type | Enum: clip |
<Extra>
...
<Type>clip</Type>
...
</Extra>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 Elements | None |
| Data Type | token |
<TvShow>
<ID>TV123456</ID>
...
</TvShow>
<Extra>
...
<Type>trailer</Type>
<RelatesToID>TV123456</RelatesToID>
</Extra>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 Elements | None |
| Attributes |
Data Type: Enum. Enum Values:
Data Type: string |
| Data Type | token |
<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>BroadcastLanguage
The language that this station broadcasts the majority of its content in.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Station |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | language |
<BroadcastLanguage>en</BroadcastLanguage>StationType
Broadcast station descriptors.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Station |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Enum. Values: Full Power Broadcast, Low Power Broadcast, Cable Only, Digital Broadcast Network, Network, Radio Station, Satellite, Split |
<StationType>Network</StationType>StationAttributes
Lists the attributes associated with this station.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Station |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<StationAttributes>
<StationAttribute>HDTV</StationAttribute>
</StationAttributes>StationAttribute
Station quality attributes. Required for broadcast stations where data is available.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
StationAttributes |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Enum. Values: Analog, Digital, SDTV, HDTV. |
<StationAttribute>HDTV</StationAttribute>StationAffiliateInfo
Contains references to affiliates of this station, both child and parent.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Station |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
ParentAffiliate
References to the parent affiliate of this station, if it has one.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
StationAffiliateInfo |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
ChildAffiliates
References to the child affiliates of this station, if it has any.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
StationAffiliateInfo |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
Affiliate
Represents an affiliate of this station.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
ParentAffiliateChildAffiliates |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Affiliate>
<Type>Network</Type>
<AffiliateID>abc123</AffiliateID>
</Affiliate>Type - Affiliate
The relationship between the affiliated station and this station. For example, a "network" type indicates that this station is a broadcast affiliate, or local version, of the parent network.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Affiliate |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | string |
<Type>Network</Type>AffiliateID
The ID of the associated station from your catalog.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Affiliate |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | NonEmptyToken |
<AffiliateID>abc123</AffiliateID>TimeZone
The time zone that this station broadcasts in.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Station |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | NonEmptyToken |
<TimeZone>America/Los Angeles</TimeZone>CallSigns
Call signs used by this station.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Station |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
CallSign
Unique identifier for the broadcasting station.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
CallSigns |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | NonEmptyToken |
ExternalIds
The list of IDs that can be used to reference this station or lineup in an external source.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
StationLineup |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes |
Name - Lineup
The name of the lineup.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Lineup |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | string |
<Name>ExampleTV Lineup US</Name>LocationInfo
Encodes positive and negative rights by geography. An area can be included or excluded.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
Lineup |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<LocationInfo>
<Region>
<DMA>123</DMA>
</Region>
<FilterType>INCLUDE</FilterType>
</LocationInfo>Region
The fine regions the region filter applies to.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
LocationInfoBlackoutRegion |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Region>
<DMA>123</DMA>
<PostalCodes>
<PostalCode>
<AssociatedCountry>US</AssociatedCountry>
</PostalCode>
</PostalCodes>
</Region>DMA
Designated Market Area.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
Region |
| Content Model | simpleType (no children) |
| Child Elements | None |
<DMA>123</DMA>PostalCodes
List of postal codes.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Region |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<PostalCodes>
<PostalCode>
<AssociatedCountry>US</AssociatedCountry>
</PostalCode>
</PostalCodes>PostalCode
Postal code values and associated country.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
PostalCodes |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<PostalCode>
<AssociatedCountry>US</AssociatedCountry>
</PostalCode>AssociatedCountry
The country that the postal codes apply to. If no ZIP code value is provided, default to the whole country.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
PostalCode |
| Content Model | simpleType (no children) |
| Child Elements | None |
| 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 |
<AssociatedCountry>US</AssociatedCountry>Values
List of postal code values. If no postal code value is provided, default to the whole country.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
PostalCode |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
Value
A postal code value.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
Values |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | NonEmptyToken |
FilterType
Indicates whether the specified regions should be included or excluded from access to the content.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
LocationInfoBlackoutRegion |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Enum. Values: INCLUDE, EXCLUDE. |
<FilterType>INCLUDE</FilterType>BroadcastType
Descriptors of broadcast types for lineups. Required for lineups where data is available.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Lineup |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Enum. Values: OTA, CABLE, SATELLITE, IP, IPTV, DIGITAL_BROADCAST, OTT, VIRTUAL, MVPD, TIMEZONE, VMVPD. |
<BroadcastType>IP</BroadcastType>MSO
Name of the Multiple System Operator that broadcasts this lineup.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Lineup |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | string |
<MSO>Example</MSO>Broadcasts
List of broadcasts associated with this lineup. There must be one broadcast within a lineup.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Lineup |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
Broadcast
Provides information about which of your stations are in lineups. With this information Amazon can determine which regions your stations should be available in. There should be at least one broadcast for each station. A channel number must contain only numbers and a period (for minor numbers).
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
Broadcasts |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Broadcast>
<ID>broadcast-example1</ID>
<StationReference>station-example1</StationReference>
<Channel>3</Channel>
<Transports>
<Transport subsystem="DVB_T">
<ONID>12339</ONID>
<TSID>8197</TSID>
<SID>8261</SID>
<Country>US</Country>
</Transport>
</Transports>
</Broadcast>StationReference
The station that this broadcast is associated with.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Broadcast |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | NonEmptyToken |
<StationReference>station-example1</StationReference>Channel
The channel number for this station, always delimited with a period. For example, "20.3".
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Broadcast |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | string |
<Channel>3</Channel>Transports
The Transmission Signal Identifiers that are broadcast with this channel and can be used to identify it.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Broadcast |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Transports>
<Transport subsystem="DVB_T">
<ONID>12339</ONID>
<TSID>8197</TSID>
<SID>8261</SID>
<Country>US</Country>
</Transport>
</Transports>Transport
For broadcasts that correspond to terrestrial, satellite, or cable stations using the DVB, ATSC, ISDB or DTMB standards. Required for broadcast stations where data is available.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
Transports |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes |
Data Type: Enum. Values: |
<Transport subsystem="DVB_T">
<ONID>12339</ONID>
<TSID>8197</TSID>
<SID>8261</SID>
<Country>US</Country>
</Transport>ONID
The Original Network ID.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Transport |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Non-negative integer |
<ONID>12339</ONID>TSID
The Transport Stream ID.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Transport |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Non-negative integer |
<TSID>8197</TSID>SID
The Service ID.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Transport |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Non-negative integer |
<SID>8261</SID>Country
Territories instead.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 |
RegionsTransport |
| Content Model | simpleType (no children) |
| Child Elements | None |
| 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 |
<SubscriptionOffer>
<Regions>
<Country>US</Country>
<Country>CA</Country>
</Regions>
...
</SubscriptionOffer>Date
The date when all schedule items start.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
ScheduleDay |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | date |
<Date>2023-04-25</Date>AssociatedStationId
The station ID in your catalog that this schedule corresponds to.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
ScheduleDay |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | NonEmptyToken |
<AssociatedStationId>station-example1</AssociatedStationId>Schedules
The list of schedule items for the specified date.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
ScheduleDay |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
Schedule
A schedule item from the specific source that starts on the specific date.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
Schedules |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<Schedule>
<ContentReference>abc123</ContentReference>
<StartTime>2023-01-01T12:00:00</StartTime>
<Duration>PT30M</Duration>
<BlackoutInformation>
<BlackoutApplicable>true</BlackoutApplicable>
<BlackoutRegion>
<Region>
<DMA>123</DMA>
</Region>
<FilterType>INCLUDE</FilterType>
</BlackoutRegion>
</BlackoutInformation>
<PreferredLocale>en-US</PreferredLocale>
<SubtitleLanguage>en</SubtitleLanguage>
<DubbedLanguage>es</DubbedLanguage>
<SAPLanguage>fr</SAPLanguage>
<TvRating>
<ContentRating>
<System>MPAA</System>
<Certification>PG-13</Certification>
</ContentRating>
</TvRating>
<ScheduleAttributes>
<ScheduleAttribute>New</ScheduleAttribute>
</ScheduleAttributes>
</Schedule>ContentReference
Identifies the program metadata in this catalog for the video aired in this schedule.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | NonEmptyToken |
<ContentReference>abc123</ContentReference>StartTime
Start time for the scheduled program.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | dateTime |
<StartTime>2023-04-25T01:05:00Z</StartTime>Duration - Schedule
Duration of the scheduled program in ISO-8601 format. For example, PT30M is 30 minutes.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | duration |
<Duration>PT30M</Duration>BlackoutInformation
Blackout information for this schedule slot.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<BlackoutInformation>
<BlackoutApplicable>true</BlackoutApplicable>
<BlackoutRegion>
<Region>
<DMA>123</DMA>
</Region>
<FilterType>INCLUDE</FilterType>
</BlackoutRegion>
<DeviceRestriction>mobile</DeviceRestriction>
</BlackoutInformation>BlackoutApplicable
Indicates if a blackout is in effect. If no filter is specified, the content is blacked out for all users and devices.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | One |
| Parent Elements |
BlackoutInformation |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | boolean |
<BlackoutApplicable>true</BlackoutApplicable>BlackoutRegion
Information about the region and filter type related to the blackout.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
BlackoutInformation |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<BlackoutRegion>
<Region>
<DMA>123</DMA>
</Region>
<FilterType>INCLUDE</FilterType>
</BlackoutRegion>DeviceRestriction
List of device types the blackout applies to. If not supplied, all devices are affected.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | Unlimited |
| Parent Elements |
BlackoutInformation |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | Enum. Values: mobile, tablet, television, fireTv, alexa, browser. |
<DeviceRestriction>mobile</DeviceRestriction>PreferredLocale
Preferred locale for this schedule, if any.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | language |
<PreferredLocale>en-US</PreferredLocale>SubtitleLanguage
The language of the subtitles, if applicable.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | language |
<SubtitleLanguage>en-US</SubtitleLanguage>DubbedLanguage
The language the program is dubbed in, if applicable.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | language |
<DubbedLanguage>es</DubbedLanguage>SAPLanguage
The language of the second audio program, if applicable.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | language |
<SAPLanguage>fr</SAPLanguage>TvRating
The rating and rating body for the scheduled event.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<TvRating>
<ContentRating>
<System>MPAA</System>
<Certification>PG-13</Certification>
</ContentRating>
</TvRating>ScheduleAttributes
List of the attributes associated with this schedule.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
Schedule |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | |
| Attributes | None |
<ScheduleAttributes>
<ScheduleAttribute>New</ScheduleAttribute>
</ScheduleAttributes>ScheduleAttribute
Describes an attribute associated with this schedule, like New or Live.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
ScheduleAttributes |
| Content Model | complexType – sequence. Must contain required child elements in specified order. |
| Child Elements | None |
| Attributes | None |
| Data Type | NonEmptyToken |
<ScheduleAttribute>New</ScheduleAttribute>StationRef
A station and its reference to external data providers, optional station names, logo images, and offers.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
StationMappingData |
| Content Model | simpleType (no children) |
| Child Elements | |
StationNames
Contains StationName elements, which apply to different territories and locales.
| Property | Detail |
|---|---|
| Use | Optional |
| How Many Allowed | One |
| Parent Elements |
StationRef |
| Content Model | simpleType (no children) |
| Child Elements | |
StationName
A representation of a station name for the station ref item, which applies to a set of territories, or globally if territories aren't provided.
| Property | Detail |
|---|---|
| Use | Required |
| How Many Allowed | Unlimited |
| Parent Elements |
StationNames |
| Content Model | simpleType (no children) |
| Child Elements | None |
| Data Type | TerritoryStringType - Same as string with the addition of the locale, pronunciation, and territories attributes. |
Last updated: May 27, 2026
