manifest.json para widgets de Livedeck: campos, permisos y códigos de error
Todos los campos, permisos y tipos de ajuste de manifest.json, y qué significa cada código de error.
manifest.json describe tu widget. Livedeck lo lee al subirlo, crea a partir de él los ajustes del editor y le da al widget solo los permisos que aparecen en él. Los campos desconocidos dan error, así ninguna errata pasa desapercibida.
{
"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"]
}Campos
manifestVersion
Obligatorio: sí
Significado: Siempre 1
name
Obligatorio: sí
Significado: Nombre del widget, máximo 60 caracteres
version
Obligatorio: sí
Significado: Número de versión x.y.z, por ejemplo 1.2.0
sdk
Obligatorio: sí
Significado: Versión del SDK, hoy "1"
entry
Obligatorio: no
Significado: Archivo de inicio, index.html por defecto. Debe terminar en .html.
description
Obligatorio: no
Significado: Descripción corta, máximo 300 caracteres
formats
Obligatorio: no
Significado: ["9:16"], ["16:9"] o ambos (por defecto: ambos)
size
Obligatorio: sí
Significado: Tamaño en píxeles en el lienzo del overlay: default, min y max como [ancho, alto]
permissions
Obligatorio: no
Significado: Qué datos recibe el widget (ver abajo)
settings
Obligatorio: no
Significado: Ajustes que los usuarios cambian en el editor (máximo 40)
locales
Obligatorio: no
Significado: Idiomas que admite tu widget, por ejemplo ["de", "en"]
| Campo | Obligatorio | Significado |
|---|---|---|
| manifestVersion | sí | Siempre 1 |
| name | sí | Nombre del widget, máximo 60 caracteres |
| version | sí | Número de versión x.y.z, por ejemplo 1.2.0 |
| sdk | sí | Versión del SDK, hoy "1" |
| entry | no | Archivo de inicio, index.html por defecto. Debe terminar en .html. |
| description | no | Descripción corta, máximo 300 caracteres |
| formats | no | ["9:16"], ["16:9"] o ambos (por defecto: ambos) |
| size | sí | Tamaño en píxeles en el lienzo del overlay: default, min y max como [ancho, alto] |
| permissions | no | Qué datos recibe el widget (ver abajo) |
| settings | no | Ajustes que los usuarios cambian en el editor (máximo 40) |
| locales | no | Idiomas que admite tu widget, por ejemplo ["de", "en"] |
El lienzo mide 1080 × 1920 píxeles en 9:16 y 1920 × 1080 en 16:9. Los tamaños van de 16 a 3840 píxeles. min y max son los límites cuando los usuarios cambian el tamaño del widget en el editor. Sin ellos, se aplica default. Construye el widget en píxeles fijos para default: cuando los usuarios lo redimensionan, Livedeck hace zoom a toda la página junto con el cuadro (texto, imágenes y espaciados crecen a la vez). Si el cuadro toma otra proporción distinta de default, la página gana el espacio extra en esa dirección, así que usa anchos/altos al 100 %, flexbox o grid donde deba rellenar. livedeck.context.size es el tamaño de la página en píxeles CSS y livedeck.context.scale, el zoom.
Permisos
Los compradores ven esta lista antes de comprar, y el editor la muestra en “Tiene acceso a”. Pide solo lo que de verdad necesites.
events.gift
Regalos (evento gift)
events.chat
Mensajes del chat (chat)
events.like
Me gusta, agrupados (like)
events.follow
Nuevos seguidores (follow)
events.share
Veces que se comparte el LIVE (share)
events.join
Un espectador entra al LIVE (join)
events.fanclub
Nuevos miembros del club de fans (fanclub)
events.viewers
Número de espectadores (viewers)
stream.status
En directo, offline o en revisión (stream)
media.play
Puede reproducir sonidos de los ajustes multimedia a través de Livedeck
host.profile
El nombre y la foto de perfil del streamer (livedeck.host)
| Permiso | Qué recibe el widget |
|---|---|
| events.gift | Regalos (evento gift) |
| events.chat | Mensajes del chat (chat) |
| events.like | Me gusta, agrupados (like) |
| events.follow | Nuevos seguidores (follow) |
| events.share | Veces que se comparte el LIVE (share) |
| events.join | Un espectador entra al LIVE (join) |
| events.fanclub | Nuevos miembros del club de fans (fanclub) |
| events.viewers | Número de espectadores (viewers) |
| stream.status | En directo, offline o en revisión (stream) |
| media.play | Puede reproducir sonidos de los ajustes multimedia a través de Livedeck |
| host.profile | El nombre y la foto de perfil del streamer (livedeck.host) |
Configuración
Cada ajuste tiene un key, un type y un label. El key empieza por una letra minúscula seguida de letras, dígitos o _ (máximo 32 caracteres). Un label es un texto o un objeto con idiomas como {"de": "Farbe", "en": "Colour"}, máximo 80 caracteres. El widget lee los valores de livedeck.settings.
text
Campos: default, maxLength (máximo 200)
Valor en el widget: Texto
number
Campos: default, min, max, step (todos opcionales)
Valor en el widget: Número
range
Campos: default, min y max (obligatorios), step
Valor en el widget: Número, mostrado como control deslizante en el editor
boolean
Campos: default
Valor en el widget: true o false
color
Campos: default como #rrggbb
Valor en el widget: Color como #rrggbb
select
Campos: options (de 1 a 50, cada una con value y label), default
Valor en el widget: value de la opción elegida
gift
Campos: default (ID de regalo o null)
Valor en el widget: ID de regalo como número, o null
media
Campos: accept: audio, image o video. Sin default.
Valor en el widget: true si el usuario eligió un archivo propio; si no, false
| Tipo | Campos | Valor en el widget |
|---|---|---|
| text | default, maxLength (máximo 200) | Texto |
| number | default, min, max, step (todos opcionales) | Número |
| range | default, min y max (obligatorios), step | Número, mostrado como control deslizante en el editor |
| boolean | default | true o false |
| color | default como #rrggbb | Color como #rrggbb |
| select | options (de 1 a 50, cada una con value y label), default | value de la opción elegida |
| gift | default (ID de regalo o null) | ID de regalo como número, o null |
| media | accept: audio, image o video. Sin default. | true si el usuario eligió un archivo propio; si no, false |
Si un valor falta o no es válido, el widget recibe el valor predeterminado. Así, las actualizaciones con ajustes nuevos funcionan para todos los que ya usan tu widget.
Errores en manifest.json
Si la comprobación falla con "manifest.json is invalid", debajo aparecen el código y la ubicación, por ejemplo settings[2].default.
manifest_not_object
El archivo no es un objeto JSON.
manifest_too_large
El archivo pesa más de 64 KB.
manifest_invalid_json
JSON no válido (a menudo sobra o falta una coma).
unknown_field
Este campo no existe. Suele ser un error de escritura.
required
Falta un campo obligatorio.
wrong_type
Tipo incorrecto, por ejemplo texto en lugar de una lista.
unsupported_manifest_version
manifestVersion no es 1.
unsupported_sdk
sdk no es "1".
invalid_name
Nombre vacío, de más de 60 caracteres o con caracteres de control invisibles.
invalid_text
Texto vacío, demasiado largo o con caracteres de control invisibles.
invalid_version
La versión no tiene el formato x.y.z (por ejemplo 1.0.0).
invalid_entry
entry no es una ruta relativa a un archivo .html.
invalid_format
El formato no es "9:16" ni "16:9".
duplicate
Entrada duplicada.
invalid_size
Tamaño fuera del rango de 16 a 3840 píxeles, o default no está entre min y max.
unknown_permission
Este permiso no existe.
too_many_settings
Más de 40 ajustes.
invalid_setting_key
key no coincide con el patrón (ver arriba).
unknown_setting_type
Este tipo de ajuste no existe.
invalid_default
default no corresponde al tipo o está fuera de los límites.
invalid_bounds
min, max, step o maxLength no es válido.
invalid_options
options falta, está vacío, tiene más de 50 o una opción no tiene value.
invalid_media_kind
accept no es audio, image ni video.
invalid_locale
Este idioma no existe. Permitidos: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th.
| Código | Significado |
|---|---|
| manifest_not_object | El archivo no es un objeto JSON. |
| manifest_too_large | El archivo pesa más de 64 KB. |
| manifest_invalid_json | JSON no válido (a menudo sobra o falta una coma). |
| unknown_field | Este campo no existe. Suele ser un error de escritura. |
| required | Falta un campo obligatorio. |
| wrong_type | Tipo incorrecto, por ejemplo texto en lugar de una lista. |
| unsupported_manifest_version | manifestVersion no es 1. |
| unsupported_sdk | sdk no es "1". |
| invalid_name | Nombre vacío, de más de 60 caracteres o con caracteres de control invisibles. |
| invalid_text | Texto vacío, demasiado largo o con caracteres de control invisibles. |
| invalid_version | La versión no tiene el formato x.y.z (por ejemplo 1.0.0). |
| invalid_entry | entry no es una ruta relativa a un archivo .html. |
| invalid_format | El formato no es "9:16" ni "16:9". |
| duplicate | Entrada duplicada. |
| invalid_size | Tamaño fuera del rango de 16 a 3840 píxeles, o default no está entre min y max. |
| unknown_permission | Este permiso no existe. |
| too_many_settings | Más de 40 ajustes. |
| invalid_setting_key | key no coincide con el patrón (ver arriba). |
| unknown_setting_type | Este tipo de ajuste no existe. |
| invalid_default | default no corresponde al tipo o está fuera de los límites. |
| invalid_bounds | min, max, step o maxLength no es válido. |
| invalid_options | options falta, está vacío, tiene más de 50 o una opción no tiene value. |
| invalid_media_kind | accept no es audio, image ni video. |
| invalid_locale | Este idioma no existe. Permitidos: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th. |
¿Te resultó útil este artículo?