Organize Content Posters and Metadata for SFTP Upload

Note: This task is only required for Merchants with streaming video, audio, or gaming content. Before uploading the content posters and metadata via SFTP, make sure to prepare the content metadata folder, content poster files, and JSON file as described on this page. Content posters can be in JPG or PNG format. For each content poster, two files need to be provided: one in landscape format (480x270) and the other in portrait format (270x480). Content posters should have the focal point in the central area and the central 80% of the image should not be cut off. For more information about the image safe area, see Image Asset Safe Area Guidelines.

Create the content metadata folder.
1. In the folder you named after the Reseller (in this step), create a subfolder with the following naming convention: content_metadata_mm_dd_yy_v1 (where mm is the month, dd) is the day, and yy is the last two digits of the year). Add the file version number (replacing v1) if this is not the first time you are providing this file.
Configure the JSON file.
1. Download the template JSON file and place it in the new content metadata folder.
2. Open the template JSON file. For each content poster, provide all of the required JSON fields and specify their values. See the tables below for more information.
3. Save the JSON file.
Add the content poster files to the content metadata folder.
1. For each content poster, two files need to be provided: one in landscape format (480x270) and the other in portrait format (270x480). Name the content poster in the landscape format as follows: <ContentPosterName>_480x270. Name the content poster in the portrait format as follows: <ContentPosterName>_270x480. For example: ContentPoster1_480x270.png and ContentPoster1_270x480.png.

Go to the next step: configure your SFTP settings.

Metadata JSON Fields

Parent topic:Organize and Upload Assets (SFTP Method)

Metadata JSON Fields

Example

{
    "resources": [
        {
            "platform_id": "OTT_content_id_123456",
            "dataset": "partnername",
            "type": 0,
            "title": "Example Movie",
            "subtitle": "A thrilling adventure",
            "description": "An exciting journey.",
            "short_description": "Two best friends embark on an adventure and surprises happen along the way.",
            "country": "IE",
            "cast": [
                {
                    "name": "John",
                    "middle": "A.",
                    "last": "Doe",
                    "locale": "en_US",
                    "role": "1"
                }
            ],
            "locale": "en_GB",
            "pictures": [
                {
                    "platform_id": "OTT_content_id_456",
                    "type": 5,
                    "url": "<ContentPosterName1_480x270>"
                },
                {
                    "platform_id": "OTT_content_id_789",
                    "type": 4,
                    "url": "<ContentPosterName1_270x480>"
                }
            ],
            "genres": [
                "Drama",
                "Action",
                "Crime",
                "American movies",
                "Drama movies",
                "Crime movies",
                "Action movies"
            ]
        }
    ]
}

Main JSON Fields

Field Name	Type	Description	Required	Example
platform_id	string	The identifier for the content provider.	Yes	”OTT_content_id_123456”
dataset	string	The name of the content provider.	Yes	”partnername”
type	number	The content type. The following values are allowed: - 0: Movie. - 1: Series. - 2: Season. - 3: Episode. - 4: A collection of movies, series, or both. - 5: Episodic show. - 6: An orphan season that doesn’t belong to any series. - 7: An orphan episode that doesn’t belong to any season.	Yes	0
title	string	The content’s main title. The maximum number of characters allowed is 255.	No	”Example Movie”
subtitle	string	The content’s subtitle. The maximum number of characters allowed is 255.	No	”A thrilling adventure”
description	string	A description of the content. The maximum number of characters allowed is 2000.	No	”An exciting journey.”
short_description	string	A short description of the content. The maximum number of characters allowed is 2000.	No	”Two best friends embark on an adventure and surprises happen along the way.”
country	string	The item’s country of origin. A 2 digit country code.	Yes	”IE”
cast	array	A list of cast members.	No	See Cast Object table.
locale	string	The locale of the item in the format of <language_code>_<country/region_code>.	Yes	”en_GB”
pictures	array	The array provides information related to content’s artwork.	Yes	See Pictures Object table.
genres	array	A list of categories/genres.	No	[“Drama”, “Action”]

Cast Object

Field Name	Type	Description	Required	Example
ID	string	The database identifier.	No	”45511”
platform_id	string	The identifier of the provider.	No	”65333”
name	string	The localized first name of the cast member.	No	”John”
middle	string	The localized middle name of the cast member.	No	”A.”
last	string	The localized last name of the cast member.	No	”Doe”
locale	string	The locale in the format of <language_code>_<country/region_code>.	No	”en_US”
role	string	The cast member’s role.The following values are allowed: - 1: “ACTOR” - 2: “DIRECTOR” - 3: “PRODUCER” - 4: “WRITER”	No	”1”
pictures	string	The cast member’s pictures.	No

Pictures Object

Field Name	Type	Description	Required	Example
platform_id	string	The catalog ID on the Merchant’s side of the integration.	Yes	”OTT_content_id_456”
type	number	The picture orientation:- 4: portrait (270x480) - 5: landscape (480x270)	Yes	4
url	string	The file name of the content poster.	Yes	”ContentPosterName1_480x270.jpg”
Parent topic:Organize Content Posters and Metadata for SFTP Upload

Home

Introduction

For Merchants

For Resellers

Partner Ecosystem Management

Commerce Engine

Storefront Experience

APIs

Metadata JSON Fields

Example

Main JSON Fields

Cast Object

Pictures Object

​Metadata JSON Fields

​Example

​Main JSON Fields

​Cast Object

​Pictures Object

Metadata JSON Fields

Example

Main JSON Fields

Cast Object

Pictures Object