資訊清單檔案格式

每個擴充功能的根目錄中都必須有 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"
一或多個代表擴充功能的圖示。如要瞭解 請參閱「圖示」。

選用鍵

"action"
定義擴充功能圖示，在 Google 工具列。詳情請參閱 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"
用於指定擴充功能首頁網址的字串。如果沒有定義 會將首頁預設為擴充功能的 Chrome 線上應用程式商店網頁這個欄位 在代管擴充功能時特別實用
"host_permissions"
列出擴充功能可以互動的網頁 (定義為 網址比對模式。系統會在安裝時要求這些網站的使用者權限 讓應用程式從可以最快做出回應的位置 回應使用者要求詳情請參閱「主機權限」。
"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"
宣告選用主機 權限 你的擴充功能
"optional_permissions"
宣告擴充功能的選用權限。
"options_page"
指定 options.html 檔案的路徑，供擴充功能做為 選項頁面。詳情請參閱「將權限授予使用者 選項。
"options_ui"
指定 HTML 檔案路徑，可讓使用者變更擴充功能選項 以及前往 Chrome 擴充功能頁面如需詳細資訊，請參閱嵌入 選項。
"permissions"
可使用特定擴充功能 API。查看權限 瞭解一般解釋個別 API 的參考頁面會列出 所需的權限
"requirements"
列出使用擴充功能所需的技術。如需支援的清單 請參閱相關規定一節。
"sandbox"
定義一組無法存取擴充功能 API 的擴充功能頁面。 直接存取非採用沙箱機制的網頁。若需更多資訊，請參閲 沙箱。
"short_name"
字串，包含要使用的擴充功能名稱縮寫 字元空間有限時長度上限為 12 個半形字元。如果這是 未定義、截斷的「name」版本就會改為顯示按鍵。
"side_panel"
識別要顯示的 HTML 檔案。 sidePanel。
"storage"
宣告代管儲存空間的 JSON 結構定義 區域。如要 相關資訊，請參閱儲存區域的資訊清單。
"tts_engine"
將擴充功能註冊為文字轉語音引擎。若需更多資訊，請參閲 ttsEngine API。
"update_url"
包含擴充功能更新頁面網址的字串。如符合以下情況，請使用這組金鑰 你代管擴充功能 。
"version_name"
說明擴充功能版本的字串。例如 "1.0 beta" 和 "build rc2"。如果未指定，則為「version」值會顯示在 。
"web_accessible_resources"
在擴充功能中定義網頁或其他可供存取的檔案 。詳情請參閱「Web Accessable」(可網頁存取) 資源。

選用的 ChromeOS 金鑰

"file_browser_handlers"
提供fileBrowserHandler的存取權 API，可讓擴充功能存取 ChromeOS 檔案瀏覽器。
"file_handlers"
指定 ChromeOS 擴充功能要處理的檔案類型。詳情請參閱「file_handlers」一文。
"file_system_provider_capabilities"
允許存取「fileSystemProvider」 API，讓擴充功能建立 ChromeOS 能使用的檔案系統。
"input_components"
允許使用 Input Method Editor API。詳情請參閱 input_components 的說明。