ウェブアプリマニフェストのメンバーのリファレンス

このページでは、ウェブで使用されるウェブアプリマニフェストのメンバーのリファレンスを一覧で紹介します。

background_color

background_color メンバーは、スタイルシートが読み込まれる前に表示するアプリケーションページの背景色を定義します。 この色は、スタイルシートが読み込まれる前にマニフェストが利用可能な場合、ショートカットの背景色を描画するために、ユーザーエージェントが使用します。

categories

categories はマニフェストのメンバーで、ウェブアプリケーションに 1 つ以上の分類を指定することができます。 これらのカテゴリーは、ユーザーがアプリストアでアプリを見つけるのに役立ちます。

description

description はマニフェストのメンバーで、このウェブアプリケーションの主な特性や機能を説明するために使用します。 このテキストは、アプリストアでアプリを表示した際に、ユーザーがアプリの目的を理解する手助けとなります。

display

display はマニフェストのメンバーで、ウェブアプリケーションの推奨表示モードを指定するために使用します。表示モードは、オペレーティングシステムのコンテキスト内でアプリケーションが起動された際に、ブラウザのUIがユーザーに表示される範囲を決定します。ブラウザのインターフェースをすべて表示するか、あるいは非表示にして、よりアプリケーションらしい体験を提供するかを選択できます。

display_override

display メンバーは、開発者が推奨するウェブサイトの表示モードを決定するために使用されます。これは、要求された表示モードに対応していない場合に、ブラウザーが次善の表示モードに代替するプロセスに従います。高度な用途では、この代替プロセスでは十分でない場合があります。

file_handlers

file_handlers メンバーは、インストールされたプログレッシブウェブアプリ (PWA) が処理できるファイルの型を表すオブジェクトの配列を指定します。

icons

icons はマニフェストのメンバーで、このウェブアプリケーションを表すアイコンを定義する 1 つ以上の画像を指定するために使用します。

id

id はマニフェストメンバーで、このウェブアプリケーションのための一意な識別子を指定するために使用します。

launch_handler

launch_handler メンバーは、ウェブアプリケーションの起動を制御する値を定義します。現時点では、このメンバーには単一の値 client_mode しか設定できません。この値は、アプリケーションが起動された際に読み込むべきコンテキストを指定します。例えば、アプリケーションのインスタンスを含む既存のウェブアプリケーションクライアントであったり、または新しいウェブアプリケーションクライアントであったりです。これにより、将来的に launch_handler の値をさらに定義できる余地が残されています。

name

name はマニフェストのメンバーで、ウェブアプリケーションのフルネームを指定するために使用します。これは通常、アプリケーションの一覧に掲載されている場合や、アプリケーションのアイコンのラベルとして表示される場合など、ユーザーに表示されます。

note_taking

note_taking メンバーは、ウェブアプリをメモアプリとして識別し、新しいメモを作成するための機能を示す URL などの関連情報を定義します。これにより、オペレーティングシステムは、アプリのメモ作成機能を統合できるようになります。例えば、アプリのコンテキストメニューに「新しいメモ」オプションを記載したり、他にもアプリでメモを作成するためのオプションとしてアプリを提供したりすることができます。

orientation

orientation はマニフェストのメンバーで、ウェブアプリケーションの既定の方向を指定します。 アプリが起動時および使用中にどのように表示されるべきかを、端末の画面の向きに関連して定義します。特に、複数の方向に対応している端末で具体的な内容が定義されます。

prefer_related_applications マニフェストメンバーは、 related_applications マニフェストメンバーで指定されたネイティブアプリケーションをウェブアプリケーションよりも優先してインストールするかどうかをブラウザーに指定するためのヒントを提供するために使用されます。

protocol_handlers

protocol_handlers メンバーは、このウェブアプリが登録・処理することができるプロトコルを表すオブジェクトの配列を指定します。プロトコルハンドラーは、 OS のアプリケーション設定にアプリケーションを登録します。登録は、特定のアプリケーションと与えられたプロトコルスキームを関連付けます。例えば、ウェブページで mailto:// というプロトコルハンドラーを使用すると、登録されたメールアプリケーションが開きます。

related_applications はマニフェストメンバーで、ウェブアプリケーションに関連する 1 つまたは複数のネイティブアプリケーションを指定するために使用します。 関連のネイティブアプリケーションまたはウェブアプリケーションのどちらかをインストールする環境設定を示す、 prefer_related_applications マニフェストメンバーと一緒に使用することができます。

scope

scope はマニフェストメンバーで、ウェブアプリケーションのページとサブディレクトリーを格納する最上位の URL パスを指定するために使用します。 ユーザーがウェブアプリをインストールして使用すると、スコープ内のページがアプリのようなインターフェイスを提供します。 ユーザーがアプリの対象外のページに移動した場合でも、アプリのようなインターフェイスはそのままですが、ブラウザーではコンテキストの変化を示すために、 URL バーなどの UI の要素が表示されます。

screenshots

screenshots はマニフェストメンバーで、ウェブアプリケーションのショーケースとなる 1 枚以上の画像を指定することができます。 これらの画像は、ユーザーがアプリストアでウェブアプリのインターフェイスや機能をプレビューするのに役立ちます。

serviceworker

serviceworker メンバーは、商業ウェブサイトで指定された決済方法の決済メカニズムを提供するウェブベースの決済アプリケーションを実行するために、ジャストインタイム (JIT) でインストールされ、登録されたサービスワーカーを指定します。詳細は、Payment Handler API を参照してください。

share_target

share_target はマニフェストのメンバーで、Progressive web apps (PWA) をシステムの共有ダイアログの共有先として登録することができます。

short_name

short_name はマニフェストメンバーで、ウェブアプリケーションの短縮名を指定するために使用します。これは、完全な name が利用できる空間に対して長すぎる場合に、使用されるかもしれません。

shortcuts

shortcuts はマニフェストメンバーで、ウェブアプリケーション内の主要な課題やページへのリンクを指定するために使用します。 ブラウザーは、この情報を使用してコンテキストメニューを作成することができます。コンテキストメニューは通常、ユーザーがウェブアプリケーションのアイコンを操作したときに表示されます。

start_url

start_url はマニフェストメンバーで、ユーザーがウェブアプリケーションを起動した際に開くための URL を指定するために使用します。例えば、端末のホーム画面にあるアプリケーションのアイコンをタップしたり、アプリケーションの一覧に掲載されているアプリケーションを起動したりした際などです。

theme_color

theme_color メンバーは、ウェブアプリケーションのユーザーインターフェイスの既定色を指定するために使用します。 この色は、ツールバー、アドレスバー、ステータスバーなど、さまざまなブラウザー UI 要素に適用されます。 タスクスイッチャーやホーム画面にアプリケーションが追加された場合など、特に目立つ場合があります。

関連情報