Cloud Search API

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

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

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

مستند Discovery

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

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

نقطة نهاية الخدمة هي عنوان 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

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

مورد REST: v1.query.sources

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

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