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

マニフェストファイル形式

すべての拡張機能のルートディレクトリに、manifest.json ファイルが必要です。には、その拡張機能の構造と動作に関する重要な情報が記載されています。このページでは、拡張機能のマニフェストの構造とマニフェストで利用できる機能について説明します。含まれます。

例

次のマニフェストの例は、基本的なマニフェスト構造と、よく使われる機能は、独自のマニフェストを作成するための出発点として利用できます。

最小限のマニフェスト

{
  "manifest_version": 3,
  "name": "Minimal Manifest",
  "version": "1.0.0",
  "description": "A basic example extension with only required keys",
  "icons": {
    "48": "images/icon-48.png",
    "128": "images/icon-128.png"
  },
}

コンテンツスクリプトを登録する

{
  "manifest_version": 3,
  "name": "Run script automatically",
  "description": "Runs a script on www.example.com automatically when user installs the extension",
  "version": "1.0",
  "icons": {
    "16": "images/icon-16.png",
    "32": "images/icon-32.png",
    "48": "images/icon-48.png",
    "128": "images/icon-128.png"
  },
  "content_scripts": [
    {
      "js": [
        "content-script.js"
      ],
      "matches": [
        "http://*.example.com//"
      ]
    }
  ]
}

コンテンツスクリプトを挿入する

{
  "manifest_version": 3,
  "name": "Click to run",
  "description": "Runs a script when the user clicks the action toolbar icon.",
  "version": "1.0",
  "icons": {
    "16": "images/icon-16.png",
    "32": "images/icon-32.png",
    "48": "images/icon-48.png",
    "128": "images/icon-128.png"
  },
  "background": {
    "service_worker": "service-worker.js"
  },
  "action": {
    "default_icon": {
      "16": "images/icon-16.png",
      "32": "images/icon-32.png",
      "48": "images/icon-48.png",
      "128": "images/icon-128.png"
    }
  },
  "permissions": ["scripting", "activeTab"]
}

{
  "manifest_version": 3,
  "name": "Popup extension that requests permissions",
  "description": "Extension that includes a popup and requests host permissions and storage permissions .",
  "version": "1.0",
  "icons": {
    "16": "images/icon-16.png",
    "32": "images/icon-32.png",
    "48": "images/icon-48.png",
    "128": "images/icon-128.png"
  },
  "action": {
    "default_popup": "popup.html"
  },
  "host_permissions": [
    "https://*.example.com/"
  ],
  "permissions": [
    "storage"
  ]
}

サイドパネル

{
  "manifest_version": 3,
  "name": "Side panel extension",
  "version": "1.0",
  "description": "Extension with a default side panel.",
  "icons": {
    "16": "images/icon-16.png",
    "48": "images/icon-48.png",
    "128": "images/icon-128.png"
  },
  "side_panel": {
    "default_path": "sidepanel.html"
  },
  "permissions": ["sidePanel"]
}

マニフェストキー

サポートされているすべてのマニフェストキーは次のとおりです。

拡張機能プラットフォームで必要な鍵

"manifest_version": 使用するマニフェストファイル形式のバージョンを指定する整数できます。サポートされる値は 3 のみです。
"name": Chrome ウェブで拡張機能を識別する文字列です。ストア、インストールダイアログ、ユーザーの Chrome 拡張機能ページ（chrome://extensions）。「最大文字数は 75 文字です。ロケール固有の名前の使用方法については、国際化をご覧ください。
"version": 拡張機能のバージョン番号を識別する文字列。詳細については、バージョン番号の形式については、バージョンをご覧ください。

Chrome ウェブストアに必要なキー

"description": Chrome ウェブストアとユーザーの両方に表示される拡張機能を説明する文字列です。拡張機能の管理ページにあります最大長は 132 文字です。詳細情報説明のローカライズについては、国際化をご覧ください。
"icons": 拡張機能を表す 1 つ以上のアイコン。ベストプラクティスについては、アイコンをご覧ください。

オプションのキー

"action": Google Chat の拡張機能のアイコンの外観と動作をツールバー。詳細については、chrome.action をご覧ください。
"author": あります。
"background": 拡張機能の Service Worker を含む JavaScript ファイルを指定します。使用します。詳しくは、拡張機能サービスについてワーカー
"chrome_settings_overrides": 選択した Chrome 設定のオーバーライドを定義します。詳細については、次をご覧ください: Chrome の設定のオーバーライド
"chrome_url_overrides": デフォルトの Chrome ページのオーバーライドを定義します。詳細については、次をご覧ください: Chrome のページをオーバーライドする
"commands": 拡張機能内でキーボードショートカットを定義します。詳細詳しくは、chrome.commands をご覧ください。
"content_scripts": ユーザーが特定のウェブを開く際に使用する JavaScript ファイルまたは CSS ファイルを指定しますできます。詳細については、コンテンツスクリプトをご覧ください。
"content_security_policy": 拡張機能がスクリプト、スタイル、その他のリソースに関する制限を定義します使用できます。詳細については、コンテンツセキュリティポリシーをご覧ください。
"cross_origin_embedder_policy": Cross-Origin-Embedder-Policy HTTP ヘッダーの値を指定します。拡張機能ページにクロスオリジンリソースの埋め込みを構成します。
"cross_origin_opener_policy": Cross-Origin-Opener-Policy HTTP ヘッダーの値を指定します。これにより、最上位の拡張機能ページでブラウジングコンテキストが共有されないようにするクロスオリジンドキュメントで共有できます
"declarative_net_request": declarativeNetRequest の静的ルールを定義します。ネットワークリクエストのブロックや変更を可能にする API。
"default_locale": サポート対象の拡張機能のデフォルト言語を定義する文字列使用できます。例: 「en」「pt_BR」を入力します。この鍵はローカライズされていない拡張機能では使用できません。詳細については、国際化をご覧ください。
"devtools_page": DevTools API を使用するページを定義します。
"export": 拡張機能からリソースをエクスポートできるようにします。詳細については、次をご覧ください: エクスポート。
"externally_connectable": 拡張機能に接続できる他のページや拡張機能を指定します。対象詳細については、"externally_connectable" をご覧ください。
"homepage_url": 拡張機能のホームページの URL を指定する文字列。これが未定義の場合ホームページはデフォルトで拡張機能の Chrome ウェブストアページに設定されます。このフィールドは拡張機能をホストする場合に特に便利おすすめします。
"host_permissions": 拡張機能がやり取りできるウェブページのリストです。 URL 一致パターン。インストール時にこれらのサイトのユーザー権限が必要になりますあります。詳細については、ホストの権限をご覧ください。
"import": 拡張機能にリソースをインポートできるようにします。詳細については、次をご覧ください: インポート。
"incognito": シークレットモードでの拡張機能の動作を定義します。指定できる値は次のとおりです。 "spanning"、"split"、"not_allowed"。詳細については、次をご覧ください: シークレットモード。
"key": さまざまな開発ユースケースの拡張機能の ID を指定します。詳細鍵をご覧ください。
"minimum_chrome_version": 拡張機能をインストールできる最も古い Chrome バージョンを定義します。この値既存の Chrome ブラウザのバージョン文字列（ "107" または "107.0.5304.87"。Chrome のバージョンが最小バージョンに「互換性なし」と警告が表示され拡張機能をインストールできません。既存の広告表示オプションに追加した場合は古いバージョンの Chrome を使用しているユーザーには、あります。これには、次の業種のビジネスユーザーが含まれます。エフェメラルモードを使用します。
"oauth2": OAuth 2.0 セキュリティ ID の使用を許可します。このキーの値は "client_id" プロパティと "scopes" プロパティを持つオブジェクト。詳しくは、OAuth 2.0 チュートリアルをご覧ください。
"omnibox": 拡張機能が Chrome のアドレスバーにキーワードを登録できるようにします。詳細
"optional_host_permissions": オプションの host を宣言する権限できます
"optional_permissions": 拡張機能のオプションの権限を宣言します。
"options_page": 拡張機能で使用する options.html ファイルへのパスを指定します。オプションページを開きます。詳しくは、ユーザーにオプションをご覧ください。
"options_ui": ユーザーが拡張機能オプションを変更できる HTML ファイルのパスを指定しますできます。詳しくは、埋め込みオプションをご覧ください。
"permissions": 特定の拡張機能 API の使用を有効にします。権限をご覧ください。をご覧ください。各 API のリファレンスページには、ユーザーに付与します。
"requirements": 拡張機能を使用するために必要なテクノロジーを一覧表示します。サポートされている要件をご覧ください。
"sandbox": 拡張機能 API へのアクセス権がない、または拡張機能ページのセットを定義します。サンドボックス化されていないページに直接アクセスできます。詳細については、次をご覧ください: サンドボックス。
"short_name": 使用する拡張機能の名前の短縮版を含む文字列スペースが限られている場合に使用できます。最大長は 12 文字です。これが未定義。「name」の短縮版キーが表示されます。
"side_panel": sidePanel。
"storage": マネージドストレージの JSON スキーマを宣言します。エリアをご覧ください。詳細詳しくは、ストレージ領域のマニフェストをご覧ください。
"tts_engine": 拡張機能をテキスト読み上げエンジンとして登録します。詳細については、次をご覧ください: ttsEngine API を使用します。
"update_url": 拡張機能の更新ページの URL を含む文字列。次の場合にこのキーを使用拡張機能をホストしているウェブストア以外から入手できます
"version_name": 拡張機能のバージョンを表す文字列。例: "1.0 beta"、 "build rc2"。指定しない場合、"version" は値が拡張機能の管理ページを使用してください。
"web_accessible_resources": ウェブページやその他のユーザーがアクセスできる拡張機能内のファイルを定義しますできます。詳しくは、Web Accessible リソースをご覧ください。

ChromeOS キー（省略可）

"file_browser_handlers": fileBrowserHandler へのアクセス権を付与します API: 拡張機能から ChromeOS のファイルブラウザにアクセスできます。
"file_handlers": ChromeOS 拡張機能が処理するファイル形式を指定します。詳しくは、file_handlers をご覧ください。
"file_system_provider_capabilities": fileSystemProvider へのアクセスを許可します API: 拡張機能により、ChromeOS で使用できるファイルシステムを作成できます。
"input_components": インプットメソッドエディタ API を使用できるようにします。詳細については、input_components をご覧ください。

マニフェスト ファイル形式

例