manifest.json لـ widgets في Livedeck: الحقول والصلاحيات ورموز الأخطاء
كل حقل وصلاحية ونوع إعداد في manifest.json، ومعنى كل رمز خطأ.
يصف manifest.json الـ widget الخاص بك. يقرؤه Livedeck عند الرفع، ويبني منه إعدادات المحرر، ولا يمنح الـ widget إلا الصلاحيات المذكورة فيه. الحقول غير المعروفة تُعد خطأً حتى لا تختفي الأخطاء الإملائية.
{
"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
حقل مطلوب: نعم
المعنى: اسم الـ widget، بحد أقصى 60 حرفًا
version
حقل مطلوب: نعم
المعنى: رقم الإصدار x.y.z، مثلًا 1.2.0
sdk
حقل مطلوب: نعم
المعنى: إصدار الـ SDK، حاليًا "1"
entry
حقل مطلوب: لا
المعنى: ملف البداية، index.html افتراضيًا. يجب أن ينتهي بـ .html.
description
حقل مطلوب: لا
المعنى: وصف قصير، بحد أقصى 300 حرف
formats
حقل مطلوب: لا
المعنى: ["9:16"] أو ["16:9"] أو كلاهما (الافتراضي: كلاهما)
size
حقل مطلوب: نعم
المعنى: الحجم بالبكسل على لوحة الـ overlay: default وmin وmax بصيغة [العرض، الارتفاع]
permissions
حقل مطلوب: لا
المعنى: البيانات التي يتلقاها الـ widget (انظر أدناه)
settings
حقل مطلوب: لا
المعنى: إعدادات يغيّرها المستخدمون في المحرر (بحد أقصى 40)
locales
حقل مطلوب: لا
المعنى: اللغات التي يدعمها الـ widget، مثلًا ["de", "en"]
| الحقل | حقل مطلوب | المعنى |
|---|---|---|
| manifestVersion | نعم | دائمًا 1 |
| name | نعم | اسم الـ widget، بحد أقصى 60 حرفًا |
| version | نعم | رقم الإصدار x.y.z، مثلًا 1.2.0 |
| sdk | نعم | إصدار الـ SDK، حاليًا "1" |
| entry | لا | ملف البداية، index.html افتراضيًا. يجب أن ينتهي بـ .html. |
| description | لا | وصف قصير، بحد أقصى 300 حرف |
| formats | لا | ["9:16"] أو ["16:9"] أو كلاهما (الافتراضي: كلاهما) |
| size | نعم | الحجم بالبكسل على لوحة الـ overlay: default وmin وmax بصيغة [العرض، الارتفاع] |
| permissions | لا | البيانات التي يتلقاها الـ widget (انظر أدناه) |
| settings | لا | إعدادات يغيّرها المستخدمون في المحرر (بحد أقصى 40) |
| locales | لا | اللغات التي يدعمها الـ widget، مثلًا ["de", "en"] |
اللوحة بحجم 1080 × 1920 بكسل في 9:16 و1920 × 1080 في 16:9. تتراوح الأحجام من 16 إلى 3840 بكسل. min وmax هما الحدّان عندما يغيّر المستخدمون حجم الـ widget في المحرر. بدونهما يُطبَّق default. صمّم الـ widget ببكسلات ثابتة وفق 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)
| الصلاحية | ما يتلقاه الـ widget |
|---|---|
| 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 حرفًا. يقرأ الـ widget القيم من livedeck.settings.
text
الحقول: default وmaxLength (بحد أقصى 200)
القيمة في الـ widget: نص
number
الحقول: default وmin وmax وstep (كلها اختيارية)
القيمة في الـ widget: رقم
range
الحقول: default وmin وmax (إلزامية) وstep
القيمة في الـ widget: رقم، يظهر كشريط تمرير في المحرر
boolean
الحقول: default
القيمة في الـ widget: true أو false
color
الحقول: default بصيغة #rrggbb
القيمة في الـ widget: لون بصيغة #rrggbb
select
الحقول: options (من 1 إلى 50، لكل منها value وlabel) وdefault
القيمة في الـ widget: value للخيار المحدد
gift
الحقول: default (معرّف الهدية أو null)
القيمة في الـ widget: معرّف الهدية كرقم، أو null
media
الحقول: accept: audio أو image أو video. بدون default.
القيمة في الـ widget: true عندما يختار المستخدم ملفًا خاصًا به، وإلا false
| النوع | الحقول | القيمة في الـ widget |
|---|---|---|
| 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 |
عندما تكون القيمة مفقودة أو غير صالحة، يحصل الـwidget على القيمة الافتراضية. بهذا تعمل التحديثات ذات الإعدادات الجديدة لدى كل من يستخدم الـwidget الخاص بك بالفعل.
أخطاء في 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 بكسل، أو القيمة الافتراضية ليست بين 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 بكسل، أو القيمة الافتراضية ليست بين 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. |
هل كانت هذه المقالة مفيدة؟