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

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

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

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

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

يتوافق الإصدار Manifest V3 بشكل عام مع الإصدار 88 من Chrome أو الإصدارات الأحدث. بالنسبة إلى ميزات الإضافات التي تمت إضافتها في إصدارات Chrome الأحدث، يُرجى الاطّلاع على مستندات مرجعية لواجهة برمجة التطبيقات للحصول على معلومات حول مدى توفّر الدعم. إذا كانت الإضافة تتطلّب واجهة برمجة تطبيقات معيّنة، يمكنك تحديد الحد الأدنى لإصدار Chrome في ملف البيان.

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

accessibilityFeatures

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

الإجراء

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

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

alarms

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

audio

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

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

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

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

browsingData

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

certificateProvider

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

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

أوامر

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

contentSettings

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

contextMenus

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

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

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

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

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

declarativeContent

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

declarativeNetRequest

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

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

desktopCapture

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

devtools.inspectedWindow

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

devtools.network

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

devtools.panels

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

devtools.performance

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

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

devtools.recorder

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

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

dns

قناة مطوري البرامج

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

documentScan

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

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

دوم

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

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

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

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

enterprise.deviceAttributes

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

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

‫enterprise.hardwarePlatform

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

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

enterprise.networkingAttributes

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

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

enterprise.platformKeys

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

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

الأحداث

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

الإضافة

تحتوي واجهة برمجة التطبيقات 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.

غير نشِط لفترة قصيرة

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

input.ime

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

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

instanceID

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

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

loginState

الإصدار 78 من Chrome أو الإصدارات الأحدث نظام التشغيل 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 للوصول إلى شهادات العميل التي يديرها النظام الأساسي. إذا منح المستخدم أو السياسة الإذن، يمكن للإضافة استخدام هذه الشهادة في بروتوكول المصادقة المخصّص. مثلاً: ويسمح هذا باستخدام الشهادات المُدارة من قِبل النظام الأساسي في الشبكات الافتراضية الخاصة التابعة لجهات خارجية (يُرجى الاطّلاع على chrome.vpnProvider).

قوة

استخدِم واجهة برمجة التطبيقات 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

الإصدار 120 من Chrome أو الإصدارات الأحدث MV3+

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

runtime

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

النصوص البرمجية

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

استخدِم واجهة برمجة التطبيقات 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 للاستعلام عن معلومات جهاز التخزين وتلقّي إشعارات عند توصيل جهاز تخزين قابل للإزالة وفصله.

systemLog

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

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

tabCapture

يمكنك استخدام chrome.tabCapture API للتفاعل مع ساحة مشاركات الوسائط لعلامات التبويب.

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

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

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

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

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

topSites

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

تحويل النص إلى كلام

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

ttsEngine

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

types

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

userScripts

الإصدار 120 من Chrome أو الإصدارات الأحدث MV3+

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

vpnProvider

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

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

خلفية

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

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

webAuthenticationProxy

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

تسمح واجهة برمجة التطبيقات chrome.webAuthenticationProxy لبرامج سطح المكتب البعيد التي تعمل على مضيف بعيد باعتراض طلبات Web Authentication API (WebAuthn) للتعامل معها على جهاز عميل محلي.

webNavigation

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

webRequest

استخدِم chrome.webRequest API لرصد الزيارات وتحليلها واعتراض الطلبات أثناء تشغيلها أو حظرها أو تعديلها.

windows

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