All EMBER Elements
This page provides detailed descriptions of all elements used in Enhanced Metadata Bridge for Entertainment Resources (EMBER). Elements are listed alphabetically.
Select an element from the dropdown to see its hierarchical view
DataCollections hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ └── View ProgramCatalog hierarchy ├── ScheduleCatalog │ └── View ScheduleCatalog hierarchy ├── OfferCatalog │ └── View OfferCatalog hierarchy ├── StationCatalog │ └── View StationCatalog hierarchy ├── LineupCatalog │ └── View LineupCatalog hierarchy └── PolicyCatalog └── View PolicyCatalog hierarchy
ProgramCatalog hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ ├── TVEpisode │ ├── TVSeason │ ├── TVSeries │ ├── SportsEvent │ ├── Event │ ├── OffAir │ ├── Other │ ├── ToBeAnnounced │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
Movie hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ │ ├── ExternalIds │ │ │ └── ExternalId │ │ ├── Titles │ │ │ └── Title │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Synopses │ │ │ └── Synopsis │ │ ├── Images │ │ │ └── Image │ │ ├── Genres │ │ │ └── Genre │ │ ├── Keywords │ │ │ └── Keyword │ │ ├── Ratings │ │ │ └── Rating │ │ │ └── Descriptors │ │ │ └── Descriptor │ │ ├── Studios │ │ │ └── Studio │ │ │ ├── StudioNames │ │ │ │ └── StudioName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Credits │ │ │ └── Credit │ │ │ ├── PersonNames │ │ │ │ └── PersonName │ │ │ ├── ContributionNames │ │ │ │ └── ContributionName │ │ │ ├── CharacterNames │ │ │ │ └── CharacterName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Tags │ │ │ └── Tag │ │ ├── RunLengths │ │ │ └── RunLength │ │ ├── PictureColor │ │ ├── ReleaseDates │ │ │ └── ReleaseDate │ │ └── Relationships │ │ ├── isSeasonOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeason │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isExtraOf │ │ │ └── RelatedExternalIds │ │ │ └── ExternalId │ │ └── isRelatedTo │ │ └── RelatedExternalIds │ │ └── ExternalId │ ├── TVEpisode │ ├── TVSeason │ ├── TVSeries │ ├── SportsEvent │ ├── Event │ ├── OffAir │ ├── Other │ ├── ToBeAnnounced │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
TVEpisode hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ ├── TVEpisode │ │ ├── ExternalIds │ │ │ └── ExternalId │ │ ├── Titles │ │ │ └── Title │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Synopses │ │ │ └── Synopsis │ │ ├── Images │ │ │ └── Image │ │ ├── Genres │ │ │ └── Genre │ │ ├── Keywords │ │ │ └── Keyword │ │ ├── Ratings │ │ │ └── Rating │ │ │ └── Descriptors │ │ │ └── Descriptor │ │ ├── Studios │ │ │ └── Studio │ │ │ ├── StudioNames │ │ │ │ └── StudioName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Credits │ │ │ └── Credit │ │ │ ├── PersonNames │ │ │ │ └── PersonName │ │ │ ├── ContributionNames │ │ │ │ └── ContributionName │ │ │ ├── CharacterNames │ │ │ │ └── CharacterName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Tags │ │ │ └── Tag │ │ ├── RunLengths │ │ │ └── RunLength │ │ ├── PictureColor │ │ ├── ReleaseDates │ │ │ └── ReleaseDate │ │ └── Relationships │ │ ├── isSeasonOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeason │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isExtraOf │ │ │ └── RelatedExternalIds │ │ │ └── ExternalId │ │ └── isRelatedTo │ │ └── RelatedExternalIds │ │ └── ExternalId │ ├── TVSeason │ ├── TVSeries │ ├── SportsEvent │ ├── Event │ ├── OffAir │ ├── Other │ ├── ToBeAnnounced │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
TVSeason hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ ├── TVEpisode │ ├── TVSeason │ │ ├── ExternalIds │ │ │ └── ExternalId │ │ ├── Titles │ │ │ └── Title │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Synopses │ │ │ └── Synopsis │ │ ├── Images │ │ │ └── Image │ │ ├── Genres │ │ │ └── Genre │ │ ├── Keywords │ │ │ └── Keyword │ │ ├── Ratings │ │ │ └── Rating │ │ │ └── Descriptors │ │ │ └── Descriptor │ │ ├── Studios │ │ │ └── Studio │ │ │ ├── StudioNames │ │ │ │ └── StudioName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Credits │ │ │ └── Credit │ │ │ ├── PersonNames │ │ │ │ └── PersonName │ │ │ ├── ContributionNames │ │ │ │ └── ContributionName │ │ │ ├── CharacterNames │ │ │ │ └── CharacterName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Tags │ │ │ └── Tag │ │ ├── ReleaseDates │ │ │ └── ReleaseDate │ │ └── Relationships │ │ ├── isSeasonOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeason │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isExtraOf │ │ │ └── RelatedExternalIds │ │ │ └── ExternalId │ │ └── isRelatedTo │ │ └── RelatedExternalIds │ │ └── ExternalId │ ├── TVSeries │ ├── SportsEvent │ ├── Event │ ├── OffAir │ ├── Other │ ├── ToBeAnnounced │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
TVSeries hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ ├── TVEpisode │ ├── TVSeason │ ├── TVSeries │ │ ├── ExternalIds │ │ │ └── ExternalId │ │ ├── Titles │ │ │ └── Title │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Synopses │ │ │ └── Synopsis │ │ ├── Images │ │ │ └── Image │ │ ├── Genres │ │ │ └── Genre │ │ ├── Keywords │ │ │ └── Keyword │ │ ├── Ratings │ │ │ └── Rating │ │ │ └── Descriptors │ │ │ └── Descriptor │ │ ├── Studios │ │ │ └── Studio │ │ │ ├── StudioNames │ │ │ │ └── StudioName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Credits │ │ │ └── Credit │ │ │ ├── PersonNames │ │ │ │ └── PersonName │ │ │ ├── ContributionNames │ │ │ │ └── ContributionName │ │ │ ├── CharacterNames │ │ │ │ └── CharacterName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Tags │ │ │ └── Tag │ │ ├── ReleaseDates │ │ │ └── ReleaseDate │ │ └── Relationships │ │ ├── isSeasonOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeason │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isExtraOf │ │ │ └── RelatedExternalIds │ │ │ └── ExternalId │ │ └── isRelatedTo │ │ └── RelatedExternalIds │ │ └── ExternalId │ ├── SportsEvent │ ├── Event │ ├── OffAir │ ├── Other │ ├── ToBeAnnounced │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
SportsEvent hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ ├── TVEpisode │ ├── TVSeason │ ├── TVSeries │ ├── SportsEvent │ │ ├── ExternalIds │ │ │ └── ExternalId │ │ ├── Titles │ │ │ └── Title │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Synopses │ │ │ └── Synopsis │ │ ├── Images │ │ │ └── Image │ │ ├── Genres │ │ │ └── Genre │ │ ├── Keywords │ │ │ └── Keyword │ │ ├── Ratings │ │ │ └── Rating │ │ │ └── Descriptors │ │ │ └── Descriptor │ │ ├── Studios │ │ │ └── Studio │ │ │ ├── StudioNames │ │ │ │ └── StudioName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Credits │ │ │ └── Credit │ │ │ ├── PersonNames │ │ │ │ └── PersonName │ │ │ ├── ContributionNames │ │ │ │ └── ContributionName │ │ │ ├── CharacterNames │ │ │ │ └── CharacterName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Tags │ │ │ └── Tag │ │ ├── RunLengths │ │ │ └── RunLength │ │ ├── PictureColor │ │ ├── ReleaseDates │ │ │ └── ReleaseDate │ │ ├── Venues │ │ │ └── Venue │ │ │ ├── VenueNames │ │ │ │ └── VenueName │ │ │ └── Address │ │ │ ├── Street │ │ │ ├── City │ │ │ ├── StateOrProvince │ │ │ ├── Country │ │ │ └── PostalCode │ │ ├── Sports │ │ │ └── Sport │ │ │ ├── SportNames │ │ │ │ └── SportName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Leagues │ │ │ └── League │ │ │ ├── LeagueNames │ │ │ │ └── LeagueName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Season │ │ │ ├── SeasonNames │ │ │ │ └── SeasonName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Tournament │ │ │ ├── TournamentNames │ │ │ │ └── TournamentName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Round │ │ │ ├── RoundNames │ │ │ │ └── RoundName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Teams │ │ │ └── Team │ │ │ ├── TeamNames │ │ │ │ └── TeamName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Players │ │ │ └── Player │ │ │ ├── PlayerNames │ │ │ │ └── PlayerName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Gender │ │ │ └── GenderNames │ │ │ └── GenderName │ │ ├── Format │ │ │ └── FormatNames │ │ │ └── FormatName │ │ ├── EventDateTime │ │ └── Relationships │ │ ├── isSeasonOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeason │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isExtraOf │ │ │ └── RelatedExternalIds │ │ │ └── ExternalId │ │ └── isRelatedTo │ │ └── RelatedExternalIds │ │ └── ExternalId │ ├── Event │ ├── OffAir │ ├── Other │ ├── ToBeAnnounced │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
Event hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ ├── TVEpisode │ ├── TVSeason │ ├── TVSeries │ ├── SportsEvent │ ├── Event │ │ ├── ExternalIds │ │ │ └── ExternalId │ │ ├── Titles │ │ │ └── Title │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Synopses │ │ │ └── Synopsis │ │ ├── Images │ │ │ └── Image │ │ ├── Genres │ │ │ └── Genre │ │ ├── Keywords │ │ │ └── Keyword │ │ ├── Ratings │ │ │ └── Rating │ │ │ └── Descriptors │ │ │ └── Descriptor │ │ ├── Studios │ │ │ └── Studio │ │ │ ├── StudioNames │ │ │ │ └── StudioName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Credits │ │ │ └── Credit │ │ │ ├── PersonNames │ │ │ │ └── PersonName │ │ │ ├── ContributionNames │ │ │ │ └── ContributionName │ │ │ ├── CharacterNames │ │ │ │ └── CharacterName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Tags │ │ │ └── Tag │ │ ├── RunLengths │ │ │ └── RunLength │ │ ├── PictureColor │ │ ├── ReleaseDates │ │ │ └── ReleaseDate │ │ ├── Venues │ │ │ └── Venue │ │ │ ├── VenueNames │ │ │ │ └── VenueName │ │ │ └── Address │ │ │ ├── Street │ │ │ ├── City │ │ │ ├── StateOrProvince │ │ │ ├── StateOrProvince │ │ │ └── PostalCode │ │ ├── Tournament │ │ │ ├── TournamentNames │ │ │ │ └── TournamentName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Round │ │ │ ├── RoundNames │ │ │ │ └── RoundName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── EventDateTime │ │ └── Relationships │ │ ├── isSeasonOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeason │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isExtraOf │ │ │ └── RelatedExternalIds │ │ │ └── ExternalId │ │ └── isRelatedTo │ │ └── RelatedExternalIds │ │ └── ExternalId │ ├── OffAir │ ├── Other │ ├── ToBeAnnounced │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
OffAir hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ ├── TVEpisode │ ├── TVSeason │ ├── TVSeries │ ├── SportsEvent │ ├── Event │ ├── OffAir │ │ ├── Titles │ │ │ └── Title │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Synopses │ │ │ └── Synopsis │ │ ├── Images │ │ │ └── Image │ │ ├── Tags │ │ │ └── Tag │ ├── Other │ ├── ToBeAnnounced │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
Other hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ ├── TVEpisode │ ├── TVSeason │ ├── TVSeries │ ├── SportsEvent │ ├── Event │ ├── OffAir │ ├── Other │ │ ├── ExternalIds │ │ │ └── ExternalId │ │ ├── Titles │ │ │ └── Title │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Synopses │ │ │ └── Synopsis │ │ ├── Images │ │ │ └── Image │ │ ├── Genres │ │ │ └── Genre │ │ ├── Keywords │ │ │ └── Keyword │ │ ├── Ratings │ │ │ └── Rating │ │ │ └── Descriptors │ │ │ └── Descriptor │ │ ├── Studios │ │ │ └── Studio │ │ │ ├── StudioNames │ │ │ │ └── StudioName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Credits │ │ │ └── Credit │ │ │ ├── PersonNames │ │ │ │ └── PersonName │ │ │ ├── ContributionNames │ │ │ │ └── ContributionName │ │ │ ├── CharacterNames │ │ │ │ └── CharacterName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Tags │ │ │ └── Tag │ │ ├── RunLengths │ │ │ └── RunLength │ │ ├── PictureColor │ │ ├── ReleaseDates │ │ │ └── ReleaseDate │ │ ├── Sports │ │ │ └── Sport │ │ │ ├── SportNames │ │ │ │ └── SportName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Leagues │ │ │ └── League │ │ │ ├── LeagueNames │ │ │ │ └── LeagueName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ ├── Teams │ │ │ └── Team │ │ │ ├── TeamNames │ │ │ │ └── TeamName │ │ │ └── ExternalIds │ │ │ └── ExternalId │ │ └── Relationships │ │ ├── isSeasonOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeason │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isEpisodeOfSeries │ │ │ └── SeriesTitles │ │ │ └── Title │ │ ├── isExtraOf │ │ │ └── RelatedExternalIds │ │ │ └── ExternalId │ │ └── isRelatedTo │ │ └── RelatedExternalIds │ │ └── ExternalId │ ├── ToBeAnnounced │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
ToBeAnnounced hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog │ ├── Delete │ ├── Movie │ ├── TVEpisode │ ├── TVSeason │ ├── TVSeries │ ├── SportsEvent │ ├── Event │ ├── OffAir │ ├── Other │ ├── ToBeAnnounced │ │ ├── Titles │ │ │ └── Title │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Synopses │ │ │ └── Synopsis │ │ ├── Images │ │ │ └── Image │ │ └── Tags │ │ └── Tag │ └── Extra ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
Extra hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── 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 │ │ └── ExternalIds │ │ └── ExternalId │ ├── Credits │ │ └── Credit │ │ ├── PersonNames │ │ │ └── PersonName │ │ ├── ContributionNames │ │ │ └── ContributionName │ │ ├── CharacterNames │ │ │ └── CharacterName │ │ └── ExternalIds │ │ └── ExternalId │ ├── Tags │ │ └── Tag │ ├── RunLengths │ │ └── RunLength │ ├── PictureColor │ ├── ReleaseDates │ │ └── ReleaseDate │ ├── Sports │ │ └── Sport │ │ ├── SportNames │ │ │ └── SportName │ │ └── ExternalIds │ │ └── ExternalId │ ├── Leagues │ │ └── League │ │ ├── LeagueNames │ │ │ └── LeagueName │ │ └── ExternalIds │ │ └── ExternalId │ ├── Teams │ │ └── Team │ │ ├── TeamNames │ │ │ └── TeamName │ │ └── ExternalIds │ │ └── ExternalId │ └── Relationships │ ├── isSeasonOfSeries │ │ └── SeriesTitles │ │ └── Title │ ├── isEpisodeOfSeason │ │ └── SeriesTitles │ │ └── Title │ ├── isEpisodeOfSeries │ │ └── SeriesTitles │ │ └── Title │ ├── isExtraOf │ │ └── RelatedExternalIds │ │ └── ExternalId │ └── isRelatedTo │ └── RelatedExternalIds │ └── ExternalId ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
ScheduleCatalog hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog ├── ScheduleCatalog │ ├── Delete │ └── Schedule │ └── Airing │ ├── Live │ ├── New │ ├── Edited │ ├── Ratings │ │ └── Rating │ │ └── Descriptors │ | └── Descriptor │ ├── AudioLanguages │ │ └── AudioLanguage │ ├── SubtitleLanguages │ │ └── SubtitleLanguage │ ├── Tags │ │ └── Tag │ └── GeoRestrictions │ └── GeoRestriction ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
OfferCatalog hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog ├── ScheduleCatalog ├── OfferCatalog │ ├── Delete │ ├── ProgramOffers │ ├── ProgramAiringOffers │ ├── StationOffers │ └── ProgramDiscovery ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
ProgramOffer hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog ├── ScheduleCatalog ├── OfferCatalog │ ├── Delete │ ├── ProgramOffers │ │ └── ProgramOffer │ │ ├── Entitlements │ │ │ └── Entitlement │ │ ├── AudioLanguages │ │ │ └── AudioLanguage │ │ ├── SubtitleLanguages │ │ │ └── SubtitleLanguage │ │ ├── VideoResolutions │ │ │ └── VideoResolution │ │ ├── VideoAttributes │ │ │ └── VideoAttribute │ │ ├── AudioAttributes │ │ │ └── AudioAttribute │ │ ├── Ads │ │ ├── Tags │ │ │ └── Tag │ │ ├── GeoRestrictions │ │ │ └── GeoRestriction │ │ └── LaunchTargets │ │ └── LaunchTarget │ ├── ProgramAiringOffers │ ├── StationOffers │ └── ProgramDiscovery ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
ProgramAiringOffer hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog ├── ScheduleCatalog ├── OfferCatalog │ ├── Delete │ ├── ProgramOffers │ ├── ProgramAiringOffers │ │ └── ProgramAiringOffer │ │ ├── Entitlements │ │ │ └── Entitlement │ │ ├── VideoResolutions │ │ │ └── VideoResolution │ │ ├── VideoAttributes │ │ │ └── VideoAttribute │ │ ├── AudioAttributes │ │ │ └── AudioAttribute │ │ ├── Ads │ │ ├── Tags │ │ │ └── Tag │ │ └── LaunchTargets │ │ └── LaunchTarget │ ├── StationOffers │ └── ProgramDiscovery ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
StationOffer hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog ├── ScheduleCatalog ├── OfferCatalog │ ├── Delete │ ├── ProgramOffers │ ├── ProgramAiringOffers │ ├── StationOffers │ │ └── StationOffer │ │ ├── Entitlements │ │ │ └── Entitlement │ │ ├── AudioLanguages │ │ │ └── AudioLanguage │ │ ├── SubtitleLanguages │ │ │ └── SubtitleLanguage │ │ ├── VideoResolutions │ │ │ └── VideoResolution │ │ ├── VideoAttributes │ │ │ └── VideoAttribute │ │ ├── AudioAttributes │ │ │ └── AudioAttribute │ │ ├── Ads │ │ ├── Tags │ │ │ └── Tag │ │ ├── GeoRestrictions │ │ │ └── GeoRestriction │ │ ├── LaunchTargets │ │ │ └── LaunchTarget │ │ └── StationTransport │ └── ProgramDiscovery ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
ProgramDiscovery hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog ├── ScheduleCatalog ├── OfferCatalog │ ├── Delete │ ├── ProgramOffer │ ├── ProgramAiringOffers │ ├── StationOffer │ └── ProgramDiscovery │ ├── Ranks │ │ └── Rank │ ├── CustomerRatings │ │ └── CustomerRating │ └── Badges │ └── Badge ├── StationCatalog ├── LineupCatalog └── PolicyCatalog
StationCatalog hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog │ ├── Delete │ ├── Station │ │ ├── Titles │ │ │ └── Title │ │ ├── Images │ │ │ └── Image │ │ ├── ExternalIds │ │ │ └── ExternalId │ │ ├── CallSign │ │ ├── Descriptions │ │ │ └── Description │ │ ├── Genres │ │ │ └── Genre │ │ ├── Tags │ │ │ └── Tag │ │ ├── StationCategories │ │ │ └── StationCategory │ │ ├── OriginalBroadcastType │ │ ├── AffiliatedNetworks │ │ │ └── AffiliatedNetwork │ │ ├── VideoResolutions │ │ │ └── VideoResolution │ │ ├── Ratings │ │ │ └── Rating │ │ │ └── Descriptors │ │ | └── Descriptor │ │ ├── AudioLanguages │ │ │ └── AudioLanguage │ │ └── SubtitleLanguages │ │ └── SubtitleLanguage │ └── ExternalStation │ ├── ExternalId │ ├── Titles │ │ └── Title │ └── Images │ └── Image ├── LineupCatalog └── PolicyCatalog
LineupCatalog hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog │ ├── Delete │ └── Lineup │ ├── ExternalIds │ │ └── ExternalId │ ├── Channels │ │ └── Channel │ │ └── StationTransport │ └── GeoRestrictions │ └── GeoRestriction └── PolicyCatalog
PolicyCatalog hierarchy - select an element name to view its details
└── DataCollections ├── Delete ├── ProgramCatalog ├── ScheduleCatalog ├── OfferCatalog ├── StationCatalog ├── LineupCatalog └── PolicyCatalog ├── Delete ├── RegionPolicy │ └── Region │ └── PostalCode └── EntitlementPolicy ├── EntitlementId ├── ShortDisplayNames │ └── ShortDisplayName ├── LongDisplayNames │ └── LongDisplayName └── Tags └── Tag
Address
Hosts address data.
| Property | Detail |
|---|---|
| Parent Elements |
Venue |
| Data Type | AddressType - Structure that hosts address data. |
| Child Elements | Description |
|
The street in the venue address. |
|
The city in the venue address. |
|
The state or province in the venue address. |
|
The country in the venue address. |
|
Specific postal codes for the region. |
↑ Back to top
Ads
Indicates ads in the program. This is an empty element.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramOfferProgramAiringOfferStationOffer |
| Data Type | AdsType - Empty element that indicates whether dynamic ads are inserted during content playback. |
↑ Back to top
AffiliatedNetwork
References the affiliated networks of this station if it has any. For example, ABC, CBS.
| Property | Detail |
|---|---|
| Parent Elements |
AffiliatedNetworks |
| Data Type | string |
↑ Back to top
AffiliatedNetworks
List of affiliated networks.
| Property | Detail |
|---|---|
| Parent Elements |
Station |
| Data Type | AffiliatedNetworkList |
| Child Elements | Description |
Required |
References the affiliated networks of this station if it has any. For example, ABC, CBS. |
↑ Back to top
Airing
Airing entities associate programs with time slots. You must define the content for the schedule by referring to an existing program entry using a ref attribute to your identifier. You can define ratings in the schedule, but these are overrides for a single schedule entry and don't affect the content's ratings.
| Property | Detail |
|---|---|
| Parent Elements |
ScheduleProgramAiringOffer |
| Data Type | AiringType |
| Child Elements | Description |
|
Indicates that this program is being broadcast in real time. This is an empty element. |
|
Indicates that the program is being aired for the first time. This is an empty element. |
|
Indicates if the airing is altered from its original version. |
|
List of the Rating elements. |
|
Contains available audio language options. |
|
Contains available subtitle language options. |
|
List of the Tag elements. |
|
List of policy references, such as region restrictions, for the schedule. |
| Attributes | Description |
id
Required |
The identifier for the airing entity. Data Type: ID |
startTime
Required |
Start time for the airing. Data Type: DateTimeType |
duration
Required |
Duration of the airing. Data Type: DurationType |
programRef
Required |
A reference to the program that is associated with the airing. Data Type: ID |
programCatalogRef
|
Reference to the program catalog that contains the program aired. Overrides the program catalog provided for schedule. The default value is Data Type: ID |
↑ Back to top
AudioAttribute
Audio attributes of the program. Examples include Dolby Digital 5.1, DD 5.1, DD7.1, DD7.1+, and Dolby Atmos.
| Property | Detail |
|---|---|
| Parent Elements |
AudioAttributes |
| Data Type | A string. |
↑ Back to top
AudioAttributes
Contains available audio attribute options.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramOfferProgramAiringOfferStationOffer |
| Data Type | AudioAttributeList |
| Child Elements | Description |
Required |
Audio attributes of the program. |
↑ Back to top
AudioLanguage
The audio language of the program or station.
| Property | Detail |
|---|---|
| Parent Elements |
AudioLanguages |
| Data Type | AudioLanguageType - A string that represents the audio language for a program. |
| Attributes | Description |
language
Required |
Contains language data for this item. Data Type: LanguageType |
default
|
Indicates the default audio language. Data Type: boolean |
original
|
Indicates whether this is the original language of the content. Use true for original language and false for dubbed content. Data Type: boolean |
↑ Back to top
AudioLanguages
Contains available audio language options.
| Property | Detail |
|---|---|
| Parent Elements |
AiringProgramOfferStationOfferStation |
| Data Type | AudioLanguageList |
| Child Elements | Description |
Required |
The audio language of the program or station. |
↑ Back to top
Badge
A badge contains an enumerated value that allows program titles to provide additional information to customers regarding the origin or availability of the title. Localize badge text or iconography to the customer language and territory.
| Property | Detail |
|---|---|
| Parent Elements |
Badges |
| Data Type | BadgeType - Structure that provides additional information to customers regarding the origin or availability of the title. |
| Attributes | Description |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
scheme
|
The badge namespace. Supported scheme is
new, coming_soon, and leaving_soon.
Data Type: string |
↑ Back to top
Badges
List of the Badge elements.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramDiscovery |
| Data Type | BadgeList |
| Child Elements | Description |
Required |
A badge contains an enumerated value that allows program titles to provide additional information to customers regarding the origin or availability of the title. Localize badge text or iconography to the customer language and territory. |
↑ Back to top
CallSign
Unique identifier for the broadcasting station.
| Property | Detail |
|---|---|
| Parent Elements |
Station |
| Data Type | string |
↑ Back to top
Channel
Represents a specific broadcast station in the lineup. The channel links a station to its transport information and assigns it a channel number.
| Property | Detail |
|---|---|
| Parent Elements |
Channels |
| Data Type | ChannelType |
| Child Elements | Description |
Required |
Transport signal specifications. |
| Attributes | Description |
id
Required |
Identifier of the channel. Data Type: ID |
stationRef
Required |
Reference to the station. Data Type: ID |
stationCatalogRef
|
Reference to the station catalog that contains the station. The default value is Data Type: ID |
↑ Back to top
Channels
List of channels in the lineup.
| Property | Detail |
|---|---|
| Parent Elements |
Lineup |
| Data Type | ChannelList |
| Child Elements | Description |
Required |
Represents a specific broadcast station in the lineup. The channel links a station to its transport information and assigns it a channel number. |
↑ Back to top
CharacterName
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 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
CharacterNames
List of the localized character names.
| Property | Detail |
|---|---|
| Parent Elements |
Credit |
| Data Type | CharacterNameList |
| Child Elements | Description |
Required |
The character role in the program. |
↑ Back to top
City
The city in the venue address.
| Property | Detail |
|---|---|
| Parent Elements |
Address |
| Data Type | string |
↑ Back to top
ContributionName
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. |
|
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. |
|
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. |
|
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. |
|
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 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
ContributionNames
List containing the "contribution name" in different languages.
| Property | Detail |
|---|---|
| Parent Elements |
Credit |
| Data Type | ContributionNameList |
| Child Elements | Description |
Required |
Indicates the role of the contributor. |
↑ Back to top
Country
The country in the venue address.
| Property | Detail |
|---|---|
| Parent Elements |
Address |
| Data Type | string |
↑ Back to top
Credit
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 |
Required |
List containing the "person name" in different languages. |
Required |
List containing the "contribution name" in different languages. |
|
List of the localized character names. |
|
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
Credits
List of the Credits elements.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesSportsEventEventOtherExtra |
| Data Type | CreditList |
| Child Elements | Description |
Required |
Provide cast and crew information for the movie, TV special, TV episode, or sports program. |
↑ Back to top
CustomerRating
Customer ratings contain crowd-sourced or professionally reviewed relative ratings of the title. The source, score, score basis (max score), and cohort size for the system are required as is the date that the data was retrieved from the source.
| Property | Detail |
|---|---|
| Parent Elements |
CustomerRatings |
| Data Type | CustomerRating - Structure that contains crowd-sourced or professionally reviewed ratings of the title. |
| Attributes | Description |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
score
|
The actual rating value or score given to the content. Data Type: decimal |
maxScore
|
The maximum possible score in the rating system. Data Type: decimal |
numVotes
|
The total number of votes or ratings given. Data Type: unsignedInt |
sourceName
|
Name of the organization or system providing the ratings. Data Type: string |
sourceDate
|
Date when the rating data was collected or last updated. Data Type: DateType |
↑ Back to top
CustomerRatings
List of the CustomerRating elements.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramDiscovery |
| Data Type | CustomerRatingList |
| Child Elements | Description |
Required |
Customer ratings contain crowd-sourced or professionally reviewed relative ratings of the title. The source, score, score basis (max score), and cohort size for the system are required as is the date that the data was retrieved from the source. |
↑ Back to top
DataCollections
The root element of a EMBER file. Each catalog file must contain a single DataCollections element which must contain at least one program catalog, schedule, or other top-level domain. Can contain a combination of catalogs and schedules, but must be structured in the order indicated.
| Property | Detail |
|---|---|
| Parent Elements | none |
| Data Type | DataCollectionsType |
| Child Elements | Description |
|
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.
|
|
The program catalog contains all of the program entities in a catalog. |
|
Container which can hold multiple schedules. |
|
Contains offer-related entities that define how users can access and discover content. |
|
Defines the customer-facing and management attributes of a station or channel. |
|
Contains channel lineup definitions. Organizes channels into structured lineups for video service providers with support for regional variations and transport methods. |
|
Policies define availability rules and restrictions for content distribution. |
| Attributes | Description |
schemaVersion
|
The schema version number. Data Type: string |
↑ Back to top
Delete
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 |
DataCollectionsProgramCatalogScheduleCatalogOfferCatalogStationCatalogLineupCatalogPolicyCatalog |
| 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 Data Type: long |
↑ Back to top
Description
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 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
Descriptions
List of the Description elements represented by a localized string.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOtherOffAirToBeAnnouncedStation |
| Data Type | DescriptionList |
| Child Elements | Description |
Required |
A localized string that describes the program without giving away the story or detailing its premise. |
↑ Back to top
Descriptor
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
Descriptors
List of the Descriptor elements.
| Property | Detail |
|---|---|
| Parent Elements |
Rating |
| Data Type | DescriptorList |
| Child Elements | Description |
Required |
The Descriptor element provides content descriptors. A content descriptor includes a code and a corresponding description. |
↑ Back to top
Entitlement
Entitlement details to access the content. Specify either a type or a policyRef attribute, not both:
- Use
typefor simple standard entitlements (free,subscription) and when no additional policy configuration is needed. - Use
policyRefwhen sharing user entitlements with Amazon using Subscription Entitlement API integration.
| Property | Detail |
|---|---|
| Parent Elements |
Entitlements |
| Data Type | EntitlementType |
| Attributes | Description |
type
Required |
One of
Data Type: EntitlementTypeEnumType |
policyRef
Required |
One of Data Type: string |
policyCatalogRef
|
Reference to the policy catalog that contains the referenced policy. The default value is Data Type: ID |
↑ Back to top
EntitlementId
The entitlement ID sent to Amazon Subscription Entitlement API by the app.
| Property | Detail |
|---|---|
| Parent Elements |
EntitlementPolicy |
| Data Type | string |
↑ Back to top
EntitlementPolicy
Defines entitlement details for the catalog tier.
| Property | Detail |
|---|---|
| Parent Elements |
PolicyCatalog |
| Data Type | EntitlementPolicyType |
| Child Elements | Description |
Required |
The entitlement ID sent to Amazon Subscription Entitlement API by the app. |
|
Short display name for the entitlement. For example, "Sports" shown below the buy box. |
|
Long display name for the entitlement. For example, "Sports AddOn" shown during the purchase flow. |
|
List of the Tag elements. |
| Attributes | Description |
id
Required |
Unique identifier for this entitlement policy. Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
type
Required |
One of
Data Type: EntitlementTypeEnumType |
defaultForSignedInUser
|
This catalog tier is available to any user who signs in to the app. Data Type: boolean |
↑ Back to top
Entitlements
List of entitlements for content access.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramOfferProgramAiringOfferStationOffer |
| Data Type | EntitlementListType |
| Child Elements | Description |
Required |
Entitlement details to access the content. Specify either a type or a policyRef attribute, not both:
|
↑ Back to top
Edited
Indicates if the airing is altered from its original version.
| Property | Detail |
|---|---|
| Parent Elements |
Airing |
| Data Type | EditedType |
| Attributes | Description |
cropped
|
Indicates the content is cropped. Cropping edits the aspect ratio, typically for a more appropriate aspect ratio for TV. Data Type: boolean |
content
|
Indicates the program is edited for content. Editing for content shortens the broadcast length of the program. This could be done to remove more restrictive scenes or to fit the broadcast window. Data Type: boolean |
language
|
Indicates the program is edited for language. Editing the language typically doesn't affect the length of the program, but dubs the audio or mutes profanity to achieve a less restrictive rating. Data Type: boolean |
↑ Back to top
Event
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 |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
List of genres. |
|
List of the Keyword elements represented by a localized string. The catalog system uses keywords as search terms for the program. |
|
List of the Rating elements. |
|
List of the Studio elements. |
|
List of the Credits elements. |
|
List of the Tag elements. |
|
List of localized durations applied to a program. |
|
Enumerated value describing the characteristics of the picture color. |
|
List of the ReleaseDate elements. |
|
List of the Venue elements. |
|
The tournament associated with the sports program or event. |
|
The round of play associated with a tournament game or match for a sports program. |
|
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. |
|
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 Data Type: long |
↑ Back to top
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.
| Property | Detail |
|---|---|
| Parent Elements |
SportsEventEvent |
| 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
ExternalId
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 |
ExternalIdsExternalStation |
| 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
ExternalIds
Contains external system identifiers. Allows cross-referencing with third-party systems.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOtherStudioCreditSportLeagueSeasonTournamentRoundTeamPlayerStationLineup |
| Data Type | ExternalIdList |
| Child Elements | Description |
Required |
Links the program or other entity to an external source. |
↑ Back to top
ExternalStation
A station entity that references an external metadata system, with the ability to override certain fields. Supported external ID schemes for external stations are tms and gvd. For details on when to use the Station element and when to use the ExternalStation element, see Linear catalogs on the best practices page.
| Property | Detail |
|---|---|
| Parent Elements |
StationCatalog |
| Data Type | ExternalStationType |
| Child Elements | Description |
Required |
Links the program or other entity to an external source. |
|
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Image elements. |
| Attributes | Description |
id
Required |
The main identifier for a station entity. Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
name
Required |
The English name for the station that can be used for operations. Data Type: string |
territories
|
Countries where the station is available. Comma-separated list of territory codes, such as Data Type: TerritoriesType |
↑ Back to top
Extra
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 |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
List of genres. |
|
List of the Keyword elements represented by a localized string. The catalog system uses keywords as search terms for the program. |
|
List of the Rating elements. |
|
List of the Studio elements. |
|
List of the Credits elements. |
|
List of the Tag elements. |
|
List of localized durations applied to a program. |
|
Enumerated value describing the characteristics of the picture color. |
|
List of the ReleaseDate elements. |
|
List of the Sport elements. |
|
List of the League elements. |
|
List of the Team elements. |
|
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 Data Type: long |
category
Required |
Category of the extra content. Valid values: Data Type: ExtraCategoryType |
↑ Back to top
Format
Format details for the match or game.
| Property | Detail |
|---|---|
| Parent Elements |
SportsEvent |
| Data Type | FormatType |
| Child Elements | Description |
Required |
List of localized formats for the match or game. |
↑ Back to top
FormatName
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
FormatNames
List of localized formats for the match or game.
| Property | Detail |
|---|---|
| Parent Elements |
Format |
| Data Type | FormatNameList |
| Child Elements | Description |
Required |
Format for the match. Valid values: Singles, Doubles, Legends.
|
↑ Back to top
Gender
Gender details for the match or game.
| Property | Detail |
|---|---|
| Parent Elements |
SportsEvent |
| Data Type | GenderType |
| Child Elements | Description |
Required |
List of localized gender details for the match or game. |
↑ Back to top
GenderNames
List of localized gender details for the match or game.
| Property | Detail |
|---|---|
| Parent Elements |
Gender |
| Data Type | GenderNameList |
| Child Elements | Description |
Required |
Gender details for the match. Valid values: Mens, Womens, Mixed.
|
↑ Back to top
GenderName
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 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
Genre
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
Genres
List of genres.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOtherStation |
| Data Type | GenreList |
| Child Elements | Description |
Required |
The genre of the content. |
↑ Back to top
GeoRestriction
GeoRestriction details to access the content.
| Property | Detail |
|---|---|
| Parent Elements |
GeoRestrictions |
| Data Type | ID |
| Attributes | Description |
policyRef
Required |
Reference to the policy with geographic restriction details. Data Type: string |
policyCatalogRef
|
Reference to the policy catalog that contains the referenced policy. The default value is Data Type: ID |
↑ Back to top
GeoRestrictions
List of geographic restrictions to access the content.
| Property | Detail |
|---|---|
| Parent Elements |
AiringProgramOfferStationOfferLineup |
| Data Type | GeoRestrictionList |
| Child Elements | Description |
Required |
GeoRestriction details to access the content. |
↑ Back to top
Image
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:
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 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 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
Images
List of the Image elements.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOtherOffAirToBeAnnouncedStationExternalStation |
| Data Type | ImageList |
| Child Elements | Description |
Required |
Publicly available URL of the image location. |
↑ Back to top
isEpisodeOfSeason
Relationship of a TV episode to its parent TV season.
| Property | Detail |
|---|---|
| Parent Elements |
Relationships |
| Data Type | isEpisodeOfSeasonType |
| Child Elements | Description |
|
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 Data Type: TerritoriesType |
episodeNum
Required |
Episode number within the TV season. Data Type: nonNegativeInteger |
seasonNum
|
Season number within the TV series. If no 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 Data Type: ID |
↑ Back to top
isEpisodeOfSeries
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 |
|
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 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 Data Type: ID |
↑ Back to top
isExtraOf
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 |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
| Attributes | Description |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
orderNum
|
The order number for the related bonus content. If duplicate values exist for a Data Type: nonNegativeInteger |
programRef
|
The ID of the program. Required unless Data Type: ID |
programCatalogRef
|
Reference to the program catalog that contains the program. The default value is Data Type: ID |
↑ Back to top
isRelatedTo
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 |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
| Attributes | Description |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
programRef
|
The ID of the program. Required unless Data Type: ID |
programCatalogRef
|
Reference to the program catalog that contains the program. The default value is Data Type: ID |
↑ Back to top
isSeasonOfSeries
Relationship of a TV season to its parent TV series.
| Property | Detail |
|---|---|
| Parent Elements |
Relationships |
| Data Type | isSeasonOfSeriesType |
| Child Elements | Description |
|
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 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 Data Type: ID |
↑ Back to top
Keyword
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 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
Keywords
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 |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOther |
| Data Type | KeywordList |
| Child Elements | Description |
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
LaunchTarget
Specifies the information needed to launch a given program, airing, or station on various devices, services, and presentations.
| Property | Detail |
|---|---|
| Parent Elements |
LaunchTargets |
| Data Type | LaunchTargetType - A string that specifies the information needed to launch a given program, airing, or station. |
| Attributes | Description |
type
|
Enumeration of valid launch target types. Valid values: Data Type: LaunchTargetTypeEnum |
↑ Back to top
LaunchTargets
List of the LaunchTarget elements.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramOfferProgramAiringOfferStationOffer |
| Data Type | LaunchTargetList |
| Child Elements | Description |
Required |
Specifies the information needed to launch a given program, airing, or station on various devices, services, and presentations. |
↑ Back to top
League
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 |
|
List of the LeagueName elements. |
|
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
LeagueName
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 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
LeagueNames
List of the LeagueName elements.
| Property | Detail |
|---|---|
| Parent Elements |
League |
| Data Type | LeagueNameList |
| Child Elements | Description |
Required |
The league name string with an optional translation language. |
↑ Back to top
Leagues
List of the League elements.
| Property | Detail |
|---|---|
| Parent Elements |
SportsEventOtherExtra |
| Data Type | LeagueList |
| Child Elements | Description |
Required |
Open enumeration of the league associated with the sports program. |
↑ Back to top
Lineup
Channel lineups for video service providers.
| Property | Detail |
|---|---|
| Parent Elements |
LineupCatalog |
| Data Type | LineupType |
| Child Elements | Description |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
Required |
List of channels in the lineup. |
|
List of policy references, such as region restrictions, for the lineup. |
| Attributes | Description |
id
Required |
The identifier for the lineup. Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
name
|
Display name of the lineup. Data Type: string |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
broadcastType
|
The type of broadcast the lineup is associated with. Valid values: Data Type: string |
mso
|
The name of the Multiple System Operator (MSO) that broadcasts this lineup. Data Type: string |
↑ Back to top
LineupCatalog
Contains channel lineup definitions. Organizes channels into structured lineups for video service providers with support for regional variations and transport methods.
| Property | Detail |
|---|---|
| Parent Elements |
DataCollections |
| Data Type | LineupCatalogType |
| Child Elements | Description |
|
A management verb for removing lineups from the lineup catalog. |
|
Channel lineups for video service providers. |
| Attributes | Description |
id
|
The identifier for the lineup catalog. The default value is Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
action
|
Indicates which action to take for a catalog submission. Default value is Data Type: CatalogActionType |
stationCatalogRef
|
Reference to the station catalog that contains the station. The default value is Data Type: ID |
↑ Back to top
Live
Indicates that this program is being broadcast in real time. This is an empty element.
| Property | Detail |
|---|---|
| Parent Elements |
Airing |
| Data Type | string |
↑ Back to top
LongDisplayName
Long display name for the entitlement. For example, the text shown in the purchase flow.
| Property | Detail |
|---|---|
| Parent Elements |
LongDisplayNames |
| 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 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
LongDisplayNames
List of localized long display names for the entitlement.
| Property | Detail |
|---|---|
| Parent Elements |
EntitlementPolicy |
| Data Type | LongDisplayNameList |
| Child Elements | Description |
Required |
A localized string for the entitlement name. |
↑ Back to top
Movie
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 |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
List of genres. |
|
List of the Keyword elements represented by a localized string. The catalog system uses keywords as search terms for the program. |
|
List of the Rating elements. |
|
List of the Studio elements. |
|
List of the Credits elements. |
|
List of the Tag elements. |
|
List of localized durations applied to a program. |
|
Enumerated value describing the characteristics of the picture color. |
|
List of the ReleaseDate elements. |
|
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 Data Type: long |
edit
|
A comma-separated list of edit types for a program. Allows you to specify multiple edit types, such as Data Type: EditTypeList |
↑ Back to top
New
Indicates that the program is being aired for the first time. This is an empty element.
| Property | Detail |
|---|---|
| Parent Elements |
Airing |
| Data Type | string |
↑ Back to top
OffAir
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 |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
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 Data Type: long |
↑ Back to top
OfferCatalog
Contains offer-related entities that define how users can access and discover content.
| Property | Detail |
|---|---|
| Parent Elements |
DataCollections |
| Data Type | OfferCatalogType |
| Child Elements | Description |
|
A management verb for removing offers from the catalog. |
|
Defines access details for a specific program. |
|
Defines access details for specific airings of a program. |
|
Defines access details for a specific station. |
|
Defines program discovery attributes like rankings, ratings, and promotional badges. |
| Attributes | Description |
id
|
The identifier for the offer catalog. The default value is Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
action
|
Indicates which action to take for a catalog submission. Default value is Data Type: CatalogActionType |
↑ Back to top
OriginalBroadcastType
The type of broadcast the station provides. Valid values: TV, VOD, Radio, Full Power Broadcast, Low Power Broadcast, Cable Only, Digital Broadcast Network, Network, Satellite, Split, Over the Top. An example of Split is full power broadcast during day and low power broadcast at night.
| Property | Detail |
|---|---|
| Parent Elements |
Station |
| Data Type | OriginalBroadcastType |
↑ Back to top
Other
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 |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
List of genres. |
|
List of the Keyword elements represented by a localized string. The catalog system uses keywords as search terms for the program. |
|
List of the Rating elements. |
|
List of the Studio elements. |
|
List of the Credits elements. |
|
List of the Tag elements. |
|
List of localized durations applied to a program. |
|
Enumerated value describing the characteristics of the picture color. |
|
List of the ReleaseDate elements. |
|
List of the Sport elements. |
|
List of the League elements. |
|
List of the Team elements. |
|
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 Data Type: long |
↑ Back to top
PersonName
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 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
PersonNames
List containing the "person name" in different languages.
| Property | Detail |
|---|---|
| Parent Elements |
Credit |
| Data Type | PersonNameList |
| Child Elements | Description |
Required |
The name of the contributor. |
↑ Back to top
PictureColor
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 |
MovieTVEpisodeExtraSportsEventEventOther |
| 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
Player
Participating player for a match or game.
| Property | Detail |
|---|---|
| Parent Elements |
Players |
| Data Type | PlayerType |
| Child Elements | Description |
|
List of localized player names. |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
↑ Back to top
PlayerName
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
PlayerNames
List of localized player names.
| Property | Detail |
|---|---|
| Parent Elements |
Player |
| Data Type | PlayerNameList |
| Child Elements | Description |
Required |
Name of the player. |
↑ Back to top
Players
List of participating players for a match or game.
| Property | Detail |
|---|---|
| Parent Elements |
SportsEvent |
| Data Type | PlayerList |
| Child Elements | Description |
Required |
Participating player for a match or game. |
↑ Back to top
PolicyCatalog
Policies define availability rules and restrictions for content distribution.
| Property | Detail |
|---|---|
| Parent Elements |
DataCollections |
| Data Type | PolicyCatalogType |
| Child Elements | Description |
|
Management verb for removing policies from the policy catalog. |
|
Defines regional availability rules and restrictions. |
|
Defines entitlement details to access content. |
| Attributes | Description |
id
|
Unique identifier for the policy catalog. The default value is Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
action
|
Indicates which action to take for a catalog submission. Default value is Data Type: CatalogActionType |
↑ Back to top
PostalCode
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 |
AddressRegion |
| Data Type | string |
↑ Back to top
ProgramAiringOffer
Defines access details for the airing.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramAiringOffers |
| Data Type | ProgramAiringOfferType |
| Child Elements | Description |
Required |
Program airing details. |
Required |
List of entitlements for content access. |
|
Contains available video resolution options. |
|
Contains available video attribute options. |
|
Contains available audio attribute options. |
|
Indicates ads in the program. This is an empty element. |
|
List of the Tag elements. |
|
List of the LaunchTarget elements. |
| Attributes | Description |
start
|
Subscription availability start time. Data Type: DateTimeType |
end
|
Subscription availability end time. Data Type: DateTimeType |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
scheduleCatalogRef
|
Reference to the catalog that contains the airing. The default value is Data Type: ID |
↑ Back to top
ProgramAiringOffers
List of airing offers.
| Property | Detail |
|---|---|
| Parent Elements |
OfferCatalog |
| Data Type | ProgramAiringOffersType |
| Child Elements | Description |
Required |
Defines access details for the airing. |
| Attributes | Description |
id
Required |
The identifier for the airing offer. Data Type: ID |
version
|
The version for the airing offer. Default value is Data Type: long |
programRef
Required |
Reference identifier that links this offer to a specific program or program airing. Data Type: ID |
programCatalogRef
|
Reference to the catalog that contains the offered program or program airing. The default value is Data Type: ID |
↑ Back to top
ProgramCatalog
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 |
|
A management verb for removing programs from the catalog. |
|
Represents a movie program, whose content is not serialized, and which is prerecorded when originally released. |
|
Represents a TV episode program, which must be related to a TV season and TV series. |
|
Represents a TV season program. TV seasons are hierarchical entities. |
|
Represents a TV series program. TV series are hierarchical entities. |
|
Represents a sports program, which models a sport event with one or more participants or teams. |
|
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. |
|
Represents an off-air program, which communicates to customers that no programs are airing at this time. |
|
Represents an other program, which provides basic information for program types that don't fit into well-defined categories. |
|
Represents a to-be-announced program, which is a placeholder for upcoming programming. |
|
Represents extra content related to a program. |
| Attributes | Description |
id
|
The identifier for the program catalog. The default value is Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
action
|
Indicates which action to take for a catalog submission. Default value is Data Type: CatalogActionType |
↑ Back to top
ProgramDiscovery
Defines program discovery attributes like rankings, ratings, and promotional badges.
| Property | Detail |
|---|---|
| Parent Elements |
OfferCatalog |
| Data Type | ProgramDiscoveryType |
| Child Elements | Description |
|
List of the Rank elements. |
|
List of the CustomerRating elements. |
|
List of the Badge elements. |
| Attributes | Description |
start
|
Discovery availability start time. Data Type: DateTimeType |
end
|
Discovery availability end time. Data Type: DateTimeType |
territories
|
Countries where the program or station can be discovered. Comma-separated list of territory codes, such as Data Type: TerritoriesType |
programRef
Required |
Reference identifier that links this offer to a specific program or program airing. Data Type: ID |
programCatalogRef
|
Reference to the catalog that contains the offered program or program airing. The default value is Data Type: ID |
↑ Back to top
ProgramOffer
Defines access details for the program.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramOffers |
| Data Type | ProgramOfferType |
| Child Elements | Description |
Required |
List of entitlements for content access. |
|
Contains available audio language options. |
|
Contains available subtitle language options. |
|
Contains available video resolution options. |
|
Contains available video attribute options. |
|
Contains available audio attribute options. |
|
Indicates ads in the program. This is an empty element. |
|
List of the Tag elements. |
|
List of geographic restrictions to access the content. |
|
List of the LaunchTarget elements. |
| Attributes | Description |
start
|
Subscription availability start time. Data Type: DateTimeType |
end
|
Subscription availability end time. Data Type: DateTimeType |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
↑ Back to top
ProgramOffers
List of program offers.
| Property | Detail |
|---|---|
| Parent Elements |
OfferCatalog |
| Data Type | ProgramOffersType |
| Child Elements | Description |
Required |
Defines access details for the program. |
| Attributes | Description |
id
Required |
The identifier for the program offer. Data Type: ID |
version
|
The version for the program offer. Default value is Data Type: long |
programRef
Required |
Reference identifier that links this offer to a specific program. Data Type: ID |
programCatalogRef
|
Reference to the catalog that contains the offered program. The default value is Data Type: ID |
↑ Back to top
Rank
Rank is a score relative to every other program in the catalog. Lower value means that the program is ranked higher than other items with a higher value. The highest rank an item can have is 1. It is acceptable for multiple items to have the same rank.
| Property | Detail |
|---|---|
| Parent Elements |
Ranks |
| Data Type | RankType - A structure that contains the ranking of the program. |
| Attributes | Description |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
value
|
Data Type: nonNegativeInteger |
↑ Back to top
Ranks
List of the Rank elements.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramDiscovery |
| Data Type | RankList |
| Child Elements | Description |
Required |
Rank is a score relative to every other program in the catalog. |
↑ Back to top
Rating
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 |
|
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 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
Ratings
List of the Rating elements.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOtherAiringStation |
| Data Type | RatingList |
| Child Elements | Description |
Required |
Provides certification for age-appropriate viewer restrictions. |
↑ Back to top
Region
Defines specific geographical areas using territories and postal codes.
| Property | Detail |
|---|---|
| Parent Elements |
RegionPolicy |
| Data Type | RegionType |
| Child Elements | Description |
|
Specific postal codes for the region. |
| Attributes | Description |
filter
Required |
Postal code filters for the region. Valid values:
Data Type: PolicyFilterType |
territories
Required |
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
↑ Back to top
RegionPolicy
Defines geographical availability rules for specific regions and postal codes.
| Property | Detail |
|---|---|
| Parent Elements |
PolicyCatalog |
| Data Type | RegionPolicyType |
| Child Elements | Description |
|
Defines specific geographical areas using territories and postal codes. |
| Attributes | Description |
id
Required |
Unique identifier for this regional policy. Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
↑ Back to top
RelatedExternalIds
Contains external system identifiers. Allows cross-referencing with third-party systems.
| Property | Detail |
|---|---|
| Parent Elements |
isExtraOfisRelatedTo |
| Data Type | ExternalIdList |
| Child Elements | Description |
Required |
Links the program or other entity to an external source. |
↑ Back to top
Relationships
Indicates relationships between content.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesSportsEventEventOtherExtra |
| Data Type | RelationshipsType - Container for all relationships between content items. |
| Child Elements | Description |
|
Relationship of a TV season to its parent TV series. |
|
Relationship of a TV episode to its parent TV season. |
|
Relationship of a TV episode directly to its TV series. |
|
Relationship of the extra content, such as trailers, featurettes, or pre-game and post-game content. |
|
General relationship between content. For example, Lord of the Rings is related to The Hobbit. |
↑ Back to top
ReleaseDate
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 Data Type: TerritoriesType |
releaseType
|
Specifies the distribution mechanism for the release. 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
ReleaseDates
List of the ReleaseDate elements.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOther |
| Data Type | ReleaseDateList |
| Child Elements | Description |
Required |
Date that the program was first available in its original territory or specified territory. |
↑ Back to top
Round
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 |
SportsEventEvent |
| Data Type | RoundType - Structure that hosts the round associated with the sports program. |
| Child Elements | Description |
|
List of the RoundName elements. |
|
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
RoundName
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
RoundNames
List of the RoundName elements.
| Property | Detail |
|---|---|
| Parent Elements |
Round |
| Data Type | RoundNameList |
| Child Elements | Description |
Required |
The round name string with an optional translation language. |
↑ Back to top
RunLength
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 Data Type: TerritoriesType |
↑ Back to top
RunLengths
List of localized durations applied to a program.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeExtraSportsEventEventOther |
| Data Type | LocalizedRunLengthList |
| Child Elements | Description |
Required |
The unedited length of a program and the territory or territories to which it applies. |
↑ Back to top
Schedule
Represents a block of airings. All schedule dates and times must be in UTC format. Each schedule requires a unique ID and version number, where submitting a new schedule with an existing ID completely replaces the previous version.
Use schedule elements to define linear schedules. The schedule element must provide continuous non-overlapping station programming for the full 24-hour period. Suggested ID Convention: "STATION_YYYYMMDD". Required attributes: date, stationRef.
| Property | Detail |
|---|---|
| Parent Elements |
ScheduleCatalog |
| Data Type | ScheduleType |
| Child Elements | Description |
Required |
Airing entities associate programs with specific time slots. |
| Attributes | Description |
id
Required |
The identifier for the schedule. Data Type: ID |
version
|
The version for the schedule. Default value is Data Type: long |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
date
Required |
Date for the 24-hour non-overlapping station schedule. Data Type: DateType |
stationRef
Required |
Reference to the station used for the schedule. Data Type: ID |
stationCatalogRef
|
Reference to the station catalog that contains the station used for the schedule. The default value is Data Type: ID |
programCatalogRef
|
Reference to the program catalog that contains the programs used for the schedule. The default value is Data Type: ID |
↑ Back to top
ScheduleCatalog
Container which can hold multiple schedules.
| Property | Detail |
|---|---|
| Parent Elements |
DataCollections |
| Data Type | ScheduleCatalogType |
| Child Elements | Description |
|
A management verb for removing schedules from the catalog. |
|
Represents a block of airings. |
| Attributes | Description |
id
|
The identifier for the schedule catalog. The default value is Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
action
|
Indicates which action to take for a catalog submission. Default value is Data Type: CatalogActionType |
↑ Back to top
Season
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 |
|
List of Season elements when the match is being played. |
|
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
SeasonName
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
SeasonNames
List of Season elements when the match is being played.
| Property | Detail |
|---|---|
| Parent Elements |
Season |
| Data Type | SeasonNameList |
| Child Elements | Description |
Required |
The season name when the match is being played. |
↑ Back to top
SeriesTitles
List of Title elements. A Title element represents the title of the program and the locale to which it applies.
| Property | Detail |
|---|---|
| Parent Elements |
isSeasonOfSeriesisEpisodeOfSeasonisEpisodeOfSeries |
| Data Type | TitleList |
| Child Elements | Description |
Required |
A localized string representing the title of the program and the language and territory to which it applies. |
↑ Back to top
ShortDisplayName
Short display name for the entitlement. For example, the text shown below the buy box. Limited to 8 characters.
| Property | Detail |
|---|---|
| Parent Elements |
ShortDisplayNames |
| 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 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
ShortDisplayNames
List of localized short display names for the entitlement.
| Property | Detail |
|---|---|
| Parent Elements |
EntitlementPolicy |
| Data Type | ShortDisplayNameList |
| Child Elements | Description |
Required |
A localized string for the entitlement name. |
↑ Back to top
Sport
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 |
|
List of the SportName elements. |
|
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
SportName
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 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
SportNames
List of the SportName elements.
| Property | Detail |
|---|---|
| Parent Elements |
Sport |
| Data Type | SportNameList |
| Child Elements | Description |
Required |
The name of the sport. For a list of recognized sports, see EMBER Sports. |
↑ Back to top
Sports
List of the Sport elements.
| Property | Detail |
|---|---|
| Parent Elements |
SportsEventOtherExtra |
| Data Type | SportList |
| Child Elements | Description |
Required |
Default name and optionally, language and territory specific names for the sport. |
↑ Back to top
SportsEvent
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 |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
List of genres. |
|
List of the Keyword elements represented by a localized string. The catalog system uses keywords as search terms for the program. |
|
List of the Rating elements. |
|
List of the Studio elements. |
|
List of the Credits elements. |
|
List of the Tag elements. |
|
List of localized durations applied to a program. |
|
Enumerated value describing the characteristics of the picture color. |
|
List of the ReleaseDate elements. |
|
List of the Venue elements. |
|
List of the Sport elements. |
|
List of the League elements. |
|
The official name or number of the season for the match being played. |
|
The tournament associated with the sports program or event. |
|
The round of play associated with a tournament game or match for a sports program. |
|
List of the Team elements. |
|
List of participating players for a match or game. |
|
Gender details for the match or game. |
|
Format details for the match or game. |
|
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. |
|
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 Data Type: long |
↑ Back to top
StateOrProvince
The state or province in the venue address.
| Property | Detail |
|---|---|
| Parent Elements |
Address |
| Data Type | string |
↑ Back to top
Station
Contains station details such as name, image, call signs, and affiliate information. For details on when to use the Station element and when to use the ExternalStation element, see Linear catalogs on the best practices page.
| Property | Detail |
|---|---|
| Parent Elements |
StationCatalog |
| Data Type | StationType |
| Child Elements | Description |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Image elements. |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
|
Unique identifier for the broadcasting station. |
|
List of the Description elements represented by a localized string. |
|
List of genres. |
|
List of the Tag elements. |
|
Contains station category entities. |
|
The type of broadcast the station provides. |
|
List of affiliated networks. |
|
Contains available video resolution options. |
|
List of the Rating elements. |
|
Contains available audio language options. |
|
Contains available subtitle language options. |
| Attributes | Description |
id
Required |
The main identifier for a station entity. Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
name
Required |
The English name for the station that can be used for operations. Data Type: string |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
↑ Back to top
StationCatalog
Defines the customer-facing and management attributes of a station or channel.
| Property | Detail |
|---|---|
| Parent Elements |
DataCollections |
| Data Type | StationCatalogType |
| Child Elements | Description |
|
A management verb for removing stations from the catalog. |
|
Contains station details such as name, image, call signs, and affiliate information. |
|
A station entity that references an external metadata system, with the ability to override certain fields. |
| Attributes | Description |
id
|
The identifier for the station catalog. The default value is Data Type: ID |
version
|
Integer that increases with each revision. Used for version control. Default value is Data Type: long |
action
|
Indicates which action to take for a catalog submission. Default value is Data Type: CatalogActionType |
↑ Back to top
StationCategories
Contains station category entities.
| Property | Detail |
|---|---|
| Parent Elements |
Station |
| Data Type | StationCategoryList |
| Child Elements | Description |
Required |
Enumeration for the category of the station. |
↑ Back to top
StationCategory
Enumeration for the category of the station. Allows stations with similar content to be grouped together. Some station categories are similar to program genres. For stations with homogeneous content, use genres in addition to a station category. The following table lists valid categories.
| Name | Value | Description |
|---|---|---|
| Children | ember_category_children |
Contains programming for young viewers. |
| Classic TV | ember_category_classic_tv |
Contains nostalgic programming, typically over 20 years old. |
| DIY | ember_category_diy |
Hobbies, crafts, and instructional content. For example, cooking, home improvement, real estate, and painting. |
| Education | ember_category_education |
Documentaries, lectures, science, travel, history, and nature. |
| Entertainment | ember_category_entertainment |
Programming with broad appeal. Big budget movies, and the business of show business. |
| Family | ember_category_family |
Contains programming appropriate for all ages. |
| Game Shows | ember_category_game |
Contains unscripted competitions of knowledge, skill, or luck with contestants and prizes. |
| General Programming | ember_category_general |
A mix of programming for many audiences. Over the Air (OTA) local broadcast affiliate stations (LBAs) typically fall in this category. |
| Movies | ember_category_movies |
Typically contains long-format non-serialized content. |
| Music | ember_category_music |
Performances, concerts, music videos, variety shows, and audio only. |
| News | ember_category_news |
Local, national, and world news programming. |
| Seasonal | ember_category_seasonal |
Holiday-based programming. For example, Valentine's Day, Memorial Day, Thanksgiving, and Diwali. |
| Sports | ember_category_sports |
Content focuses on sports and sports-related topics. |
| TV Shows | ember_category_shows |
Contains primarily serialized content. |
| Weather | ember_category_weather |
Local, national, and international weather reporting. |
| Property | Detail |
|---|---|
| Parent Elements |
StationCategories |
| Data Type | StationCategoryType - Enum of station category values. |
| Attributes | Description |
scheme
|
Scheme of the station category. Data Type: string |
↑ Back to top
StationOffer
Defines access details for the station.
| Property | Detail |
|---|---|
| Parent Elements |
StationOffers |
| Data Type | StationOfferType |
| Child Elements | Description |
Required |
List of entitlements for content access. |
|
Contains available audio language options. |
|
Contains available subtitle language options. |
|
Contains available video resolution options. |
|
Contains available video attribute options. |
|
Contains available audio attribute options. |
|
Indicates ads in the program. This is an empty element. |
|
List of the Tag elements. |
|
List of geographic restrictions to access the content. |
|
List of the LaunchTarget elements. |
|
Station transport details. |
| Attributes | Description |
start
|
Subscription availability start time. Data Type: DateTimeType |
end
|
Subscription availability end time. Data Type: DateTimeType |
territories
|
Comma-separated list of territory codes, such as Data Type: TerritoriesType |
↑ Back to top
StationOffers
List of station offers.
| Property | Detail |
|---|---|
| Parent Elements |
OfferCatalog |
| Data Type | StationOffersType |
| Child Elements | Description |
Required |
Defines access details for the station. |
| Attributes | Description |
id
Required |
The identifier for the station offer. Data Type: ID |
version
|
The version for the station offer. Data Type: long |
stationRef
Required |
Reference identifier that links this offer to a specific station. Data Type: ID |
stationCatalogRef
|
Reference to the catalog that contains the offered station. The default value is Data Type: ID |
↑ Back to top
StationTransport
Specifies the information needed to launch a given station title on various devices, services, and presentations.
| Property | Detail |
|---|---|
| Parent Elements |
StationOfferChannel |
| Data Type | StationTransportType - A string that specifies the information needed to launch a given station title. |
| Attributes | Description |
channelnum
Required |
The channel number as displayed to viewers. Can include decimals and subchannels, such as "2.1". Data Type: string |
subsystem
|
The delivery system type. Valid values: Data Type: string |
onid
|
Original Network ID. Unique identifier for the network. Data Type: string |
tsid
|
Transport Stream ID. Identifies the multiplex stream. Data Type: string |
sid
|
Service ID. Identifies the specific service within the transport stream. Data Type: string |
↑ Back to top
Street
The street in the venue address.
| Property | Detail |
|---|---|
| Parent Elements |
Address |
| Data Type | string |
↑ Back to top
Studio
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 |
Required |
List of the StudioName elements. |
|
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
StudioName
StudioNames
List of the StudioName elements.
| Property | Detail |
|---|---|
| Parent Elements |
Studio |
| Data Type | StudioNameList |
| Child Elements | Description |
Required |
Name of the studio. |
↑ Back to top
Studios
List of the Studio elements.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOther |
| Data Type | StudioList |
| Child Elements | Description |
Required |
Reference to the creative organizations. It is an open enumeration type with support for external IDs. |
↑ Back to top
SubtitleLanguage
The subtitle language of the program or station.
| Property | Detail |
|---|---|
| Parent Elements |
SubtitleLanguages |
| Data Type | SubtitleLanguageType - A string that represents the subtitle language for a program. |
| Attributes | Description |
language
Required |
Contains language data for this item. Data Type: LanguageType |
closed
|
True for closed captions; false or omitted for burned-in subtitles. Data Type: boolean |
default
|
Indicates the default subtitle language in a list of Data Type: boolean |
↑ Back to top
SubtitleLanguages
Contains available subtitle language options.
| Property | Detail |
|---|---|
| Parent Elements |
AiringProgramOfferStationOfferStation |
| Data Type | SubtitleLanguageList |
| Child Elements | Description |
Required |
The subtitle language of the program or station. |
↑ Back to top
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.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOtherOffAirToBeAnnounced |
| Data Type | SynopsisList |
| Child Elements | Description |
Required |
A concise but entertaining summary of the major points of the program. Synopses are typically longer than descriptions. |
↑ Back to top
Synopsis
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 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
Tag
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
Tags
List of the Tag elements.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOtherOffAirToBeAnnouncedAiringProgramOfferStationOfferProgramAiringOfferStationEntitlementPolicy |
| Data Type | TagList |
| Child Elements | Description |
Required |
Additional metadata used to categorize, promote, or otherwise apply custom processing to a program or airing. |
↑ Back to top
Team
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 |
|
List of the TeamName elements. |
|
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
TeamName
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
TeamNames
List of the TeamName elements.
| Property | Detail |
|---|---|
| Parent Elements |
Team |
| Data Type | TeamNameList |
| Child Elements | Description |
Required |
The team name string with an optional translation language. |
↑ Back to top
Teams
List of the Team elements.
| Property | Detail |
|---|---|
| Parent Elements |
SportsEventOtherExtra |
| Data Type | TeamList |
| Child Elements | Description |
Required |
Participating teams for a match or game. |
↑ Back to top
Title
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 |
TitlesSeriesTitles |
| 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 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
Titles
List of Title elements. A Title element represents the title of the program and the locale to which it applies.
| Property | Detail |
|---|---|
| Parent Elements |
MovieTVEpisodeTVSeasonTVSeriesExtraSportsEventEventOtherOffAirToBeAnnouncedStationExternalStation |
| Data Type | TitleList |
| Child Elements | Description |
Required |
A localized string representing the title of the program and the language and territory to which it applies. |
↑ Back to top
ToBeAnnounced
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 |
|
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
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 Data Type: long |
↑ Back to top
Tournament
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 |
SportsEventEvent |
| Data Type | TournamentType - Structure that hosts the tournament associated with the sports program. |
| Child Elements | Description |
|
List of the TournamentName elements. |
|
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
TournamentName
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
TournamentNames
List of the TournamentName elements.
| Property | Detail |
|---|---|
| Parent Elements |
Tournament |
| Data Type | TournamentNameList |
| Child Elements | Description |
Required |
The tournament name string with an optional translation language. |
↑ Back to top
TVEpisode
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 |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
List of genres. |
|
List of the Keyword elements represented by a localized string. The catalog system uses keywords as search terms for the program. |
|
List of the Rating elements. |
|
List of the Studio elements. |
|
List of the Credits elements. |
|
List of the Tag elements. |
|
List of localized durations applied to a program. |
|
Enumerated value describing the characteristics of the picture color. |
|
List of the ReleaseDate elements. |
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 Data Type: long |
edit
|
A comma-separated list of edit types for a program. Allows you to specify multiple edit types, such as Data Type: EditTypeList |
↑ Back to top
TVSeason
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 |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
List of genres. |
|
List of the Keyword elements represented by a localized string. The catalog system uses keywords as search terms for the program. |
|
List of the Rating elements. |
|
List of the Studio elements. |
|
List of the Credits elements. |
|
List of the Tag elements. |
|
List of the ReleaseDate elements. |
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 Data Type: long |
edit
|
A comma-separated list of edit types for a program. Allows you to specify multiple edit types, such as Data Type: EditTypeList |
↑ Back to top
TVSeries
Represents a TV series program. TV series are hierarchical entities.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramCatalog |
| Data Type | TVSeriesType |
| Child Elements | Description |
|
Contains external system identifiers. Allows cross-referencing with third-party systems. |
Required |
List of Title elements. A Title element represents the title of the program and the locale to which it applies. |
|
List of the Description elements represented by a localized string. |
|
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.
|
|
List of the Image elements. |
|
List of genres. |
|
List of the Keyword elements represented by a localized string. The catalog system uses keywords as search terms for the program. |
|
List of the Rating elements. |
|
List of the Studio elements. |
|
List of the Credits elements. |
|
List of the Tag elements. |
|
List of the ReleaseDate elements. |
|
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 Data Type: long |
edit
|
A comma-separated list of edit types for a program. Allows you to specify multiple edit types, such as Data Type: EditTypeList |
↑ Back to top
Venue
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 |
Required |
List of the VenueName elements. |
|
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
VenueName
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
VenueNames
List of the VenueName elements.
| Property | Detail |
|---|---|
| Parent Elements |
Venue |
| Data Type | VenueNameList |
| Child Elements | Description |
Required |
Name of the venue with an optional translation language. |
↑ Back to top
Venues
List of the Venue elements.
| Property | Detail |
|---|---|
| Parent Elements |
SportsEventEvent |
| Data Type | VenueList |
| Child Elements | Description |
Required |
Location information for an event. |
↑ Back to top
VideoAttribute
Video attributes of the program that are included as part of the offer. Examples include SDR, HDR10+, and Dolby Vision.
| Property | Detail |
|---|---|
| Parent Elements |
VideoAttributes |
| Data Type | A string. |
↑ Back to top
VideoAttributes
Contains available video attribute options.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramOfferProgramAiringOfferStationOffer |
| Data Type | VideoAttributeList |
| Child Elements | Description |
Required |
Video attributes of the program that are included as part of the offer. |
↑ Back to top
VideoResolution
Closed enumeration indicating the video resolution offered. Value valids are SD, HD, FullHD, 4K, and 8K.
| Property | Detail |
|---|---|
| Parent Elements |
VideoResolutions |
| Data Type | ResolutionType |
↑ Back to top
VideoResolutions
Contains available video resolution options.
| Property | Detail |
|---|---|
| Parent Elements |
ProgramOfferProgramAiringOfferStationOfferStation |
| Data Type | VideoResolutionList |
| Child Elements | Description |
Required |
Closed enumeration indicating the video resolution offered. Value valids are SD, HD, FullHD, 4K, and 8K.
|
↑ Back to top
Last updated: May 27, 2026
