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

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

الميزات الشائعة لواجهة برمجة التطبيقات للإضافات

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

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

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

accessibilityFeatures

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

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

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

المنبّهات

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

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

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

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

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

browsingData

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

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

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

أوامر

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

contentSettings

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

contextMenus

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

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

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

برنامج تصحيح الأخطاء

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

declarativeContent

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

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
في انتظار المراجعة

استخدِم chrome.devtools.performance API للاستماع إلى تعديلات حالة التسجيل في لوحة "الأداء" ضمن "أدوات مطوري البرامج".

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

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

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

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

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

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

دوم
الإصدار 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 لتوسيع متصفّح الملفات في نظام التشغيل Chrome. على سبيل المثال، يمكنك استخدام واجهة برمجة التطبيقات هذه لتمكين المستخدمين من تحميل الملفات إلى موقعك الإلكتروني.

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

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

fontSettings

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

gcm

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

السجلّ

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

i18n

استخدِم البنية الأساسية لـ "chrome.i18n" لنشر المحتوى على نطاق عالمي على مستوى التطبيق أو الإضافة بالكامل.

الهوية

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

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

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

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

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

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

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

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

يمكنك استخدام chrome.loginState API للاطّلاع على حالة تسجيل الدخول وتتبُّعها.

الفيديوهات

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

الإشعارات

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

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

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

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

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

pageCapture

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

الأذونات

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

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

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

قوة

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

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

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

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

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

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

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

الخصوصية

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

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

استخدِم chrome.processes API للتفاعل مع عمليات المتصفِّح.

الخادم الوكيل

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

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

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

وقت التشغيل

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

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

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

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

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

الجلسات

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

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

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

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

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

system.cpu

يمكنك استخدام واجهة برمجة التطبيقات system.cpu لطلب البحث عن البيانات الوصفية لوحدة المعالجة المركزية (CPU).

system.display

استخدِم system.display API لطلب البحث عن البيانات الوصفية المعروضة.

system.memory

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

system.storage

يمكنك استخدام واجهة برمجة التطبيقات chrome.system.storage للاستعلام عن معلومات جهاز التخزين وتلقّي إشعارات عند توصيل جهاز تخزين قابل للإزالة وفصله.

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

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

tabCapture

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

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

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

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

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

topSites

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

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

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

ttsEngine

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

الأنواع

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

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

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

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

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

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

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

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

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

webNavigation

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

webRequest

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

نوافذ

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