chrome.omnibox (original) (raw)

説明

アドレスバー API を使用すると、Google Chrome のアドレスバー（アドレスバー）にキーワードを登録できます。

キーワード「Chromium Search」に関連する候補が表示されているスクリーンショット

ユーザーが拡張機能のキーワードを入力すると、ユーザーは拡張機能のみを操作するようになります。キー入力ごとに拡張機能に送信され、拡張機能はそれに応じて候補を提示できます。

候補はさまざまな方法でリッチにフォーマットできます。ユーザーが候補を承認すると、拡張機能に通知が送信され、アクションを実行できます。

マニフェスト

この API を使用するには、次のキーをマニフェストで宣言する必要があります。

"omnibox"

オムニボックス API を使用するには、マニフェストに "omnibox.keyword" フィールドを含める必要があります。また、16×16 ピクセルのアイコンも指定する必要があります。このアイコンは、ユーザーにキーワード モードへの切り替えを提案する際にアドレスバーに表示されます。

次に例を示します。

{
  "name": "Aaron's omnibox extension",
  "version": "1.0",
  "omnibox": { "keyword" : "aaron" },
  "icons": {
    "16": "16-full-color.png"
  },
  "background": {
    "persistent": false,
    "scripts": ["background.js"]
  }
}

例

この API を試すには、chrome-extension-samples リポジトリから omnibox API のサンプルをインストールします。

型

DefaultSuggestResult

候補結果。

プロパティ

DescriptionStyleType

スタイルタイプ。

列挙型

OnInputEnteredDisposition

アドレスバーのクエリのウィンドウの配置。これは、結果を表示する際の推奨コンテキストです。たとえば、オムニボックス コマンドが特定の URL に移動する場合、処理が「newForegroundTab」であれば、新しい選択されたタブで移動が行われることを意味します。

列挙型

"currentTab"

"newForegroundTab"

"newBackgroundTab"

プロパティ

メソッド

setDefaultSuggestion()

chrome.omnibox.setDefaultSuggestion(
  suggestion: DefaultSuggestResult,
): Promise

デフォルトの候補の説明とスタイルを設定します。デフォルトの候補は、URL バーの下の最初の候補行に表示されるテキストです。

パラメータ

戻り値

イベント

onDeleteSuggestion

chrome.omnibox.onDeleteSuggestion.addListener(
  callback: function,
)

ユーザーが候補の結果を削除しました。

パラメータ

onInputCancelled

chrome.omnibox.onInputCancelled.addListener(
  callback: function,
)

ユーザーが入力内容を確定せずにキーワード入力セッションを終了しました。

パラメータ

onInputChanged

chrome.omnibox.onInputChanged.addListener(
  callback: function,
)

ユーザーがオムニボックスに入力した内容を変更しました。

パラメータ

onInputEntered

chrome.omnibox.onInputEntered.addListener(
  callback: function,
)

ユーザーがアドレスバーに入力した内容を確定しました。

パラメータ

onInputStarted

chrome.omnibox.onInputStarted.addListener(
  callback: function,
)

ユーザーが拡張機能のキーワードを入力して、キーワード入力セッションを開始しました。これは、入力セッションごとに 1 回だけ、onInputChanged イベントの前に送信されることが保証されています。

パラメータ

特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。

最終更新日 2025-08-11 UTC。