Tài liệu tham khảo API

Hầu hết tiện ích cần 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 hiện có để sử dụng trong tiện ích và trình bày các trường hợp sử dụng mẫu.

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

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 để tiện ích hoạt động. Thông thường, luôn luôn, trường tệp 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 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ờ cho hoạt động yêu cầu họ hoàn tất. Sử dụng phương pháp hứa hẹn để nhận được kết quả của các phương pháp này. Để biết thêm thông tin, hãy xem phần Phương thức không đồng bộ.

API tiện ích của Chrome

accessibilityFeatures

Sử dụng API chrome.accessibilityFeatures để quản lý bộ tính năng hỗ trợ tiếp cận của Chrome. API này dựa vào nguyên mẫu Cài đặt Chrome của loại API để nhận và đặt tính năng hỗ trợ tiếp cận riêng lẻ. Để có được các trạng thái 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. Lưu ý rằng accessibilityFeatures.modify không ngụ ý quyền accessibilityFeatures.read.

hành động
Chrome 88 trở lên Video nhạc 3 trở lên

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 cho mã chạy định kỳ hoặc vào một thời điểm được chỉ định trong tương lai.

âm thanh
Chrome 59 trở lên Chỉ 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 kết nối với hệ thống. API này hiện chỉ hoạt động ở chế độ kiosk dành cho ChromeOS.

dấu trang

Dùng API chrome.bookmarks để tạo, sắp xếp và thao tác với dấu trang. Ngoài ra, hãy xem phần Ghi đè trang mà bạn có thể sử dụng để tạo trang Trình quản lý dấu trang tuỳ chỉnh.

browsingData

Dùng API chrome.browsingData để xoá dữ liệu duyệt web khỏi hồ sơ trên máy của người dùng.

certificateProvider
Chrome 46 trở lên Chỉ ChromeOS

Sử dụng API này để hiển thị các chứng chỉ cho nền tảng, nơi 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 phím tắt kích hoạt thao tác trong tiện ích của bạn, ví dụ: thao tác để mở thao tác trên trình duyệt hoặc gửi lệnh đến tiện ích.

contentSettings

Dùng API chrome.contentSettings để thay đổi 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, các 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 bộ.

contextMenus

Dùng API chrome.contextMenus để thêm 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à phần bổ sung của 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

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

trình gỡ lỗi

API chrome.debugger đóng vai trò là một phương tiện 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ẻ nhằm đo lườ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 mục tiêu các thẻ bằng sendCommand và định tuyến các sự kiện bằng tabId từ các lệnh gọi lại onEvent.

declarativeContent

Hãy dùng API chrome.declarativeContent để thực hiện thao tác tuỳ thuộc vào nội dung của trang mà không yêu cầu quyền đọc nội dung của trang.

declarativeNetRequest
Chrome 84 trở lên

API chrome.declarativeNetRequest 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 tiện ích sửa đổi các 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, từ đó cung cấp nhiều quyền riêng tư hơn.

desktopCapture

Desktop Capture API ghi lại nội dung của màn hình, từng cửa sổ hoặc từng thẻ.

devtools.inspectedWindow

Sử dụng chrome.devtools.inspectedWindow API để tương tác với cửa sổ được kiểm tra: lấy mã thẻ cho trang được kiểm tra, đánh giá mã trong bối cảnh cửa sổ được kiểm tra, tải lại trang hoặc lấy danh sách tài nguyên trên 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 do 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 của bạn vào giao diện người dùng 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 bảng điều khiển hiện có và thêm thanh bên.

devtools.performance
Đang chờ xử lý

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 để giải quyết DNS.

documentScan
Chrome 44 trở lên Chỉ ChromeOS

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

dom
Chrome 88 trở lên

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

tải xuống

Sử dụng API chrome.downloads để khởi động, giám sát, thao tác và tìm kiếm tệp đã tải xuống theo phương thức lập trình.

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

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 buộc cài đặt theo chính sách doanh nghiệp.

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

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

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

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 buộc cài đặt theo chính sách doanh nghiệp.

enterprise.platformKeys

Sử dụng API chrome.enterprise.platformKeys để tạo khoá và cài đặt chứng chỉ cho những khoá này. Các chứng chỉ này sẽ do nền tảng quản lý và có thể dùng để xác thực TLS, truy cập mạng hoặc cho các 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à các API gửi sự kiện sử dụng để thông báo cho bạn khi có điều thú vị xảy ra.

phần mở rộng

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

extensionTypes

API chrome.extensionTypes chứa nội dung khai báo loại cho tiện ích của Chrome.

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

Dùng API chrome.fileBrowserHandler để mở rộng trình duyệt tệp trên Chrome OS. Ví dụ: bạn có thể sử 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ỉ ChromeOS

Dùng API chrome.fileSystemProvider để tạo các hệ thống tệp. Bạn có thể truy cập các hệ thống này qua trình quản lý tệp trên Chrome OS.

fontSettings

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 ứng dụng và tiện ích gửi và nhận tin nhắn thông qua Giải pháp gửi thông báo qua đám mây của Firebase (FCM).

nhật ký

Dùng API chrome.history để tương tác với bản ghi của trình duyệt về các trang đã truy cập. Bạn có thể thêm, xoá và truy vấn URL trong nhật ký duyệt web 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 quốc tế hoá trên toàn bộ ứng dụng hoặc tiện ích của bạn.

danh tính

Dùng API chrome.identity để nhận mã truy cập OAuth2.

nhàn rỗi

Dùng API chrome.idle để phát hiện thời điểm trạng thái rảnh của máy thay đổi.

input.ime
Chỉ ChromeOS

Sử dụng API chrome.input.ime để triển khai một IME tuỳ chỉnh cho Chrome OS. Điều này cho phép tiện ích của bạn xử lý thao tác nhấn phím, thiết lập 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ụ mã phiên bản.

loginState
Chrome 78 trở lên Chỉ 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ý các ứng dụng và tiện ích đã cài đặt.

thông báo

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

ngoài màn hình
Chrome 109 trở lên Video nhạc 3 trở lên

Dùng API offscreen để tạo và quản lý tài liệu ngoài màn hình.

thanh địa chỉ

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

pageCapture

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

quyền

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

platformKeys
Chrome 45 trở lên Chỉ ChromeOS

Sử dụng API chrome.platformKeys để truy cập vào các chứng chỉ máy khách 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 một 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 chứng chỉ do nền tảng quản lý trong VPN của bên thứ ba (xem chrome.vpnProvider).

sức mạnh

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 hiển thị những sự kiện mà trình quản lý máy in dùng để truy vấn máy in do các tiện ích kiểm soát, để truy vấn chức năng của các tiện ích đó và gửi các lệnh in đến những máy in này.

in
Chrome 81 trở lên Chỉ ChromeOS

Dùng API chrome.printing để gửi lệnh in tới các máy in đã cài đặt trên Chromebook.

printingMetrics
Chrome 79 trở lên Chỉ 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ư

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 Cài đặt Chrome của loại API để 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 cài đặt Chrome của loại API để nhận và đặt cấu hình proxy.

readingList
Chrome 120 trở lên Video nhạc 3 trở lên

Dùng chrome.readingList API để đọc và sửa đổi các mục trong Reading List (Danh sách đọc).

thời gian chạy

Sử dụng chrome.runtime API để truy xuất trình chạy dịch vụ, trả về thông tin chi tiết về tệp kê khai, cũng như 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ể sử dụng API này để chuyển đổi đường dẫn tương đối của URL thành các URL đủ điều kiện.

tập lệnh
Chrome 88 trở lên Video nhạc 3 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

Sử dụng API chrome.search để tìm kiếm qua nhà cung cấp mặc định.

số phiên

Dùng API chrome.sessions để truy vấn cũng như 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 Video nhạc 3 trở lên

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 trang web.

bộ nhớ

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

Dùng API system.cpu để truy vấn siêu dữ liệu của 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

Dùng API chrome.system.storage để truy vấn thông tin về 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ỉ ChromeOS Yêu cầu chính sách

Dùng API chrome.systemLog để ghi lại nhật ký hệ thống Chrome từ các tiện ích.

tabCapture

Sử dụng API chrome.tabCapture để tương tác với luồng nội dung nghe nhìn trên thẻ.

tabGroups
Chrome 89 trở lên Video nhạc 3 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ể sử 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 xem có những thẻ nào trong nhóm, hãy sử 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ể sử 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

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. Các phím tắt này không bao gồm các lối tắt do người dùng tuỳ chỉnh.

tt

Dùng API chrome.tts để phát tính năng chuyển văn bản sang lời nói (TTS) được tổng hợp. Ngoài ra, hãy xem API ttsEngine có liên quan, giúp cho phép tiện ích triển khai công cụ chuyển lời nói.

ttsEngine

Dùng API chrome.ttsEngine để triển khai công cụ chuyển văn bản sang lời nói(TTS) bằng một tiện ích. Nếu tiện ích của bạn đăng ký bằng API này, tiện ích sẽ nhận được các sự kiện chứa cách phát âm sẽ được nói và các thông 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 bất kỳ công nghệ web nào hiện có để tổng hợp và xuất giọng nói, cũng như gửi sự kiện trở lại hàm gọi để báo cáo trạng thái.

loại

API chrome.types chứa các nội dung khai báo loại cho Chrome.

userScripts
Chrome 120 trở lên Video nhạc 3 trở lên

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

vpnProvider
Chrome 43 trở lên Chỉ ChromeOS

Dùng API chrome.vpnProvider để triển khai ứng dụng VPN.

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

Dùng API chrome.wallpaper để thay đổi hình nền ChromeOS.

webAuthenticationProxy
Chrome 115 trở lên Video nhạc 3 trở lên

API chrome.webAuthenticationProxy cho phép phần mềm máy tính từ xa chạy trên 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áy khách 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 điều hướng đang diễn ra.

webRequest

Dùng API chrome.webRequest để quan sát và phân tích lưu lượng truy cập cũng như để chặn, chặn hoặc sửa đổi các yêu cầu đang diễn ra.

cửa sổ

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.