Tài liệu tham khảo API

Hầu hết các tiện ích đều cần có quyền truy cập vào một hoặc nhiều API Tiện ích của Chrome để hoạt động. Tài liệu tham khảo API này mô tả các API có thể sử dụng trong tiện ích và trình bày các trường hợp sử dụng ví dụ.

Các tính năng phổ biến của Extensions API

API Tiện ích bao gồm một không gian tên chứa các phương thức và thuộc tính để thực hiện công việc liên quan đến tiện ích, và thường (nhưng không phải lúc nào cũng vậy) là các trường kê khai cho tệp manifest.json. Ví dụ: không gian tên chrome.action yêu cầu đối tượng "action" trong tệp kê khai. Nhiều API cũng yêu cầu quyền trong tệp kê khai.

Các phương thức trong API tiện ích là không đồng bộ, trừ phi có quy định khác. Các phương thức không đồng bộ sẽ trả về ngay lập tức mà không cần chờ thao tác gọi chúng hoàn tất. Sử dụng promise để nhận kết quả của các phương thức không đồng bộ này.

Chrome Extension API

accessibilityFeatures

Sử dụng API chrome.accessibilityFeatures để quản lý các tính năng hỗ trợ tiếp cận của Chrome. API này dựa vào nguyên mẫu ChromeSetting của API loại để nhận và đặt từng tính năng hỗ trợ tiếp cận. Để nhận được trạng thái của tính năng, tiện ích phải yêu cầu quyền accessibilityFeatures.read. Để sửa đổi trạng thái của tính năng, tiện ích cần có quyền accessibilityFeatures.modify. Xin lưu ý rằng accessibilityFeatures.modify không ngụ ý quyền accessibilityFeatures.read.

action
Chrome 88 trở lên MV3 trở lên

Sử dụng API chrome.action để kiểm soát biểu tượng của tiện ích trên thanh công cụ Google Chrome.

chuông báo

Sử dụng API chrome.alarms để lên lịch chạy mã định kỳ hoặc vào một thời điểm cụ thể trong tương lai.

audio
Chrome 59 trở lên Chỉ dành cho ChromeOS

API chrome.audio được cung cấp để cho phép người dùng nhận thông tin và kiểm soát các thiết bị âm thanh được gắn vào hệ thống. API này hiện chỉ có ở chế độ kiosk cho ChromeOS.

dấu trang

Sử dụng API chrome.bookmarks để tạo, sắp xếp và thao tác với dấu trang. Bạn cũng có thể xem Override Pages (Ghi đè trang) mà bạn có thể dùng để tạo một trang Trình quản lý dấu trang tuỳ chỉnh.

browsingData

Sử dụng API chrome.browsingData để xoá dữ liệu duyệt web khỏi hồ sơ cục bộ của người dùng.

certificateProvider
Chrome 46 trở lên Chỉ dành cho ChromeOS

Sử dụng API này để cung cấp chứng chỉ cho nền tảng. Nền tảng có thể sử dụng các chứng chỉ này để xác thực TLS.

lệnh

Sử dụng API lệnh để thêm các phím tắt kích hoạt các thao tác trong tiện ích của bạn, chẳng hạn như thao tác mở thao tác của trình duyệt hoặc gửi lệnh đến tiện ích.

contentSettings

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.

contextMenus

Sử dụng API chrome.contextMenus để thêm các mục vào trình đơn theo bối cảnh của Google Chrome. Bạn có thể chọn loại đối tượng mà nội dung bổ sung trong trình đơn theo bối cảnh sẽ áp dụng, chẳng hạn như hình ảnh, siêu liên kết và trang.

cookie

Sử dụng API chrome.cookies để truy vấn và sửa đổi cookie, cũng như nhận thông báo khi cookie thay đổi.

trình gỡ lỗi

API chrome.debugger đóng vai trò là một phương thức truyền tải thay thế cho giao thức gỡ lỗi từ xa của Chrome. Sử dụng chrome.debugger để đính kèm vào một hoặc nhiều thẻ để đo lường hoạt động tương tác mạng, gỡ lỗi JavaScript, thay đổi DOM và CSS, v.v. Sử dụng thuộc tính Debuggee tabId để nhắm đến các thẻ bằng sendCommand và định tuyến các sự kiện theo tabId từ các lệnh gọi lại onEvent.

declarativeContent

Sử dụng API chrome.declarativeContent để thực hiện các hành động tuỳ thuộc vào nội dung của một trang mà không cần có quyền đọc nội dung của trang đó.

declarativeNetRequest
Chrome 84 trở lên

API chrome.declarativeNetRequest được dùng để chặn hoặc sửa đổi các yêu cầu mạng bằng cách chỉ định các quy tắc khai báo. Điều này cho phép các tiện ích sửa đổi yêu cầu mạng mà không chặn các yêu cầu đó và xem nội dung của chúng, nhờ đó mang lại quyền riêng tư cao hơn.

desktopCapture

Desktop Capture API (API Chụp màn hình) chụp nội dung trên màn hình, các cửa sổ riêng lẻ hoặc các thẻ riêng lẻ.

devtools.inspectedWindow

Sử dụng API chrome.devtools.inspectedWindow để tương tác với cửa sổ được kiểm tra: lấy mã nhận dạng thẻ cho trang được kiểm tra, đánh giá mã trong bối cảnh của cửa sổ được kiểm tra, tải lại trang hoặc lấy danh sách tài nguyên trong trang.

devtools.network

Sử dụng API chrome.devtools.network để truy xuất thông tin về các yêu cầu mạng mà Công cụ cho nhà phát triển hiển thị trong bảng điều khiển Mạng.

devtools.panels

Sử dụng API chrome.devtools.panels để tích hợp tiện ích vào giao diện người dùng của cửa sổ Công cụ cho nhà phát triển: tạo bảng điều khiển của riêng bạn, truy cập vào các bảng điều khiển hiện có và thêm thanh bên.

devtools.performance
Chrome 129 trở lên

Sử dụng API chrome.devtools.performance để theo dõi thông tin cập nhật về trạng thái ghi trong bảng điều khiển Hiệu suất trong Công cụ cho nhà phát triển.

devtools.recorder
Chrome 105 trở lên

Sử dụng API chrome.devtools.recorder để tuỳ chỉnh bảng điều khiển Trình ghi trong Công cụ cho nhà phát triển.

dns
Kênh nhà phát triển

Dùng API chrome.dns để phân giải dns.

documentScan
Chrome 44 trở lên Chỉ dành cho ChromeOS

Sử dụng API chrome.documentScan để khám phá và truy xuất hình ảnh từ các trình quét tài liệu được đính kèm.

dom
Chrome 88 trở lên

Sử dụng API chrome.dom để truy cập vào các API DOM đặc biệt cho Tiện ích

downloads

Dùng API chrome.downloads để khởi tạo, giám sát, thao tác và tìm kiếm các lượt tải xuống theo phương thức lập trình.

enterprise.deviceAttributes
Chrome 46 trở lên Chỉ dành cho ChromeOS Yêu cầu chính sách

Sử dụng API chrome.enterprise.deviceAttributes để đọc các thuộc tính của thiết bị. Lưu ý: API này chỉ dành cho các tiện ích mà chính sách của doanh nghiệp buộc phải cài đặt.

enterprise.hardwarePlatform
Chrome 71 trở lên Yêu cầu chính sách

Sử dụng API chrome.enterprise.hardwarePlatform để lấy nhà sản xuất và kiểu máy của nền tảng phần cứng nơi trình duyệt chạy. Lưu ý: API này chỉ dành cho các tiện ích mà chính sách của doanh nghiệp cài đặt.

enterprise.login
Chrome 139 trở lên Chỉ dành cho ChromeOS Yêu cầu chính sách

Sử dụng API chrome.enterprise.login để thoát khỏi Phiên khách được quản lý. Lưu ý: API này chỉ dành cho các tiện ích do chính sách của doanh nghiệp cài đặt trong phiên khách được quản lý của ChromeOS.

enterprise.networkingAttributes
Chrome 85 trở lên Chỉ dành cho ChromeOS Yêu cầu chính sách

Sử dụng API chrome.enterprise.networkingAttributes để đọc thông tin về mạng hiện tại của bạn. Lưu ý: API này chỉ dành cho các tiện ích mà chính sách của doanh nghiệp buộc phải cài đặt.

enterprise.platformKeys
Chỉ dành cho ChromeOS Yêu cầu chính sách

Sử dụng API chrome.enterprise.platformKeys để tạo khoá và cài đặt chứng chỉ cho các khoá này. Các chứng chỉ này sẽ do nền tảng quản lý và có thể được dùng để xác thực TLS, truy cập vào mạng hoặc do tiện ích khác thông qua chrome.platformKeys.

sự kiện

Không gian tên chrome.events chứa các loại phổ biến mà API dùng để gửi sự kiện nhằm thông báo cho bạn khi có điều gì đó thú vị xảy ra.

tiện ích

API chrome.extension có các tiện ích mà mọi trang tiện ích đều có thể sử dụng. API này hỗ trợ việc trao đổi thông báo giữa một tiện ích và tập lệnh nội dung của tiện ích đó hoặc giữa các tiện ích, như được mô tả chi tiết trong phần Truyền thông báo.

extensionTypes

API chrome.extensionTypes chứa các khai báo kiểu cho tiện ích của Chrome.

fileBrowserHandler
Chỉ trên ChromeOS Chỉ ở nền trước

Dùng API chrome.fileBrowserHandler để mở rộng trình duyệt tệp ChromeOS. Ví dụ: bạn có thể dùng API này để cho phép người dùng tải tệp lên trang web của bạn.

fileSystemProvider
Chỉ dành cho ChromeOS

Sử dụng API chrome.fileSystemProvider để tạo hệ thống tệp. Bạn có thể truy cập vào hệ thống tệp này từ trình quản lý tệp trên ChromeOS.

fontSettings

Sử dụng API chrome.fontSettings để quản lý chế độ cài đặt phông chữ của Chrome.

gcm

Sử dụng chrome.gcm để cho phép các ứng dụng và tiện ích gửi và nhận thông báo qua Giải pháp gửi thông báo qua đám mây của Firebase (FCM).

history

Sử dụng API chrome.history để tương tác với bản ghi các trang đã truy cập của trình duyệt. Bạn có thể thêm, xoá và truy vấn URL trong nhật ký của trình duyệt. Để ghi đè trang nhật ký bằng phiên bản của riêng bạn, hãy xem phần Ghi đè trang.

i18n

Sử dụng cơ sở hạ tầng chrome.i18n để triển khai tính năng quốc tế hoá trên toàn bộ ứng dụng hoặc tiện ích của bạn.

danh tính

Sử dụng API chrome.identity để nhận mã truy cập OAuth2.

không hoạt động

Sử dụng API chrome.idle để phát hiện thời điểm trạng thái không hoạt động của máy thay đổi.

input.ime
Chỉ dành cho ChromeOS

Dùng API chrome.input.ime để triển khai một IME tuỳ chỉnh cho ChromeOS. Điều này cho phép tiện ích của bạn xử lý các lần nhấn phím, đặt thành phần và quản lý cửa sổ đề xuất.

instanceID
Chrome 44 trở lên

Sử dụng chrome.instanceID để truy cập vào dịch vụ Instance ID.

loginState
Chrome 78 trở lên Chỉ dành cho ChromeOS

Dùng API chrome.loginState để đọc và theo dõi trạng thái đăng nhập.

video

API chrome.management cung cấp các cách để quản lý ứng dụng và tiện ích đã cài đặt.

thông báo

Sử dụng API chrome.notifications để tạo thông báo đa dạng bằng cách sử dụng các mẫu và hiển thị những thông báo này cho người dùng trong khay hệ thống.

offscreen
Chrome 109 trở lên MV3 trở lên

Sử dụng API offscreen để tạo và quản lý các tài liệu ngoài màn hình.

omnibox

Omnibox API cho phép bạn đăng ký một từ khoá với thanh địa chỉ của Google Chrome, còn được gọi là hộp đa năng.

pageCapture

Dùng API chrome.pageCapture để lưu một thẻ dưới dạng MHTML.

quyền

Sử dụng API chrome.permissions để yêu cầu các quyền không bắt buộc đã khai báo tại thời gian chạy thay vì thời gian cài đặt, để người dùng hiểu lý do cần có các quyền và chỉ cấp những quyền cần thiết.

platformKeys
Chrome 45 trở lên Chỉ dành cho ChromeOS

Sử dụng API chrome.platformKeys để truy cập vào các chứng chỉ ứng dụng do nền tảng quản lý. Nếu người dùng hoặc chính sách cấp quyền, thì tiện ích có thể sử dụng chứng chỉ đó trong giao thức xác thực tuỳ chỉnh. Ví dụ: điều này cho phép sử dụng các chứng chỉ do nền tảng quản lý trong VPN của bên thứ ba (xem chrome.vpnProvider).

power

Sử dụng API chrome.power để ghi đè các tính năng quản lý nguồn của hệ thống.

printerProvider
Chrome 44 trở lên

API chrome.printerProvider cho thấy các sự kiện mà trình quản lý in dùng để truy vấn các máy in do tiện ích kiểm soát, truy vấn các chức năng của máy in và gửi lệnh in đến các máy in này.

in ấn
Chrome 81 trở lên Chỉ dành cho ChromeOS

Sử dụng API chrome.printing để gửi lệnh in đến máy in đã cài đặt trên Chromebook.

printingMetrics
Chrome 79 trở lên Chỉ dành cho ChromeOS Yêu cầu chính sách

Sử dụng API chrome.printingMetrics để tìm nạp dữ liệu về mức sử dụng tính năng in.

quyền riêng tư

Sử dụng API chrome.privacy để kiểm soát việc sử dụng các tính năng trong Chrome có thể ảnh hưởng đến quyền riêng tư của người dùng. API này dựa vào nguyên mẫu ChromeSetting của API loại để nhận và đặt cấu hình của Chrome.

quy trình
Kênh nhà phát triển

Sử dụng API chrome.processes để tương tác với các quy trình của trình duyệt.

proxy

Sử dụng API chrome.proxy để quản lý chế độ cài đặt proxy của Chrome. API này dựa vào nguyên mẫu ChromeSetting của API loại để nhận và thiết lập cấu hình proxy.

readingList
Chrome 120 trở lên MV3 trở lên

Sử dụng API chrome.readingList để đọc và sửa đổi các mục trong Danh sách đọc.

runtime

Sử dụng API chrome.runtime để truy xuất trình chạy dịch vụ, trả về thông tin chi tiết về tệp kê khai, đồng thời theo dõi và phản hồi các sự kiện trong vòng đời của tiện ích. Bạn cũng có thể dùng API này để chuyển đổi đường dẫn tương đối của URL thành URL đủ điều kiện.

scripting
Chrome 88 trở lên MV3 trở lên

Sử dụng API chrome.scripting để thực thi tập lệnh trong nhiều ngữ cảnh.

search
Chrome 87 trở lên

Dùng API chrome.search để tìm kiếm thông qua nhà cung cấp mặc định.

phiên

Dùng API chrome.sessions để truy vấn và khôi phục các thẻ và cửa sổ từ một phiên duyệt web.

sidePanel
Chrome 114 trở lên MV3 trở lên

Sử dụng API chrome.sidePanel để lưu trữ nội dung trong bảng điều khiển bên của trình duyệt cùng với nội dung chính của một trang web.

storage

Sử dụng API chrome.storage để lưu trữ, truy xuất và theo dõi các thay đổi đối với dữ liệu người dùng.

system.cpu

Sử dụng API system.cpu để truy vấn siêu dữ liệu CPU.

system.display

Dùng API system.display để truy vấn siêu dữ liệu hiển thị.

system.memory

API chrome.system.memory.

system.storage

Sử dụng API chrome.system.storage để truy vấn thông tin thiết bị lưu trữ và nhận thông báo khi thiết bị lưu trữ di động được gắn và tháo rời.

systemLog
Chrome 125 trở lên Chỉ dành cho ChromeOS Yêu cầu chính sách

Sử dụng API chrome.systemLog để ghi nhật ký hệ thống của Chrome từ các tiện ích.

tabCapture

Dùng API chrome.tabCapture để tương tác với luồng nội dung nghe nhìn của thẻ.

tabGroups
Chrome 89 trở lên MV3 trở lên

Sử dụng API chrome.tabGroups để tương tác với hệ thống nhóm thẻ của trình duyệt. Bạn có thể dùng API này để sửa đổi và sắp xếp lại các nhóm thẻ trong trình duyệt. Để nhóm và huỷ nhóm các thẻ hoặc để truy vấn những thẻ nằm trong nhóm, hãy dùng API chrome.tabs.

thẻ

Sử dụng API chrome.tabs để tương tác với hệ thống thẻ của trình duyệt. Bạn có thể dùng API này để tạo, sửa đổi và sắp xếp lại các thẻ trong trình duyệt.

topSites

Sử dụng API chrome.topSites để truy cập vào các trang web hàng đầu (tức là các trang web được truy cập nhiều nhất) xuất hiện trên trang thẻ mới. Những phím tắt này không bao gồm các phím tắt do người dùng tuỳ chỉnh.

tts

Dùng API chrome.tts để phát văn bản được tổng hợp thành lời nói (TTS). Bạn cũng có thể xem API ttsEngine có liên quan. API này cho phép một tiện ích triển khai công cụ lời nói.

ttsEngine

Dùng chrome.ttsEngine API để triển khai một công cụ chuyển văn bản sang lời nói(TTS) bằng cách sử dụng một tiện ích. Nếu đăng ký bằng API này, tiện ích của bạn sẽ nhận được các sự kiện chứa một câu nói cần được phát và các tham số khác khi bất kỳ tiện ích hoặc Ứng dụng Chrome nào sử dụng API tts để tạo lời nói. Sau đó, tiện ích của bạn có thể sử dụng mọi công nghệ web hiện có để tổng hợp và xuất lời nói, đồng thời gửi các sự kiện trở lại hàm gọi để báo cáo trạng thái.

types

API chrome.types chứa các khai báo kiểu cho Chrome.

userScripts
Chrome 120 trở lên MV3 trở lên

Sử dụng API userScripts để thực thi tập lệnh người dùng trong ngữ cảnh Tập lệnh người dùng.

vpnProvider
Chrome 43 trở lên Chỉ dành cho ChromeOS

Sử dụng API chrome.vpnProvider để triển khai một ứng dụng VPN.

hình nền
Chrome 43 trở lên Chỉ dành cho ChromeOS

Sử dụng API chrome.wallpaper để thay đổi hình nền ChromeOS.

webAuthenticationProxy
Chrome 115 trở lên MV3 trở lên

API chrome.webAuthenticationProxy cho phép phần mềm máy tính từ xa chạy trên một máy chủ từ xa chặn các yêu cầu API Xác thực web (WebAuthn) để xử lý các yêu cầu đó trên một ứng dụng cục bộ.

webNavigation

Sử dụng API chrome.webNavigation để nhận thông báo về trạng thái của các yêu cầu chỉ đường đang diễn ra.

webRequest

Sử dụng API chrome.webRequest để theo dõi và phân tích lưu lượng truy cập, đồng thời chặn, chặn hoặc sửa đổi các yêu cầu đang diễn ra.

windows

Dùng API chrome.windows để tương tác với các cửa sổ trình duyệt. Bạn có thể sử dụng API này để tạo, sửa đổi và sắp xếp lại các cửa sổ trong trình duyệt.