Navigator: getInstalledRelatedApps() メソッド

解説

getInstalledRelatedApps() を使用すると、このメソッドを呼び出しているウェブアプリに関連するユニバーサル Windows プラットフォーム (UWP) アプリ、Android アプリ、PWA のインストール状況を調べることができます。

呼び出しているウェブアプリをプラットフォーム専用のアプリまたは PWA と関連付けるには、次の 2 つのことを行う必要があります。

1. 呼び出すウェブアプリは、マニフェストファイル の related_applications メンバーで指定する必要があります。
2. プラットフォーム専用のアプリまたは PWA は、呼び出し元のアプリとの関係を定義する必要があります。

関係を定義する方法は、アプリの機種によって異なります。

• Android アプリは、デジタル資産リンクシステムを介して行います。
• Windows UWP アプリは、URI ハンドラーを介して行います。
• PWA は、次のような方法で行います。
  • PWA の場合、related_applications マニフェストメンバー内に自分自身で定義した項目で、基盤となるプラットフォームにインストールされているかどうかを調べます。
  • PWA 以外のアプリの場合、/.well-known/ ディレクトリーにある assetlinks.json ファイルに、インストールされているかどうかを調べるコードを記述します。

これらのケースのそれぞれを処理する方法の詳細については、Is your app installed? getInstalledRelatedApps() will tell you! を参照してください。

構文

getInstalledRelatedApps()

引数

なし。

返値

Promise で、インストールされた相対アプリを表すオブジェクトの配列で履行されます。各オブジェクトは、以下のプロパティを含むことができます。

id 省略可

指定されたプラットフォーム上でアプリケーションを表すために使用する ID を表す文字列。文字列の正確な書式はプラットフォームによって異なります。

platform

関連するアプリが関連付けられているプラットフォーム（エコシステムまたはオペレーティングシステム）を表す文字列です。 以下のいずれかになります。

• "chrome_web_store": Google Chrome Web Store アプリ。
• "play": Google Play ストアアプリ。
• "chromeos_play": ChromeOS Play アプリ。
• "webapp": プログレッシブウェブアプリ。
• "windows": Windows ストアアプリ。
• "f-droid": F-Droid アプリ。
• "amazon": Amazon アプリストアアプリ

url 省略可

アプリに関連付けられた URL を表す文字列です。通常、この場所でアプリに関する情報を読み、インストールすることができます。

version 省略可

関連するアプリのバージョンを表す文字列です。

関連するアプリの情報は、前回呼び出したウェブアプリの マニフェストファイル のメンバーである related_applications に指定された情報である必要があります。

例外

InvalidStateError DOMException

このメソッドが、最上位の閲覧コンテキストで呼び出されませんでした。

例

const relatedApps = await navigator.getInstalledRelatedApps();

// 関連のアプリをすべてコンソール内の表に書き出す
console.table(relatedApps);

// プラットフォーム専用の特定のアプリを検索
const psApp = relatedApps.find((app) => app.id === "com.example.myapp");

if (psApp && doesVersionSendPushMessages(psApp.version)) {
  // プッシュ通知の送信を処理するプラットフォーム専用のアプリがインストールされている
  // ウェブアプリで処理する必要はない
  return;
}

仕様書

ブラウザーの互換性

関連情報

• Is your app installed? getInstalledRelatedApps() will tell you!