本頁面由 Cloud Translation API 翻譯而成。

chrome.contentSettings

說明

使用 chrome.contentSettings API 即可變更設定，控制網站是否能使用 Cookie、JavaScript 和外掛程式等功能。簡單來說，內容設定可讓您針對個別網站自訂 Chrome 的行為，而不是全域。

權限

contentSettings

您必須在擴充功能的資訊清單中宣告 "contentSettings" 權限，才能使用這個 API。例如：

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

概念和用法

內容設定模式

您可以使用模式指定每個內容設定會影響哪些網站。例如，https://*.youtube.com/* 會指定 youtube.com 及其所有子網域。內容設定模式的語法與比對模式的語法相同，但有以下幾點不同：

如果是 http、https 和 ftp 網址，路徑必須是萬用字元 (/*)。如果是 file 網址，必須完整指定路徑，且不得包含萬用字元。
相較於比對模式，內容設定模式可以指定通訊埠編號。如果指定了通訊埠編號，則模式只會比對與該通訊埠的網站。如果未指定通訊埠號碼，模式會比對所有通訊埠。

模式優先順序

如果某個網站適用多項內容設定規則，系統會優先採用較具體的規則。

舉例來說，下列模式會依優先順序排列：

https://www.example.com/*
https://*.example.com/* (與 example.com 和所有子網域相符)
<all_urls> (比對每個網址)

下列三種萬用字元會影響特定模式的重要性：

通訊埠中的萬用字元 (例如 https://www.example.com:*/*)
配置中的萬用字元 (例如 *://www.example.com:123/*)
主機名稱中的萬用字元 (例如 https://*.example.com:123/*)

如果模式比某部分中的其他模式更明確，但在另一個部分不明確，系統會按照下列順序檢查不同的部分：主機名稱、配置、通訊埠。舉例來說，下列模式會依優先順序排列：

https://www.example.com:*/* 指定主機名稱和配置。
*:/www.example.com:123/* 這部分比較不高，因為雖然可指定主機名稱，但並未指定配置。
https://*.example.com:123/* 較低，因為雖然指定了通訊埠和配置，但主機名稱中包含萬用字元。

主要和次要模式

決定要套用的內容設定時，考量到的網址會因內容類型而有所不同。舉例來說，contentSettings.notifications 設定會以網址列顯示的網址為依據。這個網址稱為「主要」網址。

部分內容類型可考量其他網址。舉例來說，系統會根據 HTTP 要求的網址 (在本例中為主要網址) 和萬用盒中顯示的網址 (稱為「次要」網址)，決定網站是否可設定 contentSettings.cookies。

如果有多個規則包含主要和次要模式，則優先採用較明確的主要模式的規則。如果有多個規則的主要模式相同，系統會優先採用次要模式較具體的規則。舉例來說，以下主要/次要模式組合的清單會依優先順序排列：

優先順序	主要模式	次要模式
1	`https://www.moose.com/*`、	`https://www.wombat.com/*`
2	`https://www.moose.com/*`、	`<all_urls>`
3	`<all_urls>`、	`https://www.wombat.com/*`
4	`<all_urls>`、	`<all_urls>`

圖片內容設定不支援次要模式。

資源 ID

資源 ID 可讓您針對內容類型的特定子類型指定內容設定。目前，唯一支援資源 ID 的內容類型是 contentSettings.plugins，其中資源 ID 會識別特定外掛程式。套用內容設定時，首先會檢查特定外掛程式的設定。如果找不到特定外掛程式的設定，則會檢查外掛程式的一般內容設定。

舉例來說，如果內容設定規則具有資源 ID adobe-flash-player 和模式 <all_urls>，則其優先順序高於沒有資源 ID 和模式 https://www.example.com/* 的規則 (即使該模式更具體也一樣)。

您可以呼叫 contentSettings.ContentSetting.getResourceIdentifiers() 方法，取得內容類型的資源 ID 清單。系統會根據使用者電腦上已安裝的外掛程式組合，變更傳回的清單，但 Chrome 會盡量在外掛程式更新後維持穩定的 ID。

範例

如要試用這個 API，請從 chrome-extension-samples 存放區安裝 contentSettings API 範例。

類型

AutoVerifyContentSetting

Chrome 113 以上版本

列舉

"allow"

CameraContentSetting

Chrome 46 以上版本

列舉

"allow"

ClipboardContentSetting

Chrome 121 以上版本

列舉

"allow"

"ask"

ContentSetting

屬性

關閉

void

Promise

清除這個擴充功能設定的所有內容設定規則。

clear 函式如下所示：
```
(details: object, callback?: function) => {...}
```
- 詳細資料
  
  物件
  - 範圍
    
    範圍選用
    
    清除設定的位置 (預設值：一般)。
- 回呼
  
  函式選填
  
  callback 參數如下所示：
```
() => void
```
- returns
  承諾<void>
  
  Chrome 96 以上版本
  
  承諾在資訊清單 3 以上版本中受支援，但回呼則是為了回溯相容性而提供。您無法在同一函式呼叫中同時使用兩者。承諾會以傳遞至回呼的相同類型解析。
get

void

Promise

取得特定一組網址目前的內容設定。

get 函式如下所示：
```
(details: object, callback?: function) => {...}
```
- 詳細資料
  
  物件
  - 無痕模式
    
    布林值選填
    
    檢查無痕模式工作階段的內容設定。(預設為 false)
  - primaryUrl
    
    字串
    
    應擷取內容設定的主要網址。請注意，主要網址的意義會因內容類型而異。
  - resourceIdentifier
    
    ResourceIdentifier 選用
    
    應擷取設定的內容類型，其 ID 更為明確。
  - secondaryUrl
    
    string optional
    
    應擷取內容設定的次要網址。預設為主要網址。請注意，次要網址的含義取決於內容類型，且並非所有內容類型都會使用次要網址。
- 回呼
  
  函式選填
  
  callback 參數如下所示：
```
(details: object) => void
```
  - 詳細資料
    
    物件
    
    設定
    
    T
    
    內容設定。如要瞭解可能值，請參閱個別 ContentSetting 物件說明。
- returns
  Promise<object>
  
  Chrome 96 以上版本
  
  Promise 適用於 Manifest V3 及以上版本，但為了回溯相容性，提供回呼。您無法在同一函式呼叫中同時使用兩者。承諾會以傳遞至回呼的相同類型解析。
getResourceIdentifiers

void

Promise

getResourceIdentifiers 函式如下所示：
```
(callback?: function) => {...}
```
- 回呼
  
  函式選填
  
  callback 參數如下所示：
```
(resourceIdentifiers?: ResourceIdentifier[]) => void
```
  - resourceIdentifiers
    
    ResourceIdentifier[] 選填
    
    此內容類型的資源 ID 清單；如果這個內容類型未使用資源 ID，則為 undefined。
- returns
  Promise<ResourceIdentifier[]>
  
  Chrome 96 以上版本
  
  承諾在資訊清單 3 以上版本中受支援，但回呼則是為了回溯相容性而提供。您無法在同一個函式呼叫中同時使用這兩種方法。承諾會以傳遞至回呼的相同類型解析。
set

void

Promise

套用新的內容設定規則。

set 函式如下所示：
```
(details: object, callback?: function) => {...}
```
- 詳細資料
  
  物件
  - primaryPattern
    
    字串
    
    主要網址的格式。如要進一步瞭解模式的格式，請參閱內容設定模式。
  - resourceIdentifier
    
    ResourceIdentifier 選用
    
    內容類型的資源 ID。
  - 範圍
    
    範圍選填
    
    設定位置 (預設值：regular)。
  - secondaryPattern
    
    string 選填
    
    次要網址的模式。預設為比對所有網址。如要進一步瞭解格式格式，請參閱內容設定模式。
  - 設定
    
    不限
    
    這項規則套用的設定。如要瞭解可能值，請參閱個別 ContentSetting 物件說明。
- 回呼
  
  函式選填
  
  callback 參數如下所示：
```
() => void
```
- returns
  承諾<void>
  
  Chrome 96 以上版本
  
  Promise 適用於 Manifest V3 及以上版本，但為了回溯相容性，提供回呼。您無法在同一個函式呼叫中同時使用這兩種方法。承諾會以傳遞至回呼的相同類型解析。

CookiesContentSetting

Chrome 44 以上版本

列舉

"allow"

FullscreenContentSetting

Chrome 44 以上版本

值

"allow"

ImagesContentSetting

Chrome 44 以上版本

列舉

"allow"

JavascriptContentSetting

Chrome 44 以上版本

列舉

"allow"

LocationContentSetting

Chrome 44 以上版本

列舉

"allow"

MicrophoneContentSetting

Chrome 46 以上版本

列舉

"allow"

MouselockContentSetting

Chrome 44 以上版本

值

"allow"

MultipleAutomaticDownloadsContentSetting

Chrome 44 以上版本

列舉

"allow"

NotificationsContentSetting

Chrome 44 以上版本

列舉

"allow"

PluginsContentSetting

Chrome 44 以上版本

值

PopupsContentSetting

Chrome 44 以上版本

列舉

"allow"

PpapiBrokerContentSetting

Chrome 44 以上版本

值

ResourceIdentifier

唯一使用資源 ID 的內容類型是 contentSettings.plugins。詳情請參閱「資源 ID」。

屬性

說明

string 選填

使用者可理解的資源說明。
id

字串

指定內容類型的資源 ID。

Scope

Chrome 44 以上版本

ContentSetting 的範圍。regular：一般設定檔的設定 (如果無覆寫設定，就會由無痕模式設定檔繼承) 設定，incognito\_session\_only：適用於無痕模式設定檔的設定，只有在無痕模式工作階段期間才能調整，而且在無痕模式工作階段結束後就會刪除 (覆寫一般設定)。

列舉

屬性

automaticDownloads

是否允許網站自動下載多個檔案。allow：允許網站自動下載多個檔案。block：禁止網站自動下載多個檔案。ask：詢問網站要在第一個檔案下載完畢後自動下載檔案。預設值為 ask。主要網址是頂層頁框的網址。不會使用次要網址。

類型

ContentSetting<MultipleAutomaticDownloadsContentSetting>

autoVerify

Chrome 113 以上版本

是否允許網站使用 Private State Tokens API。allow：允許網站使用 Private State Tokens API；block：禁止網站使用 Private State Tokens API。預設值為 allow。主要網址是頂層框架的網址。請勿使用次要網址。注意：呼叫 set() 時，主要模式必須為。

類型

ContentSetting<AutoVerifyContentSetting>

camera

Chrome 46 以上版本

是否允許網站存取攝影機。以下其中一種： allow：允許網站存取攝影機。 block：不允許網站存取攝影機。 ask：當網站想要存取攝影機時，必須先詢問你。預設值為 ask。主要網址是要求相機存取權的文件網址。系統不會使用次要網址。注意：如果兩個模式皆為「」，則「允許」設定無效。

類型

ContentSetting<CameraContentSetting>

clipboard

Chrome 121 以上版本

是否允許網站透過 Async Clipboard API 的進階功能存取剪貼簿。「進階」功能除了在使用者手勢後寫入內建格式之外，還包括其他功能，例如讀取功能、寫入自訂格式功能，以及不需使用者手勢即可寫入功能。以下其中一項： allow：允許網站使用進階剪貼簿功能。 block：禁止網站使用進階剪貼簿功能。 ask：系統會在網站要使用進階剪貼簿功能時詢問你。預設值為 ask。主要網址是要求剪貼簿存取權的文件網址。請勿使用次要網址。

類型

ContentSetting<ClipboardContentSetting>

cookies

是否允許網站設定 Cookie 和其他本機資料。allow：接受 Cookie、block：封鎖 Cookie、session\_only：只接受目前工作階段的 Cookie。預設值為 allow。主要網址是代表 Cookie 來源的網址。次要網址是頂層框架的網址。

類型

ContentSetting<CookiesContentSetting>

fullscreen

已淘汰。不再有任何效果。系統現在會自動向所有網站授予全螢幕權限。值一律為 allow。

類型

ContentSetting<FullscreenContentSetting>

images

是否顯示圖片。其中之一 allow：顯示圖片，block：不顯示圖片。預設值為 allow。主要網址是頂層頁框的網址。次要網址是圖片的網址。

類型

ContentSetting<ImagesContentSetting>

javascript

是否執行 JavaScript。以下其中一種 allow：執行 JavaScript、block：請勿執行 JavaScript。預設值為 allow。主要網址是頂層頁框的網址。請勿使用次要網址。

類型

ContentSetting<JavascriptContentSetting>

location

是否允許地理位置。您可以選擇：allow：允許網站追蹤您的實體位置；block：不允許網站追蹤您的實體位置；ask：允許網站追蹤您的實體位置前先詢問。預設值為 ask。主要網址是要求位置資料的文件網址。次要網址是頂層頁框的網址 (不一定與要求網址不同)。

類型

ContentSetting<LocationContentSetting>

microphone

Chrome 46 以上版本

是否允許網站存取麥克風。以下其中一項： allow：允許網站存取麥克風。 block：不允許網站存取麥克風。 ask：當網站要求存取麥克風時，必須先詢問你。預設值為 ask。主要網址是指要求麥克風存取權的文件網址。請勿使用次要網址。注意：如果兩個模式皆為「」，則「允許」設定無效。

類型

ContentSetting<MicrophoneContentSetting>

mouselock

已淘汰。不再有任何效果。系統現在會自動授予所有網站滑鼠鎖定權限。值一律為 allow。

類型

ContentSetting<MouselockContentSetting>

notifications

是否允許網站顯示桌面通知。allow：允許網站顯示桌面通知、block：不允許網站顯示桌面通知、ask：詢問網站是否要顯示桌面通知。預設值為 ask。主要網址是指要顯示通知的文件網址。不會使用次要網址。

類型

ContentSetting<NotificationsContentSetting>

plugins

已淘汰。在 Chrome 第 88 版中移除 Flash 後，這項權限就無法再產生。值一律為 block。系統會忽略對 set() 和 clear() 的呼叫。

類型

ContentSetting<PluginsContentSetting>

popups

是否允許網站顯示彈出式視窗。以下其中一項： allow：允許網站顯示彈出式視窗。 block：不允許網站顯示彈出式視窗。預設值為 block。主要網址是頂層框架的網址。不會使用次要網址。

類型

ContentSetting<PopupsContentSetting>

unsandboxedPlugins

已淘汰。先前，這項權限會控管是否允許網站在無沙箱的情況下執行外掛程式，但由於 Chrome 88 已移除 Flash 中介服務程序，這項權限已無任何效果。值一律為 block。系統會忽略對 set() 和 clear() 的呼叫。

類型

ContentSetting<PpapiBrokerContentSetting>