Cloud Search API

توفّر Cloud Search إمكانات بحث مستندة إلى السحابة الإلكترونية في بيانات Google Workspace. تتيح واجهة برمجة تطبيقات Cloud Search فهرسة البيانات غير التابعة إلى Google Workspace في Cloud Search.

الخدمة: cloudsearch.googleapis.com

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

مستند الاستكشاف

مستند الاستكشاف هو عبارة عن مواصفات يمكن أن تقرأها الآلة لوصف REST API واستخدامها. وهو يُستخدم لإنشاء مكتبات العميل ومكوّنات IDE الإضافية وغيرها من الأدوات التي تتفاعل مع Google APIs. تجدر الإشارة إلى أنّ خدمة واحدة قد تقدّم أكثر من وثيقة استكشاف. توفّر هذه الخدمة مستند الاكتشاف التالي:

نقطة نهاية الخدمة

نقطة نهاية الخدمة هي الجزء الأساسي من عنوان URL الذي يحدّد عنوان الشبكة لخدمة واجهة برمجة التطبيقات. قد يكون للخدمة الواحدة أكثر من نقطة نهاية واحدة. تحتوي هذه الخدمة على نقطة النهاية التالية، وجميع عناوين URI أدناه تكون نسبيّة لهذه النقطة:

  • https://cloudsearch.googleapis.com

مورد REST: ‏ v1

الطُرق
initializeCustomer POST /v1:initializeCustomer
تفعّل هذه السمة إمكانية استخدام third party في Google Cloud Search.

مورد REST: ‏ v1.debug.datasources.items

الطُرق
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
تتحقّق هذه السمة مما إذا كان يمكن الوصول إلى عنصر معيّن من خلال كيان أساسي محدّد.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
يستردّ هذا الإجراء العنصر الذي يتطابق عنوان viewUrl الخاص به تمامًا مع عنوان URL المقدَّم في الطلب.

مورد REST: ‏ v1.debug.datasources.items.unmappedids

الطُرق
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
تعرض هذه السمة جميع المعرّفات غير المرتبطة بسلعة معيّنة.

مورد REST: ‏ v1.debug.identitysources.items

الطُرق
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
تعرض هذه السمة أسماء العناصر المرتبطة بمعرّف غير مرتبط.

مورد REST: ‏ v1.debug.identitysources.unmappedids

الطُرق
list GET /v1/debug/{parent=identitysources/*}/unmappedids
تعرض هذه السمة هويات المستخدمين غير المرتبطة بمصدر هوية.

مورد REST: ‏ v1.indexing.datasources

الطُرق
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
لحذف مخطط مصدر بيانات
getSchema GET /v1/indexing/{name=datasources/*}/schema
تعرض هذه السمة مخطط مصدر بيانات.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
تعدّل هذه الطريقة مخطط مصدر بيانات.

مورد REST: ‏ v1.indexing.datasources.items

الطُرق
delete DELETE /v1/indexing/{name=datasources/*/items/*}
لحذف Item resource لاسم المورد المحدّد
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
لحذف جميع العناصر في قائمة انتظار
get GET /v1/indexing/{name=datasources/*/items/*}
تعرض هذه السمة Item resource حسب اسم السلعة.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
تعديل Item قائمة التحكم بالوصول (ACL) والبيانات الوصفية والمحتوى
list GET /v1/indexing/{name=datasources/*}/items
تعرض هذه السمة كل أو جزءًا من Item resources.
poll POST /v1/indexing/{name=datasources/*}/items:poll
يتم استطلاع العناصر غير المحجوزة من قائمة انتظار الفهرسة ووضع علامة "محجوز" على مجموعة منها، بدءًا بالعناصر التي تحمل أقدم طابع زمني من أعلى أولوية ItemStatus.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
يضيف عنصرًا إلى قائمة انتظار ليتم استطلاعه وتعديله لاحقًا.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
تؤدي هذه السمة إلى إلغاء حجز جميع العناصر من قائمة الانتظار، ما يجعلها مؤهَّلة للاستطلاع.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
تنشئ هذه الطريقة جلسة تحميل لتحميل محتوى عنصر.

مورد REST: ‏ v1.media

الطُرق
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
تحميل الوسائط لفهرستها

مورد REST: ‏ v1.operations

الطُرق
get ‫GET /v1/{name=operations/**}
تتيح هذه الطريقة الاطّلاع على أحدث حالة لعملية طويلة.

مورد REST: ‏ v1.query

الطُرق
removeActivity POST /v1/query:removeActivity
توفّر هذه السمة وظيفة لإزالة النشاط المسجّل لأحد المستخدمين.
search POST /v1/query/search
توفّر واجهة برمجة التطبيقات لطلبات البحث في Cloud Search طريقة البحث التي تعرض النتائج الأكثر صلة بطلب بحث المستخدم.
suggest POST /v1/query/suggest
تقدّم اقتراحات لإكمال طلب البحث تلقائيًا.

مورد REST: ‏ v1.query.sources

الطُرق
list GET /v1/query/sources
تعرض هذه السمة قائمة بالمصادر التي يمكن للمستخدم استخدامها مع واجهات برمجة التطبيقات Search وSuggest.

مورد REST: ‏ v1.settings

الطُرق
getCustomer GET /v1/settings/customer
الحصول على إعدادات العميل
updateCustomer PATCH /v1/settings/customer
تعديل إعدادات العميل

مورد REST: ‏ v1.settings.datasources

الطُرق
create POST /v1/settings/datasources
تُستخدَم لإنشاء مصدر بيانات.
delete DELETE /v1/settings/{name=datasources/*}
يحذف مصدر بيانات.
get GET /v1/settings/{name=datasources/*}
تعرض هذه الطريقة مصدر بيانات.
list GET /v1/settings/datasources
تعرض مصادر البيانات.
patch PATCH /v1/settings/{source.name=datasources/*}
تعدّل مصدر بيانات.
update PUT /v1/settings/{source.name=datasources/*}
تعدّل مصدر بيانات.

مورد REST: ‏ v1.settings.searchapplications

الطُرق
create POST /v1/settings/searchapplications
لإنشاء تطبيق بحث
delete DELETE /v1/settings/{name=searchapplications/*}
لحذف تطبيق بحث.
get GET /v1/settings/{name=searchapplications/*}
تعرض هذه الطريقة تطبيق البحث المحدّد.
list GET /v1/settings/searchapplications
تعرض هذه السمة جميع تطبيقات البحث.
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
تعدّل هذه الطريقة تطبيق بحث.
reset POST /v1/settings/{name=searchapplications/*}:reset
تعيد ضبط تطبيق بحث على الإعدادات التلقائية.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
تعدّل هذه الطريقة تطبيق بحث.

مورد REST: ‏ v1.stats

الطُرق
getIndex GET /v1/stats/index
تعرض هذه الطريقة إحصاءات العناصر المفهرسة المجمّعة من جميع مصادر البيانات.
getQuery GET /v1/stats/query
الحصول على إحصاءات الاستعلامات الخاصة بالعميل
getSearchapplication GET /v1/stats/searchapplication
الحصول على إحصاءات تطبيق البحث الخاص بالعميل
getSession GET /v1/stats/session
احصل على عدد جلسات البحث، والنسبة المئوية للجلسات الناجحة التي تتضمّن إحصاءات طلب بحث بنقرة للعميل.
getUser GET /v1/stats/user
الحصول على إحصاءات المستخدمين للعميل

مورد REST: ‏ v1.stats.index.datasources

الطُرق
get GET /v1/stats/index/{name=datasources/*}
تعرض هذه الطريقة إحصاءات العناصر المفهرسة لمصدر بيانات واحد.

مورد REST: ‏ v1.stats.query.searchapplications

الطُرق
get GET /v1/stats/query/{name=searchapplications/*}
الحصول على إحصاءات طلبات البحث لتطبيق البحث

مورد REST: ‏ v1.stats.session.searchapplications

الطُرق
get GET /v1/stats/session/{name=searchapplications/*}
الحصول على عدد جلسات البحث، ونسبة الجلسات الناجحة التي تتضمّن إحصاءات طلب بحث بنقرة لتطبيق البحث

مورد REST: ‏ v1.stats.user.searchapplications

الطُرق
get GET /v1/stats/user/{name=searchapplications/*}
الحصول على إحصاءات المستخدمين لتطبيق البحث