Program Catalog

The program catalog contains all of the program entities in a catalog. The id attribute of the program catalog is referenced by the schedule to namespace the program identifiers. The ProgramCatalog element can contain as many entries as needed, and as many of each type as needed.

Property	Detail
Parent Elements	`DataCollections`
Data Type	ProgramCatalogType
Child Elements	Description
`Delete`	A management verb for removing programs from the catalog.
`Movie`	Represents a movie program, whose content is not serialized, and which is prerecorded when originally released.
`TVEpisode`	Represents a TV episode program, which must be related to a TV season and TV series.
`TVSeason`	Represents a TV season program. TV seasons are hierarchical entities.
`TVSeries`	Represents a TV series program. TV series are hierarchical entities.
`SportsEvent`	Represents a sports program, which models a sport event with one or more participants or teams.
`Event`	Represents an event program, which is used for standalone programs taking place at a physical location that can be broadcast live. Use for non-sporting events only.
`OffAir`	Represents an off-air program, which communicates to customers that no programs are airing at this time.
`Other`	Represents an other program, which provides basic information for program types that don't fit into well-defined categories.
`ToBeAnnounced`	Represents a to-be-announced program, which is a placeholder for upcoming programming.
`Extra`	Represents extra content related to a program.
Attributes	Description
`id`	The identifier for the program catalog. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`action`	Indicates which action to take for a catalog submission. Default value is `upsert`. Valid values: `upsert`, `replace`. Data Type: CatalogActionType

↑ Back to top

A management verb that enables programmatic removal of an item from the catalog. When the ingestion system processes a Delete element, it removes the item with the specified ID from the system.

Property	Detail
Parent Elements	`DataCollections` `ProgramCatalog` `ScheduleCatalog` `OfferCatalog` `StationCatalog` `LineupCatalog` `PolicyCatalog`
Data Type	DeleteType
Attributes	Description
`id` Required	The unique identifier of the entity to delete. Data Type: ID
`version`	Version of the entity to delete. Must be greater than or equal to the current entity version. Default value is `1`. Data Type: long

↑ Back to top

Any length program whose content is not serialized, and which is prerecorded when originally released.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	MovieType
Child Elements	Description
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Genres`	List of genres.
`Keywords`	List of the `Keyword` elements represented by a localized string. The catalog system uses keywords as search terms for the program.
`Ratings`	List of the `Rating` elements.
`Studios`	List of the `Studio` elements.
`Credits`	List of the `Credits` elements.
`Tags`	List of the `Tag` elements.
`RunLengths`	List of localized durations applied to a program.
`PictureColor`	Enumerated value describing the characteristics of the picture color.
`ReleaseDates`	List of the `ReleaseDate` elements.
`Relationships`	Indicates relationships between content.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`edit`	A comma-separated list of edit types for a program. Allows you to specify multiple edit types, such as `"DIRECTORSCUT,UNRATED"`. Valid edit types are `ORIGINAL`, `DIRECTORSCUT`, `EXTENDED`, `UNRATED`, `CENSORED`, `REGIONALIZED`, `COLORIZED`, `SHORTENED`. Data Type: EditTypeList

↑ Back to top

Represents a TV episode program, which must be related to a TV season and TV series. A TV episode is part of a larger organization (TV season and series). You must add a TV series to a program catalog before its TV seasons. You must add TV seasons before adding TV episodes.

You can model special episodes like Christmas specials as TV episodes and reference the TV series. Special episodes must also have a release year.

TV episode requirements

Failure to follow these requirements can lead to error reports.

Send dependent parent programs ahead of child programs that reference them.
Add a TV series before adding the respective TV seasons.
Add TV seasons before adding TV episodes.
Delete the child elements of a parent program before deleting the parent program.
Before deleting a season, remove all its episodes.
Before deleting a series, delete all its seasons.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	TVEpisodeType
Child Elements	Description
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Genres`	List of genres.
`Keywords`	List of the `Keyword` elements represented by a localized string. The catalog system uses keywords as search terms for the program.
`Ratings`	List of the `Rating` elements.
`Studios`	List of the `Studio` elements.
`Credits`	List of the `Credits` elements.
`Tags`	List of the `Tag` elements.
`RunLengths`	List of localized durations applied to a program.
`PictureColor`	Enumerated value describing the characteristics of the picture color.
`ReleaseDates`	List of the `ReleaseDate` elements.
`Relationships` Required	Indicates relationships between content.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`edit`	A comma-separated list of edit types for a program. Allows you to specify multiple edit types, such as `"DIRECTORSCUT,UNRATED"`. Valid edit types are `ORIGINAL`, `DIRECTORSCUT`, `EXTENDED`, `UNRATED`, `CENSORED`, `REGIONALIZED`, `COLORIZED`, `SHORTENED`. Data Type: EditTypeList

<TVEpisode id="JAM_S01E01" version="1">
    <ExternalIds>
        <ExternalId scheme="imdb">tt4318858</ExternalId>
        <ExternalId scheme="asin">B01578XLQU</ExternalId>
    </ExternalIds>
    
    <Titles>
        <Title language="en" territories="US,GB,CA,AU" default="true">Just Add Magic</Title>
        <Title language="es" territories="ES,MX">Solo Añade Magia</Title>
        <Title language="fr" territories="FR,CA">Il Suffit d'Ajouter de la Magie</Title>
        <Title language="de" territories="DE,AT,CH">Einfach Magie Hinzufügen</Title>
    </Titles>

    <Descriptions>
        <Description language="en" territories="US,GB,CA,AU">
            Kelly Quinn and her two best friends discover a mysterious cookbook in her attic and find out that its recipes are magical. When they try to use the book to help Kelly's grandmother, they find out that each recipe comes with a price.
        </Description>
    </Descriptions>

    <Synopses>
        <Synopsis language="en" territories="US,GB,CA,AU">
            When Kelly Quinn stumbles upon her grandmother's mysterious cookbook in the attic, she and her friends Darbie and Hannah discover that the book is filled with magical recipes. As they attempt to help Kelly's grandmother, who hasn't spoken in years, they learn that every magical recipe comes with unexpected consequences and they must be careful with their newfound powers.
        </Synopsis>
    </Synopses>

    <Images>
        <Image category="episodic" language="en" territories="GLOBAL" 
              aspectRatio="16:9" mimeType="image/jpeg" resolution="HD">
            https://example.com/images/just_add_magic/s01e01.jpg
        </Image>
    </Images>

    <Genres>
        <Genre scheme="ember_genre">ember_genre_family</Genre>
        <Genre scheme="ember_genre">ember_genre_fantasy</Genre>
        <Genre scheme="ember_genre">ember_subgenre_family_kids</Genre>
    </Genres>

    <Keywords>
        <Keyword language="en" territories="GLOBAL">Magic</Keyword>
        <Keyword language="en" territories="GLOBAL">Cooking</Keyword>
        <Keyword language="en" territories="GLOBAL">Friendship</Keyword>
        <Keyword language="en" territories="GLOBAL">Family</Keyword>
        <Keyword language="en" territories="GLOBAL">Adventure</Keyword>
    </Keywords>

    <Ratings>
        <Rating system="TV" certification="TV-Y7">
            <Descriptors>
                <Descriptor code="FV">Fantasy Violence</Descriptor>
            </Descriptors>
        </Rating>
    </Ratings>

    <Studios>
        <Studio>
            <StudioNames>
                <StudioName>Amazon Studios</StudioName>
            </StudioNames>
        </Studio>
    </Studios>

    <Credits>
        <Credit>
            <PersonNames>
                <PersonName>Olivia Sanabia</PersonName>
            </PersonNames>
            <ContributionNames>
                <ContributionName>Actor</ContributionName>
            </ContributionNames>
            <CharacterNames>
                <CharacterName language="en" territories="GLOBAL">Kelly Quinn</CharacterName>
            </CharacterNames>
            <ExternalIds>
                <ExternalId scheme="imdb">nm3821346</ExternalId>
            </ExternalIds>
        </Credit>
        <!-- Additional credits -->
    </Credits>

    <RunLengths>
        <RunLength territories="GLOBAL">PT27M</RunLength>
    </RunLengths>

    <PictureColor>color</PictureColor>

    <ReleaseDates>
        <ReleaseDate territories="GLOBAL" releaseType="streaming">2015-01-15</ReleaseDate>
    </ReleaseDates>

    <Relationships>
        <isEpisodeOfSeries programRef="JAM_SERIES" episodeNum="1"/>
    </Relationships>
</TVEpisode>

↑ Back to top

Represents a TV season program. TV seasons are hierarchies entities with TV series as the parent entity and playable TV episodes as child entities.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	TVSeasonType
Child Elements	Description
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Genres`	List of genres.
`Keywords`	List of the `Keyword` elements represented by a localized string. The catalog system uses keywords as search terms for the program.
`Ratings`	List of the `Rating` elements.
`Studios`	List of the `Studio` elements.
`Credits`	List of the `Credits` elements.
`Tags`	List of the `Tag` elements.
`ReleaseDates`	List of the `ReleaseDate` elements.
`Relationships` Required	Indicates relationships between content.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`edit`	A comma-separated list of edit types for a program. Allows you to specify multiple edit types, such as `"DIRECTORSCUT,UNRATED"`. Valid edit types are `ORIGINAL`, `DIRECTORSCUT`, `EXTENDED`, `UNRATED`, `CENSORED`, `REGIONALIZED`, `COLORIZED`, `SHORTENED`. Data Type: EditTypeList

↑ Back to top

Represents a TV series program. TV series are hierarchical entities.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	TVSeriesType
Child Elements	Description
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Genres`	List of genres.
`Keywords`	List of the `Keyword` elements represented by a localized string. The catalog system uses keywords as search terms for the program.
`Ratings`	List of the `Rating` elements.
`Studios`	List of the `Studio` elements.
`Credits`	List of the `Credits` elements.
`Tags`	List of the `Tag` elements.
`ReleaseDates`	List of the `ReleaseDate` elements.
`Relationships`	Indicates relationships between content.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`edit`	A comma-separated list of edit types for a program. Allows you to specify multiple edit types, such as `"DIRECTORSCUT,UNRATED"`. Valid edit types are `ORIGINAL`, `DIRECTORSCUT`, `EXTENDED`, `UNRATED`, `CENSORED`, `REGIONALIZED`, `COLORIZED`, `SHORTENED`. Data Type: EditTypeList

↑ Back to top

Represents a sports program, which models a sport event with one or more participants or teams.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	SportsEventType
Child Elements	Description
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Genres`	List of genres.
`Keywords`	List of the `Keyword` elements represented by a localized string. The catalog system uses keywords as search terms for the program.
`Ratings`	List of the `Rating` elements.
`Studios`	List of the `Studio` elements.
`Credits`	List of the `Credits` elements.
`Tags`	List of the `Tag` elements.
`RunLengths`	List of localized durations applied to a program.
`PictureColor`	Enumerated value describing the characteristics of the picture color.
`ReleaseDates`	List of the `ReleaseDate` elements.
`Venues`	List of the `Venue` elements.
`Sports`	List of the `Sport` elements.
`Leagues`	List of the `League` elements.
`Season`	The official name or number of the season for the match being played.
`Tournament`	The tournament associated with the sports program or event.
`Round`	The round of play associated with a tournament game or match for a sports program.
`Teams`	List of the `Team` elements.
`Players`	List of participating players for a match or game.
`Gender`	Gender details for the match or game.
`Format`	Format details for the match or game.
`EventDateTime`	The time when actual programming begins, not necessarily the broadcast start time. For example, in American football, this time is known as kick off, and for basketball, tip off.
`Relationships`	Indicates relationships between content.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long

<SportsEvent id="NFLS52W05G4" version="1648486014">
    <ExternalIds>
        <ExternalId scheme="SportsRadar">SR123456789012</ExternalId>
    </ExternalIds>
    <Titles>
        <Title language="en"
              territories="US"
              default="true">Baltimore at Cleveland</Title>
    </Titles>
    <Descriptions>
        <Description language="en"
                    territories="US"
                    default="true">The Cleveland Browns host the Baltimore Ravens at M&T Bank Stadium in Cleveland</Description>
    </Descriptions>
    <Synopses>
        <Synopsis language="en"
                  territories="US"
                  default="true">Browns coach Kevin Stefanski faces Ravens coach John Harbaugh in what should be an offensive battle in this long standing rivalry between blue collar squads. The Browns have homefield advantage, but the 0-3 Ravens are hungry for a win.</Synopsis>
    </Synopses>
    <Images>
        <Image category="cover"
              language="en"
              territories="US"
              aspectRatio="16:9"
              mimeType="image/jpeg">
                https://i.ytimg.com/vi/4DEMG6ulA4o/maxresdefault.jpg 
            </Image>
        <Image category="background"
              aspectRatio="16:9"
              mimeType="image/jpeg">
                https://i.ytimg.com/vi/4DEMG6ulA4o/maxresdefault.jpg
            </Image>
    </Images>
    <Genres>
        <Genre>ember_genre_sports_programming</Genre>
    </Genres>
    <Keywords>
        <Keyword language="en"
                territories="US">football</Keyword>
        <Keyword language="es"
                territories="US">fútbol americano</Keyword>
        <Keyword language="en"
                territories="GB">american football</Keyword>
    </Keywords>
    <RunLengths>
        <RunLength>PT3H</RunLength>
    </RunLengths>
    <PictureColor>color</PictureColor>
    <Ratings>
        <Rating system="TV Parental Guidelines"
                certification="TVG"/>
    </Ratings>
    <ReleaseDates>
        <ReleaseDate>2020-05-14</ReleaseDate>
    </ReleaseDates>
    <EventDateTime>2020-05-14T13:20:00Z</EventDateTime>
    <Sports>
        <Sport>
            <SportNames>
                <SportName>American Football</SportName>
            </SportNames>
        </Sport>
    </Sports>
    <Leagues>
        <League>
            <LeagueNames>
                <LeagueName>National Football League</LeagueName>
            </LeagueNames>
            <ExternalIds>
                <ExternalId scheme="sportsRadar">lg3344</ExternalId>
            </ExternalIds>
        </League>
    </Leagues>
    <Teams>
        <Team homeTeam="true">
            <TeamNames>
                <TeamName>Cleveland Browns</TeamName>
            </TeamNames>
            <ExternalIds>
                <ExternalId scheme="sportsRadar">sr2345</ExternalId>
            </ExternalIds>
        </Team>
        <Team>
            <TeamNames>
                <TeamName>Baltimore Ravens</TeamName>
            </TeamNames>
            <ExternalIds>
                <ExternalId scheme="sportsRadar">sr3425</ExternalId>
            </ExternalIds>
        </Team>
    </Teams>
    <Venues>
        <Venue>
            <VenueNames>
                <VenueName>M&T Bank Stadium</VenueName>
                <VenueName language="es">Estadio M&T Bank</VenueName>
            </VenueNames>
            <Address>
                <City>Cleveland</City>
                <StateOrProvince>Ohio</StateOrProvince>
                <Country>USA</Country>
            </Address>
        </Venue>
    </Venues>
    <Studios>
        <Studio>
            <StudioNames>
                <StudioName>CBS Sports</StudioName>
            </StudioNames>
        </Studio>
    </Studios>
</SportsEvent>

↑ Back to top

Use events for standalone programs taking place at a physical location that can be broadcast live. For example, the Live Aid concert, Tournament of Roses parade, and telethons. Don't use the Event element for sports. Events can also be non-sports tournaments or competitions, such as the Miss America pageant. When the event takes place over several rounds but is independent from a TV series, use the tournament and round fields. For example, Concours de Genève is an annual multi-day music festival and competition that exists independently of televised coverage. The Westminster Kennel Club Dog Show is another example of a non-sports event outside of music and performing arts.

Don't use the Event element for a reality TV series that takes place over a season. For example, American Idol is a TV series with a content structure that mimics a tournament, but would not be an event. Similarly, other competition-style reality TV series, such as Survivor, Big Brother, The Voice, and Dancing with the Stars, are not events. Special episodes, such as holiday specials are not events.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	EventType
Child Elements	Description
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Genres`	List of genres.
`Keywords`	List of the `Keyword` elements represented by a localized string. The catalog system uses keywords as search terms for the program.
`Ratings`	List of the `Rating` elements.
`Studios`	List of the `Studio` elements.
`Credits`	List of the `Credits` elements.
`Tags`	List of the `Tag` elements.
`RunLengths`	List of localized durations applied to a program.
`PictureColor`	Enumerated value describing the characteristics of the picture color.
`ReleaseDates`	List of the `ReleaseDate` elements.
`Venues`	List of the `Venue` elements.
`Tournament`	The tournament associated with the sports program or event.
`Round`	The round of play associated with a tournament game or match for a sports program.
`EventDateTime`	The time when actual programming begins, not necessarily the broadcast start time. For example, in American football, this time is known as kick off, and for basketball, tip off.
`Relationships`	Indicates relationships between content.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long

<Event id="MUSIC_FEST_2024" version="1">
    <!-- Basic Event Information -->
    <Titles>
        <Title language="en" territories="US,CA" default="true">
            Summer Music Festival 2024 - Live from Central Park
        </Title>
        <Title language="es" territories="MX">
            Festival de Música Verano 2024 - En vivo desde Central Park
        </Title>
    </Titles>

    <!-- Event Description -->
    <Descriptions>
        <Description language="en" territories="US,CA" default="true">
            Annual summer music festival featuring top artists performing live from Central Park. 
            Headliners include Rock Band, Pop Star, and DJ Famous.
        </Description>
    </Descriptions>

    <!-- Detailed Synopsis -->
    <Synopses>
        <Synopsis language="en" territories="US,CA" default="true">
            Join us for the biggest music event of the summer! This 6-hour live broadcast features 
            performances from Rock Band, Pop Star, DJ Famous, and more. Special guest appearances, 
            behind-the-scenes footage, and exclusive interviews with the artists. Hosted by 
            Famous Host with live commentary and crowd interaction.
        </Synopsis>
    </Synopses>

    <!-- Event Images -->
    <Images>
        <Image category="background" territories="US,CA" 
               aspectRatio="16:9" mimeType="image/jpeg">
            https://images.example.com/musicfest/background.jpg
        </Image>
        <Image category="cover" language="en" territories="US,CA" 
               aspectRatio="16:9" mimeType="image/jpeg">
            https://images.example.com/musicfest/cover.jpg
        </Image>
    </Images>

    <!-- Event Keywords -->
    <Keywords>
        <Keyword language="en" territories="US,CA">summer festival</Keyword>
        <Keyword language="en" territories="US,CA">live music</Keyword>
        <Keyword language="en" territories="US,CA">concert</Keyword>
    </Keywords>

    <!-- Content Ratings -->
    <Ratings>
        <Rating system="USA_TV" certification="TV-PG" territories="US">
            <Descriptors>
                <Descriptor code="L">Mild Language</Descriptor>
            </Descriptors>
        </Rating>
    </Ratings>

    <!-- Production Studios -->
    <Studios>
        <Studio>
            <StudioNames>
                <StudioName>MusicFest Productions</StudioName>
            </StudioNames>
        </Studio>
    </Studios>

    <!-- Credits (Hosts, Performers, etc.) -->
    <Credits>
        <Credit>
            <PersonNames>
                <PersonName>Famous Host</PersonName>
            </PersonNames>
            <ContributionNames>
                <ContributionName>Host</ContributionName>
           </ContributionNames>
            <ExternalIds>
                <ExternalId scheme="imdb">nm123456</ExternalId>
            </ExternalIds>
        </Credit>

        <Credit>
           <PersonNames>
                <PersonName>Rock Band</PersonName>
            </PersonNames>
            <ContributionNames>
                <ContributionName>Performer</ContributionName>
            </ContributionNames>
        </Credit>

        <Credit>
            <PersonNames>
                <PersonName>Pop Star</PersonName>
            </PersonNames>
            <ContributionNames>
                <ContributionName>Performer</ContributionName>
            </ContributionNames>
        </Credit>
    </Credits>

    <!-- Event Duration -->
    <RunLengths>
        <RunLength territories="US,CA">PT6H</RunLength>
    </RunLengths>

    <!-- Release Information -->
    <ReleaseDates>
        <ReleaseDate territories="US,CA">2024-07-15</ReleaseDate>
    </ReleaseDates>

    <!-- Venue Information -->
    <Venues>
        <Venue>
            <VenueNames>
                <VenueName language="en">Central Park Great Lawn</VenueName>
            </VenueNames>
            <Address>
                <Street>Central Park West</Street>
                <City>New York</City>
                <StateOrProvince>NY</StateOrProvince>
                <Country>USA</Country>
                <PostalCode>10024</PostalCode>
            </Address>
        </Venue>
    </Venues>

    <!-- Event Date/Time -->
    <EventDateTime>2024-07-15T18:00:00Z</EventDateTime>
</Event>

↑ Back to top

Represents an off-air program, which communicates to customers that no programs are airing at this time. You can use OffAir to provide details of upcoming programs or otherwise customize the off-air experience.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	OffAirType
Child Elements	Description
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Tags`	List of the `Tag` elements.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long

↑ Back to top

Represents an other program, which provides basic information for program types that don't fit into well-defined categories. Other must not be used to avoid creating TVSeries or TVSeason entities.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	OtherType
Child Elements	Description
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Genres`	List of genres.
`Keywords`	List of the `Keyword` elements represented by a localized string. The catalog system uses keywords as search terms for the program.
`Ratings`	List of the `Rating` elements.
`Studios`	List of the `Studio` elements.
`Credits`	List of the `Credits` elements.
`Tags`	List of the `Tag` elements.
`RunLengths`	List of localized durations applied to a program.
`PictureColor`	Enumerated value describing the characteristics of the picture color.
`ReleaseDates`	List of the `ReleaseDate` elements.
`Sports`	List of the `Sport` elements.
`Leagues`	List of the `League` elements.
`Teams`	List of the `Team` elements.
`Relationships`	Indicates relationships between content.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long

↑ Back to top

Represents a to-be-announced program, which is a placeholder for upcoming programming. To-be-announced programming is appropriate for use in Live TV cases only, and must be resolved to the actual programming in the schedules at the time of airing.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	ToBeAnnouncedType
Child Elements	Description
`Titles`	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Tags`	List of the `Tag` elements.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long

↑ Back to top

Represents extra content related to a program. Includes the following content types: teaser, trailer, clip, featurette, behind the scenes, deleted scenes, bloopers, commentary, interview, highlights, pre-event, and post-event.

Property	Detail
Parent Elements	`ProgramCatalog`
Data Type	ExtraType
Child Elements	Description
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Synopses`	List of the `Synopsis` elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.
`Images`	List of the `Image` elements.
`Genres`	List of genres.
`Keywords`	List of the `Keyword` elements represented by a localized string. The catalog system uses keywords as search terms for the program.
`Ratings`	List of the `Rating` elements.
`Studios`	List of the `Studio` elements.
`Credits`	List of the `Credits` elements.
`Tags`	List of the `Tag` elements.
`RunLengths`	List of localized durations applied to a program.
`PictureColor`	Enumerated value describing the characteristics of the picture color.
`ReleaseDates`	List of the `ReleaseDate` elements.
`Sports`	List of the `Sport` elements.
`Leagues`	List of the `League` elements.
`Teams`	List of the `Team` elements.
`Relationships`	Indicates relationships between content.
Attributes	Description
`id` Required	Contains durable identifier that is reserved only for the program referenced. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`category` Required	Category of the extra content. Valid values: `teaser`, `trailer`, `clip`, `featurette`, `behindthescenes`, `deletedscenes`, `bloopers`, `commentary`, `interview`, `highlights`, `preevent`, `postevent`. Data Type: ExtraCategoryType

↑ Back to top

Contains external system identifiers. Allows cross-referencing with third-party systems.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `Studio` `Credit` `Sport` `League` `Season` `Tournament` `Round` `Team` `Player` `Station` `Lineup`
Data Type	ExternalIdList
Child Elements	Description
`ExternalId` Required	Links the program or other entity to an external source.

↑ Back to top

Links the program or other entity to an external source. The scheme attribute identifies the external source, and the value is a valid ID within that namespace. A partial list of program ID schemes includes: imdb, tms, isan, ean, upc, asin, gvd, sportsradar, and stats. Other schemes are used for people and sports entities, such as teams and players. You can also use the ExternalId element to relate sports factual data and sports programs. Use multiple external IDs if they are available.

The ExternalStation element, can have only one ExternalId. Applicable external ID schemes for ExternalStation are tms and gvd.

Property	Detail
Parent Elements	`ExternalIds` `ExternalStation`
Data Type	ExternalIdType - string with a required `scheme` attribute.
Attributes	Description
`scheme` Required	The source of the external ID. Data Type: string

↑ Back to top

List of Title elements. A Title element represents the title of the program and the locale to which it applies.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `OffAir` `ToBeAnnounced` `Station` `ExternalStation`
Data Type	TitleList
Child Elements	Description
`Title` Required	A localized string representing the title of the program and the language and territory to which it applies.

↑ Back to top

A localized string representing the title of the program and the language and territory to which it applies. The default attribute specifies the title for the original release territory and is the fallback title for any language that isn't specified. Territory-specific values are used where specified.

Property	Detail
Parent Elements	`Titles` `SeriesTitles`
Data Type	LocalizedStringType
Attributes	Description
`language` Required	Contains language data for this item. Data Type: LanguageType
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the Description elements represented by a localized string.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `OffAir` `ToBeAnnounced` `Station`
Data Type	DescriptionList
Child Elements	Description
`Description` Required	A localized string that describes the program without giving away the story or detailing its premise.

↑ Back to top

A localized string that describes the program without giving away the story or detailing its premise.

Property	Detail
Parent Elements	`Descriptions`
Data Type	LocalizedStringType
Attributes	Description
`language` Required	Contains language data for this item. Data Type: LanguageType
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the Synopsis elements. A synopsis is a concise but entertaining summary of the major points of the program and supports localized values. Synopses are typically longer than descriptions.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `OffAir` `ToBeAnnounced`
Data Type	SynopsisList
Child Elements	Description
`Synopsis` Required	A concise but entertaining summary of the major points of the program. Synopses are typically longer than descriptions.

↑ Back to top

A concise but entertaining summary of the major points of the program. Synopses are typically longer than descriptions.

Property	Detail
Parent Elements	`Synopses`
Data Type	LocalizedStringType
Attributes	Description
`language` Required	Contains language data for this item. Data Type: LanguageType
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the Image elements.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `OffAir` `ToBeAnnounced` `Station` `ExternalStation`
Data Type	ImageList
Child Elements	Description
`Image` Required	Publicly available URL of the image location.

↑ Back to top

Publicly available URL of the image location. Supports HTTP and HTTPS protocols. Amazon imports these images and provides geographically distributed copies (CDN) of the images to Fire TV clients. Image locations must allow anonymous public access, conform to the Uniform Resource Locators (w3.org) specification, and must not exceed 10 MB in size. To avoid spaces and other invalid characters in the URL, you must perform URL encoding. The URL must be accessible without additional authentication (must not be password protected). HTTPS access must maintain up-to-date and valid certificates.

For image details and examples, see EMBER Images.

Property	Detail
Parent Elements	`Images`
Data Type	ImageType - Structure that provides the image data. The Image URL value is a string with the pattern `(http\|HTTP)(s\|S)://.`.
Attributes	Description
`category`	Type of image. Supported image categories are as follows: `background` – A program image without burned-in title text. No language attribute is required for this image type. Ambient text such as signs in the scenery are not reason for localization. JPEG format. Aspect Ratio: 16:9. `cover` – A program image with burned-in text. Language must match the text in the title. Language is a required attribute for this image category. JPEG format. Aspect Ratio: 16:9. `poster` – Poster art. JPEG format. Aspect Ratio: 2:3. Preferred size: 2000 x 3000 px. Minimum size: 2000 x 3000 px. `episodic` – Used to capture the context of the content. It is usually a still from the TV episode or extra (e.g., trailer) content. JPEG format. Aspect Ratio: 16:9. `title` – The catalog system uses this type of image in place of title text on detail pages. It consists of a 5:2 PNG image of the program title treatment with a transparent background. `logo` – Used for station logos. PNG format. Aspect Ratio: 16:9. Preferred size: 3840 x 2160 px. Minimum size: 1920 x 1080 px. Has background color options: color, white, light, black, gray, dark. Data Type: ImageCategory
`language`	Applies to cover, poster, and title images. The burned-in title on the image must match the title text for the same language/territory combination. Background images do not have text and therefore do not have a language. They can have territories. Data Type: LanguageType
`territories`	Optionally applies to all image types, including background. If present, it indicates that the image is preferred for distribution in the indicated territories. Use ISO 3166-1 alpha-2 format or `GLOBAL`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`aspectRatio`	Expressed in width to height, for example: 16:9, 2:3. Data Type: AspectRatioType
`mimeType`	Background, cover, poster, and episodic images must be JPEG images. Title images (used in place of text titles) and station logos must be transparent PNG images. Data Type: MimeType
`resolution`	Closed enumeration which indicates that the image has enough vertical pixels to use as a background for common screen resolutions. Value valids are `SD`, `HD`, `FullHD`, `4K`, and `8K`. Data Type: ResolutionType
`version`	The version or checksum of the image. This value must change whenever you update the contents of the image without changing the URL. Alternately, you can change the image URL when you update the image. This value is used to optimize the image downloading, encoding, and CDN redistribution process. Data Type: long
`color`	Specifies the color variant of an image, particularly for logos. Data Type: ImageColorType
`default`	If set to true, the catalog system uses this image for languages and territories that do not have an explicit image provided. Apply default to no more than one image per image type. Data Type: boolean
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of genres.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `Station`
Data Type	GenreList
Child Elements	Description
`Genre` Required	The genre of the content.

↑ Back to top

The genre of the content. You can use the scheme attribute to indicate a specific genre enum value. The supported scheme value is ember_genre. You can also use free-form text without the scheme attribute. For a list of supported genre codes in the EMBER genre scheme, see EMBER Genres.

Property	Detail
Parent Elements	`Genres`
Data Type	GenreType - A structure that holds the genre namespace and value. Use the scheme attribute to indicate a specific genre enum value or use free-form text without the scheme attribute.
Attributes	Description
`scheme`	The genre namespace. Data Type: string
`language`	Contains language data for this item. Data Type: LanguageType
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the Keyword elements represented by a localized string. The catalog system uses keywords as search terms for the program.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other`
Data Type	KeywordList
Child Elements	Description
`Keyword` Required	Localized string for the catalog system to use as a search term for the program. Search terms are language and optionally, territory specific.

↑ Back to top

Localized string for the catalog system to use as a search term for the program. Search terms are language and optionally, territory specific.

Property	Detail
Parent Elements	`Keywords`
Data Type	LocalizedStringType
Attributes	Description
`language` Required	Contains language data for this item. Data Type: LanguageType
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the Rating elements.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `Airing` `Station`
Data Type	RatingList
Child Elements	Description
`Rating` Required	Provides certification for age-appropriate viewer restrictions.

↑ Back to top

Provides certification for age-appropriate viewer restrictions. The adultProduct and notRated flags are boolean attributes that indicate that the program has applicable age restriction business rules applied. Rating values exist for actual programs and for airings. The Rating element includes content descriptors, which have a code and a corresponding description. Descriptions are from the governing body of the rating system and use the primary language of the rating body. Content descriptors are legally required in some territories. Supported ratings and descriptors are listed in the Video Central documentation. Use the Global Ratings specification.

Catalog-specific conditions:

Schedule catalog: If you specify a rating for an airing, it overwrites the program rating information.
Station catalog: If there is no program or airing rating, the catalog system uses the station rating.

Property	Detail
Parent Elements	`Ratings`
Data Type	RatingType - Structure that contains the certification for age-appropriate viewer restrictions.
Child Elements	Description
`Descriptors`	List of the `Descriptor` elements.
Attributes	Description
`system` Required	Motion picture content rating system. Data Type: string
`certification` Required	Certification value based on a program's suitability for audiences. Data Type: string
`adultProduct`	Indicates whether the program has applicable age restriction business rules applied. Data Type: boolean
`notRated`	Indicates whether the program has applicable age restriction business rules applied. Data Type: boolean
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the Descriptor elements.

Property	Detail
Parent Elements	`Rating`
Data Type	DescriptorList
Child Elements	Description
`Descriptor` Required	The `Descriptor` element provides content descriptors. A content descriptor includes a code and a corresponding description.

↑ Back to top

The Descriptor element provides content descriptors. A content descriptor includes a code and a corresponding description. Descriptions are from the governing body of the rating system and use the primary language of the rating body. Content descriptors are legally required in some territories. Supported ratings and descriptors are listed in the Video Central documentation. Use the Global Ratings specification.

Property	Detail
Parent Elements	`Descriptors`
Data Type	DescriptorType
Attributes	Description
`code`	Two letter code for the descriptor. Data Type: string

↑ Back to top

List of the Studio elements.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other`
Data Type	StudioList
Child Elements	Description
`Studio` Required	Reference to the creative organizations. It is an open enumeration type with support for external IDs.

↑ Back to top

Reference to the creative organizations. It is an open enumeration type with support for external IDs.

Property	Detail
Parent Elements	`Studios`
Data Type	StudioType - Structure that contains references to the creative organizations.
Child Elements	Description
`StudioNames` Required	List of the `StudioName` elements.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the StudioName elements.

Property	Detail
Parent Elements	`Studio`
Data Type	StudioNameList
Child Elements	Description
`StudioName` Required	Name of the studio.

↑ Back to top

Name of the studio.

Property	Detail
Parent Elements	`StudioNames`
Data Type	string

↑ Back to top

List of the Credits elements.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `SportsEvent` `Event` `Other` `Extra`
Data Type	CreditList
Child Elements	Description
`Credit` Required	Provide cast and crew information for the movie, TV special, TV episode, or sports program.

↑ Back to top

Provide cast and crew information for the movie, TV special, TV episode, or sports program. Credit is suitable for any contributor to the production. For actors performing a named character role, include the Character element. ExternalIds refer to the person, not the character.

Property	Detail
Parent Elements	`Credits`
Data Type	CreditType - Structure that hosts cast and crew information for the program.
Child Elements	Description
`PersonNames` Required	List containing the "person name" in different languages.
`ContributionNames` Required	List containing the "contribution name" in different languages.
`CharacterNames`	List of the localized character names.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List containing the "person name" in different languages.

Property	Detail
Parent Elements	`Credit`
Data Type	PersonNameList
Child Elements	Description
`PersonName` Required	The name of the contributor.

↑ Back to top

The name of the contributor.

Property	Detail
Parent Elements	`PersonNames`
Data Type	string
Attributes	Description
`language`	Contains language data for this item. Default value is `en`. Data Type: LanguageType
`default`	The catalog system uses this value as a default when no matching language is available. Data Type: boolean

↑ Back to top

List containing the "contribution name" in different languages.

Property	Detail
Parent Elements	`Credit`
Data Type	ContributionNameList
Child Elements	Description
`ContributionName` Required	Indicates the role of the contributor.

↑ Back to top

Indicates the role of the contributor. The following table lists the recommended contribution values.

Role	Description	Examples
`Actor`	A person providing physical presence for a character or themselves in a program.	Leonard Nemoy as Mr. Spock in Star Trek. Harrison Ford as Henry "Indiana" Jones Jr. in the Indiana Jones movies.
`Guest`	A person providing physical presence for a character or themselves in a program who is not typically associated with the program. Cameos, guest appearances, or lead roles outside the core cast often fall in this category.	Cary Elwes as the recurring character Pierre Desperaux in multiple episodes of the TV series Psych. Alfred Hitchcock made a cameo appearance in every movie he directed. Stan Lee made cameo appearances in Marvel movies starting in 1989 including all MCU movies and TV series up until his death.
`Voice`	A person providing voice-only for a character in a program. Typically not a narrator, although in some programs, the narrator is a character who interacts with the other characters.	James Earl Jones as the voice of Darth Vader in Star Wars movies. Nancy Cartwright as the voice of Bartholomew Jojo "Bart" Simpson in The Simpsons.
`Director`	Supervises the actors, camera crew, and other staff.	Ron Howard for Far and Away (1992), Apollo 13 (1995), and Thirteen Lives (2022).
`Producer`	Responsible for the financial and managerial aspects.	Francis Ford Coppola directed and produced The Godfather Part II and The Godfather Part III, but only directed The Godfather.
`Writer`	Contributor to the writing the script for the program.	Francis Ford Coppola and Mario Puzo co-wrote The Godfather trilogy.
`Composer`	Contributor to the writing of music for the program.	John Williams composed music for Jaws (1975), Star Wars (1977), and Close Encounters of the Third Kind (1978). The title theme from each made the Billboard Hot 100 and Adult Contemporary top 25 lists.
`Creator`	Responsible for developing a significant part of a programs format, concept, characters, and pilot script.	Jos Whedon created Buffy the Vampire Slayer (1997-2003), Firefly (2002-2003), and Agents of S.H.I.E.L.D (2013-2020)
`Crew`	Any other non-acting role contributing to the production of a program.	Key grips, gaffers, lighting, special effects, pyrotechnics, and stunts.
`Performer`	A person who entertains an audience.	Bruce Springsteen is the top live music performer as ranked by Rolling Stone. Tony Bennet was a performer for over 74 years.
`Coach`	Someone in charge of training an athlete or a team.	Nick Saban coached Alabama to six NCAA Football national championships.
`Athlete`	Someone who competes in a sport or game that involves physical strength, agility, stamina, speed, or skill.	Christiano Ronaldo is the highest paid player in the world in any sport at $136 million followed by Lionel Messi at $130 million.
`Self`	Cameos (as themselves), interviews, newscasters, where the role is the person, and played by the person, whether the content of the program is fictional or non-fiction.	The Beatles (John Lennon, Paul McCartney, George Harrison, and Ringo Starr) played a fictional version of themselves in A Hard Day's Night.
`Host`	The emcee of a talk show or game show.	Pat Sajack was the long time host of the game show Wheel of Fortune.
`Narrator`	Voice-over talent providing commentary or insights, as in a documentary.	Sebastian Cabot was the narrator in Winnie the Pooh and the Honey Tree (1966).
`Judge`	The arbitrator in a competition or non-dramatized court.	Judy Sheindlin is the titular Judge Judy.
`Contestant`	A participant in a non-sports competition, like a game show.	Brad Rutter earned $4.89 million appearing in 38 episodes of Jeopardy!
`Anchor`	Typically for a newscast, the primary broadcast personality.	As news anchor for the CBS Evening News, Walter Cronkite was the "most trusted man in America" for 19 years (1962-1981).
`Correspondent`	Typically for a newscast, someone who narrates and covers a single article.	Ed Bradley was a reporter who covered the Vietnam War, the 1976 presidential race, and the White House at CBS and was a correspondent on 60 Minutes for 26 years.
`Announcer`	For a sports event, this person narrates the play-by-play.	As WGN baseball announcer, Harry Caray was the voice of the Chicago Cubs for 17 years.
`Analyst`	For a sports or news program, this person provides in-depth insights and opinions.	Terry Bradshaw is widely recognized for his remarkable career in the National Football League (NFL), and as a knowledgeable and entertaining football analyst.

Property	Detail
Parent Elements	`ContributionNames`
Data Type	string
Attributes	Description
`language`	Language of the string. Default value is `en`. Data Type: LanguageType
`default`	The catalog system uses this value as a default when no matching language is available. Data Type: boolean

↑ Back to top

List of the localized character names.

Property	Detail
Parent Elements	`Credit`
Data Type	CharacterNameList
Child Elements	Description
`CharacterName` Required	The character role in the program.

↑ Back to top

The character role in the program.

Property	Detail
Parent Elements	`CharacterNames`
Data Type	LocalizedStringType
Attributes	Description
`language` Required	Contains language data for this item. Data Type: LanguageType
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the Tag elements.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `OffAir` `ToBeAnnounced` `Airing` `ProgramOffer` `StationOffer` `ProgramAiringOffer` `Station` `EntitlementPolicy`
Data Type	TagList
Child Elements	Description
`Tag` Required	Additional metadata used to categorize, promote, or otherwise apply custom processing to a program or airing.

↑ Back to top

Additional metadata used to categorize, promote, or otherwise apply custom processing to a program or airing. The scheme, key, and valid formats for those values must be negotiated between you and Amazon. This feature serves to enable non-standard or emerging use cases until dedicated entities or attributes are added and versioned into the specification.

Property	Detail
Parent Elements	`Tags`
Data Type	TagType -A string with the addition of required `scheme`, and `key` attributes.
Attributes	Description
`scheme` Required	Universally unique namespace for key-value pairs. Data Type: string
`key` Required	The key of the key-value pair. The value is the element value. Data Type: string

↑ Back to top

List of localized durations applied to a program.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `Extra` `SportsEvent` `Event` `Other`
Data Type	LocalizedRunLengthList
Child Elements	Description
`RunLength` Required	The unedited length of a program and the territory or territories to which it applies.

↑ Back to top

The unedited length of a program and the territory or territories to which it applies.

Property	Detail
Parent Elements	`RunLengths`
Data Type	LocalizedDurationType - Structure that contains the unedited length of a program, and the territory or territories to which it applies.
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType

↑ Back to top

Enumerated value describing the characteristics of the picture color. This attribute applies to actual programs (not seasons or series). Valid values are found in MovieLabs PictureColor specification and include color, bandw, colorized, composite, and unknown.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `Extra` `SportsEvent` `Event` `Other`
Data Type	PictureColorType - PictureColorEnumType with the addition of the source attributes `sourceName`, `sourceDate`, and `sourceId`.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the ReleaseDate elements.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other`
Data Type	ReleaseDateList
Child Elements	Description
`ReleaseDate` Required	Date that the program was first available in its original territory or specified territory.

↑ Back to top

Date that the program was first available in its original territory or specified territory. Release date is synonymous with the original air date for TV programs. Release date can contain either a date or just the year if the actual date is not known. Multiple releases in a territory are allowed. However, multiple releases of the same type in the same territory must have different dates.

Property	Detail
Parent Elements	`ReleaseDates`
Data Type	ReleaseDateType - string with the pattern `(\d{4})-(0[1-9]\|1[012])-(0[1-9]\|[12][0-9]\|3[01])\|(\d{4})`. Defines the pattern for a release year or date. Dates are represented as YYYY-MM-DD or YYYY. Uses ISO-8601 Coordinated Universal Time values.
Attributes	Description
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`releaseType`	Specifies the distribution mechanism for the release. Valid values: `theater`, `video`, `streaming`. Data Type: ReleaseType
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

Indicates relationships between content.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `SportsEvent` `Event` `Other` `Extra`
Data Type	RelationshipsType - Container for all relationships between content items.
Child Elements	Description
`isSeasonOfSeries`	Relationship of a TV season to its parent TV series.
`isEpisodeOfSeason`	Relationship of a TV episode to its parent TV season.
`isEpisodeOfSeries`	Relationship of a TV episode directly to its TV series.
`isExtraOf`	Relationship of the extra content, such as trailers, featurettes, or pre-game and post-game content.
`isRelatedTo`	General relationship between content. For example, Lord of the Rings is related to The Hobbit.

↑ Back to top

Relationship of a TV season to its parent TV series.

Property	Detail
Parent Elements	`Relationships`
Data Type	isSeasonOfSeriesType
Child Elements	Description
`SeriesTitles`	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
Attributes	Description
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`seasonNum` Required	Season number within the TV series. Data Type: nonNegativeInteger
`programRef`	The ID of the program. Data Type: ID
`programCatalogRef`	Reference to the program catalog that contains the program. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

Relationship of a TV episode to its parent TV season.

Property	Detail
Parent Elements	`Relationships`
Data Type	isEpisodeOfSeasonType
Child Elements	Description
`SeriesTitles`	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
Attributes	Description
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`episodeNum` Required	Episode number within the TV season. Data Type: nonNegativeInteger
`seasonNum`	Season number within the TV series. If no `seasonNum` is specified, either the episode release year or 'season 1' is assigned to the episode. Data Type: nonNegativeInteger
`premiere`	Indicates whether the episode is the first in the season. Data Type: boolean
`finale`	Indicates whether the episode is the last in the season. Data Type: boolean
`programRef`	The ID of the program. Data Type: ID
`programCatalogRef`	Reference to the program catalog that contains the program. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

Relationship of a TV episode directly to its TV series.

Note: You can model special episodes like Christmas specials as TV episodes and reference the TV series without the need to add TV season.

Property	Detail
Parent Elements	`Relationships`
Data Type	isEpisodeOfSeriesType
Child Elements	Description
`SeriesTitles`	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
Attributes	Description
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`episodeNum` Required	Episode number within the TV season. Data Type: nonNegativeInteger
`premiere`	Indicates whether the episode is the first in the series. Data Type: boolean
`finale`	Indicates whether the episode is the last in the series. Data Type: boolean
`programRef`	The ID of the program. Data Type: ID
`programCatalogRef`	Reference to the program catalog that contains the program. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

List of Title elements. A Title element represents the title of the program and the locale to which it applies.

Property	Detail
Parent Elements	`isSeasonOfSeries` `isEpisodeOfSeason` `isEpisodeOfSeries`
Data Type	TitleList
Child Elements	Description
`Title` Required	A localized string representing the title of the program and the language and territory to which it applies.

↑ Back to top

Relationship of the extra content, such as trailers, featurettes, or pre-game and post-game content.

Property	Detail
Parent Elements	`Relationships`
Data Type	isExtraOfType
Child Elements	Description
`RelatedExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`orderNum`	The order number for the related bonus content. If duplicate values exist for a `programRef`, then ordering is nondeterministic. Data Type: nonNegativeInteger
`programRef`	The ID of the program. Required unless `RelatedExternalIDs` are defined. Data Type: ID
`programCatalogRef`	Reference to the program catalog that contains the program. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

General relationship between content. For example, Lord of the Rings is related to The Hobbit.

Property	Detail
Parent Elements	`Relationships`
Data Type	isRelatedToType
Child Elements	Description
`RelatedExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`programRef`	The ID of the program. Required unless `RelatedExternalIDs` are defined. Data Type: ID
`programCatalogRef`	Reference to the program catalog that contains the program. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

Contains external system identifiers. Allows cross-referencing with third-party systems.

Property	Detail
Parent Elements	`isExtraOf` `isRelatedTo`
Data Type	ExternalIdList
Child Elements	Description
`ExternalId` Required	Links the program or other entity to an external source.

↑ Back to top

List of the Venue elements.

Property	Detail
Parent Elements	`SportsEvent` `Event`
Data Type	VenueList
Child Elements	Description
`Venue` Required	Location information for an event.

↑ Back to top

Location information for an event. The VenueNames and City elements in the Address element are required fields. The default name is the official name for the venue.

Property	Detail
Parent Elements	`Venues`
Data Type	VenueType - Structure that hosts the location information for an event.
Child Elements	Description
`VenueNames` Required	List of the `VenueName` elements.
`Address`	Hosts address data.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the VenueName elements.

Property	Detail
Parent Elements	`Venue`
Data Type	VenueNameList
Child Elements	Description
`VenueName` Required	Name of the venue with an optional translation language.

↑ Back to top

Name of the venue with an optional translation language.

Property	Detail
Parent Elements	`VenueNames`
Data Type	VenueNameType - A string representing the venue name with an optional `language` attribute.
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean

↑ Back to top

Hosts address data.

Property	Detail
Parent Elements	`Venue`
Data Type	AddressType - Structure that hosts address data.
Child Elements	Description
`Street`	The street in the venue address.
`City`	The city in the venue address.
`StateOrProvince`	The state or province in the venue address.
`Country`	The country in the venue address.
`PostalCode`	Specific postal codes for the region.

↑ Back to top

The street in the venue address.

Property	Detail
Parent Elements	`Address`
Data Type	string

↑ Back to top

The city in the venue address.

Property	Detail
Parent Elements	`Address`
Data Type	string

↑ Back to top

The state or province in the venue address.

Property	Detail
Parent Elements	`Address`
Data Type	string

↑ Back to top

The country in the venue address.

Property	Detail
Parent Elements	`Address`
Data Type	string

↑ Back to top

Defines a specific postal code. In a region policy, postal code is used for content availability control. In venue address element, it is used as postal code for the address.

Property	Detail
Parent Elements	`Address` `Region`
Data Type	string

↑ Back to top

List of the Sport elements.

Property	Detail
Parent Elements	`SportsEvent` `Other` `Extra`
Data Type	SportList
Child Elements	Description
`Sport` Required	Default name and optionally, language and territory specific names for the sport.

↑ Back to top

Default name and optionally, language and territory specific names for the sport. The default name must be the sport's name as specified by the respective sports federation. For a list of recognized sports, see EMBER Sports. You can provide External IDs for the sport.

Property	Detail
Parent Elements	`Sports`
Data Type	SportType - Structure that hosts the sport information.
Child Elements	Description
`SportNames`	List of the `SportName` elements.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the SportName elements.

Property	Detail
Parent Elements	`Sport`
Data Type	SportNameList
Child Elements	Description
`SportName` Required	The name of the sport. For a list of recognized sports, see EMBER Sports.

↑ Back to top

The name of the sport. For a list of recognized sports, see EMBER Sports.

Property	Detail
Parent Elements	`SportNames`
Data Type	SportNameType
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean

↑ Back to top

List of the League elements.

Property	Detail
Parent Elements	`SportsEvent` `Other` `Extra`
Data Type	LeagueList
Child Elements	Description
`League` Required	Open enumeration of the league associated with the sports program.

↑ Back to top

Open enumeration of the league associated with the sports program. The default name must be the official name for the league (not an abbreviation) in the primary language for the governing body. For example, Bundesliga (German), Serie A (Italian), Ligue 1 (French), La Liga (Spanish), and Premier League (English). You can provide language-specific translations.

Consider the XML example that follows this table. If ingested, the catalog system would use NFL as an abbreviation when displaying the league for English speakers in the US, who are presumably familiar with the league. The system would use the default value for everyone else. You can provide External IDs for the league.

Property	Detail
Parent Elements	`Leagues`
Data Type	LeagueType - Structure that hosts the league associated with the sports program.
Child Elements	Description
`LeagueNames`	List of the `LeagueName` elements.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the LeagueName elements.

Property	Detail
Parent Elements	`League`
Data Type	LeagueNameList
Child Elements	Description
`LeagueName` Required	The league name string with an optional translation language.

↑ Back to top

The league name string with an optional translation language.

Property	Detail
Parent Elements	`LeagueNames`
Data Type	LeagueNameType
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean

↑ Back to top

The official name or number of the season for the match being played. This might differ from the release date of the program (which might be just a year) because some sports play over a calendar year boundary. For example, the NBA uses a hyphenated year designation, such as 2023-24, for their regular season, while the NFL uses a single year, for example, 2023. Consistent with other sports data, the governing body of the league determines the season language.

Property	Detail
Parent Elements	`SportsEvent`
Data Type	SportSeasonType - Structure that contains the official name or number of the season of the match being played.
Child Elements	Description
`SeasonNames`	List of `Season` elements when the match is being played.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of Season elements when the match is being played.

Property	Detail
Parent Elements	`Season`
Data Type	SeasonNameList
Child Elements	Description
`SeasonName` Required	The season name when the match is being played.

↑ Back to top

The season name when a sports match is being played (for example, 2023-24 NBA Season) with an optional translation language.

Property	Detail
Parent Elements	`SeasonNames`
Data Type	SeasonNameType
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean

↑ Back to top

The tournament associated with the sports program or event. The default must be the official name for the tournament (not an abbreviation) in the primary language for the governing body. For example, FIFA World Cup (English). When available, provide language-specific translations. For example, La Copa Mundial De Fútbol (Spanish), La Coppa Mondiale di Calcio (Italian).

The XML example that follows this table specifies a default and US-specific version of the FIFA World Cup. Note that the default language for the World Cup is in French, the language of the governing body: Fédération Internationale de Football Association (FIFA). You can provide external IDs for the tournament.

Property	Detail
Parent Elements	`SportsEvent` `Event`
Data Type	TournamentType - Structure that hosts the tournament associated with the sports program.
Child Elements	Description
`TournamentNames`	List of the `TournamentName` elements.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the TournamentName elements.

Property	Detail
Parent Elements	`Tournament`
Data Type	TournamentNameList
Child Elements	Description
`TournamentName` Required	The tournament name string with an optional translation language.

↑ Back to top

The tournament name string with an optional translation language.

Property	Detail
Parent Elements	`TournamentNames`
Data Type	TournamentNameType
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean

↑ Back to top

The round of play associated with a tournament game or match for a sports program. Round names will vary by tournament type and sport. For example, the FIFA World Cup has: round of 16, quarter-final, semi-final, play-off for third place, and final, while the Rolland-Garros French Open has: qualifying rounds, main draw rounds, first round, second round, third round, fourth round, quarterfinals, semifinals, and finals. Round is used as a synonym for stage, heat, and other terms. The round names without a translation must be the official name for the round (not an abbreviation) in the primary language for the governing body.

Property	Detail
Parent Elements	`SportsEvent` `Event`
Data Type	RoundType - Structure that hosts the round associated with the sports program.
Child Elements	Description
`RoundNames`	List of the `RoundName` elements.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the RoundName elements.

Property	Detail
Parent Elements	`Round`
Data Type	RoundNameList
Child Elements	Description
`RoundName` Required	The round name string with an optional translation language.

↑ Back to top

The round name string with an optional translation language.

Property	Detail
Parent Elements	`RoundNames`
Data Type	RoundNameType
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean

↑ Back to top

List of the Team elements.

Property	Detail
Parent Elements	`SportsEvent` `Other` `Extra`
Data Type	TeamList
Child Elements	Description
`Team` Required	Participating teams for a match or game.

↑ Back to top

Participating teams for a match or game. You can provide translations. For a match between individuals, don't translate the names. Make sure names are consistent with alphabetization standards (for example, Lincoln, Abraham). Apply the homeTeam attribute to at most one team.

Consider the XML example that follows this table. If ingested, the catalog system would use the official names of the teams for everyone except US English speaking customers.

Property	Detail
Parent Elements	`Teams`
Data Type	TeamType - Structure that provides the data of the team in a sports program.
Child Elements	Description
`TeamNames`	List of the `TeamName` elements.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
Attributes	Description
`homeTeam`	Indicates whether the team is the home team for a sports program. Data Type: boolean
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the TeamName elements.

Property	Detail
Parent Elements	`Team`
Data Type	TeamNameList
Child Elements	Description
`TeamName` Required	The team name string with an optional translation language.

↑ Back to top

The team name string with an optional translation language.

Property	Detail
Parent Elements	`TeamNames`
Data Type	TeamNameType
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean

↑ Back to top

List of participating players for a match or game.

Property	Detail
Parent Elements	`SportsEvent`
Data Type	PlayerList
Child Elements	Description
`Player` Required	Participating player for a match or game.

↑ Back to top

Participating player for a match or game.

Property	Detail
Parent Elements	`Players`
Data Type	PlayerType
Child Elements	Description
`PlayerNames`	List of localized player names.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.

↑ Back to top

List of localized player names.

Property	Detail
Parent Elements	`Player`
Data Type	PlayerNameList
Child Elements	Description
`PlayerName` Required	Name of the player.

↑ Back to top

Name of the player.

Property	Detail
Parent Elements	`PlayerNames`
Data Type	PlayerNameType
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType

↑ Back to top

Gender details for the match or game.

Property	Detail
Parent Elements	`SportsEvent`
Data Type	GenderType
Child Elements	Description
`GenderNames` Required	List of localized gender details for the match or game.

↑ Back to top

List of localized gender details for the match or game.

Property	Detail
Parent Elements	`Gender`
Data Type	GenderNameList
Child Elements	Description
`GenderName` Required	Gender details for the match. Valid values: `Mens`, `Womens`, `Mixed`.

↑ Back to top

Gender details for the match. Valid values: Mens, Womens, Mixed.

Property	Detail
Parent Elements	`GenderNames`
Data Type	GenderNameType
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean

↑ Back to top

Format details for the match or game.

Property	Detail
Parent Elements	`SportsEvent`
Data Type	FormatType
Child Elements	Description
`FormatNames` Required	List of localized formats for the match or game.

↑ Back to top

List of localized formats for the match or game.

Property	Detail
Parent Elements	`Format`
Data Type	FormatNameList
Child Elements	Description
`FormatName` Required	Format for the match. Valid values: `Singles`, `Doubles`, `Legends`.

↑ Back to top

Format for the match. Valid values: Singles, Doubles, Legends.

Property	Detail
Parent Elements	`FormatNames`
Data Type	FormatNameType
Attributes	Description
`language`	Contains language data for this item. Data Type: LanguageType
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean

↑ Back to top

The time when actual programming begins, not necessarily the broadcast start time. For example, in American football, this time is known as kick off, and for basketball, tip off.

Property	Detail
Parent Elements	`SportsEvent` `Event`
Data Type	EventDateTimeType - a string with the pattern `(\d{4})-(0[1-9]\|1[012])-(0[1-9]\|[12][0-9]\|3[01])[T]([01][0-9]\|2[0-3]):([0-5][0-9]):([0-5][0-9]\|60)(\.[0-9]+)?(([Zz])\|([\+\|\-]([01][0-9]\|2[0-3]):[0-5][0-9]))` with the addition of `sourceName`, `sourceDate`, and `sourceId` attributes. Uses ISO-8601 Coordinated Universal Time values.
Attributes	Description
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

Program Catalog

ProgramCatalog

Delete

Movie

TVEpisode

TVSeason

TVSeries

SportsEvent

Event

OffAir

Other

ToBeAnnounced

Extra

ExternalIds

ExternalId

Titles

Title

Descriptions

Description

Synopses

Synopsis

Images

Image

Genres

Genre

Keywords

Keyword

Ratings

Rating

Descriptors

Descriptor

Studios

Studio

StudioNames

StudioName

Credits

Credit

PersonNames

PersonName

ContributionNames

ContributionName

CharacterNames

CharacterName

Tags

Tag

RunLengths

RunLength

PictureColor

ReleaseDates

ReleaseDate

Relationships

isSeasonOfSeries

isEpisodeOfSeason

isEpisodeOfSeries

SeriesTitles

isExtraOf

isRelatedTo

RelatedExternalIds

Venues

Venue

VenueNames

VenueName

Address

Street

City

StateOrProvince

Country

PostalCode

Sports

Sport

SportNames

SportName

Leagues

League

LeagueNames

LeagueName

Season

SeasonNames

SeasonName

Tournament