הפניית API

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

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

תכונות נפוצות ב-Extensions API

ממשק Extensions API מורכב ממרחב שמות שמכיל שיטות ומאפיינים לביצוע עבודות שקשורות לתוספים, ובדרך כלל, אבל לא תמיד, משדות מניפסט לקובץ manifest.json. לדוגמה, מרחב השמות chrome.action דורש אובייקט "action" במניפסט. ממשקי API רבים דורשים גם הרשאות במניפסט.

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

Chrome Extension APIs

accessibilityFeatures

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

action
‫Chrome 88 ואילך MV3 ואילך

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

alarms

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

אודיו
‫Chrome 59 ואילך ChromeOS בלבד

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

bookmarks

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

browsingData

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

certificateProvider
‫Chrome 46 ואילך ChromeOS בלבד

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

פקודות

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

contentSettings

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

contextMenus

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

קובצי Cookie

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

debugger

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

declarativeContent

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

declarativeNetRequest
‫Chrome 84 ואילך

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

desktopCapture

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

devtools.inspectedWindow

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

devtools.network

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

devtools.panels

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

devtools.performance
‫Chrome 129 ואילך

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

devtools.recorder
‫Chrome 105 ואילך

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

dns
ערוץ Dev

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

documentScan
‫Chrome 44 ואילך ChromeOS בלבד

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

dom
‫Chrome 88 ואילך

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

הורדות

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

enterprise.deviceAttributes
‫Chrome 46 ואילך ‫ChromeOS בלבד נדרשת מדיניות

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

enterprise.hardwarePlatform

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

enterprise.login
‫Chrome 139+ 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

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

extensionTypes

‫chrome.extensionTypes API מכיל הצהרות על סוגים של תוספים ל-Chrome.

fileBrowserHandler
ChromeOS בלבד רק בחזית

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

fileSystemProvider
ל-ChromeOS בלבד

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

fontSettings

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

gcm

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

היסטוריה

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

i18n

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

זהות

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

idle

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

input.ime
ל-ChromeOS בלבד

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

instanceID
‫Chrome 44 ואילך

משתמשים ב-chrome.instanceID כדי לגשת לשירות Instance ID.

loginState
‫Chrome 78 ואילך ChromeOS בלבד

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

סרטונים

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

התראות

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

offscreen
‫Chrome 109 ואילך MV3 ואילך

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

סרגל הכתובות

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

pageCapture

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

הרשאות

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

platformKeys
‫Chrome 45 ואילך ChromeOS בלבד

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

power

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

printerProvider
‫Chrome 44 ואילך

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

הדפסה
‫Chrome 81 ואילך ‫ChromeOS בלבד

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

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

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

פרטיות

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

processes
ערוץ Dev

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

proxy

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

readingList
‫Chrome 120 ואילך MV3 ואילך

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

runtime

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

scripting
‫Chrome 88 ואילך MV3 ואילך

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

search
‫Chrome 87 ואילך

משתמשים ב-chrome.search API כדי לחפש דרך ספק ברירת המחדל.

סשנים

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

sidePanel
‫Chrome 114 ואילך ‫MV3 ואילך

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

אחסון

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

system.cpu

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

system.display

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

system.memory

‫chrome.system.memory API.

system.storage

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

systemLog
‫Chrome 125 ואילך ‫ChromeOS בלבד נדרשת מדיניות

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

tabCapture

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

tabGroups
‫Chrome 89 ואילך MV3 ואילך

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

כרטיסיות

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

topSites

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

tts

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

ttsEngine

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

types

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

userScripts
‫Chrome 120 ואילך MV3 ואילך

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

vpnProvider
‫Chrome 43 ואילך ChromeOS בלבד

משתמשים ב-chrome.vpnProvider API כדי להטמיע לקוח VPN.

טפט
‫Chrome 43 ואילך ChromeOS בלבד

משתמשים ב-chrome.wallpaper API כדי לשנות את הטפט ב-ChromeOS.

webAuthenticationProxy
‫Chrome 115 ואילך MV3 ואילך

ממשק ה-API של chrome.webAuthenticationProxy מאפשר לתוכנת שולחן עבודה מרוחק שפועלת במארח מרוחק ליירט בקשות של Web Authentication API ‏ (WebAuthn) כדי לטפל בהן בלקוח מקומי.

webNavigation

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

webRequest

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

Windows

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