Video playback items with all available options.
Defined with the PlaybackItem data structure.
※ Exception:
• Trailer data does not require this field.
• The "season" and "show" program types do not require this field, except for a standalone "show" program without any related episode content, which does require this field.
type
String
True
Program type:
• "show": this type has two meanings:
1) A single TV show
2) A series of programs (the parent of seasons/episodes)
• "season": a season of a show
• "episode": an episode of a season
• "movie": movie content
• "music": music service content
Note:
• If your content is a TV show, it should follow the show-season-episode hierarchy, and the type value should be one of those.
• If your content is a movie, the type value should be "movie".
• The "music" program type is restricted to music-only content without accompanying video, or to music video content exclusively. Do not use the "music" program type simply because a program is music-related; doing so may result in exclusion from content recommendations and service exposure.
subtype
String
False
Additional predefined subtype keyword.
Defined in the Subtype list.
series_info
JSON object
True with Exception
Indicates the program ID of the parent program (show/season) and the season/episode number.
Defined with the SeriesInfo data structure.
※ Exception: The "show", "movie", and "music" program types do not require this field.
Official titles of the video content.
Defined with the Title data structure.
Every program must have at least one "main" type title ("short" type titles are optional).
Note: Do not provide multiple "main" or "short" titles for the same language. Only one "main" and one "short" title are allowed per language.
Descriptions or synopses of the video content.
Defined with the Description data structure.
Note: Do not provide multiple descriptions for the same language. Only one description is allowed per language.
Images of the video content.
Defined with the Image data structure.
Note: Do not provide the same image more than once in a program. Each image URL must be unique within a program.
Program content ratings, as assigned by national content rating organizations.
Defined with the ParentalRating data structure.
genres
List of Strings
False
Representative genres of the program. Multiple genres are acceptable, in decreasing order of importance.
The supported genres are defined in Genre Field Enums.
release_date
String
False
Release date (or year) of the program.
For "show", "season", and "episode": "YYYY-MM-DD"
For "movie": "YYYY" or "YYYY-MM-DD"
Cast and credit list of the program.
Defined with the Cast data structure.
Note: Cast data can be provided only when the program type is "movie" or "show".
promotion_score
Integer
False
A promotion score assigned by your service to this program, from 1 (lowest) to 99999 (highest). The higher the value, the greater the chance that this program will be exposed in our content discovery services.
Table 1: Program data structure without external ID
Subtype
The subtypes in the following table have been defined by mutual agreement; subtypes that have not been agreed upon in advance are not accepted.
Name
Description
Notes
sports event
Sports match programs such as "EPL", "MLB", and "Formula 1".
By adding this subtype, the program can be exposed by the Search service even if it is episode-type content.
This subtype is for actual sports event content only.
Do not add it to sports-related programs such as sports talk shows or sports documentaries.
Note: The "sports event" subtype is allowed only when the program type is "show", "season", or "episode". Do not use it with the "movie" type.
Table 2: Subtypes
SeriesInfo
The SeriesInfo data structure is required if the program type is "season" or "episode". It is used to organize content into groups based on shows and seasons.
NoteDo not provide this field when the program type is "movie", "show", or "music".
Field
Type
Mandatory
Description
show_id
String
True
Unique ID of the parent show program
season_id
String
False with Exception
Unique ID of the parent season program
※ Exception: The "episode" program type requires this field.
season_number
Integer
False with Exception
Season number of the program
※ Exception: The "season" program type requires this field.
episode_number
Integer
False with Exception
Episode number of the program
※ Exception: The "episode" program type requires this field.
The descriptions array defines the program descriptions with the Description data structures.
NoteDo not provide multiple descriptions for the same language. Only one description is allowed per language.
Field
Type
Mandatory
Description
description
String
True
Program description
language
String
True
Description language, in ISO 639-1 format (2-letter language codes)
(See Mandatory Language.)
Table 6: Description data structure
Example:
{
"descriptions": [
{
"description": "Game of Thrones is roughly based on the storylines of A Song of Ice and Fire, set in the fictional Seven Kingdoms of Westeros and the continent of Essos. The series chronicles the violent dynastic struggles among the realm's noble families for the Iron Throne, while other families fight for independence from it.",
"language": "en"
}
]
}
Image
The images array defines the representative images of the program with the Image data structures. You can define images for multiple languages.
Each program must have at least one image. A landscape image must be at least 928 pixels wide and 522 pixels high. A portrait image must be at least 522 pixels high.
NoteDo not provide the same image more than once in a program. Each image URL must be unique within a program.
Field
Type
Mandatory
Description
url
String
True
URL of the image. It must be publicly accessible.
Note: The image URL protocol MUST be HTTPS.
width
Integer
True
Image width, in pixels
height
Integer
True
Image height, in pixels
type
String
True
Image type:
• "banner": an image with text on it, such as the program title
• "iconic": an image without any text on it
language
String
True with Exception
Language of the text on the image, in ISO 639-1 format (2-letter language codes)
(See Mandatory Language.)
※ Exception: The "iconic" image type does not require this field.
The parental_ratings array defines the program content ratings, as assigned by a national content rating organization, with the ParentalRating data structures.
You can define ratings for multiple countries and organizations.
Field
Type
Mandatory
Description
country_code
String
True
Country to which the rating applies, in ISO 3166-1 alpha-2 format (2-letter country codes)
body
String
True
Rating organization that issued the rating.
This must match one of the supported rating organizations for the country.
code
String
True
Content rating code issued by the organization.
This must match one of the supported rating codes for the country.
Table 8: ParentalRating data structure
The following rating organizations and codes are supported:
The following example feeds define program metadata without an external ID:
Example JSON feed (without external ID):
{
"programs": [
{
"program_id": "12335",
"playback_items": [
{
"deeplink_payload": "content_id=12335",
"country_code": "US",
"license": "purchase",
"price": 10.99,
"currency": "USD",
"quality": "FHD",
"audio_languages": ["en", "es"],
"subtitle_languages": ["en", "es"],
"available_starting": "2019-04-14 00:00:00",
"available_ending": "2020-04-14 16:00:00",
"attributes": ["live_ott", "hdr10+"],
"geo_restrictions": {
"access_type": "deny",
"type": "area",
"value": [
{
"region": "Texas",
"city": ["El Paso"]
},
{
"region": "California",
"city": ["San Diego", "San Francisco"]
}
]
}
},
{
"deeplink_payload": "content_id=12559",
"country_code": "US",
"license": "subscription",
"quality": "FHD",
"audio_languages": ["en"],
"subtitle_languages": ["en"],
"available_starting": "2025-03-17 16:00:00",
"available_ending": "2025-03-17 17:30:00",
"attributes": ["live_ott", "hdr10+"],
"geo_restrictions": {
"access_type": "deny",
"type": "area",
"value": [
{
"region": "Texas",
"city": ["El Paso"]
},
{
"region": "California",
"city": ["San Diego", "San Francisco"]
}
]
}
},
{
"deeplink_payload": "content_id=67890",
"country_code": "IT",
"license": "subscription",
"quality": "HD",
"audio_languages": ["en", "it"],
"available_starting": "2022-01-15 19:13:00",
"available_ending": "2022-05-22 23:59:00"
}
],
"type": "episode",
"series_info": {
"show_id": "GT29085",
"season_id": "23456",
"episode_number": 1
},
"titles": [
{
"title": "Game of Thrones",
"language": "en",
"type": "main"
},
{
"title": "GOT",
"language": "en",
"type": "short"
},
{
"title": "Il Trono di Spade",
"language": "it",
"type": "main"
}
],
"descriptions": [
{
"description": "Game of Thrones is roughly based on the storylines of A Song of Ice and Fire, set in the fictional Seven Kingdoms of Westeros and the continent of Essos. The series chronicles the violent dynastic struggles among the realm's noble families for the Iron Throne, while other families fight for independence from it.",
"language": "en"
}
],
"images": [
{
"url": "https://my.image.cdn/my/image/file.jpg",
"width": 1920,
"height": 1080,
"type": "banner",
"language": "en"
},
{
"url": "https://my.image.cdn/my/image/file2.jpg",
"width": 1920,
"height": 1080,
"type": "iconic"
}
],
"parental_ratings": [
{
"country_code": "US",
"body": "USA Parental Rating",
"code": "TV-MA"
}
],
"genres": ["Action", "Adventure", "Fantasy"],
"release_date": "2019-04-14",
"running_time": 4524,
"promotion_score": 789
}
]
}
Example XML feed (without external ID):
<?xml version="1.0" encoding="UTF-8"?>
<programs>
<program>
<program_id>12335</program_id>
<playback_items>
<playback_item>
<deeplink_payload>content_id=12335</deeplink_payload>
<country_code>US</country_code>
<license>purchase</license>
<price>10.99</price>
<currency>USD</currency>
<quality>FHD</quality>
<audio_languages>
<audio_language>en</audio_language>
<audio_language>es</audio_language>
</audio_languages>
<subtitle_languages>
<subtitle_language>en</subtitle_language>
<subtitle_language>es</subtitle_language>
</subtitle_languages>
<available_starting>2019-04-14 00:00:00</available_starting>
<available_ending>2020-04-14 16:00:00</available_ending>
<attributes>
<attribute>live_ott</attribute>
<attribute>hdr10+</attribute>
</attributes>
<geo_restrictions>
<access_type>deny</access_type>
<type>area</type>
<value>
<area_object>
<region>Texas</region>
<city>
<city_object>El Paso</city_object>
</city>
</area_object>
<area_object>
<region>California</region>
<city>
<city_object>San Diego</city_object>
<city_object>San Francisco</city_object>
</city>
</area_object>
</value>
</geo_restrictions>
</playback_item>
<playback_item>
<deeplink_payload>content_id=12559</deeplink_payload>
<country_code>US</country_code>
<license>subscription</license>
<quality>FHD</quality>
<audio_languages>
<audio_language>en</audio_language>
</audio_languages>
<subtitle_languages>
<subtitle_language>en</subtitle_language>
</subtitle_languages>
<available_starting>2025-03-17 16:00:00</available_starting>
<available_ending>2025-03-17 17:30:00</available_ending>
<attributes>
<attribute>live_ott</attribute>
<attribute>hdr10+</attribute>
</attributes>
<geo_restrictions>
<access_type>deny</access_type>
<type>area</type>
<value>
<area_object>
<region>Texas</region>
<city>
<city_object>El Paso</city_object>
</city>
</area_object>
<area_object>
<region>California</region>
<city>
<city_object>San Diego</city_object>
<city_object>San Francisco</city_object>
</city>
</area_object>
</value>
</geo_restrictions>
</playback_item>
<playback_item>
<deeplink_payload>content_id=67890</deeplink_payload>
<country_code>IT</country_code>
<license>subscription</license>
<quality>HD</quality>
<audio_languages>
<audio_language>en</audio_language>
<audio_language>it</audio_language>
</audio_languages>
<available_starting>2022-01-15 19:13:00</available_starting>
<available_ending>2022-05-22 23:59:00</available_ending>
</playback_item>
</playback_items>
<type>episode</type>
<series_info>
<show_id>GT29085</show_id>
<season_id>23456</season_id>
<episode_number>1</episode_number>
</series_info>
<titles>
<title_object>
<title>Game of Thrones</title>
<language>en</language>
<type>main</type>
</title_object>
<title_object>
<title>GOT</title>
<language>en</language>
<type>short</type>
</title_object>
<title_object>
<title>Il Trono di Spade</title>
<language>it</language>
<type>main</type>
</title_object>
</titles>
<descriptions>
<description_object>
<description>Game of Thrones is roughly based on the storylines of A Song of Ice and Fire, set in the fictional Seven Kingdoms of Westeros and the continent of Essos. The series chronicles the violent dynastic struggles among the realm's noble families for the Iron Throne, while other families fight for independence from it.</description>
<language>en</language>
</description_object>
</descriptions>
<images>
<image>
<url>https://my.image.cdn/my/image/file.jpg</url>
<width>1920</width>
<height>1080</height>
<type>banner</type>
<language>en</language>
</image>
<image>
<url>https://my.image.cdn/my/image/file2.jpg</url>
<width>1920</width>
<height>1080</height>
<type>iconic</type>
</image>
</images>
<parental_ratings>
<parental_rating>
<country_code>US</country_code>
<body>USA Parental Rating</body>
<code>TV-MA</code>
</parental_rating>
</parental_ratings>
<genres>
<genre>Action</genre>
<genre>Adventure</genre>
<genre>Fantasy</genre>
</genres>
<release_date>2019-04-14</release_date>
<running_time>4524</running_time>
<promotion_score>789</promotion_score>
</program>
</programs>
The following example feeds define program metadata with a three-level hierarchy (show - season - episode) without an external ID:
Example JSON feed with 3 depths (without external ID):
{
"programs": [
{
"program_id": "abc-12345-001",
"titles": [
{
"title": "Premier League Live",
"language": "en",
"type": "main"
}
],
"descriptions": [
{
"description": "The Premier League is the highest level of the English football league system. Contested by 20 clubs, it operates on a system of promotion and relegation with the English Football League (EFL).",
"language": "en"
}
],
"images": [
{
"url": "https://my.image.cdn/my/image/banner1.jpg",
"width": 1280,
"height": 720,
"type": "banner",
"language": "en"
},
{
"url": "https://my.image.cdn/my/image/iconic1.jpg",
"width": 1280,
"height": 720,
"type": "iconic"
}
],
"genres": ["Soccer", "Football"],
"type": "show",
"subtype": "sports event"
},
{
"program_id": "abc-12345-002",
"titles": [
{
"title": "Premier League 2024/25",
"language": "en",
"type": "main"
}
],
"descriptions": [
{
"description": "The 2024/25 season of the Premier League, the top tier of English football.",
"language": "en"
}
],
"images": [
{
"url": "https://my.image.cdn/my/image/banner2.jpg",
"width": 1280,
"height": 720,
"type": "banner",
"language": "en"
},
{
"url": "https://my.image.cdn/my/image/iconic2.jpg",
"width": 1280,
"height": 720,
"type": "iconic"
}
],
"genres": ["Soccer", "Football"],
"type": "season",
"subtype": "sports event",
"series_info": {
"show_id": "abc-12345-001",
"season_number": 33
}
},
{
"program_id": "abc-12345-003",
"playback_items": [
{
"deeplink_payload": "content_id=abc-12345-003",
"country_code": "US",
"license": "subscription",
"quality": "FHD",
"audio_languages": ["en"],
"subtitle_languages": ["en"],
"available_starting": "2024-10-06 12:50:00",
"available_ending": "2024-10-06 15:00:00",
"attributes": ["live_ott", "hdr10+"]
}
],
"titles": [
{
"title": "Chelsea vs Nott'm Forest",
"language": "en",
"type": "main"
}
],
"descriptions": [
{
"description": "Chelsea is playing against Nott'm Forest.",
"language": "en"
}
],
"images": [
{
"url": "https://my.image.cdn/my/image/banner3.jpg",
"width": 1280,
"height": 720,
"type": "banner",
"language": "en"
},
{
"url": "https://my.image.cdn/my/image/iconic3.jpg",
"width": 1280,
"height": 720,
"type": "iconic"
}
],
"genres": ["Soccer", "Football"],
"running_time": 7800,
"type": "episode",
"subtype": "sports event",
"series_info": {
"show_id": "abc-12345-001",
"season_id": "abc-12345-002",
"episode_number": 101
}
},
{
"program_id": "abc-12345-004",
"playback_items": [
{
"deeplink_payload": "content_id=abc-12345-004",
"country_code": "US",
"license": "subscription",
"quality": "FHD",
"audio_languages": ["en"],
"subtitle_languages": ["en"],
"available_starting": "2024-10-06 20:00:00",
"available_ending": "2024-10-06 22:00:00",
"attributes": ["live_ott", "hdr10+"]
}
],
"titles": [
{
"title": "Lexington SC vs Ascent FC",
"language": "en",
"type": "main"
}
],
"descriptions": [
{
"description": "Lexington SC is playing against Ascent FC.",
"language": "en"
}
],
"images": [
{
"url": "https://my.image.cdn/my/image/banner4.jpg",
"width": 1280,
"height": 720,
"type": "banner",
"language": "en"
},
{
"url": "https://my.image.cdn/my/image/iconic4.jpg",
"width": 1280,
"height": 720,
"type": "iconic"
}
],
"genres": ["Soccer", "Football"],
"running_time": 7200,
"type": "episode",
"subtype": "sports event",
"series_info": {
"show_id": "abc-12345-001",
"season_id": "abc-12345-002",
"episode_number": 102
}
}
]
}
Example XML feed with 3 depths (without external ID):
<?xml version="1.0" encoding="UTF-8"?>
<programs>
<program>
<program_id>abc-12345-001</program_id>
<titles>
<title_object>
<title>Premier League Live</title>
<language>en</language>
<type>main</type>
</title_object>
</titles>
<descriptions>
<description_object>
<description>The Premier League is the highest level of the English football league system. Contested by 20 clubs, it operates on a system of promotion and relegation with the English Football League (EFL).</description>
<language>en</language>
</description_object>
</descriptions>
<images>
<image>
<url>https://my.image.cdn/my/image/banner1.jpg</url>
<width>1280</width>
<height>720</height>
<type>banner</type>
<language>en</language>
</image>
<image>
<url>https://my.image.cdn/my/image/iconic1.jpg</url>
<width>1280</width>
<height>720</height>
<type>iconic</type>
</image>
</images>
<genres>
<genre>Soccer</genre>
<genre>Football</genre>
</genres>
<type>show</type>
<subtype>sports event</subtype>
</program>
<program>
<program_id>abc-12345-002</program_id>
<titles>
<title_object>
<title>Premier League 2024/25</title>
<language>en</language>
<type>main</type>
</title_object>
</titles>
<descriptions>
<description_object>
<description>The 2024/25 season of the Premier League, the top tier of English football.</description>
<language>en</language>
</description_object>
</descriptions>
<images>
<image>
<url>https://my.image.cdn/my/image/banner2.jpg</url>
<width>1280</width>
<height>720</height>
<type>banner</type>
<language>en</language>
</image>
<image>
<url>https://my.image.cdn/my/image/iconic2.jpg</url>
<width>1280</width>
<height>720</height>
<type>iconic</type>
</image>
</images>
<genres>
<genre>Soccer</genre>
<genre>Football</genre>
</genres>
<type>season</type>
<subtype>sports event</subtype>
<series_info>
<show_id>abc-12345-001</show_id>
<season_number>33</season_number>
</series_info>
</program>
<program>
<program_id>abc-12345-003</program_id>
<playback_items>
<playback_item>
<deeplink_payload>content_id=abc-12345-003</deeplink_payload>
<country_code>US</country_code>
<license>subscription</license>
<quality>FHD</quality>
<audio_languages>
<audio_language>en</audio_language>
</audio_languages>
<subtitle_languages>
<subtitle_language>en</subtitle_language>
</subtitle_languages>
<available_starting>2024-10-06 12:50:00</available_starting>
<available_ending>2024-10-06 15:00:00</available_ending>
<attributes>
<attribute>live_ott</attribute>
<attribute>hdr10+</attribute>
</attributes>
</playback_item>
</playback_items>
<titles>
<title_object>
<title>Chelsea vs Nott'm Forest</title>
<language>en</language>
<type>main</type>
</title_object>
</titles>
<descriptions>
<description_object>
<description>Chelsea is playing against Nott'm Forest.</description>
<language>en</language>
</description_object>
</descriptions>
<images>
<image>
<url>https://my.image.cdn/my/image/banner3.jpg</url>
<width>1280</width>
<height>720</height>
<type>banner</type>
<language>en</language>
</image>
<image>
<url>https://my.image.cdn/my/image/iconic3.jpg</url>
<width>1280</width>
<height>720</height>
<type>iconic</type>
</image>
</images>
<genres>
<genre>Soccer</genre>
<genre>Football</genre>
</genres>
<running_time>7800</running_time>
<type>episode</type>
<subtype>sports event</subtype>
<series_info>
<show_id>abc-12345-001</show_id>
<season_id>abc-12345-002</season_id>
<episode_number>101</episode_number>
</series_info>
</program>
<program>
<program_id>abc-12345-004</program_id>
<playback_items>
<playback_item>
<deeplink_payload>content_id=abc-12345-004</deeplink_payload>
<country_code>US</country_code>
<license>subscription</license>
<quality>FHD</quality>
<audio_languages>
<audio_language>en</audio_language>
</audio_languages>
<subtitle_languages>
<subtitle_language>en</subtitle_language>
</subtitle_languages>
<available_starting>2024-10-06 20:00:00</available_starting>
<available_ending>2024-10-06 22:00:00</available_ending>
<attributes>
<attribute>live_ott</attribute>
<attribute>hdr10+</attribute>
</attributes>
</playback_item>
</playback_items>
<titles>
<title_object>
<title>Lexington SC vs Ascent FC</title>
<language>en</language>
<type>main</type>
</title_object>
</titles>
<descriptions>
<description_object>
<description>Lexington SC is playing against Ascent FC.</description>
<language>en</language>
</description_object>
</descriptions>
<images>
<image>
<url>https://my.image.cdn/my/image/banner4.jpg</url>
<width>1280</width>
<height>720</height>
<type>banner</type>
<language>en</language>
</image>
<image>
<url>https://my.image.cdn/my/image/iconic4.jpg</url>
<width>1280</width>
<height>720</height>
<type>iconic</type>
</image>
</images>
<genres>
<genre>Soccer</genre>
<genre>Football</genre>
</genres>
<running_time>7200</running_time>
<type>episode</type>
<subtype>sports event</subtype>
<series_info>
<show_id>abc-12345-001</show_id>
<season_id>abc-12345-002</season_id>
<episode_number>102</episode_number>
</series_info>
</program>
</programs>
Manage Your Cookies
We use cookies to improve your experience on our website and to show you relevant
advertising. Manage you settings for our cookies below.
Essential Cookies
These cookies are essential as they enable you to move around the website. This
category cannot be disabled.
Company
Domain
Samsung Electronics
developer.samsung.com, .samsung.com
Analytical/Performance Cookies
These cookies collect information about how you use our website. for example which
pages you visit most often. All information these cookies collect is used to improve
how the website works.
Company
Domain
Samsung Electronics
.samsung.com
Functionality Cookies
These cookies allow our website to remember choices you make (such as your user name, language or the region your are in) and
tailor the website to provide enhanced features and content for you.
Company
Domain
Samsung Electronics
developer.samsung.com, google.account.samsung.com
Preferences Submitted
You have successfully updated your cookie preferences.