הפניית API

כדי לפעול, רוב התוספים צריכים גישה לממשק API אחד או יותר של תוספים ל-Chrome. במאמרי העזרה האלה של ה-API מתוארים ממשקי ה-API שאפשר להשתמש בהם בתוספים, ומוצגים תרחישים לדוגמה.

החל מגרסה 148 של Chrome, ממשקי ה-API האלה זמינים גם במרחב השמות browser כחלופה ל-chrome בדפדפנים שונים. במאמר מרחב השמות של הדפדפן מוסבר איך להטמיע את התכונה.

תכונות נפוצות של Extensions API

Extensions API מורכב ממרחב שמות שמכיל שיטות ומאפיינים לביצוע פעולות של תוספים, ובדרך כלל, אבל לא תמיד, שדות מניפסט לקובץ manifest.json. לדוגמה, מרחב השמות browser.action דורש אובייקט "action" במניפסט. בנוסף, ממשקי API רבים דורשים הרשאות במניפסט.

ה-methods בממשקי ה-API של התוספים הן אסינכרוניות, אלא אם צוין אחרת. שיטות אסינכרוניות מחזירות תשובה באופן מיידי, בלי לחכות שהפעולה שקוראת להן תסתיים. כדי לקבל את התוצאות של השיטות האסינכרוניות האלה, צריך להשתמש בהבטחות.

ממשקי API של תוספים ל-Chrome

accessibilityFeatures

אפשר להשתמש ב-API של chrome.accessibilityFeatures כדי לנהל את תכונות הנגישות של Chrome. ה-API הזה מסתמך על אב הטיפוס ChromeSetting של ה-API מסוג type כדי לקבל ולהגדיר תכונות נגישות ספציפיות. כדי לקבל את מצבי התכונה ב-Fleet כולו, התוסף צריך לבקש את ההרשאה accessibilityFeatures.read. כדי לשנות את מצב התכונה ב-Fleet כולו, התוסף צריך את ההרשאה accessibilityFeatures.modify. חשוב לזכור שההרשאה accessibilityFeatures.modify לא כוללת את ההרשאה accessibilityFeatures.read.

action
‫Chrome 88 ואילך ‫browser.* ‎ מגרסה Chrome 148 ‫MV3 ואילך

אפשר להשתמש ב-API של chrome.action כדי לשלוט בסמל של התוסף בסרגל הכלים של Google Chrome.

alarms

משתמשים ב-API של chrome.alarms כדי לתזמן קוד להפעלה מדי פעם או בזמן מסוים בעתיד.

אודיו
‫Chrome מגרסה 59 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫ChromeOS בלבד

‫API של chrome.audio מאפשר למשתמשים לקבל מידע על מכשירי האודיו שמחוברים למערכת ולשלוט בהם. ה-API הזה זמין כרגע רק במצב קיוסק ב-ChromeOS.

סימניות

אפשר להשתמש ב-API של chrome.bookmarks כדי ליצור סימניות, לארגן אותן ולבצע בהן פעולות אחרות. כדאי גם לעיין בקטע דפי שינוי ברירת המחדל, שבו אפשר להשתמש כדי ליצור דף מותאם אישית של מנהל הסימניות.

browsingData

אפשר להשתמש ב-API של chrome.browsingData כדי להסיר נתוני גלישה מהפרופיל המקומי של המשתמש.

certificateProvider
‫Chrome 46 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫ChromeOS בלבד

אפשר להשתמש ב-API הזה כדי לחשוף אישורים לפלטפורמה, שיכולה להשתמש בהם לאימותי TLS.

commands

אפשר להשתמש ב-API של הפקודות כדי להוסיף מקשי קיצור שמפעילים פעולות בתוסף, למשל פעולה לפתיחת פעולת הדפדפן או לשליחת פקודה לתוסף.

contentSettings

אפשר להשתמש ב-API של chrome.contentSettings כדי לשנות הגדרות שקובעות אם אתרים יכולים להשתמש בתכונות כמו קובצי Cookie, ‏JavaScript ויישומי פלאגין. באופן כללי יותר, הגדרות התוכן מאפשרות לכם להתאים אישית את ההתנהגות של Chrome בכל אתר בנפרד, במקום באופן גלובלי.

contextMenus

אפשר להשתמש ב-API של chrome.contextMenus כדי להוסיף פריטים לתפריט ההקשר של Google Chrome. אתם יכולים לבחור לאילו סוגי אובייקטים יחולו התוספות לתפריט ההקשר, כמו תמונות, היפר-קישורים ודפים.

קובצי Cookie

אפשר להשתמש ב-API של chrome.cookies כדי לשלוח שאילתות לגבי קובצי Cookie ולשנות אותם, ולקבל התראות כשהם משתנים.

כלי לניפוי באגים

‫chrome.debugger API משמש כהעברה חלופית לפרוטוקול ניפוי הבאגים מרחוק של Chrome. אפשר להשתמש ב-chrome.debugger כדי לצרף לכרטיסייה אחת או יותר כדי למדוד אינטראקציה ברשת, לנפות באגים ב-JavaScript, לשנות את ה-DOM וה-CSS ועוד. משתמשים במאפיין Debuggee tabId כדי לטרגט כרטיסיות באמצעות sendCommand ולנתב אירועים לפי tabId מהקריאות החוזרות (callbacks) של onEvent.

declarativeContent

אפשר להשתמש ב-API של chrome.declarativeContent כדי לבצע פעולות בהתאם לתוכן של דף, בלי לבקש הרשאה לקרוא את התוכן של הדף.

declarativeNetRequest
‫Chrome 84 ואילך ‫browser.* ‎ מגרסת Chrome 148

‫chrome.declarativeNetRequest API משמש לחסימה או לשינוי של בקשות לאחזור מהרשת על ידי ציון כללים הצהרתיים. כך התוספים יכולים לשנות בקשות לאחזור מהרשת בלי ליירט אותן ולראות את התוכן שלהן, וכך לשמור על פרטיות המשתמשים.

desktopCapture

‫Desktop Capture API מצלם את התוכן של המסך, חלונות ספציפיים או כרטיסיות ספציפיות.

devtools.inspectedWindow

משתמשים ב-API של chrome.devtools.inspectedWindow כדי לקיים אינטראקציה עם החלון שנבדק: מקבלים את מזהה הכרטיסייה של הדף שנבדק, מעריכים את הקוד בהקשר של החלון שנבדק, טוענים מחדש את הדף או מקבלים את רשימת המשאבים בדף.

devtools.network

אפשר להשתמש ב-API של chrome.devtools.network כדי לאחזר את המידע על בקשות לאחזור מהרשת שמוצגות על ידי הכלים למפתחים בחלונית "רשת".

devtools.panels

משתמשים ב-API של chrome.devtools.panels כדי לשלב את התוסף בממשק המשתמש של חלון הכלים למפתחים: יוצרים חלוניות משלכם, ניגשים לחלוניות קיימות ומוסיפים סרגלי צד.

devtools.performance
‫Chrome 129 ואילך ‫browser.* ‎ מגרסת Chrome 152

משתמשים ב-API של chrome.devtools.performance כדי להאזין לעדכונים של סטטוס ההקלטה בחלונית Performance בכלי הפיתוח.

devtools.recorder
‫Chrome 105 ואילך browser.* ‎ מ-Chrome 152 ואילך

משתמשים ב-API ‏chrome.devtools.recorder כדי להתאים אישית את החלונית Recorder בכלי הפיתוח.

dns
ערוץ Dev

משתמשים ב-API של chrome.dns לפענוח DNS.

documentScan
Chrome 44 ואילך browser.* ‎ מגרסה 148 של Chrome ChromeOS בלבד

אפשר להשתמש ב-API של chrome.documentScan כדי למצוא ולאחזר תמונות מסורקי מסמכים מחוברים.

dom
‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

שימוש ב-API של chrome.dom כדי לגשת לממשקי API מיוחדים של DOM לתוספים

הורדות

אפשר להשתמש ב-API של chrome.downloads כדי להתחיל, לעקוב, לשנות ולחפש הורדות באופן פרוגרמטי.

enterprise.deviceAttributes
‫Chrome 46 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫ChromeOS בלבד נדרשת מדיניות

משתמשים ב-API של chrome.enterprise.deviceAttributes כדי לקרוא את מאפייני המכשיר. הערה: ה-API הזה זמין רק לתוספים שהותקנו באופן מחייב על ידי המדיניות הארגונית.

enterprise.hardwarePlatform
‫Chrome מגרסה 71 ואילך ‫browser.* ‎ מגרסה 148 של Chrome נדרשת מדיניות

אפשר להשתמש ב-API‏ chrome.enterprise.hardwarePlatform כדי לקבל את היצרן והדגם של פלטפורמת החומרה שבה הדפדפן פועל. הערה: ה-API הזה זמין רק לתוספים שהותקנו על ידי המדיניות הארגונית.

enterprise.login
‫Chrome מגרסה 139 ואילך ‫browser.* ‎ מגרסת Chrome 148 ‫ChromeOS בלבד נדרשת מדיניות

משתמשים ב-API של chrome.enterprise.login כדי לצאת מסשנים מנוהלים של גלישה כאורח. הערה: ה-API הזה זמין רק לתוספים שהותקנו על ידי מדיניות ארגונית בגלישה מנוהלת כאורחים ב-ChromeOS.

enterprise.networkingAttributes
‫Chrome 85 ואילך browser.* ‎ מגרסה 148 של Chrome ChromeOS בלבד נדרשת מדיניות

משתמשים ב-API של chrome.enterprise.networkingAttributes כדי לקרוא מידע על הרשת הנוכחית. הערה: ה-API הזה זמין רק לתוספים שהותקנו באופן מחייב על ידי המדיניות הארגונית.

enterprise.platformKeys
ChromeOS בלבד נדרשת מדיניות

משתמשים ב-API של chrome.enterprise.platformKeys כדי ליצור מפתחות ולהתקין אישורים למפתחות האלה. האישורים ינוהלו על ידי הפלטפורמה וניתן יהיה להשתמש בהם לאימות TLS, לגישה לרשת או באמצעות תוסף אחר דרך chrome.platformKeys.

אירועים

מרחב השמות chrome.events מכיל סוגים נפוצים שמשמשים ממשקי API ששולחים אירועים כדי להודיע לכם כשמשהו מעניין קורה.

תוסף

ב-API של chrome.extension יש כלי שירות שאפשר להשתמש בהם בכל דף של תוסף. הוא כולל תמיכה בהחלפת הודעות בין תוסף לבין הסקריפטים של התוכן שלו או בין תוספים, כפי שמתואר בפירוט במאמר העברת הודעות.

extensionTypes

‫chrome.extensionTypes API מכיל הצהרות על סוגים של תוספים ל-Chrome.

fileBrowserHandler
ChromeOS בלבד חזית בלבד

אפשר להשתמש ב-API של chrome.fileBrowserHandler כדי להרחיב את דפדפן הקבצים של ChromeOS. לדוגמה, אתם יכולים להשתמש ב-API הזה כדי לאפשר למשתמשים להעלות קבצים לאתר שלכם.

fileSystemProvider
ChromeOS בלבד

אפשר להשתמש ב-API של chrome.fileSystemProvider כדי ליצור מערכות קבצים שאפשר לגשת אליהן ממנהל הקבצים ב-ChromeOS.

fontSettings

אפשר להשתמש ב-API של chrome.fontSettings כדי לנהל את הגדרות הגופנים ב-Chrome.

gcm

אפשר להשתמש ב-chrome.gcm כדי לאפשר לאפליקציות ולתוספים לשלוח ולקבל הודעות דרך העברת הודעות בענן ב-Firebase ‏(FCM).

היסטוריה

משתמשים ב-API של chrome.history כדי לבצע פעולות ברשומת הדפים שהמשתמשים ביקרו בהם בדפדפן. אתם יכולים להוסיף, להסיר ולשאול לגבי כתובות URL בהיסטוריה של הדפדפן. כדי לשנות את דף ההיסטוריה לגרסה משלכם, עיינו במאמר שינוי דפים.

i18n

משתמשים בתשתית של chrome.i18n כדי להטמיע התאמה לשוק הבינלאומי בכל האפליקציה או התוסף.

זהות

משתמשים ב-API של chrome.identity כדי לקבל טוקני גישה מסוג OAuth2.

idle

אפשר להשתמש ב-API של chrome.idle כדי לזהות מתי מצב חוסר הפעילות של המכונה משתנה.

input.ime
ChromeOS בלבד

משתמשים ב-API של chrome.input.ime כדי להטמיע IME בהתאמה אישית ל-ChromeOS. כך התוסף יכול לטפל בהקשות, להגדיר את הקומפוזיציה ולנהל את חלון המועמדים.

instanceID
Chrome 44 ואילך browser.* ‎ מ-Chrome 148

משתמשים ב-chrome.instanceID כדי לגשת לשירות Instance ID.

loginState
‫Chrome 78 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫ChromeOS בלבד

משתמשים ב-API של chrome.loginState כדי לקרוא את מצב ההתחברות ולעקוב אחריו.

סרטונים

‫chrome.management API מספק דרכים לנהל אפליקציות ותוספים מותקנים.

mimeHandler
‫Chrome מגרסה 151 ואילך

משתמשים ב-API של chrome.mimeHandler כדי לטפל בסטרימינג של סוגי MIME בתוספים של צד שלישי.

התראות

אפשר להשתמש ב-API של chrome.notifications כדי ליצור התראות עשירות באמצעות תבניות ולהציג את ההתראות האלה למשתמשים במגש המערכת.

offscreen
‫Chrome 109 ואילך ‫browser.* ‎ מגרסה Chrome 148 ‫MV3 ואילך

משתמשים ב-API של offscreen כדי ליצור ולנהל מסמכים מחוץ למסך.

omnibox

‫omnibox API מאפשר לכם לרשום מילת מפתח בסרגל הכתובות של Google Chrome, שנקרא גם סרגל הכתובות המשולב.

pageCapture

משתמשים ב-API של chrome.pageCapture כדי לשמור כרטיסייה כ-MHTML.

הרשאות

משתמשים ב-API של chrome.permissions כדי לבקש הרשאות אופציונליות שהוצהרו בזמן הריצה ולא בזמן ההתקנה, כדי שהמשתמשים יבינו למה ההרשאות נחוצות ויתנו רק את ההרשאות שצריך.

platformKeys
Chrome 45 ואילך browser.* ‎ החל מ-Chrome 148 ChromeOS בלבד

משתמשים ב-API של chrome.platformKeys כדי לגשת לאישורי לקוח שמנוהלים על ידי הפלטפורמה. אם המשתמש או המדיניות מעניקים את ההרשאה, תוסף יכול להשתמש באישור כזה בפרוטוקול האימות המותאם אישית שלו. לדוגמה, המדיניות הזו מאפשרת שימוש באישורים שמנוהלים על ידי הפלטפורמה ברשתות VPN של צד שלישי (ראו chrome.vpnProvider).

power

משתמשים ב-API של chrome.power כדי לשנות את התכונות של ניהול צריכת החשמל במערכת.

printerProvider
Chrome 44 ואילך browser.* ‎ מ-Chrome 148

‫chrome.printerProvider API חושף אירועים שמשמשים את מנהל ההדפסה כדי לשלוח שאילתות למדפסות שנשלטות על ידי תוספים, כדי לשלוח שאילתות לגבי היכולות שלהן וכדי לשלוח משימות הדפסה למדפסות האלה.

הדפסה
‫Chrome 81 ואילך ‫browser.* ‎ החל מגרסה 148 של Chrome ChromeOS בלבד

אפשר להשתמש ב-API של chrome.printing כדי לשלוח משימות הדפסה למדפסות שמותקנות ב-Chromebook.

printingMetrics
‫Chrome מגרסה 79 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫ChromeOS בלבד נדרשת מדיניות

משתמשים ב-API של chrome.printingMetrics כדי לאחזר נתונים על השימוש בהדפסה.

פרטיות

אפשר להשתמש ב-API של chrome.privacy כדי לשלוט בשימוש בתכונות ב-Chrome שיכולות להשפיע על פרטיות המשתמשים. ה-API הזה מסתמך על אב הטיפוס ChromeSetting של ה-API מסוג type כדי לקבל ולהגדיר את ההגדרות של Chrome.

תהליכים
ערוץ Dev

משתמשים ב-API של chrome.processes כדי לבצע פעולות בתהליכים של הדפדפן.

proxy

אפשר להשתמש ב-API של chrome.proxy כדי לנהל את ההגדרות לשרת proxy של Chrome. ה-API הזה מסתמך על אב הטיפוס ChromeSetting של ה-API מסוג API כדי לקבל ולהגדיר את הגדרות שרת ה-proxy.

publicSuffix
‫Chrome מגרסה 153 ואילך

משתמשים ב-API של chrome.publicSuffix כדי לשלוח שאילתה לרשימת הסיומות הציבוריות (PSL) של הדפדפן.

readingList
‫Chrome 120 ואילך ‫browser.* ‎ מגרסה Chrome 148 ‫MV3 ואילך

משתמשים ב-API של chrome.readingList כדי לקרוא ולשנות את הפריטים ברשימת הקריאה.

runtime

משתמשים ב-API של chrome.runtime כדי לאחזר את ה-Service Worker, להחזיר פרטים על המניפסט, להאזין לאירועים במחזור החיים של התוסף ולהגיב להם. אפשר גם להשתמש ב-API הזה כדי להמיר את הנתיב היחסי של כתובות URL לכתובות URL מוגדרות במלואן.

scripting
‫Chrome 88 ואילך ‫browser.* ‎ מגרסה Chrome 148 ‫MV3 ואילך

משתמשים ב-API של chrome.scripting כדי להריץ סקריפט בהקשרים שונים.

search
‫Chrome 87 ואילך ‫‎browser.* ‎ מגרסה 148 של Chrome

משתמשים ב-API של chrome.search כדי לחפש באמצעות ספק ברירת המחדל.

סשנים

משתמשים ב-API של chrome.sessions כדי לשלוח שאילתות ולשחזר כרטיסיות וחלונות מסשן גלישה.

sidePanel
‫Chrome 114 ואילך ‫browser.* ‎ מגרסה Chrome 148 ‫MV3 ואילך

משתמשים ב-API של chrome.sidePanel כדי לארח תוכן בחלונית הצדדית של הדפדפן לצד התוכן הראשי של דף אינטרנט.

storage

אפשר להשתמש ב-API של chrome.storage כדי לאחסן, לאחזר ולעקוב אחרי שינויים בנתוני המשתמשים.

system.cpu

משתמשים ב-API של system.cpu כדי לשלוח שאילתות על המטא-נתונים של המעבד (CPU).

system.display

משתמשים ב-API של system.display כדי לשלוח שאילתות לגבי המטא-נתונים המוצגים.

system.memory

‫chrome.system.memory API.

system.storage

אפשר להשתמש ב-API של chrome.system.storage כדי לשלוח שאילתות לגבי מידע על התקן האחסון ולקבל התראה כשמחובר או מנותק התקן אחסון נשלף.

systemLog
‫Chrome 125 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫ChromeOS בלבד נדרשת מדיניות

משתמשים ב-API של chrome.systemLog כדי לתעד את יומני המערכת של Chrome מתוספים.

tabCapture

משתמשים ב-API של chrome.tabCapture כדי לקיים אינטראקציה עם סטרימינג של מדיה בכרטיסיות.

tabGroups
‫Chrome 89 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫MV3 ואילך

אפשר להשתמש ב-API של chrome.tabGroups כדי לבצע פעולות במערכת של קיבוץ הכרטיסיות בדפדפן. אתם יכולים להשתמש ב-API הזה כדי לשנות ולסדר מחדש קבוצות של כרטיסיות בדפדפן. כדי לקבץ כרטיסיות ולבטל את הקיבוץ שלהן, או כדי לשלוח שאילתה לגבי הכרטיסיות שנמצאות בקבוצות, משתמשים ב-API של chrome.tabs.

כרטיסיות

משתמשים ב-API של chrome.tabs כדי לבצע פעולות במערכת הכרטיסיות של הדפדפן. אתם יכולים להשתמש ב-API הזה כדי ליצור, לשנות ולסדר מחדש כרטיסיות בדפדפן.

topSites

משתמשים ב-API של chrome.topSites כדי לגשת לאתרים המובילים (כלומר, האתרים שבהם מבקרים הכי הרבה) שמוצגים בדף הכרטיסייה החדשה. הם לא כוללים קיצורי דרך שהמשתמש התאים אישית.

tts

משתמשים ב-API של chrome.tts כדי להפעיל המרת טקסט לדיבור (TTS) מסונתזת. כדאי גם לעיין ב-API הקשור ttsEngine, שמאפשר לתוסף להטמיע מנוע דיבור.

ttsEngine

משתמשים ב-API של chrome.ttsEngine כדי להטמיע מנוע המרת טקסט לדיבור(TTS) באמצעות תוסף. אם התוסף שלכם נרשם באמצעות ה-API הזה, הוא יקבל אירועים שמכילים ביטוי להקראה ופרמטרים אחרים כשתוסף או אפליקציית Chrome כלשהם משתמשים ב-API ‏tts כדי ליצור דיבור. לאחר מכן, התוסף יכול להשתמש בכל טכנולוגיית אינטרנט זמינה כדי לסנתז את הדיבור ולהפיק אותו, ולשלוח אירועים בחזרה לפונקציה שביצעה את הקריאה כדי לדווח על הסטטוס.

types

ה-API של chrome.types מכיל הצהרות על סוגים ל-Chrome.

userScripts
‫Chrome 120 ואילך ‫browser.* ‎ מגרסה Chrome 148 ‫MV3 ואילך

משתמשים ב-API של userScripts כדי להריץ סקריפטים של משתמשים בהקשר של סקריפטים של משתמשים.

vpnProvider
‫Chrome 43 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫ChromeOS בלבד

משתמשים ב-API של chrome.vpnProvider כדי להטמיע לקוח VPN.

טפט
‫Chrome 43 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫ChromeOS בלבד

משתמשים ב-API של chrome.wallpaper כדי לשנות את הטפט ב-ChromeOS.

webAuthenticationProxy
‫Chrome 115 ואילך browser.* ‎ מגרסה Chrome 148 MV3 ואילך

‫chrome.webAuthenticationProxy API מאפשר לתוכנת שולחן עבודה מרוחק שפועלת במארח מרוחק ליירט בקשות של Web Authentication API ‏ (WebAuthn) כדי לטפל בהן בלקוח מקומי.

webNavigation

אפשר להשתמש ב-API של chrome.webNavigation כדי לקבל התראות על הסטטוס של בקשות ניווט בזמן אמת.

webRequest

אפשר להשתמש ב-API של chrome.webRequest כדי לצפות בתנועה ולנתח אותה, וגם כדי ליירט, לחסום או לשנות בקשות תוך כדי תנועה.

windows

משתמשים ב-API של chrome.windows כדי לבצע פעולות בחלונות של הדפדפן. אתם יכולים להשתמש ב-API הזה כדי ליצור, לשנות ולסדר מחדש חלונות בדפדפן.