ウェブアプリ マニフェスト - アプリケーション情報

W3Cグループノート

このドキュメントの詳細
このバージョン:
https://www.w3.org/TR/2023/NOTE-manifest-app-info-20230821/
最新公開バージョン:
https://www.w3.org/TR/manifest-app-info/
最新エディタードラフト:
https://w3c.github.io/manifest-app-info/
履歴:
https://www.w3.org/standards/history/manifest-app-info/
コミット履歴
編集者:
Aaron Gustafson (Microsoft Corporation)
フィードバック:
GitHub w3c/manifest-app-info (プルリクエスト, 新しい課題, オープンな課題)

要約

このドキュメントは、 Web Application Manifest仕様の補助メンバーのレジストリです。これらは アプリケーションマニフェストに追加のメタデータを提供します。このメタデータは、 デジタルストアフロントや本ウェブアプリケーションがマーケティングや配布される他の場面、またはウェブアプリケーションのインストール時のインストールダイアログの強化などに利用できます。

このドキュメントのステータス

このセクションは、本ドキュメントの公開時点での状況を示します。現在のW3C 公開文書およびこの技術レポートの最新版は、W3C 技術レポート一覧(https://www.w3.org/TR/)で確認できます。

このドキュメントは常に進化しており、変更がコミットされるたびに新しいスナップショットを公開しています。関心のある方は変更を購読したり、manifest-app-info GitHub リポジトリで新しいマニフェストメンバーの提案も可能です。

このドキュメントは、Web Applications Working Groupによってグループノートとして ノートトラックで公開されています。

このグループノートは Web Applications Working Groupによって支持されていますが、 W3C自身およびそのメンバーによる承認ではありません。

このドキュメントはドラフトであり、随時更新・置換・廃止される可能性があります。このドキュメントを進行中の作業以外のものとして引用することは不適切です。

W3C 特許ポリシーは、 本ドキュメントにおいてライセンス要件やコミットメントを伴いません。

このドキュメントは 2023年6月12日 W3Cプロセスドキュメント によって管理されています。

1. 販売可能なウェブアプリケーション

ウェブアプリケーションがより多くのサービス(例えば、デジタルストアフロントや検索結果など)を通じて提供され、ネイティブアプリケーションと並んで表示されるようになるにつれて、ネイティブアプリと同様の外観で表示されることが非常に重要になっています。ウェブアプリケーションは、マニフェスト内で nameicons を定義できますが、それらのキーだけでは、ユーザーがインストールしたいかどうか判断するのに十分な情報は提供されません。ユーザーは、インストールを検討する際にアプリについての詳細情報が提供されることに慣れており、このドキュメントはそのための追加のマニフェストメンバーを定義します。

2. 補助マニフェストメンバー

以下のメンバーは アプリケーションマニフェスト のメンバーを補完します。これらは補助的なメンバーとして分類され、実行時にウェブアプリケーションに 適用 されるものではありません(つまり、純粋に助言的であり、ユーザーエージェントが インストールされたウェブアプリケーション をどのように表示するかには影響しません)。すべてのメンバーは任意であり、以下の例のように アプリケーションマニフェスト のルートに追加できます。

1: 補助メンバーの使用例
{
  "name": "Donate App",
  "categories": ["fundraising", "donations"],
  "description": "This app helps you donate to worthy causes.",
  "iarc_rating_id": "e84b072d-71b3-4d3e-86ae-31a8ce4e53b7",
  "screenshots": [{
    "src": "images/screenshot.png",
    "sizes": "800x600",
    "platform": "windows",
    "label": "Lots of organizations to donate to"
  }]
}

アプリケーションマニフェスト はJSONであるため、この仕様のメンバーはThe JSON Data Interchange Format, 2nd edition で定義される objectarray、およびstring 型です。

2.1 categories メンバー

categories メンバーは、ウェブアプリケーションが属するアプリケーションカテゴリを記述する 配列 であり、 文字列 の集まりです。それはウェブアプリケーションを一覧表示するカタログやストアへのヒントとして機能します。これらは最善の努力により適切なカテゴリー(またはカテゴリ)でウェブアプリケーションをリストしようとしますが、検索エンジンやメタキーワード同様に、カタログやストアがこのヒントを必ずしも尊重する必要はありません。

マニフェストの作成者は小文字の使用を推奨します。

既知のカテゴリ一覧:

注意: カテゴリーの追加について

追加のカテゴリを希望する場合は、manifest-app-info GitHub リポジトリ にバグ報告またはプルリクエストを送ってください。

2.2 description メンバー

description メンバーは、ウェブアプリケーションの目的を開発者が説明できる 文字列 です。これは アクセシブルな説明 として機能します(インストールされたウェブアプリケーション に対して)。

2.3 iarc_rating_id メンバー

iarc_rating_id メンバーは、ウェブアプリケーションの 国際年齢評価連合(IARC) の 認証コードを示す 文字列 です。これは、そのウェブアプリケーションがどの年齢層に適切かを判断するためのものです。

注意

IARC証明書は、配布に使用するストアを通じて取得できます。iarc_rating_id メンバーには認証コードを一つだけ指定できます。同じプロダクトの配布であれば、参加ストア間で同一コードを共有できます(すなわち、ユーザーエージェントスニッフィングなどによって全く異なるコードパスを提供しない限り)し、ストア側がサポートしていれば利用可能です。

IARCに関する詳細は IARCの仕組み開発者がIARCでレーティングを受けるには を参照してください。

2.4 screenshots メンバー

screenshots メンバーは、ウェブアプリケーションの一般的な利用シーンを表現する screenshotsオブジェクト の配列です。

3. スクリーンショットオブジェクトとそのメンバー

screenshotsオブジェクトImageResource オブジェクト であり、下記の追加メンバーを持ちます。

3.1 label メンバー

label メンバーは、その screenshotsオブジェクト文字列 であり、アクセシブルな名前として機能します。アクセシビリティの観点から、著者は各スクリーンショットに label を記載することを推奨します。このメンバーは、レンダリングされたスクリーンショットの代替テキストとして機能します。

2: 補助メンバーの使用例
{
  "screenshots": [{
    "src": "images/screenshot.png",
    "sizes": "800x600",
    "form_factor": "wide",
    "label": "With Software, you can select a part of your screen and take a screenshot in seconds."
  }]
}

3.2 platform メンバー

platform メンバーは、与えられたスクリーンショットが適用される配信プラットフォームを表す 文字列 です。著者は、そのスクリーンショットが特定の状況にのみ該当する場合のみこのメンバーを使用することを推奨します。

注意: プラットフォーム指定に関するガイダンス

著者は、platform は汎用的な体験を示さない場合にのみ使用してください。例えば、OS固有の platform 指定は、そのスクリーンショットにOS特有の機能が含まれている場合に限ります。

ユーザーエージェントは、表示するスクリーンショット数を自由に決められますが、自分のプラットフォームに関係ないスクリーンショット(例:Google PlayがiOS専用スクリーンショット)を表示すべきではありません。

platform が設定されていない場合、ユーザーエージェントはそのスクリーンショットがすべてのプラットフォームに適用されるとみなすべきです。

ユーザーエージェントはスクリーンショットのアスペクト比( sizes)を基に表示するかどうか判断できます。

OS固有の platform 値一覧:

android
Google Android 用。
chromeos
Google ChromeOS 用。
ipados
Apple iPadOS 用。
ios
Apple iOS 用。
kaios
KaiOS 用。
macos
Apple macOS 用。
windows
Microsoft Windows 用。
xbox
Microsoft Xbox 用。

アプリ配信プラットフォーム固有の platform 値一覧:

chrome_web_store
Google Chrome Web Store
play
Google Play Store
itunes
iTunes App Store
microsoft-inbox
Microsoft Windowsにプリインストール
microsoft-store
Microsoft Store
注意: カテゴリーの追加について

追加のプラットフォームを希望する場合は、manifest-app-info GitHub リポジトリ にバグ報告またはプルリクエストを送ってください。

3.3 form_factor メンバー

form_factor メンバーは、そのスクリーンショットが適用されるデバイスの画面形状を表す 文字列 です。著者は、そのスクリーンショットが特定の状況にのみ該当する場合のみこのメンバーを利用することを推奨します。

注意: form_factor使用に関するガイダンス

form_factorは、そのスクリーンショットが汎用的な体験を示さない場合のみに使用してください。たとえば、画面の向きによってレイアウトやデザインが異なる場合は、"narrow" または "wide" を指定するのが望ましいです。

ユーザーエージェントは表示するスクリーンショット数を自由に決められますが、自分のform factorに該当しない(例えばモバイル端末が"wide"のform_factorスクリーンショット)ものは表示すべきではありません。

form_factor が未設定の場合、ユーザーエージェントはすべてのフォームファクターに適用されるものとします。

form_factor の値一覧:

narrow
狭い画面(例:モバイル端末)のみに該当するスクリーンショット向け。
wide
広い画面(例:ステータスボード)のみに該当するスクリーンショット向け。

A. 国際化

このセクションは規範的ではありません。

著者は、本ドキュメントで定義されているすべてのテキスト文字列の内容を、Manifest仕様で概説されている手法に基づいてローカライズすることが期待されます。

B. 謝辞

Rob Dolin は本作業全体、特に iarc_rating_id メンバーの主導に尽力し、Kenneth Rohde Christiansen はこれらのアイデアの精査にご協力くださいました。

また、次の貢献者の方々にも感謝いたします: Christian Liebel、Julien Cayzac、Marcos Cáceres、Thomas Steiner、Xiaoqian Wu、Yajing Tang

C. 索引

C.1 この仕様で定義されている用語

C.2 他で参照されている用語

D. 参考文献

D.1 参考情報

[accname-1.2]
Accessible Name and Description Computation 1.2. Bryan Garaventa; Joanmarie Diggs; Michael Cooper. W3C. 2019年7月11日. W3C 作業草案. URL: https://www.w3.org/TR/accname-1.2/
[appmanifest]
Web Application Manifest. Marcos Caceres; Kenneth Christiansen; Matt Giuca; Aaron Gustafson; Daniel Murphy; Anssi Kostiainen. W3C. 2023年5月2日. W3C 作業草案. URL: https://www.w3.org/TR/appmanifest/
[ECMA-404]
The JSON Data Interchange Format, 2nd edition. Ecma International. 2017年12月1日. 標準. URL: https://www.ecma-international.org/wp-content/uploads/ECMA-404_2nd_edition_december_2017.pdf
[image-resource]
Image Resource. Aaron Gustafson; Rayan Kanso; Marcos Caceres. W3C. 2021年6月4日. W3C 作業草案. URL: https://www.w3.org/TR/image-resource/