chrome拡張機能をV2からV3に移行しよう

どうも、くじらいどです。

今回は、Chrome拡張機能のV2からV3への移行についてお話ししたいと思います。

2023/06/12現在は、V2が使用可能ですが、Chrome拡張機能のV2が近いうちに使えなくなると思いますので、これからchrome拡張機能を作成しようとしている方は、V3（バージョン3）での開発をおすすめ致します。

また、ChatGPTでchrome拡張機能を作成してもらう場合は、V2で作成される可能性がありますので、V3で作成してくださいと追記しておきましょう。

ｍanifest.jsonファイルの変更点

それでは、まずmanifest.jsonファイルの変更点をコードも交えて見ていきましょう。

V2のｍanifest.json

{
  "manifest_version": 2,
  "name": "My Extension",
  "version": "1.0",
  "description": "This is my extension.",
  "permissions": [
    "tabs",
    "http://*/*"
  ],
  "background": {
    "scripts": [
      "background.js"
    ],
    "persistent": false
  },
  "content_scripts": [
    {
      "matches": [
        "<all_urls>"
      ],
      "js": [
        "content.js"
      ],
      "run_at": "document_idle"
    }
  ],
  "browser_action": {
    "default_popup": "popup.html",
    "default_icon": {
      "16": "icon16.png",
      "48": "icon48.png"
    }
  },
  "icons": {
    "16": "icon16.png",
    "48": "icon48.png",
    "128": "icon128.png"
  },
  "manifest_key": "value"
}

V3のｍanifest.json

{
  "manifest_version": 3,
  "name": "My Extension",
  "version": "2.0",
  "description": "This is my extension.",
  "host_permissions": [
    "tabs",
    "http://*/*"
  ],
  "background": {
    "service_worker": "background.js"
  },
  "action": {
    "default_popup": "popup.html",
    "default_icon": {
      "16": "icon16.png",
      "48": "icon48.png"
    }
  },
  "icons": {
    "16": "icon16.png",
    "48": "icon48.png",
    "128": "icon128.png"
  },
  "permissions": [
    "scripting"
  ],
  "manifest_key": "value"
}

変更点は、いくつかあります。

V3では、manifest_versionの値は3に設定されます。

V3では、バックグラウンドスクリプトはbackgroundフィールドのservice_workerフィールドにファイル名を指定します。

V3では、ブラウザアクションはactionフィールドで定義されます。

ちなみにV2では、browser_actionでした。短くなっていますね。

• V2では、必要なパーミッションはpermissionsフィールドに配列として指定します。
• V3では、必要なパーミッションはhost_permissionsフィールドに配列として指定します。また、APIの特定の機能に対しては、permissionsフィールドを使用して許可をリクエストする必要があります。

上記のように、V3のｍanifest.jsonに移行するには、いくつかの変更をする必要があります。

下記に公式のｍanifest.jsonの移行に関するドキュメントのリンクを貼っておりますのでご確認ください。

Chrome for Developers

Update the manifest  |  Chrome Extensions  |  Chrome for Developers The manifest.json file requires a slightly different format for Manifest V3 than for Manifest V2.

メソッドの変更点

今後、廃止されるメソッドが追加になったり、新しいメソッドが追加されたりするばあいがありますので詳しくは、公式ドキュメントをご覧ください。

Chrome for Developers

Update your code  |  Chrome Extensions  |  Chrome for Developers The first of three sections describing changes needed for code that is not part of the extension service worker.

まとめ

いかがでしたでしょうか。V3になって間もない事もあり、まだV4が誕生するのが結構先かと思いますので、この際にchrome拡張機能開発に入門してみるのも良い機会かなと思います。

普段、私たちがよく使うchromeブラウザで動作するので、結構役に立つchrome拡張機能も作れるかと思います。

もっとchrome拡張機能の中身について知りたい方は以下の記事ご覧いただければ幸いです。

あわせて読みたい

手軽に始めるchrome拡張機能開発　V3対応 chrome拡張機能は、chromeウェブストアでダウンロードできますが、自分で拡張機能を作成してローカルで使用したり、chromeウェブストアに公開して一般のユーザーに使っ…

あわせて読みたい

手軽に始めるchrome拡張機能開発V3　メッセージパッシング 今回は、chrome拡張機能のバックグラウンドやアクション、コンテンツスクリプトを連携（値を送ったり、受け取ったり）するのに必要なメッセージパッシングについて解説…