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.

Ця стаття була корисною?