manifest.json для виджетов Livedeck: поля, разрешения и коды ошибок

Все поля, разрешения и типы настроек manifest.json, а также значения кодов ошибок.

8 мин чтения Обновлено 4 нояб. 2026 г.

manifest.json описывает ваш виджет. Livedeck читает его при загрузке, строит по нему настройки в редакторе и даёт виджету только перечисленные в нём разрешения. Неизвестные поля считаются ошибкой, чтобы опечатки не оставались незамеченными.

json
{
  "manifestVersion": 1,
  "name": "Gift Goal",
  "version": "1.0.0",
  "sdk": "1",
  "entry": "index.html",
  "description": "A bar that fills up with gifts.",
  "formats": ["9:16", "16:9"],
  "size": { "default": [600, 160], "min": [300, 80], "max": [1080, 400] },
  "permissions": ["events.gift", "media.play"],
  "settings": [
    { "key": "goal", "type": "number", "label": { "de": "Ziel", "en": "Goal" }, "default": 100, "min": 1 },
    { "key": "giftId", "type": "gift", "label": { "de": "Nur dieses Geschenk", "en": "Only this gift" } },
    { "key": "accent", "type": "color", "label": { "de": "Farbe", "en": "Colour" }, "default": "#22c55e" },
    { "key": "doneSound", "type": "media", "label": { "de": "Ton bei Ziel", "en": "Goal sound" }, "accept": "audio" }
  ],
  "locales": ["de", "en"]
}

Поля

manifestVersion

Обязательное поле: да

Значение: Всегда 1

name

Обязательное поле: да

Значение: Название виджета, не более 60 символов

version

Обязательное поле: да

Значение: Номер версии x.y.z, например 1.2.0

sdk

Обязательное поле: да

Значение: Версия SDK, сейчас "1"

entry

Обязательное поле: нет

Значение: Стартовый файл, по умолчанию index.html. Должен заканчиваться на .html.

description

Обязательное поле: нет

Значение: Краткое описание, не более 300 символов

formats

Обязательное поле: нет

Значение: ["9:16"], ["16:9"] или оба (по умолчанию — оба)

size

Обязательное поле: да

Значение: Размер в пикселях на холсте оверлея: default, min и max в виде [ширина, высота]

permissions

Обязательное поле: нет

Значение: Какие данные получает виджет (см. ниже)

settings

Обязательное поле: нет

Значение: Настройки, которые пользователи меняют в редакторе (не более 40)

locales

Обязательное поле: нет

Значение: Языки, которые поддерживает виджет, например ["de", "en"]

Холст — 1080 × 1920 пикселей в 9:16 и 1920 × 1080 в 16:9. Размеры — от 16 до 3840 пикселей. min и max — пределы, в которых пользователи могут менять размер виджета в редакторе. Без них действует default. Верстайте виджет в фиксированных пикселях под default: при изменении размера Livedeck масштабирует всю страницу вместе с рамкой (текст, изображения и отступы растут вместе). Если пропорции рамки отличаются от default, страница получает дополнительное место в этом направлении, поэтому там, где нужно заполнить пространство, используйте ширину/высоту 100%, flexbox или grid. livedeck.context.size — размер страницы в CSS-пикселях, livedeck.context.scale — масштаб.

Разрешения

Покупатели видят этот список перед покупкой, а редактор показывает его в разделе «Получает доступ к». Запрашивайте только то, что действительно нужно.

events.gift

Подарки (событие gift)

events.chat

Сообщения чата (chat)

events.like

Лайки, пакетами (like)

events.follow

Новые подписчики (follow)

events.share

Репосты LIVE (share)

events.join

Зритель заходит в LIVE (join)

events.fanclub

Вступления в фан-клуб (fanclub)

events.viewers

Число зрителей (viewers)

stream.status

В эфире, офлайн или проверяется (stream)

media.play

Может воспроизводить звуки из медиа-настроек через Livedeck

host.profile

Имя и фото профиля стримера (livedeck.host)

Настройки

У каждой настройки есть key, type и label. key начинается со строчной буквы, за которой идут буквы, цифры или _ (не более 32 символов). label — это текст или объект с языками, например {"de": "Farbe", "en": "Colour"}, не более 80 символов. Виджет считывает значения из livedeck.settings.

text

Поля: default, maxLength (не более 200)

Значение в виджете: Текст

number

Поля: default, min, max, step (все необязательны)

Значение в виджете: Число

range

Поля: default, min и max (обязательны), step

Значение в виджете: Число, в редакторе отображается ползунком

boolean

Поля: default

Значение в виджете: true или false

color

Поля: default в формате #rrggbb

Значение в виджете: Цвет в формате #rrggbb

select

Поля: options (от 1 до 50, у каждой value и label), default

Значение в виджете: value выбранного варианта

gift

Поля: default (ID подарка или null)

Значение в виджете: ID подарка числом или null

media

Поля: accept: audio, image или video. Без default.

Значение в виджете: true, если пользователь выбрал свой файл, иначе false

Примечание: Медиа-настройки никогда не передают виджету адрес файла. Воспроизводите звуки через livedeck.media.play(key), а картинки и клипы получайте через livedeck.media.url(key).

Если значение отсутствует или некорректно, виджет получает значение по умолчанию. Так обновления с новыми настройками работают у всех, кто уже использует ваш виджет.

Ошибки в manifest.json

Если проверка завершается ошибкой «manifest.json is invalid», под ней указаны код и место, например settings[2].default.

manifest_not_object

Файл не является JSON-объектом.

manifest_too_large

Файл больше 64 KB.

manifest_invalid_json

Некорректный JSON (часто лишняя или пропущенная запятая).

unknown_field

Такого поля не существует. Обычно это опечатка.

required

Отсутствует обязательное поле.

wrong_type

Неверный тип, например текст вместо списка.

unsupported_manifest_version

manifestVersion не равен 1.

unsupported_sdk

sdk не равен "1".

invalid_name

Название пустое, длиннее 60 символов или содержит невидимые управляющие символы.

invalid_text

Текст пустой, слишком длинный или содержит невидимые управляющие символы.

invalid_version

Версия не в формате x.y.z (например 1.0.0).

invalid_entry

entry не является относительным путём к файлу .html.

invalid_format

Формат не "9:16" и не "16:9".

duplicate

Повторяющаяся запись.

invalid_size

Размер вне диапазона от 16 до 3840 пикселей или default не находится между min и max.

unknown_permission

Такого разрешения не существует.

too_many_settings

Больше 40 настроек.

invalid_setting_key

key не соответствует шаблону (см. выше).

unknown_setting_type

Такого типа настройки не существует.

invalid_default

default не подходит к типу или выходит за границы.

invalid_bounds

Некорректное значение min, max, step или maxLength.

invalid_options

options отсутствуют, пусты, их больше 50 или у варианта нет value.

invalid_media_kind

accept не равен audio, image или video.

invalid_locale

Такого языка не существует. Допустимые: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th.

Статья была полезной?