Metadata Specifications

The specs below provide information on each field available for configuring entries in your metadata feed. Each field section contains details on:

• The field name.
• Whether the field is required or optional.
• Maximum instances of the field allowed in each entry.
• Example syntax.
• The available field attributes.

General fields

title

Required | Max 1

Contains title of the content. OpenIngest does not expect attributes to be sent.

Example

<title>Harry Potter and the Goblet of Fire</title>

Attributes

description

Optional | Max 1
For movie, seriesMaster, or episode entityTypes, can use shortDescription, mediumDescription, and/or longDescription instead.

Example

<description> Harry Potter description</description>

Attributes

shortDescription

Optional | Max 1
Merlin has no character lengths but the consuming applications may truncate each of these descriptions.

Example

<gmrss:shortDescription>Harry Potter</gmrss:shortDescription>

Attributes

mediumDescription

Optional | Max 1

Example

<gmrss:mediumDescription>Harry Potter and the Goblet of Fire medium synopsis.</gmrss:mediumDescription>

Attributes

longDescription

Optional | Max 1

Example

<gmrss:longDescription>Hermione and Ron try to help Harry win the tri-wizard tournament.</gmrss:longDescription>

Attributes

pubDate

Optional | Max 1
The pubDate value must be in milliseconds.

Example

<pubDate>1312416000000</pubDate>

Attributes

releaseYear

Optional | Max 1
Release year. Automatically populated from pubDate if not specified.

Example

<releaseYear>2018</releaseYear>

Attributes

dcterms:valid

Required | Max 1
Available and expiration date of the content. Can be used to express local time or universal time.

Example

<dcterms:valid>start=2002-10-13T09:00Z;end=2002-10-17T17:00Z;scheme=W3C-DTF</dcterms:valid>

Attributes

contentRights

Required | Unlimited
Represents the locations and platforms that a piece of content is available in and also the necessary entitlement(s) to view the content. See ContentRights table below.

Example

Attributes

contentProviderName

Preferred | Max 1
The name of the content provider.

Example

<gmrss:contentProviderName>MEDIASET</gmrss:contentProviderName>

Attributes

distributionRights

Required | Unlimited
Information about a set of content which may be made available via a Distributor that is supported by our platform. See DistributionRights table below.

Example

Attributes

restriction

Optional | Unlimited
Restrictions which constrain this piece of content. Field privacyIdentifier is required when type="REST:PRIVACY".

Example

<gmrss:restriction type="REST:PRIVACY"><gmrss:usage>inclusive</gmrss:usage><gmrss:privacyIdentifier>subjectToCoppa</gmrss:privacyIdentifier></gmrss:restriction>

Attributes

distributor

Required | Max 1
Distributor of the video asset. An example from traditional ADI VOD would be distributor=indemand and brand=NBC Universal. An example from an OTT provider would be distributor=Netflix and brand=NBC Universal. This will be saved as a Merlin ProgramMediaAssociation.companies entry with role=Distributor.

Example

<gmrss:distributor>Peacock</gmrss:distributor>

Attributes

languageDetails

Required | Max 1
Create a time marker with the provided offset in milliseconds from the beginning of the asset.

Example

<gmrss:languageDetails title="en-US" description="en-US" episodeTitle="en-US" originalAudio="en-GB" intendedAudience="en-US"/>

Attributes

entityType

Required | Max 1
Type of video. Legal types are Merlin Program types: Movie, Episode, SeriesMaster, SportingEvent, Other, Preview, Extra, Offer, Person, TvSeason. If the entityType=SeriesMaster, Offer, Person, or TVSeason the element should not have any video content (no videoAssetId or media:group elements). Other items in the GMRSS feed can reference this item using the gmrss:entityReference element.

Example

<gmrss:entityType>SeriesMaster</gmrss:entityType>

Attributes

workflowPolicy

Optional | Max 1
Indicates the type of SLEs that will be created for the given event.

Example

<gmrss:workflowPolicy>LIVEONLY</gmrss:workflowPolicy>

Attributes

videoAssetId

Required | Max 1
Provider ID of the video asset. This becomes the seed ID of the Merlin Program that represents this video asset. There should be at most one videoAssetId. If videoAssetId is defined, seriesAssetId should not be defined.

Example

<gmrss:videoAssetId provider="NBC" namespace="SkyShowtime-en-US">GMO_1111</gmrss:videoAssetId>

Attributes

programVariantId

Required | Max 1
Used to create or update programVariant associated with the current item. If canonicalOverride is set, program fields such as title, episodeTitle, description will be copied to programVariant. Namespace of programVariant is language specific.

Example

<gmrss:programVariantId provider="NBC" namespace="SkyShowtime-en-US">GTMV0000645117</gmrss:programVariantId>

Attributes

durableAppId

Required | Max 1
Our app's X1 user-friendly app identifier, should represent the specific app where this content is intended to be played. Identifier of the OTT app the content is contained in. It is required for X1 integration.

Example

<gmrss:durableAppId>Peacock</gmrss:durableAppId>

Attributes

seasonAssetId

Required | Max 1
ID of the TvSeason this item represents, so that Episodes in the season can be connected to it. Other items in the GMRSS feed can reference this item using the gmrss:entityReference element.

Example

<ns2:seasonAssetId namespace="SkyShowtime-en-US" provider="NBC">GTMV0000111111-1</ns2:seasonAssetId>

Attributes

seriesTitle

Required | Max 1
Contains the series title of the content. This will become the title of the Merlin Program for Episodes, if it is not matched to some other canonical Program metadata. The episode title can be set using the title field.

Example

<gmrss:seriesTitle>The Office</gmrss:seriesTitle>

Attributes

sportsSubtitle

Optional | Max 1
The sportsSubtitle of the content. Usually used for SportingEvent.

Example

<gmrss:sportsSubtitle>Eagles vs. Dallas</gmrss:sportsSubtitle>

Attributes

seriesAssetId

Required | Max 1
ID of the SeriesMaster this item represents, so that Episodes in that series can be connected to it. Other items in the GMRSS feed can reference this item using the gmrss:entityReference element.

Example

<gmrss:seriesAssetId namespace="SkyShowtime" provider="NBC">SM5678</gmrss:seriesAssetId>

Attributes

entityReference

Required | Unlimited
Reference to an entity (e.g. Movie, Episode, TvSeason, SeriesMaster). There can be many entity references per one item. The value of the entity reference is an entity ID in a specific namespace. The entityReference field can be used to link an Episode to a SeriesMaster.

Example

<gmrss:entityReference provider="NBC" entityType="EntityCollection">GTMV0000645117</gmrss:entityReference>

Attributes

tagReference

Optional | Unlimited
Reference to a tag. There can be many tag references per one item. The value of the tag reference is a tag ID in a specific namespace. The tagReference field can be used to create a TagAssociation. If an optional attribute type is provided, also the referred tag will be created if it does not exist. The attribute will be only effective if the ingesting partner has the parameter createTags set to true.

Example

<gmrss:tagReference provider="GRACENOTE_VIDEO_DESCRIPTOR">GN164S651XQJ19N</gmrss:tagReference>

Attributes

brand

Required | Max 1
Drives the brand logo selection. Brand of the video asset. An example from traditional ADI VOD would be distributor=indemand and brand=NBC Universal. An example from an OTT provider would be distributor=Netflix and brand=NBC Universal. This will be saved as a Merlin ProgramMediaAssociation.companies entry with role=Provider. Also supports "merlin:" instead of Brand name.

Example

<gmrss:brand>nbcentertainment</gmrss:brand>

Attributes

episodeNumber

Preferred | Max 1
Episode number for episode entity metadata.

Example

<gmrss:episodeNumber>1</gmrss:episodeNumber>

Attributes

seasonNumber

Preferred | Max 1
Season number for episode season metadata.

Example

<gmrss:seasonNumber>2</gmrss:seasonNumber>

Attributes

externalAssetId

Required | Max 1
Id to link to the appropriate in-app page. This id will be used for deeplink generation.

Example

<gmrss:externalAssetId>id123</gmrss:externalAssetId>

Attributes

externalEntityId

Required | Max 1 (for non-native playback)
Id to link to the appropriate in-app page. This id will be used for deeplink generation.

Example

<gmrss:externalEntityId>id123</gmrss:externalEntityId>

Attributes

externalSeriesId

Preferred | Max 1
Id to link to the appropriate in-app page. This id will be used for deeplink generation.

Example

<gmrss:externalSeriesId>id123</gmrss:externalSeriesId>

Attributes

creditAssociation

Optional | Unlimited
Used to create persons (both people and characters) within Merlin and relate those persons to a program through a new credit. For credit types of 'Actor' a partReference field is also required to link the actor-person to the character-person.

Example

<gmrss:creditAssociation type="Actor" partName="Shrek" >
    <gmrss:personReference provider="NBC" namespace="SkyShowtime-en-US">NBC_ID_MM</gmrss:personReference>
    <gmrss:partReference provider="NBC" namespace="SkyShowtime-en-US">NBC_ID_SHREK</gmrss:partReference>
</gmrss:creditAssociation>

Attributes

personReference

Optional | Unlimited
Reference to a person. Use as element in creditAssociation, as standalone field will be deprecated.

Example

<gmrss:personReference provider="LIVE_EXTRA" type="Appearing">PERSON_ID</gmrss:personReference>

Attributes

partReference

Optional | Unlimited
Reference to a part. Use as element in creditAssociation, as standalone field will be deprecated.

Example

<gmrss:creditAssociation type="Actor" partName="Shrek" >
    <gmrss:personReference provider="NBC" namespace="SkyShowtime-en-US">NBC_ID_MM</gmrss:personReference>
    <gmrss:partReference provider="NBC" namespace="SkyShowtime-en-US">NBC_ID_SHREK</gmrss:partReference>
</gmrss:creditAssociation>

Attributes

companyReference

Optional | Unlimited
Reference to a company.

Example

<gmrss:companyReference provider="XUMO" role="Provider">ProviderCompanyName</gmrss:companyReference>

Attributes

liveWindowEnd

Only if live | Max 1
End date of live window asset. The date must be absolute; it must have timezone set or Z (example: 2017-10-13T09:00Z).

Example

<gmrss:liveWindowEnd>2022-03T03:45:00Z</gmrss:liveWindowEnd>

Attributes

visibilityDate

Only if live | Max 1
Date when livod content will surface. The date must be absolute; it must have timezone set or Z (example: 2017-10-13T09:00Z).

Example

<gmrss:visibilityDate>2022-03T03:45:00Z</gmrss:visibilityDate>

Attributes

displayStartDate

Only if live | Max 1
Start date to be displayed livod content. The date must be absolute; it must have timezone set or Z (example: 2017-10-13T09:00Z).

Example

<gmrss:displayStartDate>2022-03T03:45:00Z</gmrss:displayStartDate>

Attributes

availabilityStatus

Only if live | Max 1
Status of content. Values: Upcoming, Live, Concluded, ConcludedWithReplay, Delayed, Cancelled, Replay (VOD).

Example

<gmrss:availabilityStatus>Live</gmrss:availabilityStatus>

Attributes

airingType

Only if live | Max 1
Airing type from listing. Valid values are New, Live, Repeat, Taped, and null value. Required for SportingEvent, Live Programming and TV Series.

Example

<gmrss:airingType>New</gmrss:airingType>

Attributes

subjectToCoppa

Optional | Max 1
Deprecated. Use gmrss:restriction instead. A boolean that indicates whether COPPA - Children's Online Privacy Protection Act - rules should be obeyed. This impacts the amount of data that should be sent to the DAI platform during playback for Ad selection. When this boolean is true, it basically means that the intended audience for the program is children, therefore additional COPPA privacy rules should be enforced. Possible value could be "true" or "false".

Example

<gmrss:subjectToCoppa>false</gmrss:subjectToCoppa>

Attributes

ivod

Optional | Max 1
Whether this gmrss represents an IVOD asset or not.

Example

<gmrss:ivod>true</gmrss:ivod>

Attributes

listingStartTime

Only if IVOD | Max 1
The listingStartTime that this IVOD GMRSS is associated to.

Example

<gmrss:listingStartTime>2021-04-20T00:00:00Z</gmrss:listingStartTime>

Attributes

stationReference

Only if IVOD | Max 1
A reference to a station using provider and provider's native id.

Example

<gmrss:stationReference provider="GRACENOTE">19145</gmrss:stationReference>

Attributes

eventTournamentReference

Optional | Max 1
Reference to an eventTournament. This will create the eventAssociation between the event and the eventTournament if eventReference is also provided.

Example

<gmrss:eventTournamentReference provider="NBC" namespace="SkyShowtime">5145191819992904293</gmrss:eventTournamentReference>

Attributes

sportsConferenceReference

Optional | Max 1
Reference to a sportsConference. This will create the eventAssociation between the event and the sportsConference if eventReference is also provided. If sportsConference doesn't exist or there is no eventReference in the gmrss, it will soft fail.

Example

<gmrss:sportsConferenceReference provider="NBC" namespace="SkyShowtime">5145191819992904290</gmrss:sportsConferenceReference>

Attributes

timeSlice

Optional | Unlimited
Create a time slice with the provided interval with start and end offsets in milliseconds from the beginning of the asset. For livod time slices, absolute time instead of offset must be provided.

Example

<gmrss:timeSlice start="740" end="840" type="Clip" title="Weekend Update" description="Weekend update description"/>

Attributes

timeMarker

Optional | Unlimited
Create a time marker with the provided offset in milliseconds from the beginning of the asset.

Example

<gmrss:timeMarker offset="740" type="EndOfOpeningCredits" title="End of Credits" />

Attributes

offerId

Required | Max 1
This uniquely identifies the offer in the provider's Id space. It is used to support updates to existing Offers (and avoid dupes).

Example

<gmrss:offerId namespace="SkyShowtime" provider="NBC">OFFER1234</gmrss:offerId>

Attributes

offerType

Required | Max 1
SingleMovieBundle - Used for Movies or Episodes with a single "Feature" asset. Extras may optionally be included. Bundle - Used for collections of multiple assets. Extras may optionally be included.

Example

<gmrss:offerType>SingleMovieBundle</gmrss:offerType>

Attributes

price

Required | Max 1
Price in pennies (or smallest units of currency).

Example

<gmrss:price>999</gmrss:price>

Attributes

currencyCode

Required | Max 1
Basic unit of currency.

Example

<gmrss:currencyCode>USD</gmrss:currencyCode>

Attributes

purchaseCategory

Required | Max 1
Indicates the type of transaction, permanent buy vs rental.

Example

<gmrss:purchaseCategory>Buy</gmrss:purchaseCategory>

Attributes

mediaAssociations

Required | Max 1
Contains a list of media associated with the offer. See gmrss:mediaAssociation and mediaAssociation table.

Example

<gmrss:mediaAssociations>
    <gmrss:mediaAssociation>
        <gmrss:role>FEATURE</gmrss:role>
        <gmrss:videoAssetId provider="PROVIDER" namespace="namespace">761022</gmrss:videoAssetId>
    </gmrss:mediaAssociation>
</gmrss:mediaAssociations>

Attributes

mediaAssociation

Required | Unlimited
Media associated with the offer, contained within gmrss:mediaAssociations tag. See mediaAssociation table.

Example

<gmrss:mediaAssociations>
    <gmrss:mediaAssociation>
        <gmrss:role>FEATURE</gmrss:role>
        <gmrss:videoAssetId provider="PROVIDER" namespace="namespace">761022</gmrss:videoAssetId>
    </gmrss:mediaAssociation>
</gmrss:mediaAssociations>

Attributes

videoQuality

Required | Max 1
Defaults to same value as asset, required if different prices are required for lower quality variants.

Example

<gmrss:videoQuality>HD</gmrss:videoQuality>

Attributes

preOrder

Optional | Max 1
True if offer supports pre-order period before it goes live. Defaults to false.

Example

<gmrss:preOrder>true</gmrss:preOrder>

Attributes

external

Optional | Max 1
Boolean that denotes whether the offer is internal or external. Default if field is not present is false (internal).

Example

<gmrss:external>true</gmrss:external>

Attributes

goLiveDate

Optional | Max 1
Date format. The timestamp after which an Offer should no longer be presented to customers as a "pre-order". Not required at pre-order creation, can be sent later as an update.

Example

<gmrss:goLiveDate></gmrss:goLiveDate>

Attributes

lowestPrice

Optional | Max 1
Lowest price of the offer in pennies. May not be set if price is set.

Example

<gmrss:lowestPrice>999</gmrss:lowestPrice>

Attributes

labelPolicy

Optional | Unlimited
Reference to a labelPolicyAssociations.

Example

<gmrss:labelPolicy provider="XUMO">kids14+</gmrss:labelPolicy>

Attributes

videoSource

Optional | Unlimited
Contains gmrss:sourcePart element(s).

Example

Attributes

sourcePart

Optional | Unlimited
Contains media:content element(s) that can be used to describe the source video components. See Content table for details. It also contains gmrss:breakpoint objects.

Example

<gmrss:sourcePart number="1" type="PROGRAM" elementClass="PART" checksum="3sdofijds87343"></gmrss:sourcePart>

Attributes

breakpoint

Optional | Unlimited
Defines where an ad-break should be placed within a given part. The offset is from the start of the part the breakpoint is embedded into. For breaks happening before the start of a part, use 0; for breaks happening at the end of the part use offset >= part.duration.

Example

<gmrss:breakpoint offset="0"/><gmrss:breakpoint offset="600"/>

Attributes

media:status

Required | Max 1
Specifies the status of a media object – whether it's still active or it has been blocked/deleted.

Example

<media:status reason="add" state="active" force="false"/>

Attributes

media:group

Required | Max 1
Contains media:content element(s). See media:content and Content table below for details.

Example

Attributes

media:content

Required | Unlimited
Allows grouping of elements that are effectively the same content, yet different representations. See content table. Contained within media:group tag.

Example

<media:content duration="5047" lang="en-US" gmrss:checksum="3sdofijds87343" gmrss:videoQuality="HD" gmrss:framerate="23.976" gmrss:sap="false" gmrss:dvs="true" gmrss:subtitle="true" gmrss:cc="true" type="MPEG-DASH" url="https://${US_VOD_PROD}/pub/global/xYh/EIw/SKYSHOWTIME_1611852294372.3757_01/cmaf/mpeg_cenc/master_cmaf.mpd" gmrss:videoQualityVariant="1080" startOfEssence="0" startOfMedia="15.123" endOfMedia="5238.123"> ... </media:content>

Attributes

media:rating

Preferred | Unlimited
This allows the permissible audience to be declared. If this element is not included, it assumes that no restrictions are necessary (suitable for all ages). Schemes must be preconfigured in Merlin.

Example

<media:rating scheme="urn:kijkwijzer">5</media:rating>
<media:rating scheme="urn:sky:advisory" subRatings="private:VIOLENCE,private:FEAR,private:SEX,private:DISCRIMINATION,private:DRUGS_ALCOHOL,private:COARSE_LANG">N/A</media:rating>

Attributes

media:thumbnail

Optional | Unlimited
Images for the video or Program the video represents. Note that any size is permissible, but sizes should align with X1 supported sizes otherwise invalid sized images may be ignored. The image URL must be internet accessible so that the X1 image resizing service, Myriad, can retrieve it and store it to the Comcast CDN.

Example

<media:thumbnail height="1080" url="http://fakeimageurl.com/image.jpg" width="1920" type="Provider Poster Art" format="jpeg"/>

Attributes

media:keywords

Optional | Max 1
Relevant keywords/tags describing the media.

Example

<media:keywords></media:keywords>

Attributes

media:copyright

Optional | Max 1
Copyright line for video asset.

Example

<media:copyright>2012 A&E Television Networks</media:copyright>

Attributes

nativeId

Required | Max 1
Used to create or update station associated with the current item. NativeIds must be limited to 6 digits. Namespace will be ignored.

Example

<gmrss:nativeId provider="XUMO" namespace="XUMO">99940</gmrss:nativeId>

Attributes

stationReference

Required | Max 1
A reference to a station using provider and provider's native id. Namespace will be ignored.

Example

<gmrss:stationReference provider="XUMO" namespace="XUMO">9999340</gmrss:stationReference>

Attributes

languageDetails

Preferred | Max 1
Language details for the provided station.

Example

<gmrss:languageDetails primaryBroadcast="en-US" broadcast="en-US" edited="en-US"/>

Attributes

locator

Required | Unlimited
Information required to produce a Firebolt "TuneIntent" when a customer expresses the desire to play a particular linear stream. See Locator table below.

Example

Attributes

channelLineupReference

Required | Max 1
A reference to a ChannelLineup using provider and provider's native id.

Example

<gmrss:channelLineupReference provider="XUMO" namespace="XUMO">Xumo National</gmrss:channelLineupReference>

Attributes

callSign

Required | Max 1
On screen identifier for this channel.

Example

<gmrss:callSign>XFOOD</gmrss:callSign>

Attributes

number

Required | Max 1
Channel number.

Example

<gmrss:number>9999340</gmrss:number>

Attributes

provider

Required | Max 1
The provider of the listing.

Example

<gmrss:provider>XUMO</gmrss:provider>

Attributes

accessibility

Required | Max 1
All subtitle and audio track information available for the listing program. See Accessibility table below.

Example

Attributes

colorDepth

Optional | Max 1
Inherited from station if not provided. Valid values are SDR and HDR.

Example

<gmrss:colorDepth>SDR</gmrss:colorDepth>

Attributes

videoQuality

Required | Max 1
Describes video stream quality.

Example

<gmrss:videoQuality>HD</gmrss:videoQuality>

Attributes

locatorType

Required | Max 1
The type of the locator. For fireboltLocator use FireboltTune. For streamLocator use LinearStream.

Example

<gmrss:locatorType>FireboltTune</gmrss:locatorType>

Attributes

fireboltEntityId

Required | Max 1 (if locatorType is FireboltTune)
The unique entity identifier for the TuneIntent.

Example

<gmrss:fireboltEntityId>*9999340*</gmrss:fireboltEntityId>

Attributes

fireboltChannelType

Required | Max 1
The channel type of the TuneIntent. Valid values are streaming or overTheAir.

Example

<gmrss:fireboltChannelType>streaming</gmrss:fireboltChannelType>

Attributes

fireboltAppContentData

Optional | Max 1
Additional app content data for TuneIntent.

Example

<gmrss:fireboltAppContentData/>

Attributes

locatorPath

Required | Max 1 (if locatorType is LinearStream)
Path to the stream object.

Example

<gmrss:locatorPath>{proto}://d2esudvxtgwpgo.cloudfront.net/v1/master/3fec3e5cac39a52b2132f9c66c83dae043dc17d4/appName/{ads.appName}/xumo_channelId/{xumo_channelId}.{fmt}</gmrss:locatorPath>

Attributes

streamTitle

Required | Max 1 (if locatorType is LinearStream)
Title of stream object.

Example

<gmrss:streamTitle>Xumo Free Movie</gmrss:streamTitle>

Attributes

streamStatus

Required | Max 1 (if locatorType is LinearStream)
Status of stream object.

Example

<gmrss:streamStatus>Production</gmrss:streamStatus>

Attributes

playerConfig

Optional | Unlimited
Type of playerConfig. Values such as externalEntityId, externalChannelType, appContentData, etc. will be preferred over other similar locator fields in locator.

Example

<gmrss:playerConfig key="videoPlatform">com.xumo.play.ipa</gmrss:playerConfig>

Attributes

accessibleName

Optional | Max 1
A station name that satisfies the need of screen readers. Some station names are not human-readable, so this field will contain the human-readable station name.

Example

<gmrss:accessibleName>ESPN</gmrss:accessibleName>

Attributes

offers

Optional | Unlimited
List of single-asset TVOD options available to allow consumption of this content.

Example

<gmrss:offers>
    <gmrss:offer purchaseCategory="Buy" videoQuality="UHD" wholesalePrice="1099" price="1499" currencyCode="USD" billingId="billingId1" merchCategory="Library" featureAvailabilityDate="2025-02-14T05:00:00+0000" externalOfferId="fandangoABC" leaseDuration="172800" playDuration="2592000">
        <dcterms:valid>start=2024-09-24T07:00:00+0000; end=2037-11-18T21:00:00+0000;</dcterms:valid>
    </gmrss:offer>
    <gmrss:offer purchaseCategory="Rent" videoQuality="HD" wholesalePrice="399" price="499" currencyCode="USD" billingId="billingId4" merchCategory="Library" externalOfferId="fandangoDEF" leaseDuration="172800" playDuration="2592000">
        <gmrss:promotions>
            <gmrss:promotion wholesalePrice="299" price="399" currencyCode="USD" billingId="billingId5">
                <dcterms:valid>start=2024-09-24T07:00:00+0000; end=2037-11-18T21:00:00+0000;</dcterms:valid>
            </gmrss:promotion>
        </gmrss:promotions>
    </gmrss:offer>
</gmrss:offers>

Attributes

bundle

Required | Max 1
Bundles do not include Mezz files, rather they reference other separately published assets. It is not necessary for all assets in the bundle to exist at time of bundle publish - assets which arrive later are automatically added to the bundle.

Example

<gmrss:bundle type="SeasonBundle">
    <gmrss:asset type="FEATURE">
        <gmrss:videoAssetId provider="FANDANGO" namespace="FANDANGO">296654</gmrss:videoAssetId>
    </gmrss:asset>
    <gmrss:asset type="FEATURE">
        <gmrss:videoAssetId provider="FANDANGO" namespace="FANDANGO">296658</gmrss:videoAssetId>
    </gmrss:asset>
</gmrss:bundle>

Attributes

Content fields

metadataFile

Optional | Unlimited

Optional references to additional metadata files required to process the source content.

Example

<gmrss:metadataFile type="DolbyVision" url="s3://prod-mgo.com/D24385_DolbyVision.xml" />

Attributes

audioTrack

Required | Unlimited

Describes a single audio track. Audio track metadata attributes are modeled after HTML5. See AudioTrack object for additional elements.

Example

<gmrss:audioTrack dvs="false" index="0" lang="en-US" audioType="Surround" original="true" container="MXF" codec="AAC" url="https://s3./videos/4sepPoK6-sxvDjFyM.m4a" startOfEssence="0" startOfMedia="15.123" endOfMedia="5238.123"/>

Attributes

audioTrack

Required | Max 1

Describes a single audio track. Audio track metadata attributes are modeled after HTML5.

Example

<gmrss:audioTrack dvs="false" index="0" lang="en-US" audioType="Surround" original="true"/>

Attributes

trackAssignment

Optional* | Unlimited

*Required only on sourceParts
Defines the audioTrack layout for a source audio file.

Example

<gmrss:audioTrack audioType="Stereo"><gmrss:trackAssignment number="1">L</gmrss:trackAssignment><gmrss:trackAssignment number="2">R</gmrss:trackAssignment></gmrss:audioTrack>

Attributes

subtitle

Preferred | Unlimited

Represents a single subtitle or cc track. Values are cc, forcedNarrative, or subtitle.

Example

<gmrss:subtitle lang="en-US" role="cc" codec="EBU_STL" url="https://s3./videos/4sepPoK6-sxvDjFyM.m4a"/>

Attributes

videoCodec

Optional | Max 1

String describing the video codec used for the video encoding. Required when type!=APP.

Example

<gmrss:videoCodec>H264</gmrss:videoCodec>

Attributes

videoQualityVariant

Optional | Max 1

String describing the video quality variant used.

Example

<gmrss:videoQualityVariant>HDR</gmrss:videoQualityVariant>

Attributes

audioCodec

Optional | Max 1

String describing the audio codec used for the audio encoding. Required when type!=APP.

Example

<gmrss:audioCodec>H264</gmrss:audioCodec>

Attributes

transport

Optional | Max 1

String describing transport used for the video encoding. Required when type!=APP.

Example

<gmrss:audioCodec>HLS</gmrss:audioCodec>

Attributes

protectionMethod

Optional | Unlimited

String describing the protection method used for the video encoding.

Example

<gmrss:protectionMethod>PLAYREADY</gmrss:protectionMethod>

Attributes

protectionKey

Optional | Max 1

String describing the protection method used for the video encoding.

Example

<gmrss:protectionKey>US-EDC-VOD-1-CENC:PCK_1611852294372.3757_01</gmrss:protectionKey>

Attributes

container

Optional | Max 1

Required when type!=APP.

Example

<gmrss:container>ISOBMFF</gmrss:container>

Attributes

protectionScheme

Optional | Max 1

String describing the protection key/scheme used for the video encoding.

Example

<gmrss:protectionScheme>CENC</gmrss:protectionScheme>

Attributes

protectionSystem

Optional | Max 1

String describing the protection system used for the video encoding.

Example

<gmrss:protectionSystem>CKS</gmrss:protectionSystem>

Attributes

appStartMode

Optional | Max 1

String describing start mode for application content.

Example

<gmrss:appStartMode>video</gmrss:appStartMode>

Attributes

appMetadata

Optional | Max 1

Json blob describing additional metadata for application content.

Example

<gmrss:appMetadata>{"appaction": "details", "appargs": {"query":{"page": "details", "type": "series", "id": "3ZoBZ52QHb4x"}}}</gmrss:appMetadata>

Attributes

optimizedFor

Optional | Unlimited

What this specific media/content is optimized for.

Example

<gmrss:optimizedFor>STREAMING</gmrss:optimizedFor>
<gmrss:optimizedFor>DOWNLOAD</gmrss:optimizedFor>

Attributes

adCompatibility

Optional | Max 1

String for the ad compatibility encoding profile.

Example

<gmrss:adCompatibility>STREAMING</gmrss:adCompatibility>

Attributes

adInstructions

Optional | Unlimited

Value for the specified adInstruction.

Example

<gmrss:adInstructions key="test">break</gmrss:adInstructions>

Attributes

targetPlatforms

Optional | Unlimited

String describing the target platforms for the content.

Example

<gmrss:targetPlatforms>Android</gmrss:targetPlatforms>

Attributes

publicationStatus

Optional | Max 1

Indicates the current content publication step of the asset rendition. Required when type=MEZZ.

Example

<gmrss:publicationStatus status="COMPLETED">TRANSCODE</gmrss:publicationStatus>

Attributes

packageType

Optional | Max 1

Indicates the target asset url DRM. Required when type=MEZZ.

Example

<gmrss:packageType>CMAFNotSecure</gmrss:packageType>

Attributes

watermarkEndDate

Optional | Max 1

ISO 8601 timestamp describing watermark end date.

Example

<gmrss:watermarkEndDate>2023-06-30T12:00:00Z</gmrss:watermarkEndDate>

Attributes

adminTag

Optional | Unlimited

List of adminTags that is used by a2g.

Example

<gmrss:adminTag>a2g-ignore</gmrss:adminTag>

Attributes

categoryPath

Optional | Unlimited

List of category paths to be added.

Example

<gmrss:categoryPath>Dummy Prefix/Dummy Advertise/Suffix</gmrss:categoryPath>

Attributes

originalHeight

Optional | Max 1

This will be used to optimize the Vertical Video playback.

Example

<gmrss:originalHeight>1024</gmrss:originalHeight>

Attributes

originalWidth

Optional | Max 1

This will be used to optimize the Vertical Video playback.

Example

<gmrss:originalWidth>768</gmrss:originalWidth>

Attributes

watermark

Optional | Unlimited

Used to provide an imperceptible digital overlay blended over the videoplane without impact to video quality.

Example

<gmrss:watermark territories="GB" copyrightSourceId="c56a18e7-e64b-4275-8116-c413f2723404" platformWatermark=true invisibleSessionWatermark=false visibleSessionWatermark=true rhythm="PT10M" longevity="PT5M" />

Attributes

Distribution rights fields

valid

Required | Unlimited

Specifies the time window during which the contentRights object is applicable.

Example

<ns3:valid downloadable="false">start=2022-01-01T00:00Z;end=2035-12-31T00:00Z;scheme=W3C-DTF</ns3:valid>

Attributes

contentCatalog

Required | Max 1

The specific app catalog, if an app provider delivers separate customized catalogs for different products. If not provided, contentProviderName is used.

Example

<gmrss:contentCatalog>Netflix</gmrss:contentCatalog>

Attributes

contentCatalogs

Optional | Max 1

Contains a list of specific app catalogs, if an app provider delivers separate customized catalogs for different products. If not provided, contentProviderName is used. This field applies only to Locator Distribution Rights.

Example

<gmrss:contentCatalogs>
    <gmrss:contentCatalog>FAST Native</gmrss:contentCatalog>
    <gmrss:contentCatalog>XUMO</gmrss:contentCatalog>
</gmrss:contentCatalogs>

Attributes

contentClass

Required | Max 1

This is expressed in industry standard terms such as SVOD, TVOD, AVOD, etc. With windows for each.

Example

<gmrss:contentClass>SVOD</gmrss:contentClass>

Attributes

contentTier

Required | Max 1

The provider-specific term for different tiering rules dictating subscription requirements to consume content.

Example

<gmrss:contentTier>Basic</gmrss:contentTier>

Attributes

playRegions

Required | Max 1

Contains a list of viable play regions for this content.

Example

<gmrss:playRegions>
    <gmrss:playRegion type="ISODIVISION">IE</gmrss:playRegion>
    <gmrss:playRegion type="ISOSUBDIVISION">GB-NIR</gmrss:playRegion>
</gmrss:playRegions>

Attributes

playRegion

Required | Unlimited

Specifies the region where the content can be played. Embedded within gmrss:playRegions.

Example

<gmrss:playRegion type="ISOSUBDIVISION">GB-NIR</gmrss:playRegion>

Attributes

downloadable

Optional | Max 1

Determines media availability for download. Defaults to false if not provided.

Example

<gmrss:downloadable>false</gmrss:downloadable>

Attributes

streamable

Optional | Max 1

Determines media availability for streaming. Defaults to true if not provided.

Example

<gmrss:streamable>true</gmrss:streamable>

Attributes

restriction

Optional | Unlimited

Restrictions which constrain this piece of content. Field privacyIdentifier is required when type="REST:PRIVACY".

Example

<gmrss:restriction type="REST:PRIVACY">
    <gmrss:usage>inclusive</gmrss:usage>
    <gmrss:privacyIdentifier>subjectToCoppa</gmrss:privacyIdentifier>
</gmrss:restriction>

Attributes

Content rights fields (legacy)

restriction (legacy)

Required | Unlimited

Space separated list of restrictions, can be used for country or platformCapability restrictions in the gmrss. Types include REST:RIGHTSTERR, DEVICE and PLATFORMCAPABILITY.

Example

<gmrss:restriction type="REST:RIGHTSTERR"><gmrss:region>...</gmrss:region><gmrss:usage>...</gmrss:usage></gmrss:restriction>

Attributes

segment (legacy)

Required | Max 1

No description provided.

Example

<gmrss:segment><gmrss:segmentCode>SKYSHOWTIME</gmrss:segmentCode><gmrss:accessRole>base_d2c</gmrss:accessRole></gmrss:segment>

Attributes

proposition (legacy)

Required | Max 1

No description provided.

Example

<gmrss:proposition><gmrss:territory>PL</gmrss:territory><gmrss:serviceProviderCode>...</gmrss:serviceProviderCode><gmrss:propositionCode>...</gmrss:propositionCode></gmrss:proposition>

Attributes

windowType (legacy)

Required | Max 1

No description provided.

Example

<gmrss:windowType>ARCHIVE</gmrss:windowType>

Attributes

windowMode (legacy)

Required | Max 1

No description provided.

Example

<gmrss:windowMode>SVOD</gmrss:windowMode>

Attributes

valid (legacy)

Required | Max 1

No description provided.

Example

<ns3:valid>start=2022-01-01T00:00Z;end=2035-12-31T00:00Z;scheme=W3C-DTF</ns3:valid>

Attributes

downloadable (legacy)

Optional | Max 1

Defaults to false if not provided.

Example

<gmrss:downloadable>true</gmrss:downloadable>

Attributes

streamable (legacy)

Optional | Max 1

Defaults to true if not provided.

Example

<gmrss:streamable>false</gmrss:streamable>

Attributes