manifest.json לווידג׳טים של Livedeck: שדות, הרשאות וקודי שגיאה
כל השדות, ההרשאות וסוגי ההגדרות של manifest.json, ומה פירוש כל קוד שגיאה.
manifest.json מתאר את הווידג׳ט שלך. Livedeck קורא אותו בהעלאה, בונה ממנו את ההגדרות בעורך ונותן לווידג׳ט רק את ההרשאות שמופיעות בו. שדות לא מוכרים הם שגיאה, כך ששגיאות הקלדה לא נעלמות.
{
"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"]
| שדה | שדה חובה | משמעות |
|---|---|---|
| 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)
| הרשאה | מה הווידג׳ט מקבל |
|---|---|
| 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 (מזהה מתנה או null)
הערך בווידג׳ט: מזהה מתנה כמספר, או null
media
שדות: accept: audio, image או video. אין default.
הערך בווידג׳ט: true כשהמשתמש בחר קובץ משלו, אחרת false
| סוג | שדות | הערך בווידג׳ט |
|---|---|---|
| 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 (מזהה מתנה או null) | מזהה מתנה כמספר, או null |
| media | accept: audio, image או video. אין default. | true כשהמשתמש בחר קובץ משלו, אחרת false |
כשערך חסר או לא תקין, הווידג’ט מקבל את ערך ברירת המחדל. כך עדכונים עם הגדרות חדשות עובדים אצל כל מי שכבר משתמש בווידג’ט שלך.
שגיאות ב־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.
| קוד | משמעות |
|---|---|
| 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. |
המאמר הזה עזר לך?