Cloud Search API

جستجوی ابری (Cloud Search) قابلیت‌های جستجوی مبتنی بر ابر را بر روی داده‌های Google Workspace ارائه می‌دهد. API جستجوی ابری (Cloud Search API) امکان فهرست‌بندی داده‌های غیر از Google Workspace را در جستجوی ابری فراهم می‌کند.

سرویس: cloudsearch.googleapis.com

برای فراخوانی این سرویس، توصیه می‌کنیم از کتابخانه‌های کلاینت ارائه شده توسط گوگل استفاده کنید. اگر برنامه شما برای فراخوانی این سرویس نیاز به استفاده از کتابخانه‌های خودتان دارد، هنگام ارسال درخواست‌های API از اطلاعات زیر استفاده کنید.

سند کشف

یک سند کشف ، مشخصاتی قابل خواندن توسط ماشین برای توصیف و استفاده از APIهای REST است. از آن برای ساخت کتابخانه‌های کلاینت، افزونه‌های IDE و سایر ابزارهایی که با APIهای گوگل تعامل دارند، استفاده می‌شود. یک سرویس ممکن است چندین سند کشف ارائه دهد. این سرویس سند کشف زیر را ارائه می‌دهد:

نقطه پایانی سرویس

یک نقطه پایانی سرویس ، یک URL پایه است که آدرس شبکه یک سرویس API را مشخص می‌کند. یک سرویس ممکن است چندین نقطه پایانی سرویس داشته باشد. این سرویس دارای نقطه پایانی سرویس زیر است و تمام URI های زیر نسبت به این نقطه پایانی سرویس هستند:

  • https://cloudsearch.googleapis.com

منبع REST: نسخه ۱

روش‌ها
initializeCustomer POST /v1:initializeCustomer
پشتیبانی third party را در جستجوی ابری گوگل فعال می‌کند.

منبع 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
طرحواره (schema) یک منبع داده را حذف می‌کند.
getSchema GET /v1/indexing/{name=datasources/*}/schema
طرحواره (Schema) یک منبع داده را دریافت می‌کند.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
طرحواره (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
به‌روزرسانی‌های ACL 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

روش‌ها
removeActivity POST /v1/query:removeActivity
قابلیت حذف فعالیت‌های ثبت‌شده برای یک کاربر را فراهم می‌کند.
search POST /v1/query/search
رابط برنامه‌نویسی کاربردی جستجوی ابری (Cloud Search Query API) روشی برای جستجو ارائه می‌دهد که مرتبط‌ترین نتایج را از یک جستجوی کاربر برمی‌گرداند.
suggest POST /v1/query/suggest
پیشنهادهایی برای تکمیل خودکار پرس‌وجو ارائه می‌دهد.

منبع REST: v1.query.sources

روش‌ها
list GET /v1/query/sources
فهرستی از منابعی را که کاربر می‌تواند برای APIهای جستجو و پیشنهاد استفاده کند، برمی‌گرداند.

منبع REST: تنظیمات نسخه ۱

روش‌ها
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/*}
آمار کاربران را برای برنامه جستجو دریافت کنید.