Livedeckウィジェットの manifest.json:フィールド、権限、エラーコード
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"]) |
キャンバスは 9:16 で 1080 × 1920 ピクセル、16:9 で 1920 × 1080 ピクセルです。サイズは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(ギフト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 | 数値(エディターではスライダーで表示) |
| 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オブジェクトではありません。
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。 |
この記事は役に立ちましたか?