البحث عن Google APIs واختيارها

1. قبل البدء

يوضّح لك هذا الدرس التطبيقي كيفية البحث عن واجهات Google API واختيارها، وعرض مقاييس واجهة برمجة التطبيقات.

المتطلبات الأساسية

  • القدرة على التنقّل في Google Cloud Console

أهداف الدورة التعليمية

  • كيفية البحث عن واجهات برمجة التطبيقات واختيارها باستخدام مكتبة Google Cloud API ومساحة بروتوكول OAuth 2.0
  • كيفية عرض مقاييس واجهة برمجة التطبيقات باستخدام "أداة استكشاف المقاييس" وCloud APIs & Services.

المتطلبات

2. الوصول إلى واجهات برمجة التطبيقات من Cloud Console

  1. في Cloud Console، اختَر 5854836f11d5d97b.png قائمة التنقّل > واجهات برمجة التطبيقات والخدمات > واجهات برمجة التطبيقات والخدمات المفعّلة.

قائمة التنقّل في Cloud Console تعرض

  1. في لوحة بيانات واجهات برمجة التطبيقات والخدمات، انقر على تفعيل واجهات برمجة التطبيقات والخدمات للاطّلاع على واجهات برمجة التطبيقات المتاحة.

لوحة بيانات "واجهات برمجة التطبيقات والخدمات" التي تعرض خيار "تفعيل واجهات برمجة التطبيقات والخدمات"

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

قائمة بواجهات برمجة التطبيقات الناتجة من حقل "البحث عن واجهات برمجة التطبيقات والخدمات"

  1. في قائمة الفئة، اختَر تعلُّم الآلة لكي تظهر لك واجهات برمجة التطبيقات الخاصة بتعلُّم الآلة فقط.

واجهات برمجة التطبيقات التي تمّت فلترتها حسب CATEGORY لعرض واجهات برمجة تطبيقات تعلُّم الآلة فقط

  1. من واجهات برمجة التطبيقات الخاصة بتعلُّم الآلة، اختَر Cloud Natural Language API للاطّلاع على تفاصيل حول هذه الواجهة.
  2. انقر على تفعيل لتفعيل واجهة برمجة التطبيقات هذه في المشروع المناسب.

لوحة Cloud Natural Language API التي تعرض الزرَّين "تفعيل" و"تجربة واجهة برمجة التطبيقات هذه"

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

صفحة "نظرة عامة" لواجهة برمجة التطبيقات المحدّدة التي تعرض مقاييس واجهة برمجة التطبيقات

في درس تطبيقي حول الترميز مستقبلي، ستتعرّف على المزيد من المعلومات حول كيفية إنشاء بيانات الاعتماد، ولكن إذا كنت مهتمًا الآن، انقر على إنشاء بيانات الاعتماد ثم أجب عن الأسئلة المعروضة.

  1. انقر على إدارة للرجوع إلى النظرة العامة في الخطوة السابقة.

صفحة النظرة العامة على Cloud Natural Language API

  1. لتجربة واجهة برمجة التطبيقات (حتى قبل تفعيلها)، انقر على تجربة واجهة برمجة التطبيقات هذه.

سينقلك هذا عادةً إلى صفحة في مستندات واجهة برمجة التطبيقات. ومع ذلك، لا تتوفّر طريقة فورية لتجربة بعض واجهات برمجة التطبيقات لأنّها تتضمّن العديد من الطرق المختلفة. وينطبق ذلك على Cloud Natural Language API.

صفحة مرجع Cloud Natural Language API

  1. اختَر طريقة analyzeEntitites.

ستظهر لك صفحة ويب تتضمّن تفاصيل حول طرق واجهة برمجة التطبيقات ولوحة تجربة واجهة برمجة التطبيقات هذه.

صفحة طريقة analyzeEntities تعرض تفاصيل الطريقة ولوحة "تجربة واجهة برمجة التطبيقات هذه".

  1. لتجربة نموذج طلب بحث، أضِف عنصر document إلى الحقل نص الطلب مع هذه المَعلمات. انقر على الرموز + لتوسيع خيارات الحقل.
  2. في الحقل content:، أدخِل النص المطلوب تحليله.

يستخدم هذا المثال Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.

  1. في الحقل type:، اختَر PLAIN_TEXT.

يجب أن يبدو نص الطلب على النحو التالي:

جزء نص الطلب الذي يعرض مَعلمات نص الطلب

لمزيد من المعلومات عن كل مَعلمة، يُرجى الرجوع إلى المستندات.

  1. أزِل العلامة من مربّع الاختيار Google OAuth 2.0، ثم انقر على تنفيذ للحصول على ردّ يتضمّن تفاصيل حول الكيانات.

الردّ 200 مع تفاصيل حول الكيانات

  1. أزِل العلامة من مربّع الاختيار مفتاح واجهة برمجة التطبيقات، ثم انقر على تنفيذ مرة أخرى.

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

الردّ 403 على طلب لا يتضمّن بيانات اعتماد

  1. ضَع علامة في مربّع الاختيار Google OAuth 2.0، ثم انقر على تنفيذ مرة أخرى.

يوفّر OAuth 2.0 أذونات واجهة برمجة التطبيقات في حسابك ويعرض لك تحذيرًا.

تحذير بشأن بروتوكول OAuth 2.0 يفيد بأنّ "مستكشف Google APIs" يريد الوصول إلى حسابك على Google

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

3- عرض مقاييس واجهة برمجة التطبيقات باستخدام "أداة استكشاف المقاييس"

يمكنك الاطّلاع على سجلّ الطلبات لأي واجهة برمجة تطبيقات فردية من صفحة "نظرة عامة على واجهة برمجة التطبيقات"، كما هو موضّح في الخطوة 6 من مقالة الوصول إلى واجهات برمجة التطبيقات من Cloud Console. ومع ذلك، للاطّلاع على المزيد من المقاييس لجميع استخدامات واجهة برمجة التطبيقات، استخدِم "مستكشف المقاييس".

  1. في قسم العمليات ضمن f6b6844bf5688982.png قائمة التنقّل، انقر على المراقبة > مستكشف المقاييس.

قسم "العمليات" في قائمة التنقّل الذي يعرض خيارات "مستكشف المراقبة والمقاييس" المحدّدة

  1. في قائمة نوع المورد، اختَر واجهة برمجة التطبيقات المستخدَمة كنوع المقياس. (إذا لم يظهر لك ذلك، امسح مربّع الاختيار عرض الإعلانات النشطة فقط).

ca850c4295ef4ec9.png

  1. في قائمة المقياس، اختَر أحد المقاييس الفردية لواجهات برمجة التطبيقات، مثل عدد الطلبات، لمعرفة عدد المرات التي تم فيها استدعاء واجهات برمجة التطبيقات في الفترة المحدّدة.

تعرض "أداة استكشاف المقاييس" مقاييس واجهات برمجة التطبيقات المستخدَمة لعدد الطلبات.

  1. لتخصيص الناتج بشكل أكبر، اضبط أداة تجميع وعدِّل الفترة الزمنية. يعرض "مستكشف المقاييس" مقاييس واجهات برمجة التطبيقات المستخدَمة لـ "عدد الطلبات" مع تحديد أداة تجميع وفترة زمنية.

4. استخدام مساحة بروتوكول OAuth 2.0 لتجربة واجهات برمجة التطبيقات

يمكنك أيضًا استخدام مساحة بروتوكول OAuth 2.0 لتجربة واجهات Google APIs. باستخدام "ساحة بروتوكول OAuth 2.0"، يمكنك اختيار واجهة برمجة تطبيقات والسماح بها، ثم إرسال الطلبات والاطّلاع على الردود في نافذة وحدة التحكّم في "ساحة بروتوكول OAuth 2.0".

  1. افتح مساحة بروتوكول OAuth 2.0.

تعرض "مساحة بروتوكول OAuth 2.0" قائمة بواجهات برمجة التطبيقات التي يمكنك تجربتها.

  1. انقر على Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > السماح لواجهات برمجة التطبيقات.

تعرض "مساحة بروتوكول OAuth 2.0" واجهات Cloud Natural Language APIs المحدّدة.

  1. سجِّل الدخول إلى حساب Google إذا لزم الأمر، ثم انقر على السماح للحصول على رمز التفويض.
  2. انقر على Exchange authorization code for tokens (تبديل رمز التفويض بالرموز المميّزة).

لوحة "تبديل رمز التفويض بالرموز المميّزة" التي يمكنك من خلالها النقر على "تبديل رمز التفويض بالرموز المميّزة"

يمكنك الآن تقديم طلب إلى واجهة برمجة التطبيقات.

  1. انقر على إدراج العمليات المحتملة لفحص جميع طلبات البيانات المحتملة من واجهة برمجة التطبيقات.

لقد فتحت سابقًا صفحة المعلومات الخاصة بمستند Natural Language API analyzeEntities، لذا يمكنك الاطّلاع على أنّ عنوان URL لطلب HTTP هو:

https://language.googleapis.com/v1beta2/documents:analyzeEntities

هذا طلب POST.

اضبط الطلب على لوحة API، حيث يمكنك اختيار طريقة HTTP وتسجيل عنوان URI للطلب وإدخال نص الطلب وإرسال الطلب.

  1. أدخِل معلومات عنوان URI للطلب وأضِف نص الطلب.

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

لوحة نص الطلب

  1. انقر على إغلاق > إرسال الطلب.

يجب أن تحصل على نتائج مشابهة لهذه الصورة:

لوحة طلب/ردّ OAuth 2.0 بعد نشر الطلب

يمكنك تجربة واجهات برمجة تطبيقات أخرى في مساحة بروتوكول OAuth 2.0.

5- تَنظيم

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

لحذف مفتاح واجهة برمجة التطبيقات هذا، اتّبِع الخطوات التالية:

  1. انقر على f6b6844bf5688982.png قائمة التنقل > واجهات برمجة التطبيقات والخدمات > بيانات الاعتماد.
  2. ضمن مفاتيح واجهة برمجة التطبيقات، اختَر المفتاح الذي تريد حذفه، ثم انقر على 247adf2e1d1eae4b.png.
  3. وبالمثل، بدلاً من القلق بشأن عدم حماية المفتاح الخاص لحساب الخدمة، اختَر حساب الخدمة الذي تريد حذفه ضمن حسابات الخدمة، ثم انقر على 247adf2e1d1eae4b.png.

6. تهانينا

تهانينا! تعرّفت على كيفية البحث عن Google APIs واختيارها وعرض مقاييسها.