דף זה תורגם על ידי Cloud Translation API.

הפניית API

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

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

ממשק ה-API של chrome.audio מאפשר למשתמשים לקבל מידע על מכשירי האודיו שמחוברים למערכת ולשלוט בהם. ממשק ה-API הזה זמין כרגע רק במצב קיוסק ב-ChromeOS.
bookmarks: שימוש ב-API chrome.bookmarks כדי ליצור, לארגן ולבצע פעולות אחרות בסימניות. כדאי לעיין גם במאמר שינוי דפים, שבו מוסבר איך ליצור דף 'ניהול סימניות' בהתאמה אישית.
browserAction: &leq; MV2

אתם יכולים להשתמש בפעולות בדפדפן כדי להוסיף סמלים לסרגל הכלים הראשי של Google Chrome, שמשמאל לסרגל הכתובות. בנוסף לסמל, פעולת דפדפן יכולה לכלול תיאור קצר, תג וחלון קופץ.
browsingData: משתמשים ב-chrome.browsingData API כדי להסיר נתוני גלישה מהפרופיל המקומי של המשתמש.
certificateProvider: Chrome מגרסה 46 ואילך ב-ChromeOS בלבד

משתמשים ב-API הזה כדי לחשוף אישורים לפלטפורמה, שיכולה להשתמש באישורים האלה לאימות TLS.
פקודות: אפשר להשתמש ב-Commands API כדי להוסיף קיצורי דרך למקלדת שמפעילים פעולות בתוסף. לדוגמה, פעולה לפתיחת הפעולה בדפדפן או שליחת פקודה לתוסף.
contentSettings: שימוש ב-chrome.contentSettings API כדי לשנות את ההגדרות ששולטות ביכולת של אתרים להשתמש בתכונות כמו קובצי 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 משמש לחסימה או לשינוי של בקשות רשת באמצעות ציון כללים מצהירים. כך התוספים יכולים לשנות בקשות רשת בלי ליירט אותן ולראות את התוכן שלהן, וכך לשפר את הפרטיות.
declarativeWebRequest: ערוץ בטא &leq; MV2

הערה: ממשק ה-API הזה הוצא משימוש. במקום זאת, כדאי להשתמש ב-API של declarativeNetRequest. שימוש ב-chrome.declarativeWebRequest API כדי ליירט, לחסום או לשנות בקשות בזמן אמת. הוא מהיר יותר באופן משמעותי מ-chrome.webRequest API כי אפשר לרשום כללים שמתבצעת להם הערכה בדפדפן ולא במנוע JavaScript, וכך מפחיתים את זמני האחזור של נסיעות הלוך ושוב ומאפשרים יעילות גבוהה יותר.
desktopCapture: באמצעות Desktop Capture API אפשר לצלם את תוכן המסך, חלונות נפרדים או כרטיסיות נפרדות.
devtools.inspectedWindow: משתמשים ב-chrome.devtools.inspectedWindow API כדי לקיים אינטראקציה עם החלון שנבדק: לקבל את מזהה הכרטיסייה של הדף שנבדק, להעריך את הקוד בהקשר של החלון שנבדק, לטעון מחדש את הדף או לקבל את רשימת המשאבים בדף.
devtools.network: אפשר להשתמש ב-API chrome.devtools.network כדי לאחזר את המידע על בקשות הרשת שמוצגות בכלים למפתחים בחלונית 'רשת'.
devtools.panels: אתם יכולים להשתמש ב-API chrome.devtools.panels כדי לשלב את התוסף בממשק המשתמש של חלון Developer Tools: ליצור חלוניות משלכם, לגשת לחלוניות קיימות ולהוסיף סרגל צד.
devtools.performance: גרסה 129 ואילך של Chrome

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

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

משתמשים ב-chrome.dns API לצורך פתרון DNS.
documentScan: Chrome מגרסה 44 ואילך ב-ChromeOS בלבד

שימוש ב-chrome.documentScan API כדי למצוא ולשלוף תמונות מסורקי מסמכים מחוברים.
dom: גרסה 88 ואילך של Chrome

שימוש ב-API ‏chrome.dom כדי לגשת לממשקי API מיוחדים של DOM עבור תוספים
הורדות: אתם יכולים להשתמש ב-chrome.downloads API כדי להפעיל, לעקוב, לבצע פעולות על הורדות ולחפש אותן באופן פרוגרמטי.
enterprise.deviceAttributes: Chrome מגרסה 46 ואילך ב-ChromeOS בלבד נדרשת מדיניות

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

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

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

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

משתמשים ב-API של chrome.enterprise.platformKeys כדי ליצור מפתחות ולהתקין אישורים למפתחות האלה. הפלטפורמה מנהלת את האישורים, וניתן להשתמש בהם לצורך אימות TLS, גישה לרשת או על ידי תוסף אחר דרך chrome.platformKeys.
אירועים: מרחב השמות chrome.events מכיל סוגים נפוצים שמשמשים ממשקי API לשליחת אירועים כדי להודיע לכם כשמשהו מעניין קורה.
extension: ל-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).
history: שימוש ב-API של chrome.history כדי לקיים אינטראקציה עם הרשומה של הדפים שנצפו בדפדפן. אתם יכולים להוסיף כתובות URL להיסטוריה של הדפדפן, להסיר אותן ולבצע שאילתות עליהן. במאמר שינוי דפים מוסבר איך לשנות את דף ההיסטוריה לגרסה משלכם.
i18n: אפשר להשתמש בתשתית chrome.i18n כדי להטמיע תמיכה בשפות שונות בכל האפליקציה או התוסף.
זהות: שימוש ב-API של chrome.identity כדי לקבל אסימוני גישה מסוג OAuth2.
idle: שימוש ב-API של chrome.idle כדי לזהות מתי מצב ההשבתה של המכונה משתנה.
input.ime: ChromeOS בלבד

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

משתמשים ב-chrome.instanceID כדי לגשת לשירות Instance ID.
loginState: Chrome מגרסה 78 ואילך ב-ChromeOS בלבד

משתמשים ב-API של chrome.loginState כדי לקרוא את מצב ההתחברות ולעקוב אחריו.
סרטונים: ממשק ה-API של chrome.management מספק דרכים לניהול אפליקציות ותוספים מותקנים.
התראות: אפשר להשתמש ב-chrome.notifications API כדי ליצור התראות עשירות באמצעות תבניות ולהציג את ההתראות האלה למשתמשים במגש המערכת.
omnibox: באמצעות Omnibox API אפשר לרשום מילת מפתח בסרגל הכתובות של Google Chrome, שנקרא גם Omnibox.
pageAction: &leq; MV2

אפשר להשתמש ב-chrome.pageAction API כדי להוסיף סמלים לסרגל הכלים הראשי של Google Chrome, שמשמאל לסרגל הכתובות. פעולות בדף מייצגות פעולות שאפשר לבצע בדף הנוכחי, אבל הן לא רלוונטיות לכל הדפים. פעולות הדף מופיעות באפור כשהן לא פעילות.
pageCapture: שימוש ב-chrome.pageCapture API כדי לשמור כרטיסייה כקובץ MHTML.
permissions: משתמשים ב-API של chrome.permissions כדי לבקש הרשאות אופציונליות שהוצהרו בזמן הריצה ולא בזמן ההתקנה, כדי שהמשתמשים יבינו למה נדרשות ההרשאות ויעניקו רק את ההרשאות הנחוצות.
platformKeys: Chrome מגרסה 45 ואילך ב-ChromeOS בלבד

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

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

אפשר להשתמש ב-API ‏chrome.printing כדי לשלוח משימות הדפסה למדפסות שמותקנות ב-Chromebook.
printingMetrics: Chrome מגרסה 79 ואילך ChromeOS בלבד נדרש תיקון מדיניות

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

שימוש ב-chrome.processes API כדי לקיים אינטראקציה עם התהליכים של הדפדפן.
proxy: אפשר להשתמש ב-chrome.proxy API כדי לנהל את הגדרות ה-proxy של Chrome. ממשק ה-API הזה מסתמך על אב הטיפוס ChromeSetting מסוג API כדי לקבל את הגדרות שרת ה-proxy ולהגדיר אותן.
runtime: משתמשים ב-chrome.runtime API כדי לאחזר את ה-service worker, להחזיר פרטים על המניפסט ולהקשיב לאירועים במחזור החיים של התוסף ולהגיב להם. אפשר גם להשתמש ב-API הזה כדי להמיר את הנתיב היחסי של כתובות URL לכתובות URL מלאות.
search: Chrome מגרסה 87 ואילך

משתמשים ב-API של chrome.search כדי לחפש דרך ספק ברירת המחדל.
סשנים: שימוש ב-chrome.sessions API כדי לשלוח שאילתות ולשחזר כרטיסיות וחלונות מסשן דפדוף.
storage: שימוש ב-API של chrome.storage כדי לאחסן, לאחזר ולעקוב אחרי שינויים בנתוני משתמשים.
system.cpu: שימוש ב-API ‏system.cpu כדי לשלוח שאילתות למטא-נתונים של מעבדים.
system.display: שימוש ב-system.display API כדי לשלוח שאילתות לגבי מטא-נתונים של מודעות לרשת המדיה.
system.memory: ה-API של chrome.system.memory.
system.storage: משתמשים ב-chrome.system.storage API כדי לשלוח שאילתות לגבי פרטי התקן האחסון ולקבל התראות כשמחברים או מנתקים התקן אחסון נשלף.
systemLog: Chrome מגרסה 125 ואילך ב-ChromeOS בלבד נדרש תיקון מדיניות

שימוש ב-API של chrome.systemLog כדי לתעד יומני מערכת של Chrome מתוספים.
tabCapture: שימוש ב-chrome.tabCapture API כדי לקיים אינטראקציה עם שידורי מדיה בכרטיסיות.
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.
vpnProvider: Chrome מגרסה 43 ואילך ב-ChromeOS בלבד

שימוש ב-API ‏chrome.vpnProvider להטמעת לקוח VPN.
wallpaper: Chrome מגרסה 43 ואילך ב-ChromeOS בלבד

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