chrome.extension

説明

chrome.extension API には、任意の拡張機能ページで使用できるユーティリティがあります。これには、拡張機能とそのコンテンツ スクリプト間、または拡張機能間でメッセージを交換するためのサポートが含まれます（メッセージの受け渡しを参照）。

型

ViewType

Chrome 44 以降

拡張機能ビューのタイプ。

列挙型

"タブ"

"popup"

プロパティ

inIncognitoContext

シークレット タブ内で実行されているコンテンツ スクリプトと、シークレット プロセス内で実行されている拡張機能ページの場合は true。後者は「分割」された拡張機能にのみ適用されます。シークレット モードです。

タイプ

ブール値

lastError

<ph type="x-smartling-placeholder"></ph> &amp;leq;MV2 Chrome 58 以降非推奨

runtime.lastError を使用してください。

非同期の拡張機能 API でエラーが発生した場合、コールバックの存続期間に設定されます。エラーが発生しなかった場合、lastError は undefined になります。

タイプ

オブジェクト

プロパティ

  • メッセージ

    文字列

    発生したエラーの説明。

メソッド

getBackgroundPage()

<ph type="x-smartling-placeholder"></ph> フォアグラウンドのみ 
chrome.extension.getBackgroundPage()

JavaScript の「window」を返します。現在の拡張機能の内部で実行されているバックグラウンド ページのオブジェクトです。拡張機能にバックグラウンド ページがない場合は null を返します。

戻り値

  • ウィンドウ |未定義

getExtensionTabs()

<ph type="x-smartling-placeholder"></ph> &amp;leq;MV2 フォアグラウンドのみ 非推奨
chrome.extension.getExtensionTabs(
  windowId?: number,
)

extension.getViews {type: "tab"} を使用してください。

JavaScript の「window」の配列を返します。現在の拡張機能で実行されている各タブのオブジェクトを生成します。windowId を指定すると、「window」のみが返されます。指定されたウィンドウにアタッチされたタブのオブジェクトです。

パラメータ

  • windowId

    数値（省略可）

戻り値

  • ウィンドウ []

    グローバル ウィンドウ オブジェクトの配列

getURL()

<ph type="x-smartling-placeholder"></ph> &amp;leq;MV2 Chrome 58 以降非推奨
chrome.extension.getURL(
  path: string,
)

runtime.getURL を使用してください。

拡張機能のインストール ディレクトリ内の相対パスを完全修飾 URL に変換します。

パラメータ

  • パス

    文字列

    拡張機能内のリソースへのパス（インストール ディレクトリを基準とする相対パス）。

戻り値

  • 文字列

    リソースの完全修飾 URL。

getViews()

<ph type="x-smartling-placeholder"></ph> フォアグラウンドのみ 
chrome.extension.getViews(
  fetchProperties?: object,
)

JavaScript の「window」の配列を返します。現在の広告表示オプション内で実行される各ページのオブジェクトを生成します。

パラメータ

  • fetchProperties

    オブジェクト（省略可）

    • tabId

      数値（省略可）

      Chrome 54 以降

      タブ ID でビューを検索します。このフィールドを省略すると、すべてのビューが返されます。

    • type

      ViewType オプション

      取得するビューのタイプ。省略すると、すべてのビュー（バックグラウンド ページとタブを含む）が返されます。

    • windowId

      数値（省略可）

      検索を制限するウィンドウ。省略すると、すべてのビューが返されます。

戻り値

  • ウィンドウ []

    グローバル オブジェクトの配列

isAllowedFileSchemeAccess()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

拡張機能の「file://」へのアクセスの状態を取得します。できます。これは、ユーザーが制御する拡張機能ごとの「ファイルの URL へのアクセスを許可する」に対応します。設定には chrome://extensions ページからアクセスできます。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      ブール値

      拡張機能が「file://」にアクセスできる場合は truescheme、それ以外の場合は false です。

戻り値

  • Promise&lt;boolean&gt;

    Chrome 99 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

isAllowedIncognitoAccess()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

拡張機能のシークレット モードへのアクセスの状態を取得します。これは、ユーザーが制御する拡張機能ごとの [シークレット モードでの実行を許可する] に相当します。設定には chrome://extensions ページからアクセスできます。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      ブール値

      拡張機能がシークレット モードにアクセスできる場合は true、それ以外の場合は false。

戻り値

  • Promise&lt;boolean&gt;

    Chrome 99 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

sendRequest()

<ph type="x-smartling-placeholder"></ph> 約束 &amp;leq;MV2 非推奨
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

runtime.sendMessage を使用してください。

拡張機能内の他のリスナーに単一のリクエストを送信します。runtime.connect と類似していますが、オプションのレスポンスとともに 1 つのリクエストのみを送信します。extension.onRequest イベントは、拡張機能の各ページで発生します。

パラメータ

  • extensionId

    文字列（省略可）

    接続する拡張機能の拡張機能 ID。省略した場合、デフォルトは独自の拡張機能になります。

  • request

    任意

  • callback

    関数（省略可）

    Chrome 99 以降

    callback パラメータは次のようになります。 

    (response: any) => void

    • レスポンス

      任意

      リクエストのハンドラによって送信された JSON レスポンス オブジェクト。拡張機能への接続中にエラーが発生した場合、コールバックは引数なしで呼び出され、runtime.lastError がエラー メッセージに設定されます。

戻り値

  • <任意> を約束する

    Chrome 99 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

拡張機能の更新 URL で使用される ap CGI パラメータの値を設定します。この値は、Chrome 拡張機能ギャラリーでホストされている拡張機能では無視されます。

パラメータ

  • データ

    文字列

イベント

onRequest

<ph type="x-smartling-placeholder"></ph> &amp;leq;MV2 非推奨
chrome.extension.onRequest.addListener(
  callback: function,
)

runtime.onMessage を使用してください。

拡張機能プロセスまたはコンテンツ スクリプトからリクエストが送信されると呼び出されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • request

      任意

    • sendResponse

      関数

      sendResponse パラメータは次のようになります。 

      () => void

onRequestExternal

<ph type="x-smartling-placeholder"></ph> &amp;leq;MV2 非推奨
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

runtime.onMessageExternal を使用してください。

別の拡張機能からリクエストが送信されると呼び出されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • request

      任意

    • sendResponse

      関数

      sendResponse パラメータは次のようになります。 

      () => void