مرجع واجهة برمجة التطبيقات

تحتاج معظم الإضافات إلى الوصول إلى واجهة برمجة تطبيقات واحدة أو أكثر من واجهات برمجة تطبيقات إضافات Chrome لكي تعمل. يوضّح مرجع واجهات برمجة التطبيقات هذا واجهات برمجة التطبيقات المتاحة للاستخدام في الإضافات، ويقدّم أمثلة على حالات الاستخدام.

الميزات الشائعة لواجهة برمجة التطبيقات Extensions API

تتألّف Extensions API من مساحة اسم تحتوي على طرق وخصائص لتنفيذ عمل الإضافات، وعادةً ما تتضمّن حقول بيان لملف manifest.json، ولكن ليس دائمًا. على سبيل المثال، تتطلّب مساحة الاسم chrome.action عنصر "action" في البيان. تتطلّب العديد من واجهات برمجة التطبيقات أيضًا أذونات في البيان.

تكون الطرق في واجهات برمجة التطبيقات الخاصة بالإضافات غير متزامنة ما لم يُذكر خلاف ذلك. يتم عرض الطُرق غير المتزامنة على الفور، بدون انتظار اكتمال العملية التي تستدعيها. استخدِم التعهدات للحصول على نتائج هذه الطرق غير المتزامنة.

واجهات برمجة تطبيقات إضافات Chrome

accessibilityFeatures

يمكنك استخدام واجهة برمجة التطبيقات chrome.accessibilityFeatures لإدارة ميزات تسهيل الاستخدام في Chrome. تعتمد واجهة برمجة التطبيقات هذه على نموذج ChromeSetting من النوع API للحصول على ميزات تسهيل الاستخدام الفردية وضبطها. للحصول على حالات الميزات، يجب أن تطلب الإضافة إذن accessibilityFeatures.read. لتعديل حالة الميزة، تحتاج الإضافة إلى إذن accessibilityFeatures.modify. يُرجى العلم أنّ الإذن accessibilityFeatures.modify لا يشير إلى الإذن accessibilityFeatures.read.

الإجراء
الإصدار 88 من Chrome والإصدارات الأحدث الإصدار 3 من MV والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات chrome.action للتحكّم في رمز الإضافة في شريط أدوات Google Chrome.

alarms

استخدِم واجهة برمجة التطبيقات chrome.alarms لجدولة تنفيذ الرمز بشكل دوري أو في وقت محدّد في المستقبل.

audio
Chrome 59 والإصدارات الأحدث نظام التشغيل ChromeOS فقط

يتم توفير واجهة برمجة التطبيقات chrome.audio للسماح للمستخدمين بالحصول على معلومات عن أجهزة الصوت المُرفَقة بالنظام والتحكّم فيها. لا تتوفّر واجهة برمجة التطبيقات هذه حاليًا إلا في وضع Kiosk لنظام التشغيل ChromeOS.

الإشارات المرجعية

استخدِم واجهة برمجة التطبيقات chrome.bookmarks لإنشاء الإشارات المرجعية وتنظيمها ومعالجتها بأي شكل آخر. اطّلِع أيضًا على صفحات الإلغاء التي يمكنك استخدامها لإنشاء صفحة مخصّصة في "مدير الإشارات المرجعية".

browsingData

استخدِم واجهة برمجة التطبيقات chrome.browsingData لإزالة بيانات التصفّح من الملف الشخصي للمستخدم على الجهاز.

certificateProvider
Chrome 46 والإصدارات الأحدث نظام التشغيل ChromeOS فقط

استخدِم واجهة برمجة التطبيقات هذه لعرض الشهادات على النظام الأساسي الذي يمكنه استخدام هذه الشهادات لمصادقات بروتوكول أمان طبقة النقل (TLS).

الطلبات

استخدِم واجهة برمجة التطبيقات Commands API لإضافة اختصارات لوحة مفاتيح تؤدي إلى تنفيذ إجراءات في الإضافة، مثل إجراء لفتح إجراء المتصفّح أو إرسال أمر إلى الإضافة.

contentSettings

استخدِم واجهة برمجة التطبيقات chrome.contentSettings لتغيير الإعدادات التي تتحكّم في إمكانية استخدام المواقع الإلكترونية لميزات مثل ملفات تعريف الارتباط وجافا سكريبت والمكونات الإضافية. بشكل عام، تتيح لك إعدادات المحتوى تخصيص سلوك Chrome على أساس كل موقع إلكتروني بدلاً من مستوى الحساب.

contextMenus

استخدِم واجهة برمجة التطبيقات chrome.contextMenus لإضافة عناصر إلى قائمة السياق في Google Chrome. يمكنك اختيار أنواع العناصر التي تنطبق عليها إضافات قائمة السياقات، مثل الصور والروابط الفائقة والصفحات.

ملفات تعريف الارتباط

استخدِم واجهة برمجة التطبيقات chrome.cookies API لطلب ملفات تعريف الارتباط وتعديلها، وللحصول على إشعارات عند تغييرها.

أداة تصحيح الأخطاء

تُستخدَم واجهة برمجة التطبيقات chrome.debugger كطريقة نقل بديلة لبروتوكول تصحيح الأخطاء عن بُعد في Chrome. استخدِم chrome.debugger للربط بعلامة تبويب واحدة أو أكثر لتسجيل التفاعل مع الشبكة وتصحيح أخطاء JavaScript وتغيير DOM وCSS وغير ذلك. استخدِم السمة Debuggee tabId لاستهداف علامات التبويب باستخدام sendCommand وتوجيه الأحداث حسب tabId من عمليات الاستدعاء onEvent.

declarativeContent

استخدام واجهة برمجة التطبيقات chrome.declarativeContent لاتّخاذ إجراءات استنادًا إلى محتوى الصفحة، بدون الحاجة إلى إذن لقراءة محتوى الصفحة

declarativeNetRequest
الإصدار 84 من Chrome والإصدارات الأحدث

تُستخدَم واجهة برمجة التطبيقات chrome.declarativeNetRequest لحظر طلبات الشبكة أو تعديلها من خلال تحديد قواعد وصفية. يتيح ذلك للإضافة تعديل طلبات الشبكة بدون اعتراضها وعرض محتواها، ما يضمن المزيد من الخصوصية.

desktopCapture

تلتقط Desktop Capture API محتوى الشاشة أو النوافذ الفردية أو علامات التبويب الفردية.

devtools.inspectedWindow

استخدِم واجهة برمجة التطبيقات chrome.devtools.inspectedWindow للتفاعل مع النافذة التي يتم فحصها: الحصول على رقم تعريف علامة التبويب للصفحة التي يتم فحصها، أو تقييم الرمز في سياق النافذة التي يتم فحصها، أو إعادة تحميل الصفحة، أو الحصول على قائمة الموارد ضمن الصفحة.

devtools.network

استخدِم واجهة برمجة التطبيقات chrome.devtools.network لاسترداد المعلومات حول طلبات الشبكة التي تعرضها "أدوات المطوّرين" في لوحة "الشبكة".

devtools.panels

استخدِم واجهة برمجة التطبيقات chrome.devtools.panels API لدمج إضافتك في واجهة مستخدم نافذة "أدوات المطوّرين": أنشئ لوحاتك الخاصة، ويمكنك الوصول إلى اللوحات الحالية وإضافة أشرطة جانبية.

devtools.performance
Chrome 129 والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات chrome.devtools.performance للاطّلاع على آخر المعلومات المتعلّقة بحالة التسجيل في لوحة "الأداء" في "أدوات مطوّري البرامج".

devtools.recorder
الإصدار 105 من Chrome والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات chrome.devtools.recorder لتخصيص لوحة "المسجّلة الذكية" في "أدوات المطوّرين".

dns
قناة المطوّرين

استخدِم واجهة برمجة التطبيقات chrome.dns لحلّ عناوين نظام أسماء النطاقات.

documentScan
Chrome 44 والإصدارات الأحدث نظام التشغيل ChromeOS فقط

استخدِم واجهة برمجة التطبيقات chrome.documentScan API لاكتشاف الصور واستردادها من الماسحات الضوئية للمستندات المرفقة.

dom
الإصدار 88 من Chrome والإصدارات الأحدث

استخدام واجهة برمجة التطبيقات chrome.dom للوصول إلى واجهات برمجة تطبيقات DOM الخاصة بالإضافات

عمليات التنزيل

استخدِم واجهة برمجة التطبيقات chrome.downloads لبدء عمليات التنزيل ومراقبتها ومعالجتها والبحث عنها بشكل آلي.

enterprise.deviceAttributes
الإصدار 46 من Chrome والإصدارات الأحدث نظام التشغيل ChromeOS فقط يتطلب السياسة

استخدِم واجهة برمجة التطبيقات chrome.enterprise.deviceAttributes لقراءة سمات الجهاز. ملاحظة: لا تتوفّر واجهة برمجة التطبيقات هذه إلا للإضافات التي فرضت المؤسسة تثبيتها حسب السياسة.

enterprise.hardwarePlatform
الإصدار 71 من Chrome والإصدارات الأحدث يتطلب سياسة

استخدِم واجهة برمجة التطبيقات chrome.enterprise.hardwarePlatform للحصول على الشركة المصنّعة وطراز النظام الأساسي للأجهزة التي يعمل عليها المتصفّح. ملاحظة: لا تتوفّر واجهة برمجة التطبيقات هذه إلا للإضافات التي تم تثبيتها بموجب سياسة المؤسسة.

enterprise.login
في انتظار المراجعة نظام التشغيل ChromeOS فقط يتطلب سياسة

استخدِم واجهة برمجة التطبيقات chrome.enterprise.login للخروج من جلسات الضيف المُدارة. ملاحظة: لا تتوفّر واجهة برمجة التطبيقات هذه إلا للإضافات التي تم تثبيتها بموجب سياسة المؤسسة في جلسات الضيف المُدارة على ChromeOS.

enterprise.networkingAttributes
الإصدار 85 من Chrome والإصدارات الأحدث نظام التشغيل ChromeOS فقط يتطلب السياسة

استخدِم واجهة برمجة التطبيقات chrome.enterprise.networkingAttributes لقراءة معلومات عن شبكتك الحالية. ملاحظة: لا تتوفّر واجهة برمجة التطبيقات هذه إلا للإضافات التي فرضت المؤسسة تثبيتها حسب السياسة.

enterprise.platformKeys
نظام التشغيل ChromeOS فقط يتطلب سياسة

استخدِم واجهة برمجة التطبيقات chrome.enterprise.platformKeys لإنشاء مفاتيح وتثبيت شهادات لهذه المفاتيح. ستدير المنصة الشهادات ويمكن استخدامها لمصادقة بروتوكول أمان طبقة النقل (TLS) أو الوصول إلى الشبكة أو من خلال إضافة أخرى من خلال chrome.platformKeys.

الأحداث

تحتوي مساحة الاسم chrome.events على أنواع شائعة تستخدمها واجهات برمجة التطبيقات لإرسال الأحداث لإعلامك عند حدوث أمر مثير للاهتمام.

extension

تحتوي واجهة برمجة التطبيقات chrome.extension على أدوات يمكن لأي صفحة إضافة استخدامها. ويشمل ذلك إمكانية تبادل الرسائل بين إضافة والنصوص البرمجية لمحتوى الإضافة أو بين الإضافات، كما هو موضّح بالتفصيل في إرسال الرسائل.

extensionTypes

تحتوي واجهة برمجة التطبيقات chrome.extensionTypes على بيانات أنواع إضافات Chrome.

fileBrowserHandler
نظام التشغيل ChromeOS فقط المقدّمة فقط

استخدِم واجهة برمجة التطبيقات chrome.fileBrowserHandler لتوسيع نطاق متصفّح ملفات ChromeOS. على سبيل المثال، يمكنك استخدام واجهة برمجة التطبيقات هذه للسماح للمستخدمين بتحميل الملفات إلى موقعك الإلكتروني.

fileSystemProvider
نظام التشغيل ChromeOS فقط

استخدِم واجهة برمجة التطبيقات chrome.fileSystemProvider لإنشاء أنظمة ملفات يمكن الوصول إليها من مدير الملفات على نظام التشغيل ChromeOS.

fontSettings

استخدِم واجهة برمجة التطبيقات chrome.fontSettings لإدارة إعدادات الخطوط في Chrome.

gcm

استخدِم chrome.gcm لتفعيل التطبيقات والإضافات لإرسال الرسائل واستلامها من خلال خدمة المراسلة عبر السحابة الإلكترونية من Firebase (FCM).

السجلّ

استخدِم واجهة برمجة التطبيقات chrome.history للتفاعل مع سجلّ المتصفّح للصفحات التي تمت زيارتها. يمكنك إضافة عناوين URL وإزالتها والبحث عنها في سجلّ المتصفّح. لإلغاء صفحة السجلّ باستخدام نسختك الخاصة، اطّلِع على إلغاء الصفحات.

i18n

استخدِم بنية chrome.i18n الأساسية لتنفيذ ميزة الترجمة والتعريب في تطبيقك أو إضافتك بالكامل.

identity

استخدِم واجهة برمجة التطبيقات chrome.identity للحصول على الرموز المميّزة للوصول إلى OAuth2.

idle

استخدِم واجهة برمجة التطبيقات chrome.idle API لرصد حالات تغيير حالة الجهاز في وضع السكون.

input.ime
نظام التشغيل ChromeOS فقط

استخدِم واجهة برمجة التطبيقات chrome.input.ime لتطبيق ميزة IME مخصّصة لنظام التشغيل ChromeOS. يتيح ذلك للإضافات معالجة ضغطات المفاتيح وضبط التركيب وإدارة نافذة المرشح.

instanceID
Chrome 44 والإصدارات الأحدث

استخدِم chrome.instanceID للوصول إلى خدمة "رقم تعريف المثيل".

loginState
Chrome 78 والإصدارات الأحدث نظام التشغيل ChromeOS فقط

استخدِم واجهة برمجة التطبيقات chrome.loginState لقراءة حالة تسجيل الدخول ومراقبتها.

الفيديوهات

توفّر واجهة برمجة التطبيقات chrome.management طرقًا لإدارة التطبيقات والإضافات المثبَّتة.

الإشعارات

استخدِم واجهة برمجة التطبيقات chrome.notifications لإنشاء إشعارات غنية باستخدام النماذج وعرض هذه الإشعارات للمستخدمين في علبة النظام.

خارج الشاشة
الإصدار 109 من Chrome والإصدارات الأحدث الإصدار 3 من MV والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات offscreen لإنشاء المستندات التي لا تظهر على الشاشة وإدارتها.

المربّع المتعدّد الاستخدامات

تتيح لك واجهة برمجة التطبيقات للمربّع المتعدّد الاستخدامات تسجيل كلمة رئيسية في شريط العناوين في Google Chrome، والذي يُعرف أيضًا باسم المربّع المتعدّد الاستخدامات.

pageCapture

استخدِم واجهة برمجة التطبيقات chrome.pageCapture لحفظ علامة تبويب بتنسيق MHTML.

الأذونات

استخدِم واجهة برمجة تطبيقات chrome.permissions لطلب الأذونات الاختيارية المعلَن عنها في وقت التشغيل بدلاً من وقت التثبيت، حتى يفهم المستخدمون سبب الحاجة إلى الأذونات ولا يمنحون سوى الأذونات الضرورية.

platformKeys
الإصدار 45 من Chrome والإصدارات الأحدث نظام التشغيل ChromeOS فقط

استخدِم واجهة برمجة التطبيقات chrome.platformKeys للوصول إلى شهادات العميل التي يديرها النظام الأساسي. إذا منح المستخدم أو السياسة الإذن، يمكن للإضافة استخدام هذه الشهادة في بروتوكول المصادقة المخصّص. على سبيل المثال، يسمح هذا باستخدام الشهادات المُدارة من النظام الأساسي في شبكات VPN التابعة لجهات خارجية (راجِع chrome.vpnProvider).

power

استخدِم واجهة برمجة التطبيقات chrome.power لإلغاء ميزات إدارة الطاقة في النظام.

printerProvider
Chrome 44 والإصدارات الأحدث

تعرِض واجهة برمجة التطبيقات chrome.printerProvider الأحداث التي يستخدمها مدير الطباعة للبحث عن الطابعات التي تتحكّم فيها الإضافات، وللبحث عن إمكاناتها وإرسال مهام الطباعة إلى هذه الطابعات.

الطباعة
الإصدار 81 من Chrome والإصدارات الأحدث نظام التشغيل ChromeOS فقط

استخدِم واجهة برمجة التطبيقات chrome.printing لإرسال مهام الطباعة إلى الطابعات المثبَّتة على جهاز Chromebook.

printingMetrics
الإصدار 79 من Chrome والإصدارات الأحدث نظام التشغيل ChromeOS فقط يتطلب سياسة

استخدِم واجهة برمجة التطبيقات chrome.printingMetrics لعرض بيانات عن استخدام الطباعة.

الخصوصية

استخدِم واجهة برمجة التطبيقات chrome.privacy للتحكّم في استخدام الميزات في Chrome التي يمكن أن تؤثّر في خصوصية المستخدم. تعتمد واجهة برمجة التطبيقات هذه على نموذج ChromeSetting من النوع API للحصول على إعدادات Chrome وضبطها.

العمليات
قناة المطوّرين

استخدِم واجهة برمجة التطبيقات chrome.processes للتفاعل مع عمليات المتصفّح.

proxy

استخدِم واجهة برمجة التطبيقات chrome.proxy لإدارة إعدادات الخادم الوكيل في Chrome. تعتمد واجهة برمجة التطبيقات هذه على نموذج ChromeSetting من النوع API للحصول على إعدادات الخادم الوكيل وضبطها.

readingList
Chrome 120 والإصدارات الأحدث MV3 والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات chrome.readingList API للقراءة من العناصر في قائمة القراءة وتعديلها.

وقت التشغيل

استخدِم واجهة برمجة التطبيقات chrome.runtime لاسترداد عامل الخدمة وعرض تفاصيل عن البيان والاستماع إلى الأحداث في دورة حياة الإضافة والاستجابة لها. يمكنك أيضًا استخدام واجهة برمجة التطبيقات هذه لتحويل المسار النسبي لعناوين URL إلى عناوين URL مؤهَّلة بالكامل.

كتابة النصوص البرمجية
الإصدار 88 من Chrome والإصدارات الأحدث الإصدار 3 من MV والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات chrome.scripting لتنفيذ النص البرمجي في سياقات مختلفة.

search
الإصدار 87 من Chrome والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات chrome.search للبحث من خلال مقدّم الخدمة التلقائي.

الجلسات

استخدِم واجهة برمجة التطبيقات chrome.sessions لطلب استرداد علامات التبويب والنوافذ من جلسة تصفّح.

sidePanel
الإصدار 114 من Chrome والإصدارات الأحدث الإصدار 3 من MV والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات chrome.sidePanel لاستضافة المحتوى في اللوحة الجانبية للمتصفّح إلى جانب المحتوى الرئيسي لصفحة الويب.

مساحة التخزين

استخدِم واجهة برمجة التطبيقات chrome.storage لتخزين بيانات المستخدمين واستردادها وتتبُّع التغييرات التي تطرأ عليها.

system.cpu

استخدِم system.cpu API لطلب البحث عن بيانات التعريف لوحدة المعالجة المركزية.

system.display

استخدِم واجهة برمجة التطبيقات system.display لطلب البيانات الوصفية المعروضة.

system.memory

واجهة برمجة التطبيقات chrome.system.memory

system.storage

استخدِم واجهة برمجة التطبيقات chrome.system.storage API لطلب معلومات عن جهاز التخزين والحصول على إشعار عند ربط جهاز تخزين قابل للإزالة أو فصله.

systemLog
الإصدار 125 من Chrome والإصدارات الأحدث نظام التشغيل ChromeOS فقط يتطلب السياسة

استخدام واجهة برمجة التطبيقات chrome.systemLog لتسجيل سجلّات نظام Chrome من الإضافات

tabCapture

استخدِم واجهة برمجة التطبيقات chrome.tabCapture للتفاعل مع أحداث بث الوسائط في علامات التبويب.

tabGroups
الإصدار 89 من Chrome والإصدارات الأحدث الإصدار 3 من MV والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات chrome.tabGroups للتفاعل مع نظام تجميع علامات التبويب في المتصفّح. يمكنك استخدام واجهة برمجة التطبيقات هذه لتعديل مجموعات علامات التبويب وإعادة ترتيبها في المتصفّح. لتجميع علامات التبويب وإلغاء تجميعها أو للاستعلام عن علامات التبويب المضمّنة في المجموعات، استخدِم واجهة برمجة التطبيقات chrome.tabs.

علامات التبويب

استخدِم واجهة برمجة التطبيقات chrome.tabs للتفاعل مع نظام علامات التبويب في المتصفّح. يمكنك استخدام واجهة برمجة التطبيقات هذه لإنشاء علامات التبويب وتعديلها وإعادة ترتيبها في المتصفّح.

topSites

استخدِم واجهة برمجة التطبيقات chrome.topSites للوصول إلى أهم المواقع الإلكترونية (أي المواقع الأكثر زيارة) التي يتم عرضها في صفحة علامة التبويب الجديدة. ولا تشمل هذه الاختصارات الاختصارات التي تخصّصها أنت.

tts

استخدِم واجهة chrome.tts API لتشغيل ميزة تحويل النص إلى كلام (TTS). اطّلِع أيضًا على واجهة برمجة التطبيقات ذات الصلة ttsEngine، والتي تسمح للإضافة بتنفيذ محرّك معالجة الكلام.

ttsEngine

استخدِم واجهة برمجة التطبيقات chrome.ttsEngine لتطبيق محرّك تحويل النص إلى كلام باستخدام إضافة. إذا سجّلت إضافة Chrome باستخدام واجهة برمجة التطبيقات هذه، ستتلقّى أحداثًا تحتوي على عبارة سيتم نطقها ومَعلمات أخرى عندما تستخدم أي إضافة أو تطبيق Chrome واجهة برمجة التطبيقات tts لإنشاء الكلام. يمكن أن تستخدم الإضافة بعد ذلك أي تقنية ويب متاحة لتجميع الكلام وإخراجه، وإرسال الأحداث مرة أخرى إلى وظيفة الاتصال للإبلاغ عن الحالة.

types

تحتوي واجهة برمجة التطبيقات chrome.types على بيانات أنواع لتطبيق Chrome.

userScripts
Chrome 120 والإصدارات الأحدث MV3 والإصدارات الأحدث

استخدِم واجهة برمجة التطبيقات userScripts لتشغيل النصوص البرمجية للمستخدمين في سياق "النصوص البرمجية للمستخدمين".

vpnProvider
Chrome 43 والإصدارات الأحدث نظام التشغيل ChromeOS فقط

استخدام واجهة برمجة التطبيقات chrome.vpnProvider لتنفيذ برنامج شبكة VPN

خلفية
Chrome 43 والإصدارات الأحدث نظام التشغيل ChromeOS فقط

استخدِم واجهة برمجة التطبيقات chrome.wallpaper لتغيير خلفية ChromeOS.

webAuthenticationProxy
Chrome 115 والإصدارات الأحدث MV3 والإصدارات الأحدث

تتيح واجهة برمجة التطبيقات chrome.webAuthenticationProxy لبرنامج "الوصول إلى الكمبيوتر المكتبي عن بُعد" الذي يعمل على مضيف بعيد اعتراض طلبات Web Authentication API (WebAuthn) من أجل معالجتها على جهاز كمبيوتر محلي.

webNavigation

استخدِم واجهة برمجة التطبيقات chrome.webNavigation لتلقّي إشعارات بشأن حالة طلبات التنقّل أثناء معالجتها.

webRequest

استخدِم واجهة برمجة التطبيقات chrome.webRequest لمراقبة عدد الزيارات وتحليلها واعتراض الطلبات أو حظرها أو تعديلها أثناء إرسالها.

windows

استخدِم واجهة برمجة التطبيقات chrome.windows للتفاعل مع نوافذ المتصفّح. يمكنك استخدام واجهة برمجة التطبيقات هذه لإنشاء النوافذ وتعديلها وإعادة ترتيبها في المتصفّح.