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