ym88659208ym87991671
SberJson структура описания видеоконтента на метавитрине Салют ТВ | Документация для разработчиков

SberJson структура описания видеоконтента на метавитрине Салют ТВ

Обновлено 3 апреля 2024

Данная документация описывает структуру данных для передачи информации о видеоконтенте, которая используется для формирования метавитрины контента на всех поверхностях Салют ТВ. Наполнение полей по каждой единице каталога влияют на его доступность на устройствах пользователей. Важным фактором является соблюдение требований по формату и обязательности заполнения полей, так как это влияет на визуальное отображение в метавитринах и каталоге контента.

Изменения с прошлой версии
  • Добавлены требования к размеру и формату изображений
  • Обновлен справочник доступных жанров контента
  • Поля audioTracks и qualities стали необязательными

Принцип формирования и доставки данных

  • Поставщик контента формирует статичную ссылку, на которой размещается выгрузка (фид). Файл выгрузки должен быть доступен по протоколу HTTPS на домене поставщика контента.

Пример ссылки на файл: https://yoursite.ru/feed.json. Content-Type=application/json; charset=utf-8.
Ссылка может быть защищена паролем.

  • Для верификации источника фида SberDevices поддерживаются в том числе и white-листы, в таком случае понадобится статичный IP-адрес.

SberDevices могут быть рассмотрены и иные технические особенности интеграции, для этого обсудите их с вашим контактным лицом в SberDevices.

  • Производить обновление данных в файле выгрузки желательно не реже, чем один раз в сутки и не чаще, чем один раз в шесть часов.

При необходимости использования иных периодов обновления – обсудите это с вашим контактным лицом в SberDevices.

  • Каждая единица контента задается отдельным объектом.
  • Опции оплат задаются как массив в каждой единице контента.
  • Сериальная матрица может отсутствовать.
  • Если вами используются уникальные идентификаторы контента, сообщите об этом отдельно.
  • При необходимости передавать новый тип контента необходимо согласовать добавление нового ТИПА, размещение в некорректных уже существующих типах контента запрещено.
  • У единицы контента может быть указано несколько «жанров». Справочник доступных жанров приведен в комментарии к соответствующему полю.
  • Маркировка возраста, эротики и порноконтента обязательна.

В случае отсутствия данных по полям помеченных в текущей документации как обязательные свяжитесь с вашим контактным лицом в SberDevices.

Полнота контента

  • Ожидается, что поставщик предоставляет весь доступный контент, кроме UGC. Если имеющиеся типы не охватывают полноту каталога (например, спортивный контент), то свяжитесь с вашим контактным лицом в SberDevices для согласования добавления новых типов.
  • Добавление UGC контента в фид имеет смысл при условии, что его использование запланировано совместно. Любые детали всегда можно уточнить у контактного лица в SberDevices.
  • В фиде могут быть переданы подборки контента, как отдельный объект данных, их промо размещение (формат, срок, состав, стоимость и т.д.) согласуется отдельно через менеджера SberDevices.
  • Если планируется отправка промоподборок и их обновление силами собственных контент-менеджеров, то возможно создание отдельных галерей контента с уникальными идентификаторами, которые далее необходимо сообщить менеджеру SberDevices.

Требования к размеру и формату изображений

НазваниеФорматРазмер, px
Горизонтальные изображения covers.webp640 х 360
Квадратные виджеты (square_small_type).webp640 х 640
Вертикальные изображения covers.webp640 х 960
Фоновое изображение для карточки контента без логотипа/названия фильма/сериала thumbnails.webp1920 х 1080
Изображение с названием/логотипом фильма/сериала titleImage.png/.webp (с прозрачным фоном)Максимальные размеры контейнера для изображения:
ширина - 392
высота - 80
Примеры использования изображений
Пример изображения title
Пример изображения covers

Описание SberJson

Общая схема

provider
required
string

Название поставщика

version
required
string

Версия фида:

  • 2.03
  • 2.02
  • 2.01
required
Array of objects[ items ]
{
  • "provider": "videoprovider",
  • "version": "string",
  • "contents": [
    ]
}

Пример формирования элемента MOVIE

provider
required
string

Название поставщика

version
string

Версия фида:

  • 2.03
  • 2.02
  • 2.01
required
Array of objects[ items ]
{
  • "provider": "videoprovider",
  • "version": "string",
  • "contents": [
    ]
}

Пример формирования элемента SERIES

provider
required
string

Название поставщика

version
string

Версия фида:

  • 2.03
  • 2.02
  • 2.01
required
Array of objects[ items ]
{
  • "provider": "videoprovider",
  • "version": "string",
  • "contents": [
    ]
}

Пример формирования элемента TVCHANNEL

provider
required
string

Название поставщика

version
string

Версия фида:

  • 2.03
  • 2.02
  • 2.01
required
Array of objects[ items ]
{
  • "provider": "videoprovider",
  • "version": "string",
  • "contents": [
    ]
}

Пример формирования элемента TVSHOW

provider
required
string

Название поставщика

version
string

Версия фида:

  • 2.03
  • 2.02
  • 2.01
required
Array of objects[ items ]
{
  • "provider": "videoprovider",
  • "version": "string",
  • "contents": [
    ]
}

Пример формирования элемента UGC

provider
required
string

Название поставщика

version
string

Версия фида:

  • 2.03
  • 2.02
  • 2.01
required
Array of objects[ items ]
{
  • "provider": "videoprovider",
  • "version": "string",
  • "contents": [
    ]
}
provider
required
string

Название поставщика

version
string

Версия фида:

  • 2.03
  • 2.02
  • 2.01
required
Array of objects[ items ]
{
  • "provider": "videoprovider",
  • "version": "string",
  • "contents": [
    ]
}

Как работать с датой релиза контента

  • Для управления доступностью контента рекомендуем использовать флаг availability, либо при недоступности возможно удаление контента из фида. Не желательно сохранять большое количество недоступных тайтлов в фиде, т.к. это приводит к увеличению размера файла и замедлению обновления каталога.

  • Для контента, дата начала доступности которого известна, можно использовать поле availabilityStartDate". При наступлении этой даты контент становится доступным (значение поля availability в таком случае игнорируется).

  • Для контента, дата начала недоступности которого известна, можно использовать поле availabilityEndDate. При наступлении этой даты контент становится недоступным (значения полей availability и availabilityStartDate в этом случае игнорируются).

//
"availability" : false,
"availabilityStartDate": "2024-01-01T00:00:01Z",
"availabilityEndDate": "2026-01-01T23:59:59Z",
//

Контент будет доступен в период указанных дат:

  • availabilityStartDate
  • availabilityEndDate
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.