Tài liệu tham khảo API

Hầu hết các 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 có thể 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 Extensions API (API tiện ích)

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 của tiện ích và thông thường nhưng không phải lúc nào cũng là các 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ộ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 đợi thao tác gọi các phương thức đó kết thúc. Sử dụng lời hứa để nhận được kết quả của các phương thức 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 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 trên nguyên mẫu Cài đặt Chrome của loại API để nhận và đặt từng tính năng hỗ trợ tiếp cận. Để nhận đượ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 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.

hành động
Chrome 88 trở lên MV3

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

chuông báo

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

âm thanh
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à điều khiển các thiết bị âm thanh đi kèm với hệ thống. API này hiện chỉ có ở chế độ kiosk dành cho ChromeOS.

dấu trang

Sử dụng API chrome.bookmarks để tạo, sắp xếp và chỉnh sửa dấu trang. Ngoài ra, hãy xem bài viết Ghi đè các trang mà bạn có thể sử dụng để tạo một 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ơ cục bộ của người dùng.

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

Hãy sử dụng API này để hiển thị các chứng chỉ cho nền tảng có thể sử dụng các chứng chỉ này cho việc xác thực TLS.

lệnh

Sử dụng API lệnh để thêm 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ư một thao tác để mở thao tác trên trình duyệt hoặc gửi một 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 trên từng trang web thay vì trên toàn hệ thống.

contextMenus

Sử 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 những loại đối tượng có thể áp dụng cho trình đơn theo bối cảnh, 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 chúng thay đổi.

debugger

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

declarativeContent

Dùng API chrome.declarativeContent để thao tác tuỳ thuộc vào nội dung trên trang mà không yêu cầu quyền đọc nội dung trên 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 yêu cầu mạng mà không chặn và xem nội dung, nhờ đó bảo vệ quyền riêng tư cao hơn.

desktopCapture

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

devtools.inspectedWindow

Sử dụng API chrome.devtools.inspectedWindow để tương tác với cửa sổ đã kiểm tra: lấy mã thẻ cho trang đã kiểm tra, đánh giá mã trong ngữ cảnh của cửa sổ đã 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 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 bảng điều khiển hiện có và thêm thanh bên.

devtools.recorder
Chrome 105 trở lên

Dùng API chrome.devtools.recorder để tuỳ chỉnh bảng điều khiển Máy ghi âm 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ừ trình quét tài liệu đí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

lượt tải xuống

Dùng API chrome.downloads để khởi tạo, giám sát, thao tác và tìm tệp 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 Cần có 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 bị buộc cài đặt theo chính sách doanh nghiệp.

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

Sử dụng API chrome.enterprise.hardwarePlatform để biết nhà sản xuất và kiểu 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ỉ dành cho ChromeOS Cần có chính sách

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

enterprise.platformKeys
Chỉ dành cho ChromeOS Cần có 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ỉ sẽ do nền tảng quản lý và có thể được 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 {@link platformKeys chrome.platformKeys}.

sự kiện

Không gian tên chrome.events chứa các loại phổ biến mà các sự kiện gửi API sử dụng để 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ể dùng. Phiên bản này hỗ trợ trao đổi thư 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ư mô tả chi tiết trong phần Chuyển thư.

extensionTypes

API chrome.extensionTypes chứa các phần khai báo loại cho các 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 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

Sử dụng API chrome.fileSystemProvider để tạo các hệ thống tệp có thể truy cập được từ trình quản lý tệp trên Chrome OS.

fontSettings

Dùng API chrome.fontSettings để quản lý các 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 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ý

Sử dụng API chrome.history để tương tác với bản ghi về các trang đã truy cập của trình duyệt. Bạn có thể thêm, xoá và truy vấn các 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 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.

không hoạt động

Sử 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

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

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

Dùng API chrome.loginState để đọc và giám sát trạng thái đăng nhập.

video

API chrome.management cung cấp các cách quản lý danh sách tiện ích/ứng dụng đã cài đặt và đang chạy. Điều này đặc biệt hữu ích cho các tiện ích ghi đè trang Thẻ mới tích hợp sẵn.

thông báo

Sử dụng API chrome.notifications để tạo thông báo chi tiết bằng mẫu và hiển thị 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 MV3

Sử 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, thanh địa chỉ này còn được gọi là thanh địa chỉ.

pageCapture

Sử dụng API chrome.pageCapture để lưu thẻ dưới dạng MHTML.

quyền

Thay vì yêu cầu trong thời gian cài đặt, hãy dùng API chrome.permissions để yêu cầu các quyền không bắt buộc được khai báo trong thời gian chạy, nhờ đó, người dùng nắm được lý do cần có những 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

Hãy dùng API chrome.platformKeys để truy cập các chứng chỉ ứng dụng 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 này, thì tiện ích có thể sử dụng chứng chỉ đó trong giao thức xác thực tuỳ chỉnh của tiện ích. Ví dụ: việc 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 {@link vpnProvider chrome.vpnProvider}).

sức mạnh

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

printerProvider
Chrome 44 trở lên

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

in
Chrome 81 trở lên Chỉ ChromeOS

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

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

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 những 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 trên nguyên mẫu Cài đặt Chrome của loại API để nhận và đặt cấu hình của Chrome.

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

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 trên 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 MV3

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

thời gian chạy

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, 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 MV3

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 trình cung cấp mặc định.

phiên

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

sidePanel
Chrome 114 trở lên MV3

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 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 về 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 thiết bị lưu trữ và nhận thông báo khi thiết bị lưu trữ di động được đính kèm và tháo rời.

tabCapture

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

tabGroups
Chrome 89 trở lên MV3

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 các thẻ có trong nhóm, hãy sử dụng API chrome.tabs.

thẻ

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) được hiển thị trên trang thẻ mới. Các phím tắt này không bao gồm lối tắt do người dùng tuỳ chỉnh.

tts

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

ttsEngine

Sử 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 lời nói 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 {@link tts} để tạo giọng nói. Sau đó, tiện ích của bạn có thể sử dụng bất kỳ công nghệ web nào có sẵn để tổng hợp và xuất giọng nói, đồng thời 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 phần khai báo loại cho Chrome.

userScripts
Chrome 120 trở lên MV3

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

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

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

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

webAuthenticationProxy
Chrome 115 trở lên MV3

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 này 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 chỉ đường đang diễn ra.

webRequest

Sử 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ổ

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.