---
title: "Metadata Specifications"
slug: "metadata-specifications"
tags: ["Metadata"]
updated: 2025-08-13T19:26:16Z
published: 2025-08-13T19:26:16Z
canonical: "docs.developer.comcast.com/metadata-specifications"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.developer.comcast.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `overrideCanonicalValue` | optional | false | Indicates if the canonical value should be overridden. |
| `lang` | optional* |  | Language code for the title. Required if overrideCanonicalValue is true. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `type` | optional |  | MIME type of the text. |
| `overrideCanonicalValue` | optional | false | Indicates if the canonical value should be overridden. |
| `lang` | optional* |  | Language code for the description. Required if overrideCanonicalValue is true. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### mediumDescription

**Optional | Max 1**

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### longDescription

**Optional | Max 1**

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### pubDate

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

**Example**

```
<pubDate>1312416000000</pubDate>
```

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### releaseYear

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

**Example**

```
<releaseYear>2018</releaseYear>
```

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### contentProviderName

**Preferred | Max 1** The name of the content provider.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `type` | required |  | Type of restriction. Types include "REST:MANUFACTURER", "REST:CUSGROUP", etc. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `intendedAudience` | required |  | Intended audience language code. |
| `title` | optional |  | Program title language. |
| `description` | optional |  | Program description language. |
| `originalAudio` | optional |  | Language the audio was recorded in. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### workflowPolicy

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the id and id namespace. |
| `namespace` | optional |  | Namespace where the id is unique. Used if multiple ID spaces exist within the same provider to guarantee uniqueness. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the id and id namespace. |
| `namespace` | optional |  | Namespace where the id is unique. Used if multiple ID spaces exist within the same provider to guarantee uniqueness. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the id and id namespace. |
| `namespace` | optional |  | Namespace where the id is unique. Used if multiple ID spaces exist within the same provider to guarantee uniqueness. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### sportsSubtitle

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the id and id namespace. |
| `namespace` | optional |  | Namespace where the id is unique. Used if multiple ID spaces exist within the same provider to guarantee uniqueness. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the tag ID. |
| `entityType` | required |  | Entity type that this reference points to (example: SeriesMaster). |
| `namespace` | optional |  | Namespace where the ID is unique. |
| `isPrimary` | optional |  | Only required when type=entityCollection. isPrimary=true creates a new entityCollection. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the tag ID. |
| `namespace` | optional |  | Namespace where the ID is unique. |
| `type` | optional |  | Type of the tag to create. Allowed values are ProviderEditorial, ProviderPlacement. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### episodeNumber

**Preferred | Max 1** Episode number for episode entity metadata.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### seasonNumber

**Preferred | Max 1** Season number for episode season metadata.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `seedTVSeason` | optional | false | Will create a TV Season object if set to true. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `type` | required |  | Type of credit. |
| `partName` | optional |  | Part played. |
| `rank` | optional |  | Integer rank. |
| `cameo` | optional |  | true/false. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the tag ID. |
| `type` | required* |  | Required if personReference is NOT embedded within creditAssociation. |
| `namespace` | optional |  | Namespace where the ID is unique. |
| `partName` | optional |  | Name of the part played. |
| `rank` | optional |  | Integer rank. |
| `cameo` | optional |  | true/false. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the tag ID. |
| `type` | optional |  | Type of the part. |
| `namespace` | optional |  | Namespace where the ID is unique. |

### companyReference

**Optional | Unlimited** Reference to a company.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the company ID. |
| `namespace` | optional |  | Namespace where the ID is unique. |
| `role` | required |  | The relationship with this company. Valid values: Provider, Distributor. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### ivod

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the station ID. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the event tournament ID. |
| `namespace` | optional |  | Namespace where the ID is unique. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the sports conference ID. |
| `namespace` | optional |  | Namespace where the ID is unique. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `start` | required* |  | Required if absoluteStartTime is not provided; start in milliseconds. |
| `end` | required* |  | Required if absoluteEndTime is not provided; end in milliseconds. |
| `absoluteStartTime` | required* |  | Required if start and end are not provided; milliseconds format. |
| `absoluteEndTime` | optional |  | Absolute end time in milliseconds. |
| `type` | required |  | Type of time slice. |
| `title` | optional |  | Title of the time slice. |
| `description` | optional |  | Description of the time slice. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `offset` | required |  | Offset in milliseconds from the beginning of the file. |
| `type` | required |  | Type of marker. |
| `title` | optional |  | Title of the marker. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the id and id namespace. |
| `namespace` | optional |  | Namespace where the id is unique. Used if multiple ID spaces exist within the same provider to guarantee uniqueness. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### price

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### currencyCode

**Required | Max 1** Basic unit of currency.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### purchaseCategory

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### labelPolicy

**Optional | Unlimited** Reference to a labelPolicyAssociations.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | optional |  | Provider of the id and id namespace. |

### videoSource

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

**Example**

```

```

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `number` | required |  | Defines the order for this part within the overall playlist. Must be unique across all source parts. |
| `type` | required |  | Defines what type of element this part is (PROGRAM, CERT, WARN, IDENT, RECAP, BUMPER, COMM, PROMO, SPONSOR). |
| `elementClass` | required |  | Defines the class for this part (PRE, MID, POST, PART). |
| `checksum` | required |  | Defines the checksum for this video file. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `offset` | required |  | Where to place an ad-break, offset from the beginning of the part (value is in seconds). |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `state` | required |  | Values are "inactive", "active", "deleted". |
| `reason` | optional |  | Values: add, update, fileUpdate, programOnly. |
| `force` | optional | false | Boolean indicating whether this item should be force processed. |

### media:group

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

**Example**

```

```

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `url` | required* |  | Required when type!=APP or externalAssetIds are not supplied; direct URL to the media object. |
| `gmrss:checksum` | optional |  | MD5 checksum of the manifest file. |
| `type` | required |  | Standard MIME type of the object. |
| `gmrss:videoQuality` | required |  | SD/HD/UHD. |
| `gmrss:colorDepth` | optional |  | The video color type. |
| `duration` | required |  | Number of seconds the media object plays. |
| `framerate` | optional |  | Number of frames per second for the media object. |
| `bitrate` | optional |  | Kilobits per second rate of media. |
| `lang` | deprecated |  | Use languageDetails instead. |
| `gmrss:expression` | optional | full | Values are full or nonstop. Determines if the object is a sample, the full version, or a continuous stream. |
| `gmrss:videoQualityVariant` | optional |  | String describing the video quality variant used. |
| `startOfEssence` | optional | 0 | The point in the file where the actual content begins. |
| `startOfMedia` | optional | 0 | The point in the file where the interested content begins. |
| `endOfMedia` | optional |  | The point in the file where the interested content ends. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `scheme` | required |  | Example: urn:mpaa. |
| `subRatings` | optional |  | Comma separated list of subRatings. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `url` | required |  | URL of the image, should be reachable on general internet. |
| `width` | required |  | Width of the image. |
| `height` | required |  | Height of the image. |
| `format` | required |  | Format of the image, only jpeg is supported. |
| `type` | required |  | Type designation of the image, such as 'Poster Art'. |
| `provider` | optional | THIRD_PARTY | Defines the feed provider type of the Image in the Merlin ingest system. |
| `external` | optional | false | If false, Myriad will download the image once a month and store it locally for resizing. |
| `useUrlHash` | optional | false | Used to tell imageManagementWebService to hash the url when true. |

### media:keywords

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

**Example**

```
<media:keywords></media:keywords>
```

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### media:copyright

**Optional | Max 1** Copyright line for video asset.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the id and id namespace. |
| `namespace` | optional |  | Namespace where the id is unique. Used if multiple ID spaces exist within the same provider to guarantee uniqueness. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the station ID. |
| `namespace` | optional |  | Namespace where the id is unique. Used if multiple ID spaces exist within the same provider to guarantee uniqueness. |

### languageDetails

**Preferred | Max 1** Language details for the provided station.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `primaryBroadcast` | optional |  | Describes the station language. |
| `broadcast` | optional |  | Comma-separated list of broadcast languages. |
| `edited` | optional |  | Comma-separated list of language edits. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `provider` | required |  | Provider of the channelLineup. |
| `namespace` | optional |  | Namespace where the id is unique. Used if multiple ID spaces exist within the same provider to guarantee uniqueness. |

### callSign

**Required | Max 1** On screen identifier for this channel.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### number

**Required | Max 1** Channel number.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### provider

**Required | Max 1** The provider of the listing.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### accessibility

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

**Example**

```

```

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### colorDepth

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### videoQuality

**Required | Max 1** Describes video stream quality.

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### locatorType

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### fireboltEntityId

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### fireboltChannelType

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### fireboltAppContentData

**Optional | Max 1** Additional app content data for TuneIntent.

**Example**

```
<gmrss:fireboltAppContentData/>
```

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### streamTitle

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### streamStatus

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `type` | required |  | Type of bundle. |

---

## 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
| `type` | required |  | metadataFile type |
| `url` | required |  | URL to the file |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
| `lang` | required |  | Follows ISO-639-1 (2 or 5 character) |
| `codec` | optional |  | Audio codec |
| `audioCodec` | required* |  | Required within sourcePart - either use this or codec |
| `dvs` | optional | false | Indicates Descriptive Video Service track |
| `audioType` | required |  | Stereo, Mono, Surround, Description |
| `index` | required |  | Integer, display order of audio track |
| `type` | optional |  | main/translation |
| `original` | optional | false | Indicates if audio track is original |
| `container` | required* |  | Required within sourcePart |
| `transport` | required* |  | Required within sourcePart |
| `url` | required* |  | Required within sourcePart whenever the audio is provided as a sidecar file |
| `startOfEssence` | optional | 0 | The point in the file where the actual content begins |
| `startOfMedia` | optional | 0 | The point in the file where the interested content begins |
| `endOfMedia` | optional | startOfEssence + content.duration | The point in the file where the interested content ends |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
| `lang` | required |  | Follows ISO-639-1 (2 or 5 character) |
| `codec` | optional |  | Audio codec |
| `dvs` | optional | false | Indicates Descriptive Video Service track |
| `audioType` | required |  | Stereo, Mono, Surround, Description |
| `index` | required |  | Integer, display order of audio track |
| `type` | optional |  | main/translation |
| `original` | optional | false | Indicates if audio track is original |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
| `number` | required |  | Integer value describing the track number. Must be unique within the sourcePart |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
| `lang` | required |  | Subtitle language |
| `role` | required |  | Subtitle role, e.g. forcedNarrative or cc |
| `codec` | required* |  | Subtitle codec (within sourcePart) |
| `url` | required* |  | URL to subtitle file (within sourcePart) |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### videoQualityVariant

**Optional | Max 1**

String describing the video quality variant used.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### transport

**Optional | Max 1**

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

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### protectionMethod

**Optional | Unlimited**

String describing the protection method used for the video encoding.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### container

**Optional | Max 1**

Required when type!=APP.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### protectionScheme

**Optional | Max 1**

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

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### protectionSystem

**Optional | Max 1**

String describing the protection system used for the video encoding.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### appStartMode

**Optional | Max 1**

String describing start mode for application content.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### optimizedFor

**Optional | Unlimited**

What this specific media/content is optimized for.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### adCompatibility

**Optional | Max 1**

String for the ad compatibility encoding profile.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### adInstructions

**Optional | Unlimited**

Value for the specified adInstruction.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
| `key` | required |  | The name of the adInstruction parameter |

### targetPlatforms

**Optional | Unlimited**

String describing the target platforms for the content.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### packageType

**Optional | Max 1**

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

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### watermarkEndDate

**Optional | Max 1**

ISO 8601 timestamp describing watermark end date.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### adminTag

**Optional | Unlimited**

List of adminTags that is used by a2g.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### categoryPath

**Optional | Unlimited**

List of category paths to be added.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### originalHeight

**Optional | Max 1**

This will be used to optimize the Vertical Video playback.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### originalWidth

**Optional | Max 1**

This will be used to optimize the Vertical Video playback.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
| `territories` | required |  | List of territories i.e. GB,IT,DE |
| `platformWatermark` | required |  | true or false. Indicates whether or not the content should be enhanced with a platform watermark. |
| `invisibleSessionWatermark` | required |  | true or false. Indicates whether or not each playback session is subject to an invisible watermark. |
| `visibleSessionWatermark` | required |  | true or false. Indicates whether or not each playback session is subject to a visible watermark. |
| `rhythm` | optional |  | String describing how often visible watermark needs to displayed, i.e. every 10 minutes = PT10M. |
| `longevity` | optional |  | String describing how long visible watermark should stay on. |
| `copyrightSourceId` | optional |  | The fingerprint Id of the source passed to FMTS. |

---

## 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `downloadable` | optional |  | Determines media availability for download. |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `type` | required |  | Type of region (e.g., ISODIVISION, ISOSUBDIVISION). |

### downloadable

**Optional | Max 1**

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### streamable

**Optional | Max 1**

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

**Example**

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

**Attributes**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attribute | Use | Default value | Description |
| --- | --- | --- | --- |
| `type` | required |  | Type of restriction. Types include "REST:MANUFACTURER", "REST:CUSGROUP", "REST:RIGHTSTERR", "REST:PLAYTERR", "REST:QUALITY", "REST:DEVICE", "REST:CONN", "REST:AREA", "REST:CLIENTCAPABILITY", "REST:PLATFORMCAPABILITY", "REST:PRIVACY". |

---

## 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
| `type` | required |  | Type of restriction. Types include "REST:RIGHTSTERR", "DEVICE", "PLATFORMCAPABILITY". |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### windowType (legacy)

**Required | Max 1**

No description provided.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### windowMode (legacy)

**Required | Max 1**

No description provided.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### 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**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### downloadable (legacy)

**Optional | Max 1**

Defaults to false if not provided.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |

### streamable (legacy)

**Optional | Max 1**

Defaults to true if not provided.

**Example**

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

**Attributes**

| Attributes | Use | Default value | Description |
| --- | --- | --- | --- |
|  |  |  |  |