このページは、2020 年にサポートが終了した Chrome アプリプラットフォームに関するドキュメントの一部です。Enterprise および Education のお客様については、少なくとも 2025 年 1 月までは ChromeOS で引き続きサポートされます。詳しくは、アプリの移行をご覧ください。

このページは Cloud Translation API によって翻訳されました。

ネイティブメッセージング

拡張機能とアプリは、他のメッセージ受け渡し API と同様の API を使用して、ネイティブアプリとメッセージを交換できます。この機能をサポートするネイティブアプリは、拡張機能との通信方法を認識しているネイティブメッセージングホストを登録する必要があります。Chrome はホストを別のプロセスで起動し、標準の入力ストリームと標準出力ストリームを使用してホストと通信します。

ネイティブメッセージングホスト

ネイティブメッセージングホストを登録するには、アプリケーションで、ネイティブメッセージングホストの構成を定義するマニフェストファイルをインストールする必要があります。マニフェストファイルの例を次に示します。

{
  "name": "com.my_company.my_application",
  "description": "My Application",
  "path": "C:\\Program Files\\My Application\\chrome_native_messaging_host.exe",
  "type": "stdio",
  "allowed_origins": [
    "chrome-extension://knldjmfmopnpolahpmmgbagdohdnhkik/"
  ]
}

ネイティブメッセージングホストのマニフェストファイルは有効な JSON で、次のフィールドが含まれている必要があります。

名前	説明
`name`	ネイティブメッセージングホストの名前。クライアントは、この文字列を runtime.connectNative または runtime.sendNativeMessage に渡します。名前に使用できるのは、英小文字、数字、アンダースコア、ドットのみです。名前の先頭や末尾をドットにすることはできません。また、ドットの後に別のドットを付けることはできません。
`description`	アプリケーションの短い説明。
`path`	ネイティブメッセージングホストバイナリへのパス。Linux と OSX では、パスは絶対パスである必要があります。Windows では、マニフェストファイルが配置されているディレクトリからの相対パスで、ホストプロセスは、ホストバイナリを含むディレクトリに設定された現在のディレクトリで開始されます。たとえば、このパラメータが `C:\Application\nm_host.exe` に設定されている場合、現在のディレクトリ `C:\Application\` で開始されます。
`type`	ネイティブメッセージングホストとの通信に使用されるインターフェースのタイプ。現在、このパラメータに使用できる値は `stdio` のみです。これは、Chrome が `stdin` と `stdout` を使用してホストと通信する必要があることを示します。
`allowed_origins`	ネイティブメッセージングホストへのアクセスを許可する必要がある拡張機能のリスト。`chrome-extension:///` などのワイルドカードは使用できません。

ネイティブメッセージングホストの場所

マニフェストファイルの場所はプラットフォームによって異なります。

Windows の場合、マニフェストファイルはファイルシステム内の任意の場所に配置できます。アプリケーションインストーラはレジストリキー HKEY_LOCAL_MACHINE\SOFTWARE\Google\Chrome\NativeMessagingHosts\_com.my_company.my_application_ または HKEY_CURRENT_USER\SOFTWARE\Google\Chrome\NativeMessagingHosts\_com.my_company.my_application_ を作成し、そのキーのデフォルト値をマニフェストファイルへのフルパスに設定する必要があります。たとえば、次のコマンドを使用します。

REG ADD "HKCU\Software\Google\Chrome\NativeMessagingHosts\com.my_company.my_application" /ve /t REG_SZ /d "C:\path\to\nmh-manifest.json" /f

または、次の .reg ファイルを使用します。

Windows Registry Editor Version 5.00
[HKEY_CURRENT_USER\Software\Google\Chrome\NativeMessagingHosts\com.my_company.my_application]
@="C:\\path\\to\\nmh-manifest.json"

Chrome がネイティブメッセージングホストを探す際、まず 32 ビットレジストリがクエリされ、次に 64 ビットレジストリがクエリされます。

OS X と Linux では、ネイティブメッセージングホストのマニフェストファイルの場所はブラウザ（Google Chrome または Chromium）によって異なります。システムレベルのネイティブメッセージングホストは固定の場所で検索され、ユーザーレベルのネイティブメッセージングホストは NativeMessagingHosts というユーザープロファイルディレクトリ内のサブディレクトリで検索されます。

OS X（システム全体）
- Google Chrome: /Library/Google/Chrome/NativeMessagingHosts/_com.my_company.my_application_.json
- Chromium: /Library/Application Support/Chromium/NativeMessagingHosts/_com.my_company.my_application_.json
OS X（ユーザー固有のデフォルトパス）
- Google Chrome: ~/Library/Application Support/Google/Chrome/NativeMessagingHosts/_com.my_company.my_application_.json
- Chromium: ~/Library/Application Support/Chromium/NativeMessagingHosts/_com.my_company.my_application_.json
Linux（システム全体）
- Google Chrome: /etc/opt/chrome/native-messaging-hosts/_com.my_company.my_application_.json
- Chromium: /etc/chromium/native-messaging-hosts/_com.my_company.my_application_.json
Linux（ユーザー固有のデフォルトパス）
- Google Chrome: ~/.config/google-chrome/NativeMessagingHosts/_com.my_company.my_application_.json
- Chromium: ~/.config/chromium/NativeMessagingHosts/_com.my_company.my_application_.json

ネイティブメッセージングプロトコル

Chrome は各ネイティブメッセージングホストを個別のプロセスで起動し、標準入力（stdin）と標準出力（stdout）を使用してホストと通信します。同じ形式で双方向のメッセージを送信します。各メッセージは JSON の UTF-8 エンコードを使用してシリアル化され、ネイティブバイト順の 32 ビットのメッセージ長が先頭に付加されます。ネイティブメッセージングホストから送信される 1 つのメッセージの最大サイズは 1 MB です。これは、ネイティブアプリの誤動作から Chrome を保護するための主な目的です。ネイティブメッセージングホストに送信されるメッセージの最大サイズは 4 GB です。

ネイティブメッセージングホストの最初の引数は、呼び出し元のオリジン（通常は chrome-extension://[ID of allowed extension]）です。これにより、ネイティブメッセージングホストマニフェストの allowed_origins キーに複数の拡張機能が指定されている場合、ネイティブメッセージングホストはメッセージのソースを識別できます。警告: Windows の Chrome 54 以前では、起点が最初のパラメータではなく 2 番目のパラメータとして渡されていました。

runtime.connectNative を使用してメッセージングポートを作成すると、Chrome はネイティブメッセージングホストプロセスを起動し、ポートが破棄されるまで実行を継続します。一方、メッセージポートを作成せずに runtime.sendNativeMessage を使用してメッセージが送信されると、Chrome はメッセージごとに新しいネイティブメッセージングホストプロセスを開始します。その場合、ホストプロセスによって生成された最初のメッセージは、元のリクエストに対するレスポンスとして処理されます。つまり、Chrome は、runtime.sendNativeMessage が呼び出されたときに指定されたレスポンスコールバックにそのメッセージを渡します。この場合、ネイティブメッセージングホストによって生成された他のすべてのメッセージは無視されます。

Windows の場合、ネイティブメッセージングホストには、呼び出し元の Chrome ネイティブウィンドウへのハンドル（--parent-window=<decimal handle value>）を含むコマンドライン引数も渡されます。これにより、ネイティブメッセージングホストは、適切な親を持つネイティブ UI ウィンドウを作成できます。呼び出し元のコンテキストがバックグラウンドのスクリプトページの場合、この値は 0 になります。

ネイティブアプリへの接続

ネイティブアプリとのメッセージの送受信は、拡張機能のメッセージとよく似ています。主な違いは、runtime.connect の代わりに runtime.connectNative を使用し、runtime.sendMessage の代わりに runtime.sendNativeMessage を使用することです。これらのメソッドは、アプリのマニフェストファイルで「nativeMessaging」権限が宣言されている場合にのみ使用できます。

次の例では、ネイティブメッセージングホスト com.my_company.my_application に接続された runtime.Port オブジェクトを作成し、そのポートからのメッセージをリッスンし、1 つの送信メッセージを送信します。

var port = chrome.runtime.connectNative('com.my_company.my_application');
port.onMessage.addListener(function(msg) {
  console.log("Received" + msg);
});
port.onDisconnect.addListener(function() {
  console.log("Disconnected");
});
port.postMessage({ text: "Hello, my_application" });

runtime.sendNativeMessage を使用すると、ポートを作成せずにネイティブアプリケーションにメッセージを送信できます。次に例を示します。

chrome.runtime.sendNativeMessage('com.my_company.my_application',
  { text: "Hello" },
  function(response) {
    console.log("Received " + response);
  });

ネイティブメッセージのデバッグ

ネイティブメッセージングホストの起動に失敗した場合、stderr に書き込む場合、または通信プロトコルに違反する場合は、出力が Chrome のエラーログに書き込まれます。Linux と OS X では、コマンドラインから Chrome を起動し、ターミナルで出力を監視することで、このログに簡単にアクセスできます。Windows では、ロギングを有効にする方法の説明に沿って --enable-logging を使用します。

エラーと、この問題を解決するためのヒントをいくつか紹介します。

ネイティブメッセージングホストを起動できませんでした。
- ファイルを実行するのに十分な権限があるかどうかを確認します。
指定されたネイティブメッセージングのホスト名が無効です。
- 名前に無効な文字が含まれていないか確認します。使用できるのは、英小文字、数字、アンダースコア、ドットのみです。名前の先頭または末尾をドットにすることはできません。また、ドットの後に別のドットを付けることはできません。
ネイティブホストを終了しました。
- Chrome でメッセージが読み取られる前に、ネイティブメッセージングホストへのパイプが切断されました。通常は、ネイティブメッセージングホストから送信されます。
指定されたネイティブメッセージングホストが見つかりません。
- 拡張機能とマニフェストファイルで、名前のスペルが正しいかをご確認ください。
- マニフェストは正しいディレクトリに配置されており、正しい名前が付けられていますか？想定される形式については、ネイティブメッセージングホストの場所をご覧ください。
- マニフェストファイルは正しい形式ですか？特に、JSON 構文は正しく、値がネイティブメッセージングホストマニフェストの定義と一致しているか。
- path で指定されたファイルは存在するか。Windows では相対パスを指定できますが、OS X と Linux では絶対パスにする必要があります。
ネイティブメッセージングホストのホスト名が登録されていません。（Windows のみ）
- Windows レジストリでネイティブメッセージングホストが見つかりませんでした。regedit を使用して、キーが実際に作成されたかどうか、およびネイティブメッセージホストの場所に記載されている必要な形式と一致していることを再確認します。
指定されたネイティブメッセージングホストへのアクセスは禁止されています。
- 拡張機能のオリジンが allowed_origins にリストされていますか？
ネイティブメッセージングホストとの通信中にエラーが発生しました。
- これは非常に一般的なエラーで、ネイティブメッセージングホストでの通信プロトコルの実装が正しくないことを示します。
- stdout のすべての出力がネイティブメッセージングプロトコルに準拠していることを確認します。デバッグ目的でデータを出力する場合は、stderr に書き込みます。
- 32 ビットのメッセージ長がプラットフォームのネイティブ整数形式（リトルエンディアン / ビッグエンディアン）であることを確認します。
- メッセージの長さは 1024*1024 以下にする必要があります。
- メッセージサイズは、メッセージのバイト数と同じである必要があります。文字は複数のバイトで表される場合があるため、文字列の「length」とは異なる場合があります。
- Windows のみ: プログラムの I/O モードが O_BINARY に設定されていることを確認します。デフォルトでは、I/O モードは O_TEXT で、改行（\n = 0A）が Windows スタイルの改行（\r\n = 0D 0A）に置き換えられるため、メッセージ形式が破損します。I/O モードは __setmode を使用して設定できます。

ネイティブ メッセージング

ネイティブ メッセージング ホスト

ネイティブ メッセージング ホストの場所

ネイティブ メッセージング プロトコル

ネイティブ アプリへの接続

ネイティブ メッセージのデバッグ