TvSeason

    TvSeason


    Article summary

    Field

    Max Occurs

    Required

    Attributes

    Description

    Example

    title

    1

    yes

    • overrideCanonicalValue: optional; default value is false

    • lang: optional unless overrideCanonicalValue=true

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

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

    description

    1

    no

    • type: optional MIME type of the text

    • overrideCanonicalValue: optional; default value is false

    • lang: optional unless overrideCanonicalValue=true

    For movie,seriesMaster, or episode entityTypes, can use shortDescription,mediumDescription, and/or longDescription instead

    <description> Harry Potter description</description>

    gmrss:languageDetails

    1

    yes

    • intendedAudience: required;

    • title: optional; Describes program title language

    • description: optional; Program description language

    • originalAudio: optional; Language the audio was recorded in.

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

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

    entityType

    1

    yes

    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.

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

    gmrss:seasonAssetId

    1

    yes

    • provider: required, provider of the id and id namespace. Consult the Merlin team to make sure the provider specified is configured for OpenIngest.

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

    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.

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

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

    1

    yes

    • seedTVSeason: optional; defaults to false. Will create a TV Season object if set to true.

    Season number for episode season metadata.

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

    Sample

    <item>
       <title>The Office Season 1</title>
       <description type="text/html">Season 1 of the acclaimed Comedy about people who work in an office.</description>
       <gmrss:seasonAssetId namespace="PROVIDER" provider="PROVIDER">GTMV0000111111-1</gmrss:seasonAssetId>
       <gmrss:seasonNumber>1</gmrss:seasonNumber>
       <gmrss:entityType>TvSeason</gmrss:entityType>
       <media:status reason="add" state="active"/>
       <gmrss:languageDetails title="en-US" description="en-US" intendedAudience="en-US"/>
       <gmrss:entityReference provider="PROVIDER" entityType="SeriesMaster">736369</gmrss:entityReference>
       <gmrss:entityReference provider="PROVIDER" namespace="PROVIDER" entityType="EntityCollection" isPrimary="true">GTMV0000111111-1</gmrss:entityReference>
    </item>
    


    Was this article helpful?

    What's Next