browser.contentSettings

Mô tả

Sử dụng API chrome.contentSettings để thay đổi các chế độ cài đặt kiểm soát việc trang web có thể sử dụng các tính năng như cookie, JavaScript và trình bổ trợ hay không. Nói chung, chế độ cài đặt nội dung cho phép bạn tuỳ chỉnh hành vi của Chrome theo từng trang web thay vì trên toàn cầu.

Quyền

contentSettings

Bạn phải khai báo quyền "contentSettings" trong tệp kê khai của tiện ích để sử dụng API. Ví dụ:

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

Khái niệm và cách sử dụng

Mẫu cài đặt nội dung

Bạn có thể sử dụng mẫu để chỉ định những trang web chịu ảnh hưởng của từng chế độ cài đặt nội dung. Ví dụ: https://*.youtube.com/* chỉ định youtube.com và tất cả miền con của trang web này. Cú pháp cho mẫu cài đặt nội dung giống với mẫu khớp, nhưng có một số điểm khác biệt:

  • Đối với URL http, https và ftp, đường dẫn phải là ký tự đại diện (/*). Đối với URL file, đường dẫn phải được chỉ định đầy đủ và không được chứa ký tự đại diện.
  • Trái ngược với mẫu khớp, mẫu cài đặt nội dung có thể chỉ định số cổng. Nếu bạn chỉ định số cổng, thì mẫu chỉ khớp với các trang web có cổng đó. Nếu bạn không chỉ định số cổng, thì mẫu này sẽ khớp với tất cả các cổng.

Thứ tự ưu tiên của mẫu

Khi có nhiều quy tắc cài đặt nội dung áp dụng cho một trang web nhất định, quy tắc có mẫu cụ thể hơn sẽ được ưu tiên.

Ví dụ: các mẫu sau đây được sắp xếp theo thứ tự ưu tiên:

  1. https://www.example.com/*
  2. https://*.example.com/* (khớp với example.com và tất cả miền con)
  3. <all_urls> (khớp với mọi URL)

Có 3 loại ký tự đại diện ảnh hưởng đến mức độ cụ thể của một mẫu:

  • Ký tự đại diện trong cổng (ví dụ: https://www.example.com:*/*)
  • Ký tự đại diện trong lược đồ (ví dụ: *://www.example.com:123/*)
  • Ký tự đại diện trong tên máy chủ (ví dụ: https://*.example.com:123/*)

Nếu một mẫu cụ thể hơn một mẫu khác ở một phần nhưng ít cụ thể hơn ở một phần khác, thì các phần khác nhau sẽ được kiểm tra theo thứ tự sau: tên máy chủ, giao thức, cổng. Ví dụ: các mẫu sau đây được sắp xếp theo thứ tự ưu tiên:

  1. https://www.example.com:*/* Chỉ định tên máy chủ và lược đồ.
  2. *:/www.example.com:123/* Không cao bằng, vì mặc dù chỉ định tên máy chủ nhưng không chỉ định lược đồ.
  3. https://*.example.com:123/* Thấp hơn vì mặc dù chỉ định cổng và lược đồ, nhưng có ký tự đại diện trong tên máy chủ.

Mẫu chính và mẫu phụ

URL được xem xét khi quyết định áp dụng chế độ cài đặt nội dung nào sẽ phụ thuộc vào loại nội dung. Ví dụ: đối với contentSettings.notifications, chế độ cài đặt dựa trên URL xuất hiện trong thanh địa chỉ. URL này được gọi là URL "chính".

Một số loại nội dung có thể tính đến các URL bổ sung. Ví dụ: việc một trang web có được phép đặt contentSettings.cookies hay không được quyết định dựa trên URL của yêu cầu HTTP (là URL chính trong trường hợp này) cũng như URL hiển thị trong thanh địa chỉ (được gọi là URL "phụ").

Nếu nhiều quy tắc có mẫu chính và mẫu phụ, thì quy tắc có mẫu chính cụ thể hơn sẽ được ưu tiên. Nếu có nhiều quy tắc có cùng mẫu chính, thì quy tắc có mẫu phụ cụ thể hơn sẽ được ưu tiên. Ví dụ: danh sách các cặp mẫu chính/phụ sau đây được sắp xếp theo thứ tự ưu tiên:

Quyền ưu tiênMẫu chínhMẫu phụ
1https://www.moose.com/*,https://www.wombat.com/*
2https://www.moose.com/*,<all_urls>
3<all_urls>,https://www.wombat.com/*
4<all_urls>,<all_urls>

Mẫu phụ không được hỗ trợ cho chế độ cài đặt nội dung hình ảnh.

Giá trị nhận dạng tài nguyên

Giá trị nhận dạng tài nguyên cho phép bạn chỉ định chế độ cài đặt nội dung cho các loại phụ cụ thể của một loại nội dung. Hiện tại, loại nội dung duy nhất hỗ trợ giá trị nhận dạng tài nguyên là contentSettings.plugins, trong đó giá trị nhận dạng tài nguyên xác định một trình bổ trợ cụ thể. Khi áp dụng chế độ cài đặt nội dung, trước tiên, chế độ cài đặt cho trình bổ trợ cụ thể sẽ được kiểm tra. Nếu không tìm thấy chế độ cài đặt nào cho trình bổ trợ cụ thể, thì chế độ cài đặt nội dung chung cho trình bổ trợ sẽ được kiểm tra.

Ví dụ: nếu một quy tắc cài đặt nội dung có giá trị nhận dạng tài nguyên adobe-flash-player và mẫu <all_urls>, thì quy tắc này sẽ được ưu tiên hơn quy tắc không có giá trị nhận dạng tài nguyên và mẫu https://www.example.com/*, ngay cả khi mẫu đó cụ thể hơn.

Bạn có thể lấy danh sách giá trị nhận dạng tài nguyên cho một loại nội dung bằng cách gọi phương thức contentSettings.ContentSetting.getResourceIdentifiers(). Danh sách được trả về có thể thay đổi theo tập hợp trình bổ trợ đã cài đặt trên máy của người dùng, nhưng Chrome cố gắng giữ cho giá trị nhận dạng ổn định trong các bản cập nhật trình bổ trợ.

Ví dụ

Để dùng thử API này, hãy cài đặt ví dụ về contentSettings API từ kho lưu trữ chrome-extension-samples.

Loại

AutoVerifyContentSetting

Chrome 113 trở lên browser.* kể từ Chrome 148

Enum

"allow"

"block"

CameraContentSetting

Chrome 46 trở lên browser.* kể từ Chrome 148

Enum

"allow"

"block"

"ask"

ClipboardContentSetting

Chrome 121 trở lên browser.* kể từ Chrome 148

Enum

"allow"

"block"

"ask"

ContentSetting

Thuộc tính

  • xoá

    void

    Xoá tất cả quy tắc cài đặt nội dung do tiện ích này đặt.

    Hàm clear có dạng như sau:

    (details: object) => {...}

    • chi tiết

      đối tượng

      • phạm vi

        Phạm vi không bắt buộc

        Nơi xoá chế độ cài đặt (mặc định: thông thường).

    • returns

      Promise<void>

      Chrome 96 trở lên browser.* kể từ Chrome 148
  • get

    void

    Lấy chế độ cài đặt nội dung hiện tại cho một cặp URL nhất định.

    Hàm get có dạng như sau:

    (details: object) => {...}

    • chi tiết

      đối tượng

      • ẩn danh

        boolean không bắt buộc

        Có kiểm tra chế độ cài đặt nội dung cho phiên truy cập ẩn danh hay không. (mặc định là false)

      • primaryUrl

        chuỗi

        URL chính mà bạn muốn truy xuất chế độ cài đặt nội dung. Xin lưu ý rằng ý nghĩa của URL chính phụ thuộc vào loại nội dung.

      • resourceIdentifier

        ResourceIdentifier không bắt buộc

        Giá trị nhận dạng cụ thể hơn về loại nội dung cần truy xuất chế độ cài đặt.

      • secondaryUrl

        chuỗi không bắt buộc

        URL phụ mà bạn muốn truy xuất chế độ cài đặt nội dung. Giá trị mặc định là URL chính. Xin lưu ý rằng ý nghĩa của URL phụ phụ thuộc vào loại nội dung và không phải loại nội dung nào cũng sử dụng URL phụ.

    • returns

      <object> hứa hẹn

      Chrome 96 trở lên browser.* kể từ Chrome 148
  • getResourceIdentifiers

    void

    Hàm getResourceIdentifiers có dạng như sau:

    () => {...}

    • returns
      Chrome 96 trở lên browser.* kể từ Chrome 148
  • đặt

    void

    Áp dụng quy tắc mới về chế độ cài đặt nội dung.

    Hàm set có dạng như sau:

    (details: object) => {...}

    • chi tiết

      đối tượng

      • primaryPattern

        chuỗi

        Mẫu cho URL chính. Để biết thông tin chi tiết về định dạng của một mẫu, hãy xem phần Mẫu cài đặt nội dung.

      • resourceIdentifier

        ResourceIdentifier không bắt buộc

        Giá trị nhận dạng tài nguyên cho loại nội dung.

      • phạm vi

        Phạm vi không bắt buộc

        Nơi đặt chế độ cài đặt (mặc định: thông thường).

      • secondaryPattern

        chuỗi không bắt buộc

        Mẫu cho URL phụ. Mặc định là khớp với tất cả URL. Để biết thông tin chi tiết về định dạng của một mẫu, hãy xem phần Mẫu cài đặt nội dung.

      • cài đặt

        bất kỳ

        Chế độ cài đặt được áp dụng theo quy tắc này. Hãy xem nội dung mô tả của từng đối tượng ContentSetting để biết các giá trị có thể có.

    • returns

      Promise<void>

      Chrome 96 trở lên browser.* kể từ Chrome 148

CookiesContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Enum

"allow"

"block"

"session_only"

FullscreenContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Giá trị

"allow"

ImagesContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Enum

"allow"

"block"

JavascriptContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Enum

"allow"

"block"

LocationContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Enum

"allow"

"block"

"ask"

MicrophoneContentSetting

Chrome 46 trở lên browser.* kể từ Chrome 148

Enum

"allow"

"block"

"ask"

MouselockContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Giá trị

"allow"

MultipleAutomaticDownloadsContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Enum

"allow"

"block"

"ask"

NotificationsContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Enum

"allow"

"block"

"ask"

PluginsContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Giá trị

"block"

PopupsContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Enum

"allow"

"block"

PpapiBrokerContentSetting

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Giá trị

"block"

ResourceIdentifier

Loại nội dung duy nhất sử dụng giá trị nhận dạng tài nguyên là contentSettings.plugins. Để biết thêm thông tin, hãy xem phần Giá trị nhận dạng tài nguyên.

Thuộc tính

  • mô tả

    chuỗi không bắt buộc

    Nội dung mô tả dễ đọc về tài nguyên.

  • id

    chuỗi

    Giá trị nhận dạng tài nguyên cho loại nội dung đã cho.

Scope

Trình duyệt Chrome 44 trở lên .* kể từ Chrome 148

Phạm vi của ContentSetting. Một trong các giá trị sau: regular: chế độ cài đặt cho hồ sơ thông thường (được hồ sơ ẩn danh kế thừa nếu không bị ghi đè ở nơi khác), incognito\_session\_only: chế độ cài đặt cho hồ sơ ẩn danh chỉ có thể được đặt trong phiên truy cập ẩn danh và sẽ bị xoá khi phiên truy cập ẩn danh kết thúc (ghi đè chế độ cài đặt thông thường).

Enum

"regular"

"incognito_session_only"

SoundContentSetting

Chrome 141 trở lên browser.* kể từ Chrome 148

Enum

"allow"

"block"

Thuộc tính

automaticDownloads

Có cho phép các trang web tự động tải nhiều tệp xuống hay không. Một trong các giá trị sau: allow: Cho phép các trang web tự động tải nhiều tệp xuống, block: Không cho phép các trang web tự động tải nhiều tệp xuống, ask: Hỏi khi một trang web muốn tự động tải tệp xuống sau tệp đầu tiên. Giá trị mặc định là ask. URL chính là URL của khung cấp cao nhất. URL phụ không được sử dụng.

autoVerify

Chrome 113 trở lên browser.* kể từ Chrome 148

Cho phép hoặc không cho phép các trang web sử dụng Private State Tokens API. Một trong các giá trị sau: allow: Cho phép các trang web sử dụng Private State Tokens API, block: Chặn các trang web sử dụng Private State Tokens API. Giá trị mặc định là allow. Khi gọi set(), mẫu URL chính phải là <all_urls>. URL phụ không được sử dụng.

camera

Chrome 46 trở lên browser.* kể từ Chrome 148

Có cho phép các trang web truy cập vào camera hay không. Một trong các lựa chọn sau: allow: Cho phép các trang web truy cập vào camera, block: Không cho phép các trang web truy cập vào camera, ask: Hỏi khi một trang web muốn truy cập vào camera. Giá trị mặc định là ask. URL chính là URL của tài liệu đã yêu cầu quyền truy cập vào camera. URL phụ không được sử dụng. LƯU Ý: Chế độ cài đặt "allow" (cho phép) sẽ không hợp lệ nếu cả hai mẫu đều là "<all_urls>".

clipboard

Chrome 121 trở lên browser.* kể từ Chrome 148

Cho phép hay không cho phép các trang web truy cập vào bảng nhớ tạm thông qua các tính năng nâng cao của Async Clipboard API. Các chức năng "Nâng cao" bao gồm mọi chức năng ngoài việc ghi các định dạng tích hợp sẵn sau cử chỉ của người dùng, tức là khả năng đọc, khả năng ghi các định dạng tuỳ chỉnh và khả năng ghi mà không cần cử chỉ của người dùng. Một trong các giá trị sau: allow: Cho phép các trang web sử dụng các tính năng nâng cao của bảng nhớ tạm, block: Không cho phép các trang web sử dụng các tính năng nâng cao của bảng nhớ tạm, ask: Hỏi khi một trang web muốn sử dụng các tính năng nâng cao của bảng nhớ tạm. Giá trị mặc định là ask. URL chính là URL của tài liệu đã yêu cầu quyền truy cập vào bảng nhớ tạm. URL phụ không được sử dụng.

cookies

Cho phép hay không cho phép các trang web đặt cookie và dữ liệu cục bộ khác. Một trong các giá trị sau: allow: Chấp nhận cookie, block: Chặn cookie, session\_only: Chỉ chấp nhận cookie cho phiên hiện tại. Giá trị mặc định là allow. URL chính là URL đại diện cho nguồn gốc cookie. URL phụ là URL của khung cấp cao nhất.

fullscreen

Không dùng nữa. Không còn hiệu lực. Quyền truy cập toàn màn hình hiện được tự động cấp cho mọi trang web. Giá trị luôn là allow.

images

Có hiển thị hình ảnh hay không. Một trong các giá trị allow: Hiện hình ảnh, block: Không hiện hình ảnh. Giá trị mặc định là allow. URL chính là URL của khung cấp cao nhất. URL phụ là URL của hình ảnh.

javascript

Có chạy JavaScript hay không. Một trong hai giá trị: allow: Chạy JavaScript, block: Không chạy JavaScript. Giá trị mặc định là allow. URL chính là URL của khung cấp cao nhất. URL phụ không được sử dụng.

location

Có cho phép truy cập thông tin vị trí địa lý hay không. Một trong các lựa chọn sau: allow: Cho phép các trang web theo dõi vị trí thực tế của bạn, block: Không cho phép các trang web theo dõi vị trí thực tế của bạn, ask: Hỏi trước khi cho phép các trang web theo dõi vị trí thực tế của bạn. Giá trị mặc định là ask. URL chính là URL của tài liệu đã yêu cầu dữ liệu vị trí. URL phụ là URL của khung cấp cao nhất (có thể khác hoặc không khác với URL yêu cầu).

microphone

Chrome 46 trở lên browser.* kể từ Chrome 148

Có cho phép các trang web truy cập vào micrô hay không. Một trong các lựa chọn sau: allow: Cho phép các trang web truy cập vào micrô, block: Không cho phép các trang web truy cập vào micrô, ask: Hỏi khi một trang web muốn truy cập vào micrô. Giá trị mặc định là ask. URL chính là URL của tài liệu đã yêu cầu quyền truy cập vào micrô. URL phụ không được sử dụng. LƯU Ý: Chế độ cài đặt "allow" (cho phép) sẽ không hợp lệ nếu cả hai mẫu đều là "<all_urls>".

mouselock

Không dùng nữa. Không còn hiệu lực. Giờ đây, quyền khoá chuột sẽ tự động được cấp cho tất cả các trang web. Giá trị luôn là allow.

notifications

Có cho phép các trang web hiển thị thông báo trên màn hình hay không. Một trong các giá trị sau: allow: Cho phép các trang web hiển thị thông báo trên màn hình, block: Không cho phép các trang web hiển thị thông báo trên màn hình, ask: Hỏi khi một trang web muốn hiển thị thông báo trên màn hình. Giá trị mặc định là ask. URL chính là URL của tài liệu muốn hiển thị thông báo. URL phụ không được sử dụng.

plugins

Không dùng nữa. Vì Chrome 88 không còn hỗ trợ Flash nên quyền này không còn hiệu lực. Giá trị luôn là block. Các lệnh gọi đến set() và clear() sẽ bị bỏ qua.

popups

Có cho phép các trang web hiện cửa sổ bật lên hay không. Một trong các giá trị sau: allow: Cho phép các trang web hiện cửa sổ bật lên, block: Không cho phép các trang web hiện cửa sổ bật lên. Giá trị mặc định là block. URL chính là URL của khung cấp cao nhất. URL phụ không được sử dụng.

unsandboxedPlugins

Không dùng nữa. Trước đây, chính sách này kiểm soát việc có cho phép các trang web chạy trình bổ trợ không có hộp cát hay không. Tuy nhiên, do quy trình của trình môi giới Flash đã bị xoá trong Chrome 88, nên quyền này không còn hiệu lực nữa. Giá trị luôn là block. Các lệnh gọi đến set() và clear() sẽ bị bỏ qua.