manifest.json สำหรับวิดเจ็ต Livedeck: ฟิลด์ สิทธิ์ และรหัสข้อผิดพลาด
ทุกฟิลด์ สิทธิ์ และประเภทการตั้งค่าของ manifest.json พร้อมความหมายของรหัสข้อผิดพลาดแต่ละตัว
manifest.json ใช้อธิบายวิดเจ็ตของคุณ Livedeck จะอ่านไฟล์นี้ตอนอัปโหลด สร้างการตั้งค่าใน Editor จากไฟล์นี้ และให้สิทธิ์วิดเจ็ตเฉพาะที่ระบุไว้เท่านั้น ฟิลด์ที่ไม่รู้จักจะถือเป็นข้อผิดพลาด เพื่อไม่ให้พิมพ์ผิดแล้วหลุดรอด
{
"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 ในรูปแบบ [width, height]
permissions
จำเป็น: ไม่
ความหมาย: ข้อมูลที่วิดเจ็ตได้รับ (ดูด้านล่าง)
settings
จำเป็น: ไม่
ความหมาย: การตั้งค่าที่ผู้ใช้ปรับได้ใน Editor (ไม่เกิน 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 ในรูปแบบ [width, height] |
| permissions | ไม่ | ข้อมูลที่วิดเจ็ตได้รับ (ดูด้านล่าง) |
| settings | ไม่ | การตั้งค่าที่ผู้ใช้ปรับได้ใน Editor (ไม่เกิน 40) |
| locales | ไม่ | ภาษาที่วิดเจ็ตรองรับ เช่น ["de", "en"] |
แคนวาสมีขนาด 1080 × 1920 พิกเซลในแบบ 9:16 และ 1920 × 1080 ในแบบ 16:9 ขนาดอยู่ระหว่าง 16 ถึง 3840 พิกเซล min และ max คือขีดจำกัดเมื่อผู้ใช้ปรับขนาดวิดเจ็ตใน Editor ถ้าไม่กำหนดจะใช้ default สร้างวิดเจ็ตด้วยพิกเซลคงที่ตาม default: เมื่อผู้ใช้ปรับขนาด Livedeck จะซูมทั้งหน้าไปพร้อมกับกรอบ (ข้อความ รูปภาพ และระยะห่างจะขยายไปด้วยกัน) ถ้ากรอบมีสัดส่วนต่างจาก default หน้าจะได้พื้นที่เพิ่มในทิศทางนั้น จึงควรใช้ความกว้าง/ความสูง 100%, flexbox หรือ grid ในส่วนที่ต้องการให้เต็มพื้นที่ livedeck.context.size คือขนาดหน้าเป็นพิกเซล CSS และ livedeck.context.scale คือค่าซูม
สิทธิ์การเข้าถึง
ผู้ซื้อจะเห็นรายการนี้ก่อนซื้อ และ Editor จะแสดงไว้ใต้ “เข้าถึงได้” ขอเฉพาะสิ่งที่จำเป็นจริงๆ เท่านั้น
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
ค่าในวิดเจ็ต: ตัวเลข แสดงเป็นแถบเลื่อนใน Editor
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
| ประเภท | ฟิลด์ | ค่าในวิดเจ็ต |
|---|---|---|
| text | default, maxLength (ไม่เกิน 200) | ข้อความ |
| number | default, min, max, step (ไม่บังคับทั้งหมด) | ตัวเลข |
| range | default, min และ max (บังคับ), step | ตัวเลข แสดงเป็นแถบเลื่อนใน Editor |
| 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 |
หากค่าหายไปหรือไม่ถูกต้อง widget จะได้รับค่าเริ่มต้นแทน การอัปเดตที่มีการตั้งค่าใหม่จึงใช้งานได้กับทุกคนที่ใช้ widget ของคุณอยู่แล้ว
ข้อผิดพลาดใน manifest.json
หากการตรวจสอบล้มเหลวพร้อมข้อความ "manifest.json is invalid" รหัสและตำแหน่งจะแสดงอยู่ด้านล่าง เช่น settings[2].default
manifest_not_object
ไฟล์ไม่ใช่ JSON object
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 ไม่ใช่ path แบบ relative ไปยังไฟล์ .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 object |
| 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 ไม่ใช่ path แบบ relative ไปยังไฟล์ .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 |
บทความนี้มีประโยชน์ไหม?