Cloud Search API

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

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

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

المستند المرتبط بميزة "اقتراحات"

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

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

نقطة نهاية الخدمة هي عنوان 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
تُستخدَم هذه الوظيفة لجلب العنصر الذي يتطابق عنوان URL المعروض له مع عنوان 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 على قائمة التحكم بالوصول والبيانات الوصفية والمحتوى
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

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

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

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

مورد 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/*}
يمكنك الحصول على إحصاءات المستخدمين لتطبيق البحث.