רוב התוספים צריכים גישה לממשקי API אחד או יותר של תוספים ל-Chrome כדי לפעול. במסמכי התיעוד של ה-API האלה מתוארים ממשקי ה-API שזמינים לשימוש בתוספים, ומוצגים תרחישים לדוגמה לשימוש.
- accessibilityFeatures
-
אפשר להשתמש ב-
chrome.accessibilityFeaturesAPI כדי לנהל את תכונות הנגישות של Chrome. ה-API הזה מסתמך על אב הטיפוס ChromeSetting של API מסוג כדי לקבל ולהגדיר תכונות נגישות ספציפיות. כדי לקבל את מצבי התכונות, התוסף צריך לבקש הרשאהaccessibilityFeatures.read. כדי לשנות את מצב התכונה, התוסף צריך את ההרשאהaccessibilityFeatures.modify. שימו לב:accessibilityFeatures.modifyלא מרמז על הרשאה שלaccessibilityFeatures.read. - alarms
-
אפשר להשתמש ב-
chrome.alarmsAPI כדי לתזמן קוד להפעלה מעת לעת או בשעה ספציפית בעתיד. - אודיו
-
Chrome 59 ואילך ChromeOS בלבד
ממשק ה-API
chrome.audioמסופק כדי לאפשר למשתמשים לקבל מידע על מכשירי האודיו שמחוברים למערכת ולשלוט בהם. ה-API הזה זמין כרגע רק במצב קיוסק ב-ChromeOS. - סימניות
-
אפשר להשתמש ב-
chrome.bookmarksAPI כדי ליצור סימניות, לארגן אותן ולבצע פעולות אחרות. אפשר גם לעיין במאמר בנושא Override Pages, שמתאר איך ליצור דף מותאם אישית של ניהול הסימניות. - browserAction
-
≤ MV2
אפשר להשתמש בפעולות בדפדפן כדי להוסיף סמלים לסרגל הכלים הראשי של Google Chrome, משמאל לסרגל הכתובות. בנוסף לאייקון, לפעולת דפדפן יכולים להיות הסבר קצר, תג וחלון קופץ.
- browsingData
-
משתמשים ב-
chrome.browsingDataAPI כדי להסיר נתוני גלישה מהפרופיל המקומי של המשתמש. - certificateProvider
-
Chrome 46 ואילך ChromeOS בלבד
אפשר להשתמש ב-API הזה כדי לחשוף אישורים לפלטפורמה, והפלטפורמה יכולה להשתמש באישורים האלה לאימות TLS.
- פקודות
-
אפשר להשתמש בממשק ה-API של הפקודות כדי להוסיף קיצורי דרך במקלדת שמפעילים פעולות בתוסף, למשל פעולה לפתיחת פעולת הדפדפן או לשליחת פקודה לתוסף.
- contentSettings
-
אפשר להשתמש ב-
chrome.contentSettingsAPI כדי לשנות הגדרות שקובעות אם אתרים יכולים להשתמש בתכונות כמו קובצי Cookie, JavaScript ויישומי פלאגין. באופן כללי יותר, הגדרות התוכן מאפשרות לכם להתאים אישית את ההתנהגות של Chrome ברמת האתר, במקום ברמה הגלובלית. - contextMenus
-
משתמשים ב-
chrome.contextMenusAPI כדי להוסיף פריטים לתפריט ההקשר של Google Chrome. אתם יכולים לבחור לאילו סוגים של אובייקטים יחולו התוספים לתפריט ההקשר, כמו תמונות, היפר-קישורים ודפים. - קובצי Cookie
-
אפשר להשתמש ב-API של
chrome.cookiesכדי לשלוח שאילתות לגבי קובצי Cookie ולשנות אותם, ולקבל התראה כשהם משתנים. - debugger
-
chrome.debuggerAPI משמש כהעברה חלופית לפרוטוקול לניפוי באגים מרחוק של Chrome. אפשר להשתמש ב-chrome.debuggerכדי לצרף כרטיסייה אחת או יותר למכשיר, כדי לבצע אינטראקציה עם הרשת, לנפות באגים ב-JavaScript, לשנות את ה-DOM ואת ה-CSS ועוד. משתמשים במאפייןDebuggeetabIdכדי לטרגט כרטיסיות עםsendCommandולנתב אירועים לפיtabIdמתוך קריאות חוזרות (callback) שלonEvent. - declarativeContent
-
אפשר להשתמש ב-API
chrome.declarativeContentכדי לבצע פעולות בהתאם לתוכן של דף, בלי לבקש הרשאה לקרוא את התוכן של הדף. - declarativeNetRequest
-
Chrome 84 ואילך
ממשק ה-API
chrome.declarativeNetRequestמשמש לחסימה או לשינוי של בקשות רשת על ידי הגדרת כללים הצהרתיים. כך התוספים יכולים לשנות את בקשות הרשת בלי ליירט אותן ולראות את התוכן שלהן, ולכן הם מספקים יותר פרטיות. - declarativeWebRequest
-
ערוץ בטא ≤ MV2
הערה: ממשק ה-API הזה הוצא משימוש. במקום זאת, כדאי לעיין ב-API של
declarativeNetRequest. אפשר להשתמש ב-chrome.declarativeWebRequestAPI כדי ליירט, לחסום או לשנות בקשות בזמן שהן נשלחות. הוא מהיר משמעותית מ-chrome.webRequestAPI כי אפשר לרשום כללים שמוערכים בדפדפן ולא במנוע JavaScript, מה שמקצר את זמן האחזור הלוך ושוב ומאפשר יעילות גבוהה יותר. - desktopCapture
-
ממשק ה-API של Desktop Capture מצלם את התוכן של המסך, של חלונות נפרדים או של כרטיסיות נפרדות.
- devtools.inspectedWindow
-
אפשר להשתמש ב-
chrome.devtools.inspectedWindowAPI כדי ליצור אינטראקציה עם החלון שנבדק: לקבל את מזהה הכרטיסייה של הדף שנבדק, להעריך את הקוד בהקשר של החלון שנבדק, לטעון מחדש את הדף או לקבל את רשימת המשאבים בדף. - devtools.network
-
אפשר להשתמש ב-
chrome.devtools.networkAPI כדי לאחזר את המידע על בקשות הרשת שמוצגות בלוח הרשת של הכלים למפתחים. - devtools.panels
-
משתמשים ב-
chrome.devtools.panelsAPI כדי לשלב את התוסף בממשק המשתמש של חלון כלי הפיתוח: יוצרים חלוניות משלכם, ניגשים לחלוניות קיימות ומוסיפים סרגלי צד. - devtools.performance
-
Chrome 129 ואילך
אפשר להשתמש ב-
chrome.devtools.performanceAPI כדי להאזין לעדכונים של סטטוס ההקלטה בחלונית הביצועים בכלי הפיתוח. - devtools.recorder
-
Chrome 105 ואילך
משתמשים ב-
chrome.devtools.recorderAPI כדי להתאים אישית את חלונית מכשיר ההקלטה בכלי הפיתוח. - dns
-
ערוץ פיתוח
משתמשים ב-
chrome.dnsAPI לפתרון DNS. - documentScan
-
Chrome 44 ואילך ChromeOS בלבד
אפשר להשתמש ב-
chrome.documentScanAPI כדי לגלות ולאחזר תמונות מסורקי מסמכים שמחוברים למכשיר. - dom
-
Chrome 88 ואילך
שימוש ב-
chrome.domAPI כדי לגשת לממשקי DOM API מיוחדים לתוספים - הורדות
-
אתם יכולים להשתמש ב-
chrome.downloadsAPI כדי להתחיל, לעקוב, לשנות ולחפש הורדות באופן פרוגרמטי. - enterprise.deviceAttributes
-
משתמשים ב-
chrome.enterprise.deviceAttributesAPI כדי לקרוא את מאפייני המכשיר. הערה: ה-API הזה זמין רק לתוספים שהותקנו לפי הגדרת האדמין דרך המדיניות הארגונית. - enterprise.hardwarePlatform
-
Chrome 71+ נדרשת מדיניות
אפשר להשתמש ב-
chrome.enterprise.hardwarePlatformAPI כדי לקבל את היצרן והדגם של פלטפורמת החומרה שבה הדפדפן פועל. הערה: ה-API הזה זמין רק לתוספים שהותקנו על ידי המדיניות הארגונית. - enterprise.login
-
משתמשים ב-API
chrome.enterprise.loginכדי לצאת מסשנים שמוגדרים "גלישה כאורח". הערה: ממשק ה-API הזה זמין רק לתוספים שהותקנו על ידי מדיניות ארגונית בסשנים מנוהלים של גלישה כאורחים ב-ChromeOS. - enterprise.networkingAttributes
-
משתמשים ב-
chrome.enterprise.networkingAttributesAPI כדי לקרוא מידע על הרשת הנוכחית. הערה: ה-API הזה זמין רק לתוספים שהותקנו לפי הגדרת האדמין דרך המדיניות הארגונית. - enterprise.platformKeys
-
ChromeOS בלבד נדרשת מדיניות
משתמשים ב-
chrome.enterprise.platformKeysAPI כדי ליצור מפתחות ולהתקין אישורים למפתחות האלה. הפלטפורמה תנהל את האישורים, ואפשר להשתמש בהם לאימות TLS, לגישה לרשת או באמצעות תוסף אחר דרך chrome.platformKeys. - אירועים
-
מרחב השמות
chrome.eventsמכיל סוגים נפוצים שמשמשים ממשקי API ששולחים אירועים כדי להודיע לכם כשקורה משהו מעניין. - extension
-
ל-
chrome.extensionAPI יש כלי עזר שאפשר להשתמש בהם בכל דף של תוסף. היא כוללת תמיכה בהעברת הודעות בין תוסף לבין סקריפטים של תוכן או בין תוספים, כפי שמתואר בפירוט במאמר בנושא העברת הודעות. - extensionTypes
-
chrome.extensionTypesAPI מכיל הצהרות על סוגים של תוספים ל-Chrome. - fileBrowserHandler
-
ChromeOS בלבד רק בחזית
משתמשים ב-API
chrome.fileBrowserHandlerכדי להרחיב את דפדפן הקבצים של ChromeOS. לדוגמה, אתם יכולים להשתמש ב-API הזה כדי לאפשר למשתמשים להעלות קבצים לאתר שלכם. - fileSystemProvider
-
ל-ChromeOS בלבד
אפשר להשתמש ב-
chrome.fileSystemProviderAPI כדי ליצור מערכות קבצים שאפשר לגשת אליהן ממנהל הקבצים ב-ChromeOS. - fontSettings
-
משתמשים ב-
chrome.fontSettingsAPI כדי לנהל את הגדרות הגופן של Chrome. - gcm
-
משתמשים ב-
chrome.gcmכדי לאפשר לאפליקציות ולתוספים לשלוח ולקבל הודעות דרך העברת הודעות בענן ב-Firebase (FCM). - היסטוריה
-
משתמשים ב-
chrome.historyAPI כדי ליצור אינטראקציה עם רשומת הדפדפן של הדפים שבוקרו. אפשר להוסיף, להסיר ולחפש כתובות URL בהיסטוריה של הדפדפן. כדי להחליף את דף ההיסטוריה בגרסה משלכם, אפשר לעיין במאמר בנושא החלפת דפים. - i18n
-
אפשר להשתמש בתשתית
chrome.i18nכדי להטמיע בינאום בכל האפליקציה או התוסף. - זהות
-
משתמשים ב-
chrome.identityAPI כדי לקבל אסימוני גישה מסוג OAuth2. - idle
-
אפשר להשתמש ב-
chrome.idleAPI כדי לזהות מתי המצב של המחשב משתנה ממצב פעיל למצב לא פעיל. - input.ime
-
ל-ChromeOS בלבד
משתמשים ב-
chrome.input.imeAPI כדי להטמיע IME מותאם אישית ב-ChromeOS. כך התוסף יכול לטפל בהקשות על המקשים, להגדיר את ההרכב ולנהל את חלון האפשרויות. - instanceID
-
Chrome 44 ואילך
משתמשים ב-
chrome.instanceIDכדי לגשת לשירות Instance ID. - loginState
-
Chrome 78 ואילך ChromeOS בלבד
משתמשים ב-
chrome.loginStateAPI כדי לקרוא את מצב ההתחברות ולעקוב אחריו. - סרטונים
-
ממשק ה-API
chrome.managementמספק דרכים לניהול אפליקציות ותוספים מותקנים. - התראות
-
אפשר להשתמש ב-
chrome.notificationsAPI כדי ליצור התראות מפורטות באמצעות תבניות ולהציג את ההתראות האלה למשתמשים במגש המערכת. - תיבת כתובת חכמה
-
ה-API של סרגל הכתובות מאפשר לרשום מילת מפתח בסרגל הכתובות של Google Chrome, שנקרא גם סרגל הכתובות.
- pageAction
-
≤ MV2
אפשר להשתמש ב-
chrome.pageActionAPI כדי להוסיף סמלים לסרגל הכלים הראשי של Google Chrome, משמאל לסרגל הכתובות. פעולות בדף מייצגות פעולות שאפשר לבצע בדף הנוכחי, אבל לא רלוונטיות לכל הדפים. כשפעולות הדף לא פעילות, הן מוצגות באפור. - pageCapture
-
משתמשים ב-
chrome.pageCaptureAPI כדי לשמור כרטיסייה כ-MHTML. - הרשאות
-
כדי שהמשתמשים יבינו למה נדרשות הרשאות ויוכלו להעניק רק את ההרשאות ההכרחיות, כדאי להשתמש ב-API של
chrome.permissionsכדי לבקש הרשאות אופציונליות מוצהרות בזמן הריצה ולא בזמן ההתקנה. - platformKeys
-
Chrome 45 ואילך ChromeOS בלבד
משתמשים ב-
chrome.platformKeysAPI כדי לגשת לאישורי לקוח שמנוהלים על ידי הפלטפורמה. אם המשתמש או המדיניות מעניקים את ההרשאה, תוסף יכול להשתמש באישור כזה בפרוטוקול האימות המותאם אישית שלו. לדוגמה, ההגדרה הזו מאפשרת שימוש באישורים שמנוהלים על ידי הפלטפורמה ברשתות VPN של צד שלישי (ראו chrome.vpnProvider). - power
-
אפשר להשתמש ב-
chrome.powerAPI כדי לבטל את התכונות של ניהול צריכת החשמל במערכת. - printerProvider
-
Chrome 44 ואילך
chrome.printerProviderAPI חושף אירועים שמשמשים את מרכז ההדפסה לשליחת שאילתות למדפסות שנשלטות על ידי תוספים, כדי לשאול על היכולות שלהן ולשלוח אליהן משימות הדפסה. - הדפסה
-
Chrome 81 ואילך ChromeOS בלבד
משתמשים ב-
chrome.printingAPI כדי לשלוח משימות הדפסה למדפסות שמותקנות ב-Chromebook. - printingMetrics
-
משתמשים ב-
chrome.printingMetricsAPI כדי לאחזר נתונים על השימוש בהדפסה. - פרטיות
-
אפשר להשתמש ב-
chrome.privacyAPI כדי לשלוט בשימוש בתכונות ב-Chrome שיכולות להשפיע על הפרטיות של המשתמש. ה-API הזה מסתמך על אב הטיפוס ChromeSetting של ה-API מסוג כדי לקבל ולהגדיר את התצורה של Chrome. - processes
-
ערוץ פיתוח
משתמשים ב-
chrome.processesAPI כדי ליצור אינטראקציה עם התהליכים של הדפדפן. - proxy
-
אפשר להשתמש ב-
chrome.proxyAPI כדי לנהל את הגדרות ה-proxy של Chrome. ממשק ה-API הזה מסתמך על אב-טיפוס ChromeSetting מסוג API כדי לקבל ולהגדיר את הגדרות ה-proxy. - runtime
-
אפשר להשתמש ב-
chrome.runtimeAPI כדי לאחזר את ה-service worker, להחזיר פרטים על המניפסט, להאזין לאירועים במחזור החיים של התוסף ולהגיב להם. אפשר גם להשתמש ב-API הזה כדי להמיר את הנתיב היחסי של כתובות URL לכתובות URL מלאות. - search
-
Chrome 87 ואילך
משתמשים ב-
chrome.searchAPI כדי לחפש דרך ספק ברירת המחדל. - סשנים
-
אפשר להשתמש ב-
chrome.sessionsAPI כדי לשלוח שאילתות ולשחזר כרטיסיות וחלונות מסשן גלישה. - storage
-
משתמשים ב-
chrome.storageAPI כדי לאחסן נתוני משתמשים, לאחזר אותם ולעקוב אחרי שינויים בהם. - system.cpu
-
משתמשים ב-
system.cpuAPI כדי לשלוח שאילתה לגבי מטא-נתונים של מעבד. - system.display
-
אפשר להשתמש ב-
system.displayAPI כדי לשלוח שאילתה לגבי מטא-נתונים של תצוגה. - system.memory
-
chrome.system.memoryAPI. - system.storage
-
משתמשים ב-
chrome.system.storageAPI כדי לשלוח שאילתה לגבי מידע על מכשיר אחסון ולקבל הודעה כשמכשיר אחסון נשלף מחובר או מנותק. - systemLog
-
אפשר להשתמש ב-API
chrome.systemLogכדי לתעד יומני מערכת של Chrome מתוספים. - tabCapture
-
משתמשים ב-
chrome.tabCaptureAPI כדי ליצור אינטראקציה עם מדיה שמוזרמת מכרטיסיות. - כרטיסיות
-
משתמשים ב-
chrome.tabsAPI כדי ליצור אינטראקציה עם מערכת הכרטיסיות של הדפדפן. אתם יכולים להשתמש ב-API הזה כדי ליצור, לשנות ולסדר מחדש כרטיסיות בדפדפן. - topSites
-
אפשר להשתמש ב-
chrome.topSitesAPI כדי לגשת לאתרים המובילים (כלומר, האתרים שבהם מבקרים הכי הרבה) שמוצגים בדף הכרטיסייה החדשה. הם לא כוללים קיצורי דרך שהמשתמש התאים אישית. - tts
-
משתמשים ב-API של
chrome.ttsכדי להפעיל המרת טקסט לדיבור (TTS) מסונתז. אפשר גם לעיין בממשק ה-API הקשורttsEngine, שמאפשר לתוסף להטמיע מנוע דיבור. - ttsEngine
-
משתמשים ב-
chrome.ttsEngineAPI כדי להטמיע מנוע להמרת טקסט לדיבור(TTS) באמצעות תוסף. אם התוסף שלכם נרשם באמצעות ה-API הזה, הוא יקבל אירועים שמכילים ביטוי שצריך להקריא ופרמטרים אחרים, כשתוסף או אפליקציית Chrome משתמשים ב-APIttsכדי ליצור דיבור. התוסף יכול להשתמש בכל טכנולוגיית אינטרנט זמינה כדי לסנתז את הדיבור ולהוציא אותו, ולשלוח אירועים בחזרה לפונקציה הקוראת כדי לדווח על הסטטוס. - types
-
chrome.typesAPI מכיל הצהרות על סוגים ב-Chrome. - vpnProvider
-
Chrome 43 ואילך ChromeOS בלבד
משתמשים ב-
chrome.vpnProviderAPI כדי להטמיע לקוח VPN. - טפט
-
Chrome 43 ואילך ChromeOS בלבד
משתמשים ב-
chrome.wallpaperAPI כדי לשנות את הטפט ב-ChromeOS. - webNavigation
-
אפשר להשתמש ב-
chrome.webNavigationAPI כדי לקבל התראות על הסטטוס של בקשות ניווט שנמצאות בתהליך. - webRequest
-
אפשר להשתמש ב-
chrome.webRequestAPI כדי לצפות בתנועת הגולשים ולנתח אותה, ולעכב, לחסום או לשנות בקשות בזמן שהן בטיסה. - windows
-
אפשר להשתמש ב-
chrome.windowsAPI כדי ליצור אינטראקציה עם חלונות דפדפן. אפשר להשתמש ב-API הזה כדי ליצור, לשנות ולסדר מחדש חלונות בדפדפן.