Listing

    Listing


    Article summary

    Field

    Max Occurs

    Required

    Attributes

    Description

    Example

    dcterms:valid

    1

    yes

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

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

    gmrss:entityReference

    unlimited

    no

    · provider: required, provider of the tag ID· entityType: required, 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 should be set on the primary asset and will create a new entityCollection. isPrimary=false should go on any language variants.

    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.

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

    gmrss:airingType

    1

    only if live

    Airing type from listing. Valid values are New, Live, Repeat, Taped, and null value. Required for SportingEvent, Live Programming and TV Series.

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

    media:rating

    unlimited

    preferred

    · scheme: required; example: urn:mpaa· subRatings: optional; comma separated list of subRatings

    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

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

    gmrss:stationReference

    1

    yes

    · provider: required, provider of the station ID· namespace: optional, namespace where the id is unique – within Merlin this is concatenated together with the value to form a guid such as "watchable:12345". This should be used if multiple ID spaces exist within the same provider to guarantee uniqueness.

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

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

    gmrss:provider

    1

    yes

    The provider of the listing.

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

    gmrss:accessibility

    1

    yes

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

    gmrss:colorDepth

    1

    no

    Inherited from station if not provided. Valid values are SDR and HDR.

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

    gmrss:videoQuality

    1

    no

    Describes video stream quality. Inherited from station if not provided.

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

    Accessibility

    Field

    Max Occurs

    Required

    Attributes

    Description

    Example

    gmrss:audioTrack

    unlimited

    yes

    · lang: required; follows ISO-639-1 (2 or 5 character)· codec: optional· dvs: optional, true/false, indicates Descriptive Video Service track. Defaults to false.· audioType: required; Stereo, Mono, Surround· index: required; integer, display order of audio track· type: optional, main/translation· original: optional; defaults to false. Indicates if audio track is original

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

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

    gmrss:subtitle

    unlimited

    preferred

    · lang: required; subtitle language· role: required; subtitle role, eg forcedNarrative or cc

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

    <gmrss:subtitle lang="en-US" role="cc" />

    Sample

    <gmrss:listing>
        <gmrss:provider>XUMO</gmrss:provider>
        <gmrss:airingType>New</gmrss:airingType>
        <gmrss:videoQuality>HD</gmrss:videoQuality>
        <gmrss:colorDepth>SDR</gmrss:colorDepth>
        <gmrss:entityReference provider="XUMO" namespace="XUMO" entityType="Episode">BLR-EPISODE-1-1</gmrss:entityReference>
        <gmrss:entityReference provider="XUMO" namespace="XUMO" entityType="SeriesMaster">BLR-SERIES</gmrss:entityReference>
        <gmrss:stationReference provider="XUMO" namespace="XUMO">9999340</gmrss:stationReference>
    
        <dcterms:valid>start=2020-05-18T10:00:00Z;end=2020-05-18T11:00:00Z;scheme=W3C-DTF</dcterms:valid>
    
        <media:rating scheme="urn:vchip">TVG</media:rating>
    
        <gmrss:accessibility>
            <gmrss:audioTrack index="0" dvs="false" lang="en-US" audioType="Stereo"/>
            <gmrss:subtitle index="0" lang="en-US" role="closedCaption" /> 
            <gmrss:subtitle index="1" lang="en-GB" role="closedCaption" /> 
        </gmrss:accessibility>
    </gmrss:listing>
    

    Frequently Asked Questions

    What is GMRSS?

    GMRSS stands for Golden Media RSS, an amalgam of MRSS and Merlin-specific extensions to aid ingest.

    How many assets should I send per payload?

    Clients should send us batches of 1 - 5 gmrss items.

    What metadata do I need to send if I provide GRACENOTE references?

    If you are a provider that contracts with GRACENOTE, you only need to send fields marked as "required." In the case of linear metadata, if you provide a GRACENOTE station reference on the station, you need only provide ChannelLineup, Station, and Channel metadata. Listing and program metadata is handled by GRACENOTE.

    How do I know if I have a correct GMRSS sample?

    You can validate against our spec using the validation API. There is a validation API for each version of the Open Ingest API. Please see the Validation section of the spec for details.


    Was this article helpful?

    What's Next