manifest.json

Estimated reading time: 5 minutes

manifest.json 構造

マニフェストファイル manifest.json にはアプリケーション情報を記載します。 (アプリケーションの ID、アプリケーションのタイトル名、スプラッシュ画像、起動 URL など) 情報や動作などの設定を行うことができます。

Field Name 必須/任意 説明
name 必須 アプリケーション名を指定します
default 必須 既定の表示言語を指定します (e.g. en_US)
以下のように、指定した言語のアプリケーション名の定義が必要です
en_US アプリケーション名 (英語) を指定します
ja_JP アプリケーション名 (日本語) を指定します
... (必要に応じて、上記のように言語毎のアプリケーション名を列挙します。)
auid 必須 auid を指定します
version 必須 アプリケーションのバージョン番号を指定します
manifest_version 必須 manifest のバージョンを指定します
("1.0" を指定してください)
app 必須 アプリケーション情報を指定します
launch 必須 以下のどちらかの方法で起動ページを指定します
local_path ("file://" で始まる) ファイルパス
web_url ("http://", "https://" で始まる) URL
cold_boot_delay 任意 AC ON初回にHTML5アプリを起動する場合、遅延時間をミリ秒で指定します
デフォルト値は0 です
利用用途の例：ネットワーク接続が確立するまでの待ち時間を指定
screen 任意 画面設定を指定します
orientation 任意 表示方向を指定します
  • 0 : 通常方向 (既定値)
  • 90 : 時計回りに 90 度
  • 270 : 時計回りに 270 度 (反時計回りに 90 度)
    ※ 180 : 指定できません
bgcolor 任意 背景色を指定します (例: "#FFFFFFFF")
window_close 任意 window.close() の動作を指定します
  • 0 : 無効 (既定値)
  • 1 : 有効
attachkeys 任意 アプリで取得可能にする追加キーイベントを指定します
(リファレンス > ユーザ入力 > リモコン入力 をご覧ください)
alert_dialog 任意 アラートダイアログの表示動作を指定します
  • ignore : アラートダイアログを表示しません
    ※ "alert_dialog" の指定がない場合、アラートダイアログを表示します
confirm_dialog 任意 確認ダイアログの表示動作を指定します
  • yes : 表示します (既定値)
  • no : 表示しません
prompt_dialog 任意 入力ダイアログの入力欄への文字列を設定します
文字列を指定することでユーザ操作を行うことなく、入力文字列を確定できます
initial_input 任意 デフォルトで適用される表示画質設定を指定します
  • video : 動画表示に適した設定 (既定値)
  • photo : 静止画表示に適した設定
fixed_input 任意 アプリのコンテンツ (静止画/動画/外部入力) が切り替わる際の動作の指定をします
  • true : コンテンツによらず、表示画質設定は変わりません (切り替えによるちらつきを抑えられます)
  • false : コンテンツに応じて、表示画質設定を変えます (既定値)
fixed_picture_mode 任意 再生するコンテンツに関係なく画質モードを固定します picture_modeが指定されている場合は、initial_inputとfixed_inputは無効になります
  • none : 再生するコンテンツに依存して自動的に画質モードが切り替わります(既定値)
  • game : 常に画質モードを"Game"に固定します
    HDMI遅延を抑えたい場合はこちらを利用します
onsleep 任意 リモコン操作により電源が切られた場合の内蔵ブラウザの動作指定
  • stop : ブラウザ動作を止めます (既定値)
  • pause : ブラウザ動作を中断し、ディスプレイの電源が入ったタイミングで動作を再開します
  • continue : ブラウザは動作を継続します
background 任意 HTML5プラットフォームがバックグランドに回った場合（HTML5プラットフォーム実行中にYouTubeアプリ起動した場合など）でも、Javascriptを継続動作させます
  • true : Javascriptを継続動作させます
  • false : Javascriptを停止します(既定値)
cache_files_and_images 任意 キャッシュ動作の指定をします
  • true : 有効にします (既定値)
    >(html, css, js, 動画/静止画コンテンツのキャッシュが有効です)
  • false : 無効にします
video 任意
multiple_video_tags 任意 video elementの複数同時利用を指定します
  • true : 複数同時利用を許可します
  • false : 同時利用を許可しません
    複数のvideo elementを作った場合の挙動は「あと勝ち方式 」になります(既定値)
error_page 任意 エラーページの指定を行います
default 任意 HTTP エラー発生時のページを指定します
("http://", "https://", "file://" が指定できます)
(例: "https://example.com/error/404.html")
detail 任意 各 HTTP ステータスコードのエラーページを指定します
以下に 403, 505, タイムアウトエラー時の例を示します
("http://", "https://", "file://" が指定できます)

[ {“status_code” : “403”, “path” : “https://example.com/errordocs/403.html”},
{“status_code” : “500”, “path” : “file://localhost/errordocs/500.html”},
{“status_code” : “timeout”, “path” : “file://localhost/errordocs/timeout.html”} ]

splash 任意 アプリ内のスプラッシュ画像ファイルを指定します。(e.g. splash.jpg)
reboot 任意 アプリがクラッシュした場合の動作を指定します
  • true : 自動的にアプリを再起動します
  • false : 何もしません (既定値)
minimum_web_platform_version 必須 ウェブプラットフォームバージョンを指定してください
("1.0" を指定してください)

以下に例を示します。マニフェストファイルは “manifest.json” というファイル名にする必要があります。

{
  "name": {
    "default": "en_US",
    "en_US": "Sample Application of BRAVIA Professional Display"
  },
  "auid": "com.example.app.myapp",
  "version": "1.0",
  "manifest_version": "1.0",
  "app": {
    "launch": {
      "web_url": "https://example.com/myapp"
    }
  },
  "splash": "splash.jpg",
  "minimum_web_platform_version": "1.0"
}
Last modified: 23 Aug 2023