ضبط إمكانية الوصول إلى Google Cloud Search API

يجب ضبط إمكانية الوصول إلى واجهة برمجة تطبيقات Google Cloud Search قبل أن تتمكّن من استخدام واجهة برمجة التطبيقات هذه إما مباشرةً أو من خلال حزمة تطوير برامج (SDK). يتناول هذا المستند الخطوات المطلوبة لاستخدام واجهة برمجة التطبيقات Google Cloud Search API REST API.

1. إنشاء مشروع واجهة برمجة التطبيقات

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

  1. افتح وحدة تحكُّم Google Cloud.

  2. في أعلى الصفحة، انقر على رمز على يسار "Google Cloud Console". سيظهر مربّع حوار يسرد المشاريع الحالية.

  3. انقر على مشروع جديد. ستظهر لك شاشة "مشروع جديد".

  4. أدخِل اسم مشروع في حقل اسم المشروع.

  5. (اختياري) انقر على تعديل لتعديل رقم تعريف المشروع. لا يمكن تغيير رقم تعريف المشروع بعد إنشائه، لذا اختَر رقم تعريف يلبي احتياجاتك طوال مدة المشروع.

  6. لتصفُّح المواقع الجغرافية للمشروع، انقر على تصفُّح.

  7. انقر على موقع جغرافي لمشروعك وانقر على اختيار.

  8. انقر على إنشاء. تنتقل وحدة التحكّم إلى صفحة "لوحة البيانات". يتم إنشاء المشروع في غضون بضع دقائق.

لمزيد من المعلومات حول إنشاء المشاريع وإدارتها، راجع إنشاء المشاريع وإدارتها.

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

عليك تفعيل Google Cloud Search API وإنشاء حساب خدمة للحصول على بيانات الاعتماد.

  1. للتأكّد من أنّك في المشروع الذي تم إنشاؤه حديثًا، انقر على رمز على يسار بانر وحدة تحكّم Google Cloud واختَر مشروعك الذي تم إنشاؤه حديثًا.
  2. انقر على تفعيل واجهات برمجة التطبيقات والخدمات. تظهر صفحة "مرحبًا بك في مكتبة واجهات برمجة التطبيقات".
  3. انتقِل إلى Google Cloud Search API.
  4. انقر على تفعيل. تظهر صفحة "نظرة عامة".

لمزيد من المعلومات حول تفعيل واجهات برمجة التطبيقات وإيقافها، يُرجى الاطّلاع على إدارة واجهات برمجة التطبيقات في Google Cloud Console.

3- إنشاء بيانات اعتماد حساب الخدمة

  1. في وحدة تحكّم Google Cloud، انقر على بيانات الاعتماد في شريط التنقّل الأيمن. ستظهر صفحة "بيانات الاعتماد".
  2. من القائمة المنسدلة إنشاء بيانات اعتماد، اختَر حساب الخدمة. تظهر صفحة "إنشاء حساب خدمة".
  3. أدخِل اسمًا في حقل اسم حساب الخدمة.
  4. (اختياري) عدِّل رقم تعريف حساب الخدمة.
  5. انقر على إنشاء. تظهر شاشة "أذونات حساب الخدمة".
  6. انقر على متابعة. تظهر شاشة "منح المستخدمين إذن الوصول إلى حساب الخدمة هذا".
  7. انقر على إنشاء مفتاح وانقر على تم. يظهر مربّع حوار "تم حفظ المفتاح الخاص على الكمبيوتر" ويتم تنزيل نسخة من المفتاح الخاص على الكمبيوتر.
  8. انقر على إغلاق (Close).

لمزيد من المعلومات عن حسابات الخدمة، يُرجى الرجوع إلى مقالة حسابات الخدمة وتطبيقات الويب والتطبيقات المثبَّتة.

4. تحديد عنوان البريد الإلكتروني

  1. من وحدة تحكُّم Google Cloud، اختَر المشروع الذي أنشأته في أعلى الصفحة.
  2. انقر على قائمة التنقّل على يمين بانر وحدة تحكّم Google Cloud.
  3. انقر على إدارة الهوية وإمكانية الوصول والمشرف > حسابات الخدمة.
  4. في القائمة، ضمن "رقم تعريف حساب الخدمة"، دوِّن عنوان البريد الإلكتروني الذي تم إنشاؤه والذي يحدِّد حساب الخدمة الذي أعددته. يتم استخدام عنوان البريد الإلكتروني هذا عند إضافة مصدر بيانات إلى Cloud Search.

5- بدء دعم الجهات الخارجية

قبل أن تتمكّن من طلب أي واجهات برمجة تطبيقات أخرى لخدمة Cloud Search، عليك بدء تكامل Google Cloud Search مع خدمات تابعة لجهات خارجية.

لبدء استخدام ميزة "البحث في Cloud" مع تطبيقات تابعة لجهات خارجية، اتّبِع الخطوات التالية:

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

  2. استخدِم مساحة OAuth 2 في Google للحصول على رمز دخول:

    1. انقر على الإعدادات وضع علامة في المربّع بجانب استخدام بيانات اعتماد المصادقة الخاصة بك.
    2. أدخِل معرِّف العميل وسر العميل من الخطوة 1.
    3. انقر على إغلاق (Close).
    4. في حقل النطاقات، اكتب https://www.googleapis.com/auth/cloud_search.settings وانقر على تفويض. تعرض واجهة OAuth 2 رمز تفويض.
    5. انقر على Exchange authorization code for tokens (تبديل رمز التفويض بالرموز المميّزة). يتم عرض رمز مميّز.

  3. لبدء استخدام واجهة برمجة التطبيقات التابعة لجهة خارجية مع Cloud Search، استخدِم الأمر curl التالي. احرص على استبدال [YOUR_ACCESS_TOKEN] بالرمز المميّز الذي تم الحصول عليه في الخطوة 2.

    curl --request POST \
'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed

    إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال operation. على سبيل المثال:

    {
name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
}

    إذا لم تنجح، يُرجى التواصل مع فريق دعم Cloud Search.

  4. استخدِم operations.get للتأكّد من أنّه تمت بدء معالجة طلبات المساعدة التابعة لجهات خارجية:

    curl \
'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
[YOUR_API_KEY]' \
--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
--header 'Accept: application/json' \
--compressed

    عند اكتمال عملية الإعداد التابعة لجهة خارجية، يحتوي على حقل done الذي تم ضبطه على true. على سبيل المثال:

    {
name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
done: true
}

الخطوات التالية

في ما يلي بعض الخطوات التالية التي يمكنك اتّخاذها:

  1. إذا كنت تخطّط لاستخدام Google Cloud Search مع مستودع بيانات غير تابع لشركة Google، مثل Microsoft® SharePoint®، عليك إنشاء مصدر بيانات. للحصول على تعليمات حول إضافة مصدر بيانات، راجِع المقالة إضافة مصدر بيانات إلى البحث.

  2. بعد إعداد مصدر البيانات، يمكنك إنشاء المخطط وتسجيله لتحديد الطريقة التي يجب أن يمثّل بها Google Cloud Search البيانات في المستودع.