OpenTV ENTera & OpenTV Platform Documentation
OpenTV ENTera & OpenTV Platform Documentation
Breadcrumbs

Mandatory fields for import

Overview

OpenTV Platform requires certain fields to have values for its recommendation functionality to work properly.

This is true whether the entities are ingested as XML files or via API calls.

These are listed for each entity below.

editorialContent

Field

Notes

Example

In order of precedence:

  • metadataSet > metadata for locale > EpisodeTitle

  • metadataSet > metadata for locale > Episode

  • metadataSet > metadata for locale > Title


JSON
{
  "metadataSet": [
  {
    "locale": "en_GB",
    "metadata": [
    {
      "key": "EpisodeTitle",
      "value": "The Episode Title"
    },
    {
      "key": "Episode",
      "value": "The Episode"
    },
    {
      "key": "Title",
      "value": "The Title"
    }
    ]
  }
  ]
}

metadataSet > metadata for locale > Categories


JSON
{
  "metadataSet": [
  {
    "locale": "en_GB",
    "metadata": [
    {
      "key": "Categories",
      "value": "Movie;Comedy"
    }
    ]
  }
  ]
}

metadataSet > metadata for locale > Genre


JSON
{
  "metadataSet": [
  {
    "locale": "en_GB",
    "metadata": [
    {
      "key": "Genre",
      "value": " Horror;Thriller"
    }
    ]
  }
  ]
}

contentType


N/A

technicalContent

Field

Notes

Example

id


N/A

start


N/A

end


N/A

editorialChannel

Field

Notes

Example

id


N/A

providerId


N/A

start


N/A

end


N/A

name


N/A

metadataSet > metadata for locale "none" > serviceType

Defaults to TV
JSON
{
  "metadataSet": [
  {
    "locale": "none",
    "metadata": [
    {
      "key": "serviceType",
      "value": "TV"
    }
    ]
  }
  ]
}

metadataSet > metadata for locale > Categories


JSON
{
  "metadataSet": [
  {
    "locale": "en_GB",
    "metadata": [
    {
      "key": "Categories",
      "value": "Movie;Comedy"
    }
    ]
  }
  ]
}

metadataSet > metadata for locale > Genre


JSON
{
  "metadataSet": [
  {
    "locale": "en_GB",
    "metadata": [
    {
      "key": "Genre",
      "value": " Horror;Thriller"
    }
    ]
  }
  ]
}

technicalChannel

Field

Notes

Example

end

For STCU

N/A

event

Field

Notes

Example

id


N/A

start


N/A

end


N/A

metadataSet > metadata for locale> EpisodeTitle

Only required for episodic content

N/A

metadataSet > metadata for locale> Episode

N/A

contentGroup

The following fields are required for both series and season content groups.

Field

Notes

Example

id


N/A

providerId


N/A

start


N/A

end


N/A

metadataSet > metadata for locale > SeriesTitle


JSON
{
  "metadataSet": [
  {
    "locale": "en_GB",
    "metadata": [
    {
      "key": "SeriesTitle",
      "value": "The Series Title"
    },
    {
      "key": "Series",
      "value": "The Series"
    },
    {
      "key": "Title",
      "value": "The Title"
    }
    ]
  }
  ]
}

metadataSet > metadata for locale > Series


metadataSet > metadata for locale > Title


metadataSet > metadata for locale > Categories


JSON
{
  "metadataSet": [
  {
    "locale": "en_GB",
    "metadata": [
    {
      "key": "Categories",
      "value": "Movie;Comedy"
    }
    ]
  }
  ]
}

metadataSet > metadata for locale > Genre


JSON
{
  "metadataSet": [
  {
    "locale": "en_GB",
    "metadata": [
    {
      "key": "Genre",
      "value": " Horror;Thriller"
    }
    ]
  }
  ]
}