مرجع API

اکثر برنامه‌های افزودنی برای کارکرد نیاز به دسترسی به یک یا چند API برنامه‌های افزودنی Chrome دارند. این مرجع API API های موجود برای استفاده در برنامه های افزودنی را توصیف می کند و موارد استفاده نمونه را ارائه می دهد.

ویژگی های Common Extensions API

یک Extensions API شامل یک فضای نام حاوی متدها و ویژگی‌ها برای انجام کار افزونه‌ها و معمولاً، اما نه همیشه، فیلدهای مانیفست برای فایل manifest.json است. به عنوان مثال، فضای نام chrome.action به یک شیء "action" در مانیفست نیاز دارد. بسیاری از APIها نیز به مجوز در مانیفست نیاز دارند.

روش‌ها در APIهای افزونه ناهمزمان هستند، مگر اینکه خلاف آن ذکر شده باشد. متدهای ناهمزمان بلافاصله برمی گردند، بدون اینکه منتظر عملیاتی باشند که آنها را فراخوانی می کند. برای به دست آوردن نتایج این روش ها از وعده ها استفاده کنید. برای اطلاعات بیشتر، روش‌های ناهمزمان را ببینید.

APIهای برنامه افزودنی Chrome

ویژگی های دسترسی

از chrome.accessibilityFeatures API برای مدیریت ویژگی‌های دسترس‌پذیری Chrome استفاده کنید. این API برای دریافت و تنظیم ویژگی‌های دسترسی فردی به نمونه اولیه ChromeSetting از نوع API متکی است. برای دریافت وضعیت‌های ویژگی، برنامه افزودنی باید مجوز accessibilityFeatures.read را درخواست کند. برای تغییر وضعیت ویژگی، برنامه افزودنی به مجوز accessibilityFeatures.modify نیاز دارد. توجه داشته باشید که accessibilityFeatures.modify به معنای مجوز accessibilityFeatures.read نیست.

عمل
Chrome 88+ MV3+

از chrome.action API برای کنترل نماد برنامه افزودنی در نوار ابزار Google Chrome استفاده کنید.

آلارم ها

از chrome.alarms API برای برنامه‌ریزی کد برای اجرای دوره‌ای یا در زمان مشخصی در آینده استفاده کنید.

سمعی
فقط Chrome 59+ ChromeOS

chrome.audio API ارائه شده است تا به کاربران اجازه دهد اطلاعاتی درباره دستگاه‌های صوتی متصل به سیستم دریافت کرده و آن‌ها را کنترل کنند. این API در حال حاضر فقط در حالت کیوسک برای ChromeOS در دسترس است.

نشانک ها

از chrome.bookmarks API برای ایجاد، سازماندهی و دستکاری نشانک ها استفاده کنید. همچنین به گزینه Override Pages مراجعه کنید، که می توانید از آن برای ایجاد یک صفحه مدیریت نشانک سفارشی استفاده کنید.

مرور داده ها

از chrome.browsingData API برای حذف داده های مرور از نمایه محلی کاربر استفاده کنید.

Certificate Provider
فقط Chrome 46+ ChromeOS

از این API برای نمایش گواهی‌ها در پلتفرم استفاده کنید که می‌تواند از این گواهی‌ها برای احراز هویت TLS استفاده کند.

دستورات

از دستورات API برای افزودن میانبرهای صفحه کلیدی استفاده کنید که اقداماتی را در برنامه افزودنی شما فعال می کند، به عنوان مثال، اقدامی برای باز کردن عملکرد مرورگر یا ارسال فرمان به برنامه افزودنی.

تنظیمات محتوا

از chrome.contentSettings API برای تغییر تنظیماتی که کنترل می‌کنند وب‌سایت‌ها می‌توانند از ویژگی‌هایی مانند کوکی‌ها، جاوا اسکریپت و افزونه‌ها استفاده کنند استفاده کنید. به طور کلی تر، تنظیمات محتوا به شما این امکان را می دهد که رفتار Chrome را بر اساس هر سایت به جای جهانی سفارشی کنید.

منوهای context

از chrome.contextMenus API برای افزودن موارد به منوی زمینه Google Chrome استفاده کنید. می‌توانید انتخاب کنید که افزوده‌های منوی زمینه‌تان برای چه نوع شی‌هایی مانند تصاویر، پیوندها و صفحات اعمال می‌شود.

بیسکویت ها

از chrome.cookies API برای پرس و جو و اصلاح کوکی ها استفاده کنید و در صورت تغییر آنها مطلع شوید.

اشکال زدا

chrome.debugger API به عنوان یک انتقال جایگزین برای پروتکل اشکال‌زدایی از راه دور Chrome عمل می‌کند. از chrome.debugger برای اتصال به یک یا چند برگه برای تعامل شبکه ابزار، اشکال زدایی جاوا اسکریپت، جهش در DOM و CSS و موارد دیگر استفاده کنید. از ویژگی tabId {@link Debuggee} برای هدف‌یابی برگه‌ها با sendCommand و مسیریابی رویدادها توسط tabId از پاسخ‌های تماس onEvent استفاده کنید.

محتوای اعلامی

از chrome.declarativeContent API برای انجام اقداماتی بسته به محتوای یک صفحه، بدون نیاز به مجوز برای خواندن محتوای صفحه استفاده کنید.

درخواست شبکه اظهاری
Chrome 84+

chrome.declarativeNetRequest API برای مسدود کردن یا اصلاح درخواست‌های شبکه با تعیین قوانین اعلامی استفاده می‌شود. این به برنامه‌های افزودنی اجازه می‌دهد تا درخواست‌های شبکه را بدون رهگیری و مشاهده محتوای آن‌ها اصلاح کنند، بنابراین حریم خصوصی بیشتری را فراهم می‌کنند.

دسکتاپ کپچر

Desktop Capture API محتوای صفحه، پنجره های جداگانه یا برگه های جداگانه را ضبط می کند.

devtools.inspectedWindow

از chrome.devtools.inspectedWindow API برای تعامل با پنجره بازرسی شده استفاده کنید: شناسه برگه صفحه بازرسی شده را به دست آورید، کد را در زمینه پنجره بازرسی شده ارزیابی کنید، صفحه را مجدداً بارگیری کنید یا فهرست منابع موجود در صفحه را دریافت کنید.

devtools.network

از chrome.devtools.network API برای بازیابی اطلاعات مربوط به درخواست های شبکه که توسط Developer Tools در پانل شبکه نمایش داده می شود، استفاده کنید.

devtools.panels

از chrome.devtools.panels API برای ادغام برنامه افزودنی خود در رابط کاربری پنجره Developer Tools استفاده کنید: پانل های خود را ایجاد کنید، به پانل های موجود دسترسی داشته باشید و نوارهای جانبی اضافه کنید.

devtools.recorder
Chrome 105+

از chrome.devtools.recorder API برای سفارشی کردن پانل Recorder در DevTools استفاده کنید.

dns
کانال توسعه دهنده

از chrome.dns API برای وضوح dns استفاده کنید.

اسناد اسکن
Chrome 44+ فقط ChromeOS

از chrome.documentScan API برای کشف و بازیابی تصاویر از اسکنرهای اسناد پیوست شده استفاده کنید.

dom
Chrome 88+

از chrome.dom API برای دسترسی به API های DOM ویژه برای برنامه های افزودنی استفاده کنید

دانلودها

از chrome.downloads API برای شروع برنامه‌ریزی، نظارت، دستکاری و جستجوی دانلودها استفاده کنید.

enterprise.deviceAttributes
Chrome 46+ ChromeOS فقط به خط مشی نیاز دارد

از chrome.enterprise.deviceAttributes API برای خواندن ویژگی های دستگاه استفاده کنید. توجه: این API فقط برای برنامه های افزودنی که به اجبار توسط خط مشی سازمانی نصب شده اند در دسترس است.

enterprise.hardwarePlatform

از chrome.enterprise.hardwarePlatform API برای دریافت سازنده و مدل پلت فرم سخت افزاری که مرورگر در آن اجرا می شود استفاده کنید. توجه: این API فقط برای برنامه های افزودنی نصب شده توسط خط مشی سازمانی در دسترس است.

enterprise.networkingAttributes
Chrome 85+ ChromeOS فقط به خط مشی نیاز دارد

از chrome.enterprise.networkingAttributes API برای خواندن اطلاعات مربوط به شبکه فعلی خود استفاده کنید. توجه: این API فقط برای برنامه های افزودنی که به اجبار توسط خط مشی سازمانی نصب شده اند در دسترس است.

enterprise.platformKeys

از chrome.enterprise.platformKeys API برای تولید کلیدها و نصب گواهینامه برای این کلیدها استفاده کنید. گواهی‌ها توسط پلتفرم مدیریت می‌شوند و می‌توانند برای احراز هویت TLS، دسترسی به شبکه یا سایر برنامه‌های افزودنی از طریق {@link platformKeys chrome.platformKeys} استفاده شوند.

مناسبت ها

فضای نام chrome.events شامل انواع متداول است که توسط APIهایی که رویدادها را ارسال می کنند تا در صورت وقوع اتفاق جالبی به شما اطلاع دهند.

افزونه

chrome.extension API دارای ابزارهایی است که می تواند توسط هر صفحه افزونه استفاده شود. این شامل پشتیبانی برای تبادل پیام‌ها بین یک برنامه افزودنی و اسکریپت‌های محتوای آن یا بین برنامه‌های افزودنی است، همانطور که به طور مفصل در ارسال پیام توضیح داده شده است.

انواع extensions

chrome.extensionTypes API حاوی اعلان‌های نوع برای برنامه‌های افزودنی Chrome است.

fileBrowserHandler
فقط ChromeOS فقط پیش زمینه

از chrome.fileBrowserHandler API برای گسترش مرورگر فایل سیستم عامل Chrome استفاده کنید. به عنوان مثال، شما می توانید از این API برای فعال کردن کاربران برای آپلود فایل ها در وب سایت خود استفاده کنید.

fileSystemProvider
فقط ChromeOS

از chrome.fileSystemProvider API برای ایجاد سیستم های فایل استفاده کنید، که می تواند از مدیر فایل در سیستم عامل Chrome قابل دسترسی باشد.

تنظیمات فونت

از chrome.fontSettings API برای مدیریت تنظیمات فونت Chrome استفاده کنید.

gcm

از chrome.gcm برای فعال کردن برنامه‌ها و برنامه‌های افزودنی برای ارسال و دریافت پیام از طریق Firebase Cloud Messaging (FCM) استفاده کنید.

تاریخ

از chrome.history API برای تعامل با سابقه مرورگر از صفحات بازدید شده استفاده کنید. می‌توانید آدرس‌های اینترنتی را در تاریخچه مرورگر اضافه، حذف و درخواست کنید. برای لغو صفحه تاریخچه با نسخه خود، به لغو صفحات مراجعه کنید.

i18n

از زیرساخت chrome.i18n برای اجرای بین المللی سازی در کل برنامه یا برنامه افزودنی خود استفاده کنید.

هویت

از chrome.identity API برای دریافت نشانه های دسترسی OAuth2 استفاده کنید.

بیکار

از chrome.idle API برای تشخیص تغییر وضعیت بیکار دستگاه استفاده کنید.

ورودی. زمان

از chrome.input.ime API برای پیاده سازی یک IME سفارشی برای سیستم عامل Chrome استفاده کنید. این به برنامه افزودنی شما اجازه می‌دهد تا با زدن کلید، ترکیب بندی را تنظیم کرده و پنجره نامزد را مدیریت کند.

شناسه نمونه
Chrome 44+

برای دسترسی به سرویس Instance ID از chrome.instanceID استفاده کنید.

ورود به سیستم
فقط Chrome 78+ ChromeOS

از chrome.loginState API برای خواندن و نظارت بر وضعیت ورود استفاده کنید.

مدیریت

chrome.management API راه‌هایی برای مدیریت فهرست افزونه‌ها/برنامه‌هایی که نصب و اجرا شده‌اند ارائه می‌کند. مخصوصاً برای برنامه‌های افزودنی که صفحه تب جدید داخلی را لغو می‌کنند مفید است.

اطلاعیه

از chrome.notifications API برای ایجاد اعلان‌های غنی با استفاده از الگوها و نمایش این اعلان‌ها به کاربران در سینی سیستم استفاده کنید.

خارج از صفحه نمایش
Chrome 109+ MV3+

از API offscreen برای ایجاد و مدیریت اسناد خارج از صفحه استفاده کنید.

omnibox

omnibox API به شما امکان می دهد کلمه کلیدی را در نوار آدرس گوگل کروم که به omnibox نیز معروف است، ثبت کنید.

صفحه گرفتن

از chrome.pageCapture API برای ذخیره یک برگه به ​​عنوان MHTML استفاده کنید.

مجوزها

از chrome.permissions API برای درخواست مجوزهای اختیاری اعلام شده در زمان اجرا به جای زمان نصب استفاده کنید، بنابراین کاربران درک کنند که چرا به مجوزها نیاز است و فقط مجوزهای ضروری را اعطا کنند.

platformKeys
فقط Chrome 45+ ChromeOS

از chrome.platformKeys API برای دسترسی به گواهی‌های مشتری که توسط پلتفرم مدیریت می‌شوند، استفاده کنید. اگر کاربر یا خط مشی مجوز را اعطا کند، یک برنامه افزودنی می تواند از چنین گواهینامه ای در پروتکل احراز هویت سفارشی خود استفاده کند. به عنوان مثال، این امکان استفاده از گواهی‌های مدیریت‌شده پلتفرم را در VPN‌های شخص ثالث فراهم می‌کند (به {@link vpnProvider chrome.vpnProvider} مراجعه کنید).

قدرت

از chrome.power API برای نادیده گرفتن ویژگی های مدیریت انرژی سیستم استفاده کنید.

printer Provider
Chrome 44+

chrome.printerProvider API رویدادهایی را که توسط مدیر چاپ استفاده می‌شود برای جستجوی چاپگرهایی که توسط برنامه‌های افزودنی کنترل می‌شوند، برای جستجو در قابلیت‌های آنها و ارسال کارهای چاپی به این چاپگرها نشان می‌دهد.

چاپ
فقط Chrome 81+ ChromeOS

از chrome.printing API برای ارسال کارهای چاپی به چاپگرهای نصب شده در Chromebook استفاده کنید.

متریک چاپ
Chrome 79+ ChromeOS فقط به خط مشی نیاز دارد

از chrome.printingMetrics API برای واکشی داده‌های مربوط به استفاده از چاپ استفاده کنید.

حریم خصوصی

از chrome.privacy API برای کنترل استفاده از ویژگی‌هایی در Chrome استفاده کنید که می‌تواند بر حریم خصوصی کاربر تأثیر بگذارد. این API برای دریافت و تنظیم پیکربندی Chrome به نمونه اولیه ChromeSetting از نوع API متکی است.

فرآیندها
کانال توسعه دهنده

از chrome.processes API برای تعامل با فرآیندهای مرورگر استفاده کنید.

پروکسی

از chrome.proxy API برای مدیریت تنظیمات پروکسی Chrome استفاده کنید. این API برای دریافت و تنظیم پیکربندی پروکسی به نمونه اولیه ChromeSetting از نوع API متکی است.

ReadingList
Chrome 120+ MV3+

از chrome.readingList API برای خواندن و اصلاح موارد موجود در Reading List استفاده کنید.

زمان اجرا

از chrome.runtime API برای بازیابی سرویس کار، بازگرداندن جزئیات مربوط به مانیفست، و گوش دادن و پاسخ به رویدادها در چرخه عمر برنامه افزودنی استفاده کنید. شما همچنین می توانید از این API برای تبدیل مسیر نسبی URL ها به URL های کاملا واجد شرایط استفاده کنید.

اسکریپت نویسی
Chrome 88+ MV3+

از chrome.scripting API برای اجرای اسکریپت در زمینه های مختلف استفاده کنید.

جستجو کردن
Chrome 87+

از chrome.search API برای جستجو از طریق ارائه دهنده پیش فرض استفاده کنید.

جلسات

از chrome.sessions API برای پرس و جو و بازیابی برگه ها و پنجره ها از یک جلسه مرور استفاده کنید.

پنل کناری
Chrome 114+ MV3+

از chrome.sidePanel API برای میزبانی محتوا در پانل کناری مرورگر در کنار محتوای اصلی یک صفحه وب استفاده کنید.

ذخیره سازی

از chrome.storage API برای ذخیره، بازیابی و پیگیری تغییرات داده های کاربر استفاده کنید.

system.cpu

از system.cpu API برای استعلام فراداده CPU استفاده کنید.

سیستم.نمایش

از system.display API برای پرس و جو از متادیتای نمایش استفاده کنید.

حافظه سیستم

chrome.system.memory API.

سیستم.ذخیره

از chrome.system.storage API برای پرس و جو کردن اطلاعات دستگاه ذخیره سازی استفاده کنید و هنگامی که یک دستگاه ذخیره سازی قابل جابجایی متصل و جدا می شود مطلع شوید.

systemLog
Chrome 125+ ChromeOS فقط به خط مشی نیاز دارد

از chrome.systemLog API برای ضبط گزارش‌های سیستم Chrome از برنامه‌های افزودنی استفاده کنید.

tabCapture

از chrome.tabCapture API برای تعامل با جریان‌های رسانه برگه استفاده کنید.

گروه های برگه
Chrome 89+ MV3+

از chrome.tabGroups API برای تعامل با سیستم گروه بندی برگه های مرورگر استفاده کنید. شما می توانید از این API برای اصلاح و تنظیم مجدد گروه های برگه در مرورگر استفاده کنید. برای گروه‌بندی و حذف گروه‌بندی برگه‌ها، یا پرس و جو اینکه چه برگه‌هایی در گروه‌ها هستند، از chrome.tabs API استفاده کنید.

زبانه ها

از chrome.tabs API برای تعامل با سیستم برگه مرورگر استفاده کنید. شما می توانید از این API برای ایجاد، اصلاح و تنظیم مجدد برگه ها در مرورگر استفاده کنید.

سایت های برتر

از chrome.topSites API برای دسترسی به سایت های برتر (یعنی سایت های پربازدید) که در صفحه برگه جدید نمایش داده می شوند، استفاده کنید. این شامل میانبرهای سفارشی شده توسط کاربر نمی شود.

tts

از chrome.tts API برای پخش متن به گفتار (TTS) ترکیب شده استفاده کنید. همچنین به API مربوط به {@link ttsEngine} مراجعه کنید، که به یک برنامه افزودنی اجازه می‌دهد موتور گفتار را پیاده‌سازی کند.

ttsEngine

از chrome.ttsEngine API برای پیاده سازی موتور تبدیل متن به گفتار (TTS) با استفاده از افزونه استفاده کنید. اگر برنامه افزودنی شما با استفاده از این API ثبت شود، هنگامی که هر برنامه افزودنی یا برنامه Chrome از API {@link tts} برای تولید گفتار استفاده می‌کند، رویدادهایی حاوی یک گفته و پارامترهای دیگر دریافت می‌کند. پس از آن برنامه افزودنی شما می تواند از هر فناوری وب موجود برای ترکیب و خروجی گفتار استفاده کند و رویدادها را برای گزارش وضعیت به عملکرد تماس ارسال کند.

انواع

chrome.types API حاوی اعلان‌های نوع برای Chrome است.

userScripts
Chrome 120+ MV3+

از userScripts API برای اجرای اسکریپت های کاربر در زمینه User Scripts استفاده کنید.

vpnProvider
فقط Chrome 43+ ChromeOS

از chrome.vpnProvider API برای پیاده سازی یک سرویس گیرنده VPN استفاده کنید.

کاغذ دیواری
فقط Chrome 43+ ChromeOS

از chrome.wallpaper API برای تغییر کاغذدیواری ChromeOS استفاده کنید.

webAuthenticationProxy
Chrome 115+ MV3+

chrome.webAuthenticationProxy API به نرم افزار دسکتاپ راه دور که روی یک میزبان راه دور اجرا می شود اجازه می دهد تا درخواست های Web Authentication API (WebAuthn) را رهگیری کند تا آنها را در یک کلاینت محلی مدیریت کند.

وب ناوبری

از chrome.webNavigation API برای دریافت اعلان‌های مربوط به وضعیت درخواست‌های ناوبری در حین پرواز استفاده کنید.

وب درخواست

از chrome.webRequest API برای مشاهده و تجزیه و تحلیل ترافیک و رهگیری، مسدود کردن یا تغییر درخواست‌های حین پرواز استفاده کنید.

پنجره ها

از chrome.windows API برای تعامل با پنجره های مرورگر استفاده کنید. شما می توانید از این API برای ایجاد، اصلاح و تنظیم مجدد پنجره ها در مرورگر استفاده کنید.