توفّر واجهة برمجة التطبيقات Developer Knowledge API إمكانية الوصول الآلي إلى مستندات المطوّرين العامة من Google، ما يتيح لك دمج قاعدة المعلومات هذه في تطبيقاتك وسير عملك.
نظرة عامة
تم تصميم واجهة برمجة التطبيقات Developer Knowledge API لتكون المصدر الأساسي الذي يتيح الوصول إلى مستندات المطوّرين من Google بتنسيق قابل للقراءة آليًا. توفّر هذه الأداة وظيفتَين رئيسيتَين:
SearchDocumentChunksللعثور على معرّفات الموارد الموحّدة (URI) ومقتطفات المحتوى ذات الصلة استنادًا إلى طلب بحثGetDocumentأوBatchGetDocumentsلجلب المحتوى الكامل لنتائج البحث.
للبدء بسرعة، اتّبِع دليل البدء السريع.
يتم إدراج مجموعة المحتوى القابل للبحث في مرجع مجموعة المحتوى.
ملاحظة بشأن المعاينة: يتيح هذا الإصدار التجريبي البحث عن صفحات المستندات واستردادها كمحتوى Markdown غير منظَّم.
تفعيل واجهة برمجة التطبيقات
لاستخدام Developer Knowledge API، عليك أولاً تفعيلها لمشروعك على Google Cloud.
- افتح صفحة Developer Knowledge API في مكتبة Google APIs.
- تأكَّد من اختيار المشروع الصحيح الذي تنوي استخدام واجهة برمجة التطبيقات فيه.
- انقر على تفعيل. لا تتطلّب واجهة برمجة التطبيقات أي أدوار محدّدة في "إدارة الهوية وإمكانية الوصول" لتفعيلها أو استخدامها.
المصادقة
يجب توفُّر مفتاح Developer Knowledge API لاستخدام واجهة Developer Knowledge API. لإنشاء حساب:
- في Google Cloud Console للمشروع الذي فعّلت فيه واجهة برمجة التطبيقات، انتقِل إلى صفحة "بيانات الاعتماد".
- انقر على إنشاء بيانات اعتماد، ثمّ اختَر مفتاح واجهة برمجة التطبيقات من القائمة. يعرض مربّع الحوار الخاص بمفتاح واجهة برمجة التطبيقات الذي تم إنشاؤه السلسلة الخاصة بالمفتاح الذي تم إنشاؤه حديثًا.
- انقر على تعديل مفتاح واجهة برمجة التطبيقات.
- في حقل الاسم، أدخِل اسمًا للمفتاح.
- ضمن قيود واجهة برمجة التطبيقات، اختَر تقييد المفتاح.
-
من قائمة اختيار واجهات برمجة التطبيقات، فعِّل واجهة برمجة التطبيقات Developer Knowledge API وانقر على حسنًا.
- ملاحظة: إذا فعّلت واجهة برمجة التطبيقات Developer Knowledge API للتو، قد يستغرق ظهورها في قائمة اختيار واجهات برمجة التطبيقات بعض الوقت.
- انقر على حفظ.
أدرِج مفتاح واجهة برمجة التطبيقات Developer Knowledge API هذا في طلباتك. على سبيل المثال، يجب أن تتضمّن طلبات REST
هذا المعرّف باستخدام مَعلمة طلب البحث key. يمكنك الرجوع إلى
دليل البدء السريع للاطّلاع على مثال.
المستندات المضمّنة
يُرجى الرجوع إلى مرجع مجموعة المستندات للحصول على معلومات حول المستندات التي تبحث فيها واجهة برمجة التطبيقات.
القيود المعروفة
- جودة Markdown: يتم إنشاء Markdown من مصدر HTML. قد تكون هناك بعض الاختلافات أو المشاكل في التنسيق.
- نطاق المحتوى: يتم تضمين الصفحات العلنية فقط في مرجع المجموعة. لا يتم تضمين المحتوى من مصادر أخرى، مثل GitHub أو مواقع OSS أو المدوّنات أو YouTube.