הפניית API

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

תכונות נפוצות של Extensions 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.

action
Chrome מגרסה 88 ואילך MV3 ואילך

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

התראות

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

אודיו
Chrome מגרסה 59 ואילך ב-ChromeOS בלבד

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

סימניות

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

browsingData

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

certificateProvider
Chrome מגרסה 46 ואילך ב-ChromeOS בלבד

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

פקודות

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

contentSettings

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

contextMenus

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

קובצי Cookie

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

מתקן באגים

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

declarativeContent

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

declarativeNetRequest
Chrome מגרסה 84 ואילך

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

desktopCapture

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

devtools.inspectedWindow

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

devtools.network

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

devtools.panels

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

devtools.performance
גרסה 129 ואילך של Chrome

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

devtools.recorder
Chrome 105+

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

dns
ערוץ פיתוח

משתמשים ב-API chrome.dns לצורך פתרון DNS.

documentScan
Chrome מגרסה 44 ואילך ב-ChromeOS בלבד

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

הרפובליקה
גרסה 88 ואילך של Chrome

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

הורדות

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

enterprise.deviceAttributes
Chrome מגרסה 46 ואילך ב-ChromeOS בלבד נדרש תיקון מדיניות

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

enterprise.hardwarePlatform
Chrome מגרסה 71 ואילך נדרש מדיניות

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

enterprise.networkingAttributes
Chrome מגרסה 85 ואילך ב-ChromeOS בלבד נדרשת מדיניות

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

enterprise.platformKeys

אפשר להשתמש ב-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 בלבד

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

fontSettings

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

gcm

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

היסטוריה

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

i18n

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

זהות

שימוש ב-API ‏chrome.identity כדי לקבל אסימוני גישה מסוג OAuth2.

idle

שימוש ב-API של chrome.idle כדי לזהות מתי מצב ההשבתה של המכונה משתנה.

input.ime
ChromeOS בלבד

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

instanceID
גרסה 44 ואילך של Chrome

כדי לגשת לשירות של מזהה המכונה, משתמשים ב-chrome.instanceID.

loginState
Chrome מגרסה 78 ואילך ChromeOS בלבד

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

סרטונים

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

התראות

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

כיבוי מסך
Chrome 109+ MV3+

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

סרגל הכתובות

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

pageCapture

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

permissions

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

platformKeys
Chrome 45+ ChromeOS בלבד

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

power

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

printerProvider
Chrome 44 ואילך

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

printing
Chrome מגרסה 81 ואילך ב-ChromeOS בלבד

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

printingMetrics
Chrome מגרסה 79 ואילך ChromeOS בלבד נדרשת מדיניות

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

פרטיות

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

תהליכים
ערוץ פיתוח

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

שרת proxy

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

readingList
Chrome 120+ MV3+

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

runtime

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

scripting
גרסה 88 ואילך של Chrome גרסה MV3 ואילך

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

search
Chrome מגרסה 87 ואילך

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

סשנים

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

sidePanel
Chrome מגרסה 114 ואילך MV3 ואילך

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

storage

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

system.cpu

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

system.display

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

system.memory

ממשק ה-API של chrome.system.memory.

system.storage

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

systemLog
Chrome מגרסה 125 ואילך ב-ChromeOS בלבד נדרש אישור מדיניות

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

tabCapture

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

tabGroups
Chrome מגרסה 89 ואילך MV3+

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

tabs

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

topSites

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

tts

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

ttsEngine

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

types

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

userScripts
גרסה 120 ואילך של Chrome גרסה 3 ואילך של MV

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

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

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

windows

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