การอ้างอิง API

ส่วนขยายส่วนใหญ่จำเป็นต้องเข้าถึง Chrome Extensions API อย่างน้อย 1 รายการจึงจะทำงานได้ ข้อมูลอ้างอิง API นี้อธิบาย API ที่มีให้ใช้งานในส่วนขยายและแสดงตัวอย่าง Use Case

ฟีเจอร์ทั่วไปของ Extensions API

Extensions API ประกอบด้วยเนมสเปซที่มีเมธอดและพร็อพเพอร์ตี้สําหรับทํางานของส่วนขยาย และมักจะมีช่องไฟล์ Manifest สําหรับไฟล์ manifest.json เช่น เนมสเปซ chrome.action ต้องใช้ออบเจ็กต์ "action" ในไฟล์ Manifest นอกจากนี้ API จำนวนมากยังต้องใช้สิทธิ์ในไฟล์ Manifest ด้วย

เมธอดใน API ของส่วนขยายเป็นแบบไม่พร้อมกัน เว้นแต่จะระบุไว้เป็นอย่างอื่น เมธอดแบบอะซิงโครนัสจะแสดงผลทันทีโดยไม่ต้องรอให้การดำเนินการที่เรียกใช้เมธอดเสร็จสมบูรณ์ ใช้ promise เพื่อรับผลลัพธ์ของเมธอดแบบอะซิงโครนัสเหล่านี้

Chrome Extension API

accessibilityFeatures

ใช้ chrome.accessibilityFeatures API เพื่อจัดการฟีเจอร์การช่วยเหลือพิเศษของ Chrome API นี้ใช้โปรโตไทป์ ChromeSetting ของประเภท API เพื่อรับและตั้งค่าฟีเจอร์การช่วยเหลือพิเศษแต่ละรายการ หากต้องการดูสถานะฟีเจอร์ ส่วนขยายต้องขอสิทธิ์ accessibilityFeatures.read ส่วนขยายต้องมีสิทธิ์ accessibilityFeatures.modify จึงจะแก้ไขสถานะของฟีเจอร์ได้ โปรดทราบว่า accessibilityFeatures.modify ไม่ได้หมายถึงสิทธิ์ accessibilityFeatures.read

action

Chrome 88 ขึ้นไป MV3 ขึ้นไป

ใช้ chrome.action API เพื่อควบคุมไอคอนส่วนขยายในแถบเครื่องมือ Google Chrome

alarms

ใช้ chrome.alarms API เพื่อกําหนดเวลาให้โค้ดทํางานเป็นระยะๆ หรือตามเวลาที่ระบุในอนาคต

audio

Chrome 59 ขึ้นไป ChromeOS เท่านั้น

chrome.audio API มีไว้เพื่อให้ผู้ใช้ได้รับข้อมูลและควบคุมอุปกรณ์เสียงที่เชื่อมต่อกับระบบ ปัจจุบัน API นี้พร้อมใช้งานในโหมดคีออสก์สำหรับ ChromeOS เท่านั้น

bookmarks

ใช้ chrome.bookmarks API เพื่อสร้าง จัดระเบียบ และดำเนินการกับบุ๊กมาร์ก โปรดดูหน้าการลบล้างด้วย ซึ่งคุณใช้สร้างหน้าการจัดการบุ๊กมาร์กที่กำหนดเองได้

browsingData

ใช้ chrome.browsingData API เพื่อนำข้อมูลการท่องเว็บออกจากโปรไฟล์ในเครื่องของผู้ใช้

certificateProvider

Chrome 46 ขึ้นไป ChromeOS เท่านั้น

ใช้ API นี้เพื่อแสดงใบรับรองต่อแพลตฟอร์มที่สามารถใช้ใบรับรองเหล่านี้สําหรับการตรวจสอบสิทธิ์ TLS

commands

ใช้ Commands API เพื่อเพิ่มแป้นพิมพ์ลัดที่จะทริกเกอร์การดำเนินการในส่วนขยาย เช่น การดำเนินการเพื่อเปิดการดำเนินการของเบราว์เซอร์หรือส่งคําสั่งไปยังส่วนขยาย

contentSettings

ใช้ chrome.contentSettings API เพื่อเปลี่ยนการตั้งค่าที่ควบคุมว่าเว็บไซต์จะสามารถใช้ฟีเจอร์อย่าง คุกกี้, JavaScript และปลั๊กอินได้หรือไม่ กล่าวโดยละเอียดคือ การตั้งค่าเนื้อหาช่วยให้คุณปรับแต่งลักษณะการทำงานของ Chrome ในแต่ละเว็บไซต์แทนที่จะปรับแต่งทั้งระบบ

contextMenus

ใช้ chrome.contextMenus API เพื่อเพิ่มรายการลงในเมนูบริบทของ Google Chrome คุณเลือกประเภทของออบเจ็กต์ที่จะใช้การเพิ่มเมนูตามบริบทได้ เช่น รูปภาพ ไฮเปอร์ลิงก์ และหน้าเว็บ

cookies

ใช้ chrome.cookies API เพื่อค้นหาและแก้ไขคุกกี้ รวมถึงรับการแจ้งเตือนเมื่อมีการเปลี่ยนแปลง

debugger

chrome.debugger API ทำหน้าที่เป็นช่องทางการนำส่งสำรองสำหรับโปรโตคอลการแก้ไขข้อบกพร่องระยะไกลของ Chrome ใช้ chrome.debugger เพื่อแนบกับแท็บอย่างน้อย 1 แท็บเพื่อวัดการโต้ตอบของเครือข่าย แก้ไขข้อบกพร่อง JavaScript เปลี่ยน DOM และ CSS และอื่นๆ ใช้พร็อพเพอร์ตี้ Debuggee tabId เพื่อกําหนดเป้าหมายแท็บด้วย sendCommand และกำหนดเส้นทางเหตุการณ์ตาม tabId จาก onEvent callbacks

declarativeContent

ใช้ chrome.declarativeContent API เพื่อดำเนินการตามเนื้อหาของหน้าเว็บโดยไม่ต้องขอสิทธิ์ในการอ่านเนื้อหาของหน้า

declarativeNetRequest

Chrome 84 ขึ้นไป

chrome.declarativeNetRequest API ใช้เพื่อบล็อกหรือแก้ไขคําขอเครือข่ายโดยการระบุกฎแบบประกาศ ซึ่งช่วยให้ส่วนขยายแก้ไขคำขอเครือข่ายได้โดยไม่ต้องขัดขวางหรือดูเนื้อหาของคำขอดังกล่าว จึงช่วยเพิ่มความเป็นส่วนตัวได้

desktopCapture

Desktop Capture API จะจับภาพเนื้อหาของหน้าจอ หน้าต่างแต่ละหน้าต่าง หรือแท็บแต่ละแท็บ

devtools.inspectedWindow

ใช้ chrome.devtools.inspectedWindow API เพื่อโต้ตอบกับหน้าต่างที่ตรวจสอบ เช่น รับรหัสแท็บของหน้าที่ตรวจสอบ ประเมินโค้ดในบริบทของหน้าต่างที่ตรวจสอบ โหลดหน้าเว็บซ้ำ หรือรับรายการทรัพยากรภายในหน้า

devtools.network

ใช้ chrome.devtools.network API เพื่อดึงข้อมูลเกี่ยวกับคําขอเครือข่ายที่เครื่องมือสําหรับนักพัฒนาซอฟต์แวร์แสดงในแผงเครือข่าย

devtools.panels

ใช้ chrome.devtools.panels API เพื่อผสานรวมส่วนขยายเข้ากับ UI ของหน้าต่างเครื่องมือสำหรับนักพัฒนาซอฟต์แวร์ เช่น สร้างแผงของคุณเอง เข้าถึงแผงที่มีอยู่ และเพิ่มแถบด้านข้าง

devtools.performance

Chrome 129 ขึ้นไป

ใช้ chrome.devtools.performance API เพื่อฟังการอัปเดตสถานะการบันทึกในแผงประสิทธิภาพในเครื่องมือสำหรับนักพัฒนาเว็บ

devtools.recorder

Chrome 105 ขึ้นไป

ใช้ chrome.devtools.recorder API เพื่อปรับแต่งแผงโปรแกรมอัดเสียงในเครื่องมือสำหรับนักพัฒนาเว็บ

dns

ช่องทางเวอร์ชันที่กำลังพัฒนา

ใช้ chrome.dns API สำหรับการแก้ไข DNS

documentScan

Chrome 44 ขึ้นไป ChromeOS เท่านั้น

ใช้ chrome.documentScan API เพื่อค้นหาและเรียกข้อมูลรูปภาพจากเครื่องสแกนเอกสารที่แนบมา

dom

Chrome 88 ขึ้นไป

ใช้ chrome.dom API เพื่อเข้าถึง DOM API พิเศษสําหรับส่วนขยาย

downloads

ใช้ chrome.downloads API เพื่อเริ่มต้น ตรวจสอบ จัดการ และค้นหาการดาวน์โหลดแบบเป็นโปรแกรม

enterprise.deviceAttributes

Chrome 46 ขึ้นไป ChromeOS เท่านั้น ต้องมีนโยบาย

ใช้ chrome.enterprise.deviceAttributes API เพื่ออ่านแอตทริบิวต์ของอุปกรณ์ หมายเหตุ: API นี้ใช้ได้กับส่วนขยายที่นโยบายขององค์กรบังคับให้ติดตั้งเท่านั้น

enterprise.hardwarePlatform

Chrome 71 ขึ้นไป ต้องมีนโยบาย

ใช้ chrome.enterprise.hardwarePlatform API เพื่อดูผู้ผลิตและรุ่นของแพลตฟอร์มฮาร์ดแวร์ที่เบราว์เซอร์ทํางานอยู่ หมายเหตุ: API นี้ใช้ได้กับส่วนขยายที่ติดตั้งโดยนโยบายองค์กรเท่านั้น

enterprise.login

รอดำเนินการ ChromeOS เท่านั้น ต้องมีนโยบาย

ใช้ chrome.enterprise.login API เพื่อออกจากเซสชันผู้มาเยือนที่มีการจัดการ หมายเหตุ: API นี้ใช้ได้กับส่วนขยายที่ติดตั้งโดยนโยบายขององค์กรในเซสชันผู้มาเยือนที่มีการจัดการของ ChromeOS เท่านั้น

enterprise.networkingAttributes

Chrome 85 ขึ้นไป ChromeOS เท่านั้น ต้องมีนโยบาย

ใช้ chrome.enterprise.networkingAttributes API เพื่ออ่านข้อมูลเกี่ยวกับเครือข่ายปัจจุบัน หมายเหตุ: API นี้ใช้ได้กับส่วนขยายที่นโยบายขององค์กรบังคับให้ติดตั้งเท่านั้น

enterprise.platformKeys

ChromeOS เท่านั้น ต้องมีนโยบาย

ใช้ chrome.enterprise.platformKeys API เพื่อสร้างคีย์และติดตั้งใบรับรองสำหรับคีย์เหล่านี้ แพลตฟอร์มจะจัดการใบรับรองดังกล่าวและสามารถใช้สำหรับการตรวจสอบสิทธิ์ TLS, การเข้าถึงเครือข่าย หรือโดยส่วนขยายอื่นๆ ผ่าน chrome.platformKeys

กิจกรรม

เนมสเปซ chrome.events มีประเภททั่วไปที่ API ใช้เพื่อส่งเหตุการณ์เพื่อแจ้งให้คุณทราบเมื่อมีเหตุการณ์ที่น่าสนใจเกิดขึ้น

extension

chrome.extension API มียูทิลิตีที่หน้าส่วนขยายใดก็ได้ใช้ ซึ่งรวมถึงการรองรับการแลกเปลี่ยนข้อความระหว่างส่วนขยายกับสคริปต์เนื้อหาของส่วนขยายหรือระหว่างส่วนขยายต่างๆ ตามที่อธิบายไว้อย่างละเอียดในการส่งข้อความ

extensionTypes

chrome.extensionTypes API มีการประกาศประเภทสําหรับส่วนขยาย Chrome

fileBrowserHandler

ChromeOS เท่านั้น เบื้องหน้าเท่านั้น

ใช้ chrome.fileBrowserHandler API เพื่อขยายเบราว์เซอร์ไฟล์ของ Chrome OS เช่น คุณสามารถใช้ API นี้เพื่อให้ผู้ใช้อัปโหลดไฟล์ไปยังเว็บไซต์ได้

fileSystemProvider

ChromeOS เท่านั้น

ใช้ chrome.fileSystemProvider API เพื่อสร้างระบบไฟล์ที่เข้าถึงได้จากเครื่องมือจัดการไฟล์ใน ChromeOS

fontSettings

ใช้ chrome.fontSettings API เพื่อจัดการการตั้งค่าแบบอักษรของ Chrome

gcm

ใช้ chrome.gcm เพื่อเปิดใช้แอปและส่วนขยายให้ส่งและรับข้อความผ่าน Firebase Cloud Messaging (FCM)

history

ใช้ chrome.history API เพื่อโต้ตอบกับบันทึกหน้าเว็บที่เข้าชมของเบราว์เซอร์ คุณสามารถเพิ่ม นำออก และค้นหา URL ในประวัติของเบราว์เซอร์ได้ หากต้องการลบล้างหน้าประวัติด้วยเวอร์ชันของคุณเอง โปรดดูลบล้างหน้า

i18n

ใช้โครงสร้างพื้นฐาน chrome.i18n เพื่อนำการจัดเตรียมให้พร้อมใช้งานหลายภาษาไปใช้กับทั้งแอปหรือส่วนขยาย

identity

ใช้ chrome.identity API เพื่อรับโทเค็นการเข้าถึง OAuth2

ไม่มีการใช้งาน

ใช้ chrome.idle API เพื่อตรวจหาเมื่อสถานะ "ไม่มีการใช้งาน" ของเครื่องมีการเปลี่ยนแปลง

input.ime

ChromeOS เท่านั้น

ใช้ chrome.input.ime API เพื่อติดตั้งใช้งาน IME ที่กําหนดเองสําหรับ Chrome OS ซึ่งจะช่วยให้ส่วนขยายจัดการการกดแป้นพิมพ์ ตั้งค่าการเขียน และจัดการกรอบตัวเลือกได้

instanceID

Chrome 44 ขึ้นไป

ใช้ chrome.instanceID เพื่อเข้าถึงบริการรหัสอินสแตนซ์

loginState

Chrome 78 ขึ้นไป ChromeOS เท่านั้น

ใช้ chrome.loginState API เพื่ออ่านและตรวจสอบสถานะการเข้าสู่ระบบ

วิดีโอ

chrome.management API มีวิธีจัดการแอปและส่วนขยายที่ติดตั้ง

notifications

ใช้ chrome.notifications API เพื่อสร้างการแจ้งเตือนแบบริชมีเดียโดยใช้เทมเพลตและแสดงการแจ้งเตือนเหล่านี้ต่อผู้ใช้ในถาดระบบ

offscreen

Chrome 109 ขึ้นไป MV3 ขึ้นไป

ใช้ offscreen API เพื่อสร้างและจัดการเอกสารนอกหน้าจอ

omnibox

Omnibox API ช่วยให้คุณลงทะเบียนคีย์เวิร์ดกับแถบที่อยู่ของ Google Chrome หรือที่เรียกว่าแถบอเนกประสงค์ได้

pageCapture

ใช้ chrome.pageCapture API เพื่อบันทึกแท็บเป็น MHTML

permissions

ใช้ chrome.permissions API เพื่อขอสิทธิ์ที่ไม่บังคับที่ประกาศไว้ขณะรันไทม์แทนที่จะเป็นขณะติดตั้ง เพื่อให้ผู้ใช้เข้าใจถึงเหตุผลที่ต้องมีสิทธิ์ดังกล่าวและมอบสิทธิ์ที่จำเป็นเท่านั้น

platformKeys

Chrome 45 ขึ้นไป ChromeOS เท่านั้น

ใช้ chrome.platformKeys API เพื่อเข้าถึงใบรับรองไคลเอ็นต์ที่แพลตฟอร์มจัดการ หากผู้ใช้หรือนโยบายให้สิทธิ์ ส่วนขยายจะใช้ใบรับรองดังกล่าวในโปรโตคอลการตรวจสอบสิทธิ์ที่กำหนดเองได้ เช่น การตั้งค่านี้อนุญาตให้ใช้ใบรับรองที่จัดการโดยแพลตฟอร์มใน VPN ของบุคคลที่สาม (ดู chrome.vpnProvider)

power

ใช้ chrome.power API เพื่อลบล้างฟีเจอร์การจัดการพลังงานของระบบ

printerProvider

Chrome 44 ขึ้นไป

chrome.printerProvider API จะแสดงเหตุการณ์ที่เครื่องมือจัดการการพิมพ์ใช้เพื่อค้นหาเครื่องพิมพ์ที่ควบคุมโดยส่วนขยาย เพื่อค้นหาความสามารถของเครื่องพิมพ์ และส่งงานพิมพ์ไปยังเครื่องพิมพ์เหล่านี้

printing

Chrome 81 ขึ้นไป ChromeOS เท่านั้น

ใช้ chrome.printing API เพื่อส่งงานพิมพ์ไปยังเครื่องพิมพ์ที่ติดตั้งใน Chromebook

printingMetrics

Chrome 79 ขึ้นไป ChromeOS เท่านั้น ต้องมีนโยบาย

ใช้ chrome.printingMetrics API เพื่อดึงข้อมูลเกี่ยวกับการใช้งานการพิมพ์

privacy

ใช้ chrome.privacy API เพื่อควบคุมการใช้งานฟีเจอร์ใน Chrome ที่อาจส่งผลต่อความเป็นส่วนตัวของผู้ใช้ API นี้ใช้ ChromeSetting โปรโตไทป์ของประเภท API เพื่อรับและตั้งค่าการกําหนดค่าของ Chrome

processes

ช่องทางเวอร์ชันที่กำลังพัฒนา

ใช้ chrome.processes API เพื่อโต้ตอบกับกระบวนการของเบราว์เซอร์

proxy

ใช้ chrome.proxy API เพื่อจัดการการตั้งค่าพร็อกซีของ Chrome API นี้ใช้โปรโตไทป์ ChromeSetting ของประเภท API เพื่อรับและตั้งค่าการกำหนดค่าพร็อกซี

readingList

Chrome 120 ขึ้นไป MV3 ขึ้นไป

ใช้ chrome.readingList API เพื่ออ่านและแก้ไขรายการในเรื่องรออ่าน

runtime

ใช้ chrome.runtime API เพื่อดึงข้อมูล Service Worker, แสดงรายละเอียดเกี่ยวกับไฟล์ Manifest และคอยฟังและตอบสนองต่อเหตุการณ์ในวงจรชีวิตของส่วนขยาย นอกจากนี้ คุณยังใช้ API นี้เพื่อแปลงเส้นทางสัมพัทธ์ของ URL เป็น URL ที่มีคุณสมบัติครบถ้วนได้ด้วย

scripting

Chrome 88 ขึ้นไป MV3 ขึ้นไป

ใช้ chrome.scripting API เพื่อเรียกใช้สคริปต์ในบริบทต่างๆ

search

Chrome 87 ขึ้นไป

ใช้ chrome.search API เพื่อค้นหาผ่านผู้ให้บริการเริ่มต้น

sessions

ใช้ chrome.sessions API เพื่อค้นหาและกู้คืนแท็บและหน้าต่างจากเซสชันการท่องเว็บ

sidePanel

Chrome 114 ขึ้นไป MV3 ขึ้นไป

ใช้ chrome.sidePanel API เพื่อโฮสต์เนื้อหาในแผงด้านข้างของเบราว์เซอร์ควบคู่ไปกับเนื้อหาหลักของหน้าเว็บ

storage

ใช้ chrome.storage API เพื่อจัดเก็บ เรียกข้อมูล และติดตามการเปลี่ยนแปลงข้อมูลผู้ใช้

system.cpu

ใช้ system.cpu API เพื่อค้นหาข้อมูลเมตาของ CPU

system.display

ใช้ system.display API เพื่อค้นหาข้อมูลเมตาของ Display

system.memory

chrome.system.memory API

system.storage

ใช้ chrome.system.storage API เพื่อค้นหาข้อมูลอุปกรณ์จัดเก็บข้อมูลและรับการแจ้งเตือนเมื่อมีการต่อและถอดอุปกรณ์จัดเก็บข้อมูลแบบถอดออกได้

systemLog

Chrome 125 ขึ้นไป ChromeOS เท่านั้น ต้องมีนโยบาย

ใช้ chrome.systemLog API เพื่อบันทึกบันทึกของระบบ Chrome จากส่วนขยาย

tabCapture

ใช้ chrome.tabCapture API เพื่อโต้ตอบกับสตรีมสื่อของแท็บ

tabGroups

Chrome 89 ขึ้นไป MV3 ขึ้นไป

ใช้ chrome.tabGroups API เพื่อโต้ตอบกับระบบการจัดกลุ่มแท็บของเบราว์เซอร์ คุณสามารถใช้ API นี้เพื่อแก้ไขและจัดเรียงกลุ่มแท็บในเบราว์เซอร์ใหม่ได้ หากต้องการจัดกลุ่มและเลิกจัดกลุ่มแท็บ หรือค้นหาแท็บที่อยู่ในกลุ่ม ให้ใช้ chrome.tabs API

tabs

ใช้ chrome.tabs API เพื่อโต้ตอบกับระบบแท็บของเบราว์เซอร์ คุณสามารถใช้ API นี้เพื่อสร้าง แก้ไข และจัดเรียงแท็บในเบราว์เซอร์ใหม่ได้

topSites

ใช้ chrome.topSites API เพื่อเข้าถึงเว็บไซต์ยอดนิยม (เว็บไซต์ที่มีการเข้าชมมากที่สุด) ที่แสดงในหน้าแท็บใหม่ ซึ่งจะไม่รวมทางลัดที่ผู้ใช้ปรับแต่ง

tts

ใช้ chrome.tts API เพื่อเล่นการอ่านออกเสียงข้อความ (TTS) ที่สังเคราะห์ โปรดดู API ttsEngine ที่เกี่ยวข้อง ซึ่งช่วยให้ส่วนขยายใช้โปรแกรมเสียงพูดได้

ttsEngine

ใช้ chrome.ttsEngine API เพื่อติดตั้งใช้งานเครื่องมือการอ่านออกเสียงข้อความ(TTS) โดยใช้ส่วนขยาย หากส่วนขยายลงทะเบียนโดยใช้ API นี้ ก็จะได้รับการแจ้งเตือนเหตุการณ์ที่มีข้อความที่จะพูดและพารามิเตอร์อื่นๆ เมื่อส่วนขยายหรือแอป Chrome ใช้ tts API เพื่อสร้างเสียงพูด จากนั้นส่วนขยายจะใช้เทคโนโลยีเว็บที่มีอยู่เพื่อสังเคราะห์และแสดงออกเสียง และส่งเหตุการณ์กลับไปยังฟังก์ชันการเรียกเพื่อรายงานสถานะ

types

chrome.types API มีการประกาศประเภทสําหรับ Chrome

userScripts

Chrome 120 ขึ้นไป MV3 ขึ้นไป

ใช้ userScripts API เพื่อเรียกใช้สคริปต์ของผู้ใช้ในบริบทสคริปต์ของผู้ใช้

vpnProvider

Chrome 43 ขึ้นไป ChromeOS เท่านั้น

ใช้ chrome.vpnProvider API เพื่อติดตั้งใช้งานไคลเอ็นต์ VPN

wallpaper

Chrome 43 ขึ้นไป ChromeOS เท่านั้น

ใช้ chrome.wallpaper API เพื่อเปลี่ยนวอลเปเปอร์ ChromeOS

webAuthenticationProxy

Chrome 115 ขึ้นไป MV3 ขึ้นไป

chrome.webAuthenticationProxy API ช่วยให้ซอฟต์แวร์เดสก์ท็อประยะไกลที่ทำงานบนโฮสต์ระยะไกลสามารถขัดจังหวะคำขอ Web Authentication API (WebAuthn) เพื่อจัดการคำขอเหล่านั้นในไคลเอ็นต์ในเครื่อง

webNavigation

ใช้ chrome.webNavigation API เพื่อรับการแจ้งเตือนเกี่ยวกับสถานะคำขอการนำทางระหว่างเที่ยวบิน

webRequest

ใช้ chrome.webRequest API เพื่อสังเกตและวิเคราะห์การเข้าชม รวมถึงสกัดกั้น บล็อก หรือแก้ไขคำขอระหว่างการส่ง

windows

ใช้ chrome.windows API เพื่อโต้ตอบกับหน้าต่างเบราว์เซอร์ คุณสามารถใช้ API นี้เพื่อสร้าง แก้ไข และจัดเรียงหน้าต่างในเบราว์เซอร์ได้