chrome.debugger

更新日: 2026-09-25 robots: noindex

説明

chrome.debugger API は、Chrome のリモート デバッグ プロトコルの代替トランスポートとして機能します。chrome.debugger を使用して 1 つ以上のタブにアタッチし、ネットワーク インタラクションの計測、JavaScript のデバッグ、DOM と CSS の変更などを行います。Debuggee プロパティ tabId を使用して、sendCommand でタブをターゲットに設定し、onEvent コールバックから tabId でイベントをルーティングします。

権限

debugger

セキュリティに関する注意事項

セキュリティ上の理由から、chrome.debugger API はすべての Chrome DevTools プロトコル ドメインへのアクセスを提供していません。使用可能なドメインは、Accessibility、Audits、CacheStorage、Console、CSS、Database、Debugger、DOM、DOMDebugger、DOMSnapshot、Emulation、Fetch、IO、Input、Inspector、Log、Network、Overlay、Page、Performance、Runtime、Storage、Target、Tracing、WebAudio、WebAuthn です。

マニフェスト

この API を使用するには、拡張機能のマニフェストで "debugger" 権限を宣言する必要があります。

{
  "name": "My extension",
  ...
  "permissions": [
    "debugger",
  ],
  ...
}

例

この API を試すには、chrome-extension-samples リポジトリからデバッガ API の例をインストールします。

型

Debuggee

デバッグ対象の識別子。tabId、extensionId、targetId のいずれかを指定する必要があります

プロパティ

  • extensionId

    文字列 省略可

    デバッグする拡張機能の ID。拡張機能のバックグラウンド ページにアタッチできるのは、--silent-debugger-extension-api コマンドライン スイッチを使用する場合のみです。

  • tabId

    number 省略可

    デバッグするタブの ID。

  • targetId

    文字列 省略可

    デバッグ ターゲットの不透明な ID。

DebuggerSession

Chrome 125 以降

デバッガ セッション ID。tabId、extensionId、targetId のいずれかを指定する必要があります。また、オプションで sessionId を指定することもできます。onEvent から送信された引数に sessionId が指定されている場合、イベントはルート デバッグ対象セッション内の子プロトコル セッションから送信されています。sendCommand に渡されるときに sessionId が指定されている場合、ルート デバッグ対象セッション内の子プロトコル セッションをターゲットにします。

プロパティ

  • extensionId

    文字列 省略可

    デバッグする拡張機能の ID。拡張機能のバックグラウンド ページにアタッチできるのは、--silent-debugger-extension-api コマンドライン スイッチを使用する場合のみです。

  • sessionId

    文字列 省略可

    Chrome DevTools Protocol セッションの不透明な ID。tabId、extensionId、または targetId で識別されるルート セッション内の子セッションを識別します。

  • tabId

    number 省略可

    デバッグするタブの ID。

  • targetId

    文字列 省略可

    デバッグ ターゲットの不透明な ID。

DetachReason

Chrome 44 以降

接続終了の理由。

列挙型

"target_closed"

"canceled_by_user"

TargetInfo

デバッグ ターゲット情報

プロパティ

  • attached

    ブール値

    デバッガがすでにアタッチされている場合は true。

  • extensionId

    文字列 省略可

    拡張機能 ID。type = 'background_page' の場合に定義されます。

  • faviconUrl

    文字列 省略可

    ターゲットのファビコン URL。

  • id

    文字列

    ターゲット ID。

  • tabId

    number 省略可

    タブ ID。type == 'page' の場合に定義されます。

  • title

    文字列

    ターゲット ページのタイトル。

  • ターゲット タイプ。

  • URL

    文字列

    ターゲット URL。

TargetInfoType

Chrome 44 以降

ターゲット タイプ。

列挙型

"page"

"background_page"

"worker"

"other"

メソッド

attach()

Promise 
chrome.debugger.attach(
  target: Debuggee,
  requiredVersion: string,
  callback?: function,
): Promise<void>

指定されたターゲットにデバッガをアタッチします。

パラメータ

  • ターゲット

    デバッグ対象

    アタッチするデバッグ ターゲット。

  • requiredVersion

    文字列

    必須のデバッグ プロトコル バージョン（「0.1」）。メジャー バージョンが一致し、マイナー バージョンが同じかそれ以降のデバッグ対象にのみアタッチできます。プロトコル バージョンのリストはこちらで確認できます。

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 96 以降

    アタッチ オペレーションが成功または失敗すると解決されます。Promise は値なしで解決されます。アタッチが失敗した場合、Promise は拒否されます。

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

detach()

Promise 
chrome.debugger.detach(
  target: Debuggee,
  callback?: function,
): Promise<void>

指定されたターゲットからデバッガをデタッチします。

パラメータ

  • ターゲット

    デバッグ対象

    デタッチするデバッグ ターゲット。

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 96 以降

    切断オペレーションが成功または失敗すると解決されます。Promise は値なしで解決されます。デタッチが失敗すると、Promise は拒否されます。

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

getTargets()

Promise 
chrome.debugger.getTargets(
  callback?: function,
): Promise<TargetInfo[]>

使用可能なデバッグ ターゲットのリストを返します。

パラメータ

  • callback

    function 省略可

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

    (result: TargetInfo[]) => void

    • 件の結果

      TargetInfo[]

      利用可能なデバッグ ターゲットに対応する TargetInfo オブジェクトの配列。

戻り値

  • Promise<TargetInfo[]>

    Chrome 96 以降

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

sendCommand()

Promise 
chrome.debugger.sendCommand(
  target: DebuggerSession,
  method: string,
  commandParams?: object,
  callback?: function,
): Promise<object | undefined>

指定されたコマンドをデバッグ ターゲットに送信します。

パラメータ

  • ターゲット

    DebuggerSession

    コマンドの送信先となるデバッグ ターゲット。

  • method

    文字列

    メソッド名。リモート デバッグ プロトコルで定義されているメソッドのいずれかである必要があります。

  • commandParams

    オブジェクト（省略可）

    リクエスト パラメータを含む JSON オブジェクト。このオブジェクトは、指定されたメソッドのリモート デバッグ パラメータ スキームに準拠している必要があります。

  • callback

    function 省略可

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

    (result?: object) => void

    • 件の結果

      オブジェクト（省略可）

      レスポンスを含む JSON オブジェクト。レスポンスの構造はメソッド名によって異なり、リモート デバッグ プロトコルのコマンドの説明の「returns」属性によって定義されます。

戻り値

  • Promise<object | undefined>

    Chrome 96 以降

    レスポンス本文。メッセージの投稿中にエラーが発生すると、Promise は拒否されます。

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

イベント

onDetach

chrome.debugger.onDetach.addListener(
  callback: function,
)

ブラウザがタブのデバッグ セッションを終了したときに呼び出されます。これは、タブが閉じられるか、接続されたタブに対して Chrome DevTools が呼び出されたときに発生します。

パラメータ

onEvent

chrome.debugger.onEvent.addListener(
  callback: function,
)

デバッグ ターゲットがインストルメンテーション イベントを発行するたびに呼び出されます。

パラメータ

  • callback

    関数

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

    (source: DebuggerSession, method: string, params?: object) => void

    • ソース

      DebuggerSession

    • method

      文字列

    • params

      オブジェクト（省略可）