כדי לפעול, רוב התוספים זקוקים לגישה לממשק API אחד או יותר לתוספים ל-Chrome. הפניית ה-API הזו מתארת את ממשקי ה-API הזמינים. לשימוש בתוספים, ומציג תרחישים לדוגמה.
תכונות נפוצות של ממשק API לתוספים
ממשק API של תוספים מורכב ממרחב שמות שמכיל שיטות ומאפיינים לביצוע פעולות התוספים. בדרך כלל, אבל לא
תמיד, שדות מניפסט של הקובץ manifest.json
. לדוגמה, למרחב השמות chrome.action
נדרש אובייקט "action"
במניפסט. בהרבה ממשקי API נדרשים גם הרשאות במניפסט.
השיטות בממשקי ה-API של התוספים הן אסינכרוניות, אלא אם צוין אחרת. שיטות אסינכרוניות חוזרות באופן מיידי, בלי להמתין לפעולה שקוראת להם לסיים. משתמשים בהבטחות כדי להשיג את התוצאות של השיטות האלה. מידע נוסף זמין במאמר שיטות אסינכרוניות.
ממשקי API של תוספים ל-Chrome
- accessibilityFeatures
-
צריך להשתמש ב-API
chrome.accessibilityFeatures
כדי לנהל את תכונות הנגישות של Chrome. ה-API הזה מסתמך על אב הטיפוס ChromeSetting של סוג API כדי לקבל ולהגדיר תכונות נגישות נפרדות. כדי לקבל מצבי תכונות, התוסף צריך לבקש הרשאתaccessibilityFeatures.read
. כדי לשנות את מצב התכונה, לתוסף נדרשת ההרשאהaccessibilityFeatures.modify
. לתשומת ליבך,accessibilityFeatures.modify
לא מרמז על הרשאהaccessibilityFeatures.read
. - פעולה
-
Chrome מגרסה 88 ואילך MV3+
אפשר להשתמש ב-API
chrome.action
כדי לשלוט בסמל התוסף בסרגל הכלים של Google Chrome. - התראות
-
אפשר להשתמש ב-API של
chrome.alarms
כדי לתזמן קוד כך שירוץ מדי פעם או בתאריך מוגדר בעתיד. - אודיו
-
Chrome 59+ ChromeOS בלבד
ממשק ה-API של
chrome.audio
ניתן כדי לאפשר למשתמשים לקבל מידע על התקני האודיו המחוברים למערכת ולשלוט בהם. ה-API הזה זמין כרגע רק במצב קיוסק ל-ChromeOS. - סימניות
-
שימוש ב-API
chrome.bookmarks
כדי ליצור סימניות, לארגן אותן ולבצע בהן שינויים בדרכים אחרות. ראו גם את המאמר שינוי דפים, שבו ניתן להשתמש כדי ליצור דף מותאם אישית של 'מנהל הסימניות'. - browsingData
-
כדי להסיר נתוני גלישה מהפרופיל המקומי של משתמש, משתמשים ב-API של
chrome.browsingData
. - certificateProvider
-
Chrome 46 ואילך ChromeOS בלבד
צריך להשתמש ב-API הזה כדי לחשוף אישורים לפלטפורמה, שיכולה להשתמש באישורים האלה לאימותי TLS.
- פקודות
-
אתם יכולים להשתמש ב-API של הפקודות כדי להוסיף מקשי קיצור שמפעילים פעולות בתוסף. לדוגמה, פעולה לפתיחת הפעולה בדפדפן או שליחת פקודה לתוסף.
- contentSettings
-
צריך להשתמש ב-API
chrome.contentSettings
כדי לשנות הגדרות שקובעות אם אתרים יכולים להשתמש בתכונות כמו קובצי cookie, JavaScript ויישומי פלאגין. באופן כללי, הגדרות התוכן מאפשרות להתאים אישית את התנהגות Chrome על בסיס אתר מסוים במקום על בסיס גלובלי. - contextMenus
-
אפשר להשתמש ב-API
chrome.contextMenus
כדי להוסיף פריטים לתפריט ההקשר של Google Chrome. אתם יכולים לבחור את סוגי האובייקטים שעליהם יחולו התוספות של תפריט ההקשר, כמו תמונות, היפר-קישורים ודפים. - קובצי Cookie
-
אפשר להשתמש ב-API של
chrome.cookies
כדי לשלוח שאילתות לגבי קובצי cookie ולשנות אותם, וכדי לקבל הודעה כשהם משתנים. - כלי לניפוי באגים
-
ה-API של
chrome.debugger
משמש כהעברה חלופית של הפרוטוקול לניפוי באגים מרחוק של Chrome. אפשר להשתמש ב-chrome.debugger
כדי לצרף כרטיסייה אחת או יותר כדי לסייע באינטראקציה ברשת, לנפות באגים ב-JavaScript, לשנות את ה-DOM וה-CSS ועוד. אפשר להשתמש בנכסDebuggee
tabId
כדי לטרגט כרטיסיות עםsendCommand
ולנתב אירועים לפיtabId
מקריאות חוזרות (callback) שלonEvent
. - declarativeContent
-
אפשר להשתמש ב-API
chrome.declarativeContent
כדי לבצע פעולות בהתאם לתוכן בדף, בלי לבקש הרשאה לקרוא את תוכן הדף. - declarativeNetRequest
-
Chrome 84 ואילך
ה-API
chrome.declarativeNetRequest
משמש לחסימה או לשינוי של בקשות רשת על ידי ציון כללים הצהרתיים. כך התוספים יכולים לשנות את בקשות הרשת בלי ליירט אותן ולצפות בתוכן שלהם, וכך לשפר את הפרטיות. - desktopCapture
-
ממשק ה-API של צילום מסך מצלם את התוכן של המסך, של חלונות מסוימים או של כרטיסיות בודדות.
- devtools.inspectedWindow
-
משתמשים ב-API
chrome.devtools.inspectedWindow
כדי לבצע פעולות בחלון הנבדק: משיגים את מזהה הכרטיסייה של הדף שנבדק, מעריכים את הקוד בהקשר של החלון שנבדק, טוענים מחדש את הדף או משיגים את רשימת המשאבים בדף. - devtools.network
-
צריך להשתמש ב-API
chrome.devtools.network
כדי לאחזר את המידע על בקשות רשת שמוצגות על ידי הכלים למפתחים בחלונית הרשת. - devtools.panels
-
אפשר להשתמש ב-API של
chrome.devtools.panels
כדי לשלב את התוסף בממשק המשתמש של החלון של הכלים למפתחים: ליצור לוחות משלכם, לגשת ללוחות קיימים ולהוסיף סרגלי צד. - devtools.performance
-
בהמתנה
אפשר להשתמש ב-API
chrome.devtools.performance
כדי להאזין לעדכונים של סטטוס ההקלטה בחלונית הביצועים בכלי הפיתוח. - devtools.recorder
-
Chrome 105+
כדי להתאים אישית את חלונית מכשיר ההקלטה בכלי הפיתוח, צריך להשתמש ב-API
chrome.devtools.recorder
. - dns
-
ערוץ פיתוח
צריך להשתמש ב-API
chrome.dns
לרזולוציית DNS. - documentScan
-
Chrome 44 ואילך ChromeOS בלבד
אפשר להשתמש ב-API של
chrome.documentScan
כדי לאתר ולאחזר תמונות מסורקי מסמכים מצורפים. - הרפובליקה
-
Chrome מגרסה 88 ואילך
להשתמש ב-API
chrome.dom
כדי לגשת לממשקי DOM API מיוחדים לתוספים - הורדות
-
שימוש ב-API של
chrome.downloads
כדי להפעיל הורדות, לעקוב אחריהן, לשנות אותן ולחפש אותן באופן פרוגרמטי. - enterprise.deviceAttributes
-
צריך להשתמש ב-API
chrome.enterprise.deviceAttributes
כדי לקרוא את מאפייני המכשיר. הערה: ה-API הזה זמין רק לתוספים שמותקנים לפי הגדרת האדמין בהתאם למדיניות הארגון. - enterprise.hardwarePlatform
-
Chrome מגרסה 71 ואילך נדרשת מדיניות
צריך להשתמש ב-API
chrome.enterprise.hardwarePlatform
כדי לקבל את היצרן והדגם של פלטפורמת החומרה שבה הדפדפן פועל. הערה: ה-API הזה זמין רק לתוספים שמותקנים בהתאם למדיניות הארגון. - enterprise.networkingAttributes
-
צריך להשתמש ב-API
chrome.enterprise.networkingAttributes
כדי לקרוא מידע על הרשת הנוכחית. הערה: ה-API הזה זמין רק לתוספים שמותקנים לפי הגדרת האדמין בהתאם למדיניות הארגון. - enterprise.platformKeys
-
ChromeOS בלבד נדרשת מדיניות
אפשר להשתמש ב-API
chrome.enterprise.platformKeys
כדי ליצור מפתחות ולהתקין אישורים למפתחות האלה. האישורים ינוהלו על ידי הפלטפורמה ואפשר יהיה להשתמש בהם לצורך אימות TLS, גישה לרשת או תוסף אחר באמצעות chrome.platformKeys. - אירועים
-
מרחב השמות
chrome.events
מכיל סוגים נפוצים של ממשקי API ששולחים אירועים כדי ליידע אותך על משהו מעניין. - תוסף
-
ב-API של
chrome.extension
יש כלי עזר שאפשר להשתמש בהם בכל דף תוסף. היא כוללת תמיכה בהעברת הודעות בין תוסף לבין הסקריפטים של התוכן שלו או בין תוספים, כפי שמתואר בפירוט במאמר העברת הודעות. - extensionTypes
-
ה-API
chrome.extensionTypes
מכיל הצהרות סוגים לתוספים ל-Chrome. - fileBrowserHandler
-
ChromeOS בלבד חזית בלבד
שימוש ב-API
chrome.fileBrowserHandler
כדי להרחיב את דפדפן הקבצים ב-Chrome OS. לדוגמה, תוכלו להשתמש בממשק ה-API הזה כדי לאפשר למשתמשים להעלות קבצים לאתר שלכם. - fileSystemProvider
-
ChromeOS בלבד
משתמשים ב-API
chrome.fileSystemProvider
כדי ליצור מערכות קבצים, שאפשר לגשת אליהן ממנהל הקבצים ב-Chrome OS. - fontSettings
-
כדי לנהל את הגדרות הגופנים של Chrome, צריך להשתמש ב-API
chrome.fontSettings
. - gcm
-
באמצעות
chrome.gcm
, אפליקציות ותוספים יכולים לשלוח ולקבל הודעות באמצעות העברת הודעות בענן ב-Firebase (FCM). - היסטוריה
-
אפשר להשתמש ב-API
chrome.history
כדי לבצע אינטראקציה עם רישום הדפים שבהם ביקרת, בדפדפן. אתם יכולים להוסיף ולהסיר כתובות URL בהיסטוריית הדפדפן, להסיר אותן ולשלוח שאילתות לגביהן. כדי לשנות את דף ההיסטוריה בגרסה משלכם, אפשר לעיין במאמר שינוי דפים. - i18n
-
אפשר להשתמש בתשתית
chrome.i18n
כדי להטמיע התאמה לשוק הבינלאומי בכל האפליקציה או התוסף. - זהות
-
משתמשים ב-API
chrome.identity
כדי לקבל אסימוני גישה מסוג OAuth2. - לא פעיל
-
אפשר להשתמש ב-API
chrome.idle
כדי לזהות מתי משתנה מצב חוסר הפעילות של המכונה. - input.ime
-
ChromeOS בלבד
השתמשו ב-API
chrome.input.ime
כדי להטמיע IME בהתאמה אישית עבור Chrome OS. ההגדרה הזו מאפשרת לתוסף לטפל בהקשות, להגדיר את הקומפוזיציה ולנהל את החלון של המועמד. - instanceID
-
Chrome 44 ואילך
כדי לגשת לשירות של מזהה המכונה, משתמשים ב-
chrome.instanceID
. - loginState
-
Chrome מגרסה 78 ואילך ChromeOS בלבד
שימוש ב-API של
chrome.loginState
כדי לקרוא את מצב ההתחברות ולעקוב אחריה. - סרטונים
-
באמצעות ה-API של
chrome.management
אפשר לנהל אפליקציות ותוספים מותקנים. - התראות
-
אפשר להשתמש ב-API של
chrome.notifications
כדי ליצור התראות עשירות באמצעות תבניות ולהציג את ההתראות האלה למשתמשים במגש המערכת. - כיבוי מסך
-
Chrome 109+ MV3+
אפשר להשתמש ב-API של
offscreen
כדי ליצור ולנהל מסמכים שלא מופיעים במסך. - סרגל הכתובות
-
ממשק ה-API של סרגל הכתובות מאפשר לרשום מילת מפתח באמצעות סרגל הכתובות של Google Chrome, שנקרא גם 'סרגל הכתובות'.
- pageCapture
-
משתמשים ב-API
chrome.pageCapture
כדי לשמור כרטיסייה כ-MHTML. - הרשאות
-
אפשר להשתמש ב-API של
chrome.permissions
כדי לבקש הרשאות אופציונליות מוצהרות בזמן הריצה במקום בזמן ההתקנה, כך שהמשתמשים יבינו למה ההרשאות נדרשות, ותעניקו רק את ההרשאות הדרושות. - platformKeys
-
Chrome 45+ ChromeOS בלבד
אפשר להשתמש ב-API
chrome.platformKeys
כדי לגשת לאישורי לקוח שמנוהלים על ידי הפלטפורמה. אם המשתמש או המדיניות מעניקים את ההרשאה, תוסף יכול להשתמש באישור כזה בפרוטוקול האימות המותאם אישית שלו. לדוגמה כך מתאפשר שימוש באישורים שמנוהלים על ידי פלטפורמה ברשתות VPN של צד שלישי (מידע נוסף זמין בכתובת chrome.vpnProvider). - חשמל
-
שימוש ב-API
chrome.power
כדי לשנות את תכונות ניהול צריכת החשמל של המערכת. - printerProvider
-
Chrome 44 ואילך
ה-API של
chrome.printerProvider
חושף את האירועים ששימשו את מנהל ההדפסה לשליחת שאילתות לגבי מדפסות שמנוהלות על ידי תוספים, כדי לשלוח שאילתות לגבי היכולות שלהן ולשלוח משימות הדפסה אל המדפסות האלה. - הדפסה
-
Chrome מגרסה 81 ואילך ChromeOS בלבד
אפשר להשתמש ב-API של
chrome.printing
כדי לשלוח משימות הדפסה למדפסות שמותקנות ב-Chromebook. - printingMetrics
-
כדי לאחזר נתונים לגבי השימוש בהדפסה, משתמשים ב-API
chrome.printingMetrics
. - פרטיות
-
שימוש ב-API
chrome.privacy
כדי לשלוט בשימוש בתכונות ב-Chrome שיכולות להשפיע על פרטיות המשתמש. ה-API הזה מסתמך על אב הטיפוס ChromeSetting של סוג API לצורך קבלה והגדרה של התצורה של Chrome. - תהליכים
-
ערוץ פיתוח
שימוש ב-API של
chrome.processes
כדי לבצע פעולות בתהליכים בדפדפן. - שרת proxy
-
צריך להשתמש ב-API
chrome.proxy
כדי לנהל את ההגדרות של Chrome לשרת ה-proxy. ה-API הזה מסתמך על אב הטיפוס ChromeSetting של סוג ה-API כדי לקבל את ההגדרות של שרת ה-proxy ולהגדיר אותן. - readingList
-
Chrome 120+ MV3+
להשתמש ב-API
chrome.readingList
כדי לקרוא ולשנות את הפריטים ברשימת הקריאה. - סביבת זמן ריצה
-
איך משתמשים ב-API
chrome.runtime
כדי לאחזר את ה-Service Worker, להחזיר פרטים על המניפסט, להאזין לאירועים במחזור החיים של התוסף ולהגיב עליהם. תוכלו גם להשתמש ב-API הזה כדי להמיר את הנתיב היחסי של כתובות URL לכתובות URL שמוגדרות במלואן. - כתיבת סקריפטים
-
Chrome מגרסה 88 ואילך MV3+
שימוש ב-API
chrome.scripting
כדי להריץ סקריפט בהקשרים שונים. - search
-
Chrome מגרסה 87 ואילך
אפשר להשתמש ב-API
chrome.search
כדי לחפש באמצעות ספק ברירת המחדל. - סשנים
-
שימוש ב-API של
chrome.sessions
כדי לשלוח שאילתות ולשחזר כרטיסיות וחלונות מסשן גלישה. - sidePanel
-
Chrome 114 ואילך MV3+
שימוש ב-API
chrome.sidePanel
כדי לארח תוכן בחלונית הצדדית של הדפדפן לצד התוכן הראשי של דף אינטרנט. - אחסון
-
שימוש ב-API של
chrome.storage
כדי לאחסן, לאחזר ולעקוב אחר שינויים בנתוני משתמשים. - system.cpu
-
שימוש ב-API
system.cpu
כדי לשלוח שאילתות על מטא-נתונים של המעבד (CPU). - system.display
-
שימוש ב-API
system.display
כדי לשלוח שאילתות על מטא-נתונים מוצגים. - system.memory
-
ממשק ה-API של
chrome.system.memory
. - system.storage
-
אפשר להשתמש ב-API של
chrome.system.storage
כדי להריץ שאילתה על פרטי מכשיר האחסון ולקבל הודעה כשהתקן אחסון נשלף מחובר ומנותק. - systemLog
-
צריך להשתמש ב-API
chrome.systemLog
כדי לתעד יומני מערכת של Chrome מתוספים. - tabCapture
-
שימוש ב-API של
chrome.tabCapture
כדי לקיים אינטראקציה עם שידורי מדיה של כרטיסיות. - tabGroups
-
Chrome מגרסה 89 ואילך 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
כדי ליצור דיבור. התוסף יכול להשתמש בכל טכנולוגיית אינטרנט זמינה כדי לסנתוז ולפלט את הדיבור ולשלוח אירועים חזרה לפונקציית ההתקשרות כדי לדווח על הסטטוס. - סוגים
-
ה-API
chrome.types
מכיל הצהרות סוגים ל-Chrome. - userScripts
-
Chrome 120+ MV3+
שימוש ב-API
userScripts
כדי להפעיל סקריפטים של משתמשים בהקשר של סקריפטים של משתמשים. - vpnProvider
-
Chrome 43 ואילך ChromeOS בלבד
שימוש ב-API
chrome.vpnProvider
כדי להטמיע לקוח VPN. - טפט
-
Chrome 43 ואילך ChromeOS בלבד
צריך להשתמש ב-API
chrome.wallpaper
כדי לשנות את הטפט של ChromeOS. - webAuthenticationProxy
-
Chrome 115+ MV3+
ה-API של
chrome.webAuthenticationProxy
מאפשר לתוכנת מחשב מרחוק שפועלת במארח מרוחק ליירט בקשות של Web Authentication API (WebAuthn) כדי לטפל בהן בלקוח מקומי. - webNavigation
-
אפשר להשתמש ב-API
chrome.webNavigation
כדי לקבל התראות על הסטטוס של בקשות ניווט בזמן אמת. - webRequest
-
אפשר להשתמש ב-API של
chrome.webRequest
כדי לצפות בתעבורת נתונים ולנתח אותה, וליירט, לחסום או לשנות בקשות בזמן שהן פועלות. - חלונות
-
שימוש ב-API של
chrome.windows
כדי לבצע פעולות בחלונות של דפדפנים. אפשר להשתמש בממשק ה-API הזה כדי ליצור, לשנות ולסדר מחדש חלונות בדפדפן.