רוב התוספים צריכים גישה לממשק API אחד או יותר של תוספי Chrome כדי לפעול. הפניית ה-API הזו מתארת את ממשקי ה-API שזמינים לשימוש בתוספים, ומציגה תרחישים לדוגמה.
- accessibilityFeatures
-
כדי לנהל את תכונות הנגישות של Chrome, יש להשתמש ב-API של
chrome.accessibilityFeatures
. ה-API הזה מסתמך על אב הטיפוס של ChromeSetting מסוג API כדי לקבל ולהגדיר תכונות נגישות נפרדות. כדי לקבל מצבי תכונות, התוסף צריך לבקש הרשאה מסוגaccessibilityFeatures.read
. כדי לשנות מצב של תכונה, לתוסף נדרשת ההרשאהaccessibilityFeatures.modify
. חשוב לשים לב ש-accessibilityFeatures.modify
לא מרמז על הרשאהaccessibilityFeatures.read
. - התראות
-
אפשר להשתמש ב-API
chrome.alarms
כדי לתזמן קוד שיפעל מעת לעת או במועד ספציפי בעתיד. - אודיו
-
Chrome 59+ ChromeOS בלבד
chrome.audio
API מסופק כדי לאפשר למשתמשים לקבל מידע על התקני האודיו שמחוברים למערכת ולשלוט בהם. ה-API הזה זמין כרגע רק במצב קיוסק ל-ChromeOS. - סימניות
-
אפשר להשתמש ב-API של
chrome.bookmarks
כדי ליצור סימניות, לארגן אותן ולבצע בהן פעולות אחרות. במאמר שינוי דפים אפשר גם ליצור דף מותאם אישית של ניהול הסימניות. - browserAction
-
≤ MV2
השתמש בפעולות הדפדפן כדי להציב סמלים בסרגל הכלים הראשי של Google Chrome, מימין לסרגל הכתובות. בנוסף לסמל של הפעולה בדפדפן, אפשר לכלול בה הסבר קצר, תג וחלון קופץ.
- browsingData
-
כדי להסיר נתוני גלישה מהפרופיל המקומי של המשתמש, יש להשתמש ב-
chrome.browsingData
API. - 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, לשנות אותם ולקבל התראות כשהם משתנים. - debugger
-
ה-API
chrome.debugger
משמש כתעבורה חלופית לפרוטוקול לניפוי באגים מרחוק של Chrome. אפשר להשתמש ב-chrome.debugger
כדי לצרף כרטיסייה אחת או יותר כדי לבצע אינטראקציה ברשת, לנפות באגים ב-JavaScript, לשנות את ה-DOM וה-CSS ועוד. השתמשו במאפייןDebuggee
tabId
כדי לטרגט כרטיסיות עםsendCommand
ולנתב אירועים עדtabId
מתוךonEvent
קריאות חוזרות (callback). - declarativeContent
-
אפשר להשתמש ב-API
chrome.declarativeContent
כדי לבצע פעולות בהתאם לתוכן הדף, בלי לבקש הרשאה לקרוא את תוכן הדף. - declarativeNetRequest
-
Chrome 84 ומעלה
ה-API
chrome.declarativeNetRequest
משמש לחסימה או לשינוי של בקשות רשת על ידי ציון כללי הצהרה. כך תוספים יכולים לשנות בקשות רשת בלי ליירט אותן ולצפות בתוכן שלהן, וכך לספק פרטיות רבה יותר. - declarativeWebRequest
-
ערוץ בטא ≤ MV2
הערה: ה-API הזה הוצא משימוש. במקום זאת, כדאי לקרוא על
declarativeNetRequest
API. אפשר להשתמש ב-APIchrome.declarativeWebRequest
כדי ליירט, לחסום או לשנות בקשות בזמן שהן מוצגות. הוא מהיר יותר באופן משמעותי מה-API שלchrome.webRequest
כי אפשר לרשום כללים שמעריכים בדפדפן במקום במנוע ה-JavaScript, וכך מפחית את זמן האחזור הלוך ושוב ומשפר את היעילות. - desktopCapture
-
ה-Desktop capture API לוכד את התוכן של המסך, של חלונות נפרדים או של כרטיסיות נפרדות.
- devtools.inspectedWindow
-
כדי לבצע פעולות בחלון שנבדק, משתמשים ב-API של
chrome.devtools.inspectedWindow
: משיגים את מזהה הכרטיסייה של הדף שנבדק, מעריכים את הקוד בהקשר של החלון שנבדק, טעינה מחדש של הדף או השגת רשימת המשאבים שבדף. - devtools.network
-
אפשר להשתמש ב-
chrome.devtools.network
API כדי לאחזר את המידע על בקשות הרשת שמוצגות על ידי הכלים למפתחים בחלונית 'רשת'. - devtools.panels
-
ניתן להשתמש ב-API של
chrome.devtools.panels
כדי לשלב את התוסף בממשק המשתמש של חלון הכלים למפתחים: יוצרים לוחות משלכם, ניגשים ללוחות קיימים ומוסיפים סרגלי צד. - devtools.recorder
-
Chrome מגרסה 105 ואילך
יש להשתמש ב-API של
chrome.devtools.recorder
כדי להתאים אישית את החלונית 'מכשיר הקלטה' בכלי הפיתוח. - dns
-
ערוץ הפיתוח
יש להשתמש ב-API של
chrome.dns
לרזולוציית DNS. - documentScan
-
Chrome 44 ואילך ChromeOS בלבד
אפשר להשתמש ב-API
chrome.documentScan
כדי לאתר ולאחזר תמונות מסורקי מסמכים מצורפים. - dom
-
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 בלבד בחזית בלבד
כדי להרחיב את דפדפן הקבצים של ChromeOS, צריך להשתמש ב-API של
chrome.fileBrowserHandler
. לדוגמה, תוכלו להשתמש ב-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
-
השתמשו ב-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
אפשר ליצור התראות עשירות באמצעות תבניות ולהציג את ההתראות האלה למשתמשים במגש המערכת. - סרגל הכתובות
-
ממשק ה-API של 'סרגל הכתובות' מאפשר לכם לרשום מילת מפתח באמצעות סרגל הכתובות של Google Chrome, שנקרא גם 'סרגל הכתובות'.
- pageAction
-
≤ MV2
יש להשתמש ב-API של
chrome.pageAction
כדי להציב סמלים בסרגל הכלים הראשי של Google Chrome, מימין לסרגל הכתובות. פעולות בדף מייצגות פעולות שאפשר לבצע בדף הנוכחי, אבל לא על כל הדפים. פעולות בדף מופיעות באפור כשהן לא פעילות. - pageCapture
-
כדי לשמור כרטיסייה כ-MHTML, יש להשתמש ב-API
chrome.pageCapture
. - הרשאות
-
צריך להשתמש ב-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
-
כדי לנהל את הגדרות שרת ה-proxy של Chrome, יש להשתמש ב-API של
chrome.proxy
. ה-API הזה מסתמך על אב הטיפוס של ChromeSetting מסוג API כדי לקבל ולהגדיר את התצורה של שרת ה-proxy. - זמן ריצה
-
אפשר להשתמש ב-API
chrome.runtime
כדי לאחזר את קובץ השירות (service worker), להחזיר פרטים על המניפסט, להאזין לאירועים במחזור החיים של התוסף ולהגיב עליהם. ניתן להשתמש ב-API הזה גם כדי להמיר את הנתיב היחסי של כתובות ה-URL לכתובות URL שמוגדרות במלואן. - search
-
Chrome 87 ומעלה
יש להשתמש ב-API של
chrome.search
כדי לחפש דרך ספק ברירת המחדל. - סשנים
-
אפשר להשתמש ב-API של
chrome.sessions
כדי ליצור שאילתות ולשחזר כרטיסיות וחלונות מסשן גלישה. - אחסון
-
אפשר להשתמש ב-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
-
כדי לתעד יומני מערכת של Chrome מתוספים, צריך להשתמש ב-API
chrome.systemLog
. - tabCapture
-
משתמשים ב-API
chrome.tabCapture
לאינטראקציה עם שידורי מדיה של כרטיסיות. - כרטיסיות
-
שימוש ב-API של
chrome.tabs
לאינטראקציה עם מערכת הכרטיסיות של הדפדפן. ממשק ה-API הזה מאפשר לכם ליצור כרטיסיות, לשנות אותן ולסדר אותן מחדש בדפדפן. - topSites
-
צריך להשתמש ב-API
chrome.topSites
כדי לגשת לאתרים המובילים (האתרים עם הכי הרבה ביקורים) שמוצגים בדף הכרטיסייה החדשה. הם לא כוללים קיצורי דרך שהותאמו אישית על ידי המשתמש. - tts
-
יש להשתמש ב-API
chrome.tts
כדי להפעיל המרת טקסט לדיבור (TTS) מסונתז. למידע נוסף, ניתן לעיין ב-API הרלוונטי שלttsEngine
, שמאפשר לתוסף להטמיע מנוע דיבור. - ttsEngine
-
צריך להשתמש ב-API
chrome.ttsEngine
כדי להטמיע מנוע של המרת טקסט לדיבור(TTS) באמצעות תוסף. אם התוסף נרשם באמצעות ה-API הזה, הוא יקבל אירועים שכוללים דיבור ופרמטרים נוספים כשתוסף או אפליקציית Chrome כלשהם משתמשים ב-APItts
כדי ליצור דיבור. לאחר מכן התוסף יכול להשתמש בכל טכנולוגיית אינטרנט זמינה כדי לסנתז ולפלט את הדיבור, ולשלוח אירועים חזרה לפונקציית הקריאה לדיווח על הסטטוס. - סוגים
-
ה-API
chrome.types
מכיל הצהרות סוגים עבור Chrome. - vpnProvider
-
Chrome 43 ואילך ChromeOS בלבד
שימוש ב-API
chrome.vpnProvider
כדי להטמיע לקוח VPN. - טפט
-
Chrome 43 ואילך ChromeOS בלבד
יש להשתמש ב-API של
chrome.wallpaper
כדי לשנות את הטפט של ChromeOS. - webNavigation
-
יש להשתמש ב-API
chrome.webNavigation
כדי לקבל התראות לגבי הסטטוס של בקשות ניווט בזמן שהן פועלות. - webRequest
-
אפשר להשתמש ב-API של
chrome.webRequest
כדי לצפות בתעבורת נתונים ולנתח אותה, וגם ליירט, לחסום או לשנות בקשות בזמן שהן מוצגות. - חלונות
-
שימוש ב-API
chrome.windows
לאינטראקציה עם חלונות הדפדפן. ממשק API זה מאפשר לכם ליצור, לשנות ולסדר מחדש חלונות בדפדפן.