Required

<umcCatalog> is the root element and has three attributes.

version (required)

Attribute version will indicate the feed specification version that this feed conforms to (value must be "3.6" for this specification).

teamld (required)

Your Team ID as registered with Apple.

catalogId (required)

Unique catalog identifier (as identified during Apple catalog registration).

Example: com.catalog.acme

<umcCatalog version="3.6" xmlns:umc="https: //www.tbd.com/ spec/umc- catalog/" teamId="VT6C486PN U" catalogId="com.catalog.acme">

totalItemCount

Required

The total number of <item> elements published in this feed across all pages.

208

link

Optional

Indicates next page URL for paginated response.

Feed assumed complete or “not paginated” when missing.

rel (required)

When included with attribute rel=“next”, the value "next" is used to indicate that this link is for the next page in a paginated feed.

href=”https://api.acme.net/catalog/endpoint?page=2"

lastBuildDate

Required

Feed build date.

YYYY-MM- DDThh:mm:ss.sTZD

ISO 8601 Format

• YYYY is four-digit year

• MM is two-digit month

  (01=January, etc.)

• DD is two-digit day of month (01 through 31)

• hh is two digits of hour (00 through 23) (am/pm NOT allowed)

• mm is two digits of minute (00 through 59)

• ss is two digits of second (00 through 59)

• s is one or more digits representing a decimal fraction of a second

• TZD is time zone designator (Z or +hh:mm or -hh:mm)

2015-03-08T18:00:12-07:00

title

Optional

Human-readable feed title.

Catalog Feed

description

Optional

Human-readable feed title.

Catalog Feed Sample

defaultLocale

Required

The locale to be used by default when a locale is not explicitly provided for various localized attributes. The locale should be specified in BCP-47 Format.

en-US

<item>

Required (repeatable)

Contains one or more content items of different content types. Refer to Item Schema Definition.

<item contentType="movie"contentId="CP012391">

Required (repeatable)

<item> has two attributes and contains one or more content items of different content types.

contentType

Indicates the type of this item. See Content Type for supported content type values.

movie

contentId (required)

Defines the unique ID you are providing for this item. This ID must be case-sensitive. 1 to 255 characters in length. Example: CP012391

The contentId for a given content item must be consistent and cannot be changed.

CP012391

pubDate

Required

Last item data update date.

YYYY-MM- DDThh:mm:ss.sTZD
 ISO 8601 Format

• YYYY is four-digit year

• MM is two-digit month

  (01=January, etc.)

• DD is two-digit day of month (01 through 31)

• hh is two digits of hour (00 through 23) (am/pm not allowed)

• mm is two digits of minute (00 through 59)

• ss is two digits of second (00 through 59)

• s is one or more digits representing a decimal fraction of a second

• TZD is time zone designator (Z or +hh:mm or -hh:mm)

2019-03-08T18:00:12-07:00

contentGroupId

Optional

Identifier used to group duplicate content items. 1 to 255 characters in length.

CPG1504

title

Required (repeatable)

Item’s title.

1 to 255 characters in length.

locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

type (optional)

Attribute type is used to indicate type of the title. See appendix Title Type for supported title types.

isPhonetic (optional)

Attribute isPhonetic with a value true or false can be supplied to designate titles with different pronunciations. If any meaningful separation units exist, they should be delimited using a space character.

Japanese phonetic title should be provided in full-width Hiragana or Katakana. Providing the phonetic title provides a better search experience for the user.

countriesRestrictedTo (optional)

Attribute countriesRestrictedTo can be used to limit the countries that the title may be used in. The value of this attribute must be a comma-separated string of the two-letter country codes as defined in the ISO 3166 International Standard. If this attribute is not specified, it will be assumed that the title can be used worldwide.

<title locale="en-US">Mountain High</title>

OR

<title locale="en-US", type="additional">
Rocky Mountain High
</title>

OR

<title locale="ja-JP", isPhonetic="true" >ロッキー マウンティ ン ハイ</title>

OR

<title locale="fr-FR" countriesRestrictedTo="FR,CA"> Haute Montagne </title>

OR

<title locale="ja-JP" type=“descriptive">
ロッキーマウンテンスペシャルシーズン
</title>

description

Optional (repeatable)

Item’s description.

0 to 4000 characters in length.


locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

countriesRestrictedTo (optional)

Attribute countriesRestrictedTo can be used to limit the countries that the description may be used in. The value of this attribute must be a comma-separated string of the two-letter country codes as defined in the ISO 3166 International Standard. If this attribute is not specified, then it will be assumed that the title can be used worldwide.

<description locale="es-ES">
 No hay lugar más alto que la Montaña Alta.
 </description>

genre

Optional (repeatable)

The genre of this item. Multiple genres may be defined as an ordered collection of values. See Genre for supported genre values.

<genre>comedy</genre><genre>horror</genre>

rating

Optional(repeatable)

Required for certain geographic regions. Contact your Apple Technical Partner to get requirements for your region.

Sets the rating for this item.

See Content Rating Schema Definition for more details for this element.

advisory

Optional (repeatable)

Required for certain geographic regions. Contact your Apple Technical Partner to get requirements for your region.

Sets the advisories for this item.

systemCode (required)

Attribute systemCode specifies which advisory system the advisory is for.

See Content Advisories and Ratings for systemCode values and rating values. There can only be one rating per systemCode.

level (optional)

Attribute level specifies the severity or the degree of expression of the advisory.

See Content Advisories and Ratings for valid level values. There can only be one level for an advisory.

<advisory systemCode="us- tv">
L</advisory>

credit

Optional (repeatable)

Specifies cast and crew credits. Credits should be provided in billing order.

For TV credits, show regular cast and crew will be provided at the show-item level, seasonal cast and crew will be provided at the season-item level, and episode-specific cast and crew will be provided at the episode-item level.

See Credit Schema Definition for more details for this element.

externalContentId

Optional (repeatable)

Specifies mapping to an equivalent content item in an external catalog.

1 to 255 characters in length.

catalogId (required)

Attribute catalogId will be used to identify the external catalog.

See External Catalog for "catalogId" values that can be used.

<externalContentId catalogId=
 "com.apple.trb.catalog"> EP00282838 </externalContentId>

artwork

Optional (repeatable)

Defines the imagery for this content.

url (required)

Attribute url specifies the URL to the artwork asset.

It is highly recommended to use default HTTP(S) ports for the artwork URLs.

type (required)

Attribute type identifies the type of the artwork from the UMC-defined types specified in Artwork Asset Type table.

locales (optional)

Attribute locales should be a comma-separated list of BCP-47 Format locales for this artwork. Missing locales will be presumed to be non-localized artwork applicable worldwide.

countriesRestrictedTo (optional)

Attribute countriesRestrictedTo can be used to limit the countries that the image may be used in. The value of this attribute must be a comma-separated string of the two-letter country codes as defined in the ISO 3166 International Standard. If this attribute is not specified, then it will be assumed that the title can be used worldwide.

<artwork url="https:// www.acme.com/coverartwork1930.jpg" type="cover_artwork_vertical" locales="en-US"/>

isOriginal

Optional

Specifies if this content is the partner’s original program. This should be set to true only for content items originally produced by or for the partner. When missing, this will be defaulted to false.

<isOriginal> true </isOriginal>

isAdultOnlyContent

* Required if adult-only content is allowed by contract.

Specifies if this contains content that is generally thought to be inappropriate for viewing by children and/or suitable for after-hours viewing. When missing, this will be defaulted to false.

<isAdultOnlyContent> true </isAdultOnlyContent>

originalSpokenLocale

Optional (repeatable)

* Required for certain geographic regions. Contact your Apple Technical Partner to get requirements for your region.

Specifies the original spoken language(s) for this content item. Multiple values should be provided in order of precedence with the primary spoken language being first.

The value should be specified as a string representing a locale in BCP-47 Format.

<originalSpokenLocale>fr-CA <originalSpokenLocale>

productionCountry

Optional (repeatable)

* Required for certain geographic regions. Contact your Apple Technical Partner to get requirements for your region.

The country that is the primary source of funds for the content’s production. This should be the country that provided most of the funds (for example, from national lotteries and other subsidies). Multiple values should be provided in order of precedence with the primary country being first.

The value of this element must be the 2-letter country code for the country of production as defined in the ISO 3166 International Standard.

<productionCountry>US</productionCountry>

countryOfOrigin

Optional (repeatable)

* Required for certain geographic regions. Contact your Apple Technical Partner to get requirements for your region.

The country where the content originates from, for example, the country where the the content was primarily produced, where the main authors and workers reside, where the main producer is established etc. Such determination must be made in accordance with applicable law. Multiple values should be provided in order of precedence with the primary country being first.

The value of this element must be the 2-letter country code for the country of production as defined in the ISO 3166 International Standard.

<countryOfOrigin>CA </countryOfOrigin>

copyrightLine

Optional (repeatable)

Statement that indicates the exclusive legal right for this content. 


0 to 4000 characters in length.

locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

countriesRestrictedTo (optional)

Attribute countriesRestrictedTo can be used to limit the countries that the copyright line may be used in. The value of this attribute must be a comma-separated string of the 2-letter country codes as defined in the ISO 3166 International Standard. If this attribute is not specified, then it will be assumed that the title can be used worldwide.

<copyrightLine locale="en" countriesRestrictedTo ="JP">
2021 Rising Sun Studios, Inc. All Rights Reserved.
</copyrightLine>

additionalItemInfo

Optional (repeatable)

Used to provide string data for this content. 0 to 4000 characters in length.


type (required)

Attribute type identifies the type of additional item information from the UMC-defined types specified in the appendix Additional Item Information Type table.

locale (optional)

Attribute locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

countriesRestrictedTo (optional)

Attribute countriesRestrictedTo can be used to limit the countries that the copyright line may be used in. The value of this attribute must be a comma-separated string of the 2-letter country codes as defined in the ISO 3166 International Standard. If this attribute is not specified, it will be assumed that the value can be used worldwide.

<additionalItemInfo type=“rating_classification_number”> A1B2C3D4 </additionalItemInfo>

primaryLocale

Optional

Used to indicate the primary language for this content. The value should be specified as a string representing a locale in BCP-47 Format.

<primaryLocale>en</primaryLocale>

“Info” element depending on content type

Required

Used to define an “Info” element that contains data specific to its content type, such as <movieInfo> for content type “movie”.

For the list of possible data per content type, see the sections describing the info schema definitions:

• Movie Info Schema Definition

• TV Show Content Type

• TV Season Content Type

• TV Episode Content Type

• Sporting Event Info Schema Definition

<movieInfo><type> feature </type> <duration> 5460 </duration>...</movieInfo>

Specifies cast and crew details.

role (required)

Attribute role will be used to define the credited role, see Credited Role for values. It is highly recommended to include at least one director and/or major actor.

order (optional)

Attribute order will be used to sequence the credits for this item. If order is not provided, credits will be sequenced based on order of appearance in the feed. Typically credits are provided in billing order.

<credit role="actor" order=“1”> <name> Ted Green </name> <character> <characterName>Batman </characterName></character> </credit>

name

Required (repeatable)

Specifies the official name of the credited entity.

1 to 255 characters in length.

locale (optional)

Attribute locale can be used to specify the locale for the name. The locale must be in BCP-47 Format. If no locale attribute is provided, the locale is assumed to be the defaultLocale as specified in the feed header. Multiple locales can be specified in multiple repeated elements.

isPhonetic (optional)

The isPhonetic attribute with a value true or false can be supplied to designate credits with different pronunciations for credited names.

<credit role="actor"> <name locale="en-US"> Bill Jones </name> <name locale="ja-JP" isPhonetic="true"> ベン アフレック </name>

creditedPersonInfo

Optional

Specifies additional information for the credited entity.

<creditedPersonInfo >
 <dateOfBirth>
 1973-10-26
 </dateOfBirth>
 <externalId catalogId=
 “com.apple.trb.cata log">
 174981
 </externalId>
 <externalId catalogId=
 “com.apple.fbk.cata log">
 Seth- MacFarlane-14105972 607
 </externalId>
 <externalId catalogId=
 "com.apple.twi.cata log">
 @SethMacFarlane
 </externalId>
 <externalId catalogId=
 "com.apple.igr.cata log">
 macfarlaneseth
 </externalId>
 </ creditedPersonInfo>

dateOfBirth

Optional

Specifies date of birth for credited entity.

The value is the date of birth in YYYY-MM-DD format.

<dateOfBirth> 1942-09-24 </dateOfBirth>

externalId

Optional (repeatable)

Specifies mapping to an equivalent entity in an external catalog.

1 to 255 characters in length.

catalogId (required)

Attribute catalogId will be used to identify the external catalog.

See External Catalog for catalogId values that can be used.

<externalId catalogId=
 "com.apple.trb.cata log">
 174981
 </externalId>

character

Optional (repeatable)

Specifies the name of the character of credited entity.

1 to 255 characters in length.

imageUrl (optional)

Specifies the cast in character image URL for credited entity.


<character imageUrl=“>https:// www.acme.com/ castInCharacter1234 .jpg”>
 <characterName>
 Batman
 </ characterName>
 </character>

characterName

Required (repeatable)

Specifies the official name of the credited entity.

1 to 255 characters in length.

locale (optional)

Attribute locale can be used to specify the locale for the character name. The locale must be in BCP-47 Format. If no locale attribute is provided, the locale is assumed to be the defaultLocale as specified in the feed header. Multiple locales can be specified in multiple repeated elements.

isPhonetic (optional)

The isPhonetic attribute with a value true or false can be supplied to designate credits with different pronunciations for credited names.

<character imageUrl=“https://www.acme.com/castInCharacter1234.jpg”>
 <characterName>
 Batman
 </characterName>
 <characterName 
 locale=“jp-JP”
 isPhonetic=“true”>
 バットマン
 </characterName>
</character>

Specifies the rating for an item.

system code (required)

Attribute systemCode specifies which system the rating is for.

value (required)

Attribute value specifies the rating code.

See Content Advisories and Ratings for supported systemCode values and rating value. There can only be one rating value per systemCode.

<rating systemCode=“mpaa" value=“R” />

reason

Optional (repeatable)

Specifies the rating reason as supplied by the ratings board for the corresponding rating system.

1 to 4000 characters in length.

locale (optional)

Attribute locale can be used to specify the locale for the rating reason. The locale must be in BCP-47 Format. If no locale attribute is provided, the locale is assumed to be the defaultLocale as specified in the feed header. Multiple locales can be specified in multiple repeated elements.

<rating systemCode=“mpaa" value=“PG-13”>
 <reason locale=“en”>
 for sequences of violence and action.
 </reason>
 <reason locale=“fr”>
 pour les séquences de violence et d’action.
 </reason>
</rating>

type

Required

See Movie Type.

• feature

• short

duration

Optional

The duration of this content in seconds; numeric integer, valid values range from 1 to 86400.

9000

studio

Optional (repeatable)

A list of studio elements each providing the name of a studio that produced this content. 1 to 255 characters in length.

Platonic Studios

originalReleaseDate

Required (repeatable)

Describes the date of an original release in a country or worldwide. This is typically the theatrical release of the movie.

The value is the date of release in YYYY-MM-DD format.

country (optional)

Attribute country indicates the country of release (two letter ISO 3166-2). If not specified, indicates a worldwide release.

type (optional) Attribute type indicates the type of release date. See Release Date Type for supported values. If not specified, the value theatrical is assumed.

2019-03-08

OR

2021-01-01 to indicate a release year “2021”

version

Optional

See Movie Version. If not supplied, the version will be set to standard.

• standard

• unrated

type

Required

Type of TV episode. See TV Episode Type.

standard

duration

Optional

The duration of this content in seconds; numeric integer, valid values range from 1 to 86400.

9000

originalAirDate

Required*

* Required if localAirDate is not provided.

The date that this episode originally aired in its country of origin. If this episode never aired on TV, this should be the date this episode was first available in its country of origin. This should be in YYYY-MM-DD format.

2019-03-13

localAirDate

Required* (repeatable)

* Required if originalAirDate is not provided.

The date that this episode aired in the countries specified. This is the first time this episode aired on any partner in the countries specified. If this episode never aired on TV, this should be the date this episode was first available in the countries specified. This should be in YYYY- MM-DD format.

countries (required)

Attribute countries must be used to specify the countries for which premiere date applies to. The value of this attribute must be a comma-separated string of the two-letter country codes as defined in the ISO 3166 International Standard. Multiple countries can be grouped together in a comma-separated value string.

<localAirDate countries="DE, FR, ES"> 2012-12-25 </localAirDate> <localAirDate countries="IT, GB">
2014-01-31
</localAirDate>

showContentId

Required

The provider-unique ID for the episode’s TV show as defined by the show contentId.

SHOW4025

seasonContentId

Required* for a standard episode in a show of type series.

* Not applicable for an episode in a show of type miniseries and type seasonless.

The provider-unique ID for the episode’s TV season as defined by the season contentId.

SEASON8820

seasonNumber

Required* for a standard episode in a show of type series.

* Not applicable for an episode in a show of type miniseries and type seasonless.

The sequential season number for this episode, specified as a non-negative integer value.

3

episodeNumber

Required* for a standard episode in a series and miniseries.

*Optional for a standard episode in a seasonless TV show.

The sequential episode number of this episode within this season; Specified as a non-negative integer or decimal value. For decimal episode numbers, only values up to one decimal place are supported.

<episodeNumber>7</episodeNumber>

<episodeNumber>1.5</episodeNumber>

<episodeNumber>0</episodeNumber>

productionNumber

Optional

A string identifying the production number of this episode.

1 to 255 characters in length.

01F01

startDate

Required

The scheduled starting date and time of the ISO 3166 International Standard: YYYY-MM-DDThh:mm:ss.sTZD

• YYYY is four-digit year

• MM is two-digit month (01=January, etc.)

• DD is two-digit day of month (01 through 31)

• hh is two digits of hour (00 through 23) (am/pm NOT allowed)

• mm is two digits of minute (00 through 59)

• ss is two digits of second (00 through 59)

• s is one or more digits representing a decimal fraction of a second

• TZD is time zone designator (Z or +hh:mm or -hh:mm)

2016-06-04T16: 00:00-07:00

sportName

Required

The abbreviation of the sport or sub-sport (if any) for this sporting event. For values supported, see Catalog Feed Specification Addendum for Sport Names and League Abbreviations.

<sportName> soccer </sportName>

<league>

Required

Describes the official governing body (such as league or federation) associated with the sporting event.

leagueId (optional)

Attribute leagueId must be a unique ID for the league.

1 to 255 characters in length.

league leagueId="8"><abbreviation> nba </ abbreviation> <name> National Basketball Association </name> </league>

abbreviation

Required

The abbreviation for this league or tournament. For values supported, see Catalog Feed Specification Addendum for Sport Names and League Abbreviations.

mlb

name

Optional

The full name of the league. For values supported, see Catalog Feed Specification Addendum for Sport Names and League Abbreviations.

Major League Baseball

<sportSeason>

Optional

Describes the details of the part of the year in which the sporting event occurs.

<sportSeason>
 <year>2016</ year> <name> 2016-2017 NBA Season </name>
 <name locale="fr- FR"> 2016-2017 NBA saison </name> <type> regular </type> </sportSeason>

year

Required

This should be the calendar year for the sport season. If the sport season spans consecutive years (2015-2016 for example), this should be the first year, ”2015” in this case.

2015

name

Optional (repeatable)

The full name of the sport season.

1 to 255 characters in length.

locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

2016-2017 La Liga Season

type

Optional

This is the type qualifier for the sport season (such as regular or pre-season); see Sport Season Type for supported values.

• pre

• regular

• post

<venue>

Required*

* Required if <competitor> is not provided.

The place where the event occurs.

City and state names should be spelled out fully, not abbreviated.

venueId (optional)

Attribute venueId should be a unique ID for the event venue. Note that this should be unique across all venues.

1 to 255 characters in length.

<venue venueId="126"> <name locale=“en- US”> Santiago Bernabéu Stadium </name> <name locale=“es- ES”> Estadio Santiago Bernabéu </name> <city locale=“en- US”> Madrid </city> <country> ES </country> </venue>

name

Required (repeatable)

The full name of the event venue.

1 to 255 characters in length.

locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

Britannia Stadium

city

Required (repeatable)

The city where the venue is located.

1 to 255 characters in length.

locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

Stoke-on-Trent

state

Optional (repeatable)

The state or region where the venue is located.


1 to 255 characters in length.

locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

Staffordshire

country

Required

The country where the venue is located. The value of this element must be the two-letter country code for the country as defined in the ISO 3166 International Standard.

• UK

• US

• CA

• AU

competitor

Required* (repeatable)

* Required if <venue> is not provided.

A team or person who takes part in the sporting event.

competitorId (optional)

Attribute venueId should be a unique ID for the event venue. Note that this should be unique across all venues.

1 to 255 characters in length.

<competitor competitorId=" 24"> <name locale="en- US"> Warriors </name> <name locale="en-US" type="addition al"> Golden State Warriors </name> <location> Oakland </location> <abbreviation>
 GSW </ abbreviation> <isHome> true </ isHome> </competitor>

name

Required (repeatable)

The name (team name, nickname, or person name) of the competitor with the location excluded.

1 to 255 characters in length.

locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

type (optional)

Attribute type with a value of "additional" can be supplied to designate secondary names.

Rockies

homeLocation

Optional

The home place or the name of college or university for the competitor.

• Colorado

• Duke

abbreviation

Optional

The common/unique abbreviation for the team.

LAL

isHome

Optional

Boolean true/false indicating if the venue is the home location for this competitor (team). For individual sports (such as tennis doubles) this is used to group players on one side versus another.

true

isPerson

Optional

Boolean true/false indicating if this competitor is a person or a team.

false

<eventRound>

Optional

Provides additional data for post-season playoff/ tournament games.

<eventRound> <name> Western Conference Finals </name> <gamesInRound> 7 </ gamesInRound> <gameNumber>
 3 </ gameNumber> </eventRound>

name

Required (repeatable)

The full name of the event round.

1 to 255 characters in length.

locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

Eastern Conference Final

gamesInRound

Optional

The total number of games in the series or round.

7

gameNumber

Optional

The number of this event in the series or round.

3

<eventStatus>

Optional

The current status of this event; see Sport Event Status for supported values.

canceled

<tournament>

Optional

Additional data for an event that is part of a tournament.

tournamentId (optional)

Attribute tournamentId should be a unique ID for the tournament. Note that this should be unique across all tournaments.

1 to 255 characters in length.

<tournament tournamentId=" t123"> <name> NCAA Men's Division I Basketball Tournament </name> <name locale="es- ES"> Torneo de baloncesto masculino de la NCAA División I </name> </tournament

name

Required (repeatable)

The full name of the tournament.

1 to 255 characters in length.

locale (optional)

Attribute locale can be used to set the locale in BCP-47 Format. If no locale attribute is provided, the locale will be set to defaultLocale value. Multiple locales can be specified in multiple repeated elements.

U.S. Open

isTBD

Optional

Boolean true/false value. A value of true should be used to indicate that, although this event is scheduled or expected to happen, some data such as the competitor details or the venue details remain to be decided.

true

callSign

Optional (repeatable)

A string sequence of letters identifying the television station, channel, or network this event is televised on.

• CBSS

• ESPN

• FS2

duration

Optional

The duration of this content in seconds; Numeric integer, valid values range 1 to 86400.

1800

editType

Optional

The type of edit for the sporting event; see Sport Event Edit Type for supported values.

condensed

type

Required

See the appendix Extra Type section

• bonus

duration

Optional

The duration of this content in seconds; Numeric integer, valid values range 1 to 86400.

1800

localAirDate

Optional (repeatable)

The date that this extra content aired in the countries specified. This is the first time this extra content aired on any partner in the countries specified. If this extra content never aired on TV, this should be the date this extra content was first available in the countries specified. This should be in YYYY-MM-DD format.

countries (required)

Attribute countries must be used to specify the countries that the air date applies to. The value of this attribute must be a comma-separated string of the 2-letter country codes as defined in the ISO 3166 International Standard. Multiple countries can be grouped together in a comma-separated value string.

<localAirDate countries="DE, FR, ES">2019-12-25 </localAirDate><localAirDate countries="IT, GB">2014-01-31</localAirDate>

studio

Optional (repeatable)

A list of studio elements each providing the name of a studio that produced this content.

1 to 255 characters in length.

Platonic Studios

network

Optional (repeatable)

Contains a name corresponding to the network airing this content.

1 to 255 characters in length.

• BCD

• XYZ

relatedItem

Optional (repeatable)

Specifies a related content item in the same catalog.

See Related Item Schema Definition for more details for this element.

Specifies the details of a related content item in the same catalog.

relatedContentType (required)

Indicates the type of the related item. See appendix Content Type for supported related content type values.

relatedContentId (required)

Defines the unique ID for the related content item in the same catalog.


1 to 255 characters in length.

orderNumber

Optional (repeatable)

The sequential number of this related item within all other related content items. Specified as a non-negative integer value.

country (optional)

Attribute country must be used to specify the countries that the order number applies to. The value of this attribute must be a comma-separated string of the 2-letter country codes as defined in the ISO 3166 International Standard. Multiple countries can be grouped together in a comma-separated value string.

<orderNumber>1</orderNumber> <orderNumber country="US">2</orderNumber

<item>

Optional (repeatable)

Describes a single content item's availability.

content type (required)

Indicates the type of this item. See Content Type for supported content type values.

contentId (required)

Identifies the content for this item from the content catalog.

catalogId (required) Indicates the catalog source for this item contentId. The catalogId provided must match the catalogId as provided in the catalog data feed or an external Apple-registered catalog identifier (see External Catalogs for supported catalogs).

pubDate

Required

Last modified date for this item data.
 YYYY-MM-DDThh:mm:ss.sTZD

ISO 8601 Format

<locators>

Optional

Describes this item’s locators.

Refer to Locators Schema Definition.

* Not applicable for Apple Subscription Video service items (isAppleSubscription=“true ”).

<playableProperties>

Optional

Describes this item’s playable properties.

Refer to Playable Properties Schema Definition.

* Not applicable for content of type tv_show and tv_season.

<linearOffers>

Optional

Describes this item’s offers.

Refer to Linear Offers Schema Definition.

* Not applicable for content of type tv_show and tv_season.

<linearOffer>

Required

(repeatable)

Describes a single offer.

windowStart

Required

Availability start date.
 YYYY-MM-DDThh:mm:ss.sTZD

ISO 8601 Format

windowEnd

Required

Availability end date.
 YYYY-MM-DDThh:mm:ss.sTZD

ISO 8601 Format

isLive

Optional

Indicates if this offer is for the live coverage of an event where the content is available to watch at the time of occurrence, not from a recording. For example: live coverage of sporting events, live news, or live coverage of award shows.

default=false.

<restrictions>

Optional

Defines this offer’s restrictions.

Refer to Restrictions Schema Definition.

<locator>

* Required

(repeatable)

Describes a single locator.

platform (required)

Indicates the locator target platform. See appendix Locator Platform Type section for supported types.

action (required)

Indicates the locator action where:

• “open” directs the user to a landing page for this item.

• “play” directs the user to an immediate video play of this item.

See appendix Locator Action Type for more information.

url (required)

Specifies the direct URL for the platform and action described by this locator.

<audioLocale>

Required

(repeated)

A locale for an audio track.

value (required)

The locale value for audio track, in BCP-47 format.

isPrimary (optional)

Indicates that this locale is the primary audio track.

default=false.

audioFormat

Optional

(repeated)

Audio format available for audio tracks in this locale. If you are providing audio formats, it is strongly recommended to provide primary locale. See Audio Format Type in the appendix.

<timedTextLocaleCollection>

Optional

A list of timed text locales available for specified types.

timedTextLocale

Required

(repeated)

A locale available for specified types. See Timed Text Locale Schema Definition for more details.

value (required)

The locale value in BCP-47 format.

timedTextLocaleTypesToIgnore

Optional

(repeated)

Indicates the types of timed text locale to ignore. See Timed Text Locale Types for supported type values.

<audioDescriptionLocale>

Optional

A locale for Audio Description (also known as DVS) data.

value (required)

The locale value for Audio Description, in BCP-47 format.

isPrimary (optional)

Indicates that this locale is the primary audio track.

default=false.

audioFormat

Optional

(repeated)

Audio format available for audio descriptions in this locale. See Audio Format Type in the appendix.

<videoQuality>

Optional

The quality of the video. See Video Quality Type in the appendix.

<videoColorRange>

Optional

The color range (HDR) of the video.

See Video Color Range Type in the appendix.

<visualDepth>

Optionalrepeated

The visual depth of the video.

See Visual Depth in the appendix.

<restriction>

Optional

(repeatable)

Defines an offer restrictions.

Multiple restrictions may be provided as repeatable elements.

relationship (required)

Indicates the restriction relationship. Possible values are “allow” and “deny”.

type (required)

Indicates the type of the restriction. Possible values are device, tier, device_location, billing_identifier, and content_download.

See appendix Restriction Type for more information.

<serviceOffer>

Required

(repeatable)

Describes a single service offer.

offeringType

Required

The type of offering for this offer.

See appendix section Offering Type.

windowStart

Required

Availability start date.
 YYYY-MM-DDThh:mm:ss.sTZD

ISO 8601 Format

windowEnd

Required

Availability end date.
 YYYY-MM-DDThh:mm:ss.sTZD

ISO 8601 Format

<restrictions>

Optional

Defines this offer’s restrictions.

Refer to Restrictions Schema Definition.

<type>

Required

(repeated)

Indicates the type of this timed text locale. See Timed Text Locale Types for supported type values.

<offer>

Required

(repeatable)

Describes a single offer.

offeringType

Required

The type of offering for this offer.

See appendix section Offering Type.

windowStart

Required

Availability start date.
 YYYY-MM-DDThh:mm:ss.sTZD

ISO 8601 Format

windowEnd

Required

Availability end date.
 YYYY-MM-DDThh:mm:ss.sTZD

ISO 8601 Format

isLive

Optional

Indicates if this offer is for the live coverage of an event where the content is available to watch at the time of occurrence, not from a recording. For example: live coverage of sporting events, live news, or live coverage of award shows.

default=false.

isBroadcast

Optional

Indicates if this offer is available as broadcast, where the window is open only while the content is streamed. Typically a single video stream is available at the same time to all viewers. For example: all live (isLive=true) or event-based offers under VOD services.

default=false.

announceDate

Optional

Date when the content can be announced to be coming soon. YYYY-MM-DDThh:mm:ss.sTZD

ISO 8601 Format

<restrictions>

Optional

Defines this offer’s restrictions.

Refer to Restrictions Schema Definition.

<item>

Optional (repeatable)

Describes a single content item's availability.

contentType (required)

Indicates the type of this item. See appendix Content Type for supported content type values.

contentId (required)

Identifies the content for this item from the content catalog. This ID must be case sensitive.

catalogId (required)

Indicates the catalog source for this item contentId. The catalogId provided must match the catalogId as provided in the catalog data feed or an external Apple-registered catalog identifier (see appendix External Catalogfor supported catalogs).

variantId (optional)
 *Required for Apple Subscription Video services (isAppleSubscription=“true”). This ID must be case sensitive.

Indicates the version of the video content that this item should be associated with. For example, the variant ID may be different for the same video content with different playable properties. When the variantId is unknown, the value of “1” should be used.

pubDate

Required

Last modified date for this item data.
 YYYY-MM-DDThh:mm:ss.sTZD

ISO 8601 Format

<locators>

Optional

Describes this item’s locators.


Refer to Locators Schema Definition.

* Not Applicable for Apple Subscription Video service items (isAppleSubscription=“true ”).

<playableProperties>

Optional

Describes this item’s playable properties. Refer to Playable Properties Schema Definition.

* Not Applicable for content of type tv_show and tv_season.

<offers>

Optional

Describes this item’s offers.
 Refer to VOD Offers Schema Definition.

For content of type tv_show and tv_season, only offers with offering type coming_soon are permitted.