การอ้างอิง API

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

accessibilityFeatures

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

นาฬิกาปลุก

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

เสียง
Chrome 59 ขึ้นไป ChromeOS เท่านั้น

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

บุ๊กมาร์ก

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

browserAction
≤ MV2

ใช้การทำงานของเบราว์เซอร์เพื่อใส่ไอคอนในแถบเครื่องมือหลักของ Google Chrome ทางด้านขวาของแถบที่อยู่ นอกจากไอคอนแล้ว การดำเนินการของเบราว์เซอร์อาจมีเคล็ดลับเครื่องมือ ป้าย และป๊อปอัปด้วย

browsingData

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

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

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

คำสั่ง

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

contentSettings

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

contextMenus

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

คุกกี้

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

โปรแกรมแก้ไขข้อบกพร่อง

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

declarativeContent

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

declarativeNetRequest
Chrome เวอร์ชัน 84 ขึ้นไป

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

declarativeWebRequest
เวอร์ชันเบต้า ≤ MV2

หมายเหตุ: API นี้เลิกใช้งานแล้ว ลองใช้ declarativeNetRequest API แทน ใช้ chrome.declarativeWebRequest API เพื่อสกัดกั้น บล็อก หรือแก้ไขคำขอที่อยู่ระหว่างดำเนินการ มีความรวดเร็วกว่า chrome.webRequest API อย่างมากเนื่องจากคุณสามารถลงทะเบียนกฎที่ได้รับการประเมินในเบราว์เซอร์แทนเครื่องมือ JavaScript ซึ่งจะลดเวลาในการตอบสนองไป-กลับและทำให้มีประสิทธิภาพสูงขึ้น

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.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 พิเศษสำหรับส่วนขยาย

ดาวน์โหลด

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

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

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

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

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

enterprise.networkingAttributes
Chrome เวอร์ชัน 85 ขึ้นไป ChromeOS เท่านั้น ต้องมีนโยบาย

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

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

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

กิจกรรม

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

ส่วนขยาย

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

extensionTypes

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

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

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

fileSystemProvider
ChromeOS เท่านั้น

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

fontSettings

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

gcm

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

ประวัติ

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

i18n

ใช้โครงสร้างพื้นฐาน chrome.i18n เพื่อปรับใช้การปรับให้เป็นสากลทั่วทั้งแอปหรือส่วนขยาย

ตัวตน

ใช้ 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 ให้วิธีจัดการแอปและส่วนขยายที่ติดตั้งไว้

การแจ้งเตือน

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

แถบอเนกประสงค์

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

pageAction
≤ MV2

ใช้ chrome.pageAction API เพื่อวางไอคอนในแถบเครื่องมือหลักของ Google Chrome ทางด้านขวาของแถบที่อยู่ การทำงานของหน้าเว็บแสดงถึงการกระทำที่ทำได้ในหน้าปัจจุบัน แต่ใช้ไม่ได้กับหน้าเว็บทั้งหมด การดำเนินการของหน้าเว็บจะปรากฏเป็นสีเทาเมื่อไม่มีการใช้งาน

pageCapture

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

สิทธิ์

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

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

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

พาวเวอร์

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

printerProvider
Chrome 44 ขึ้นไป

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

การพิมพ์
Chrome 81 ขึ้นไป ChromeOS เท่านั้น

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

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

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

ความเป็นส่วนตัว

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

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

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

พร็อกซี

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

รันไทม์

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

search
Chrome เวอร์ชัน 87 ขึ้นไป

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

เซสชัน

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

พื้นที่เก็บข้อมูล

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

system.cpu

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

system.display

ใช้ system.display API เพื่อค้นหาข้อมูลเมตาที่แสดงผล

system.memory

API ของ chrome.system.memory

system.storage

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

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

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

tabCapture

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

แท็บ

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

topSites

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

tts

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

ttsEngine

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

ประเภท

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

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

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

วอลเปเปอร์
Chrome 43 ขึ้นไป ChromeOS เท่านั้น

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

webNavigation

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

webRequest

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

หน้าต่าง

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