Method: query.search

Cloud Search query API روش جستجو را ارائه می دهد که مرتبط ترین نتایج را از یک درخواست کاربر برمی گرداند. نتایج می‌توانند از برنامه‌های Google Workspace، مانند Gmail یا Google Drive، یا از داده‌هایی که شما از شخص ثالث ایندکس کرده‌اید به دست آیند.

توجه: این API برای اجرا به یک حساب کاربری نهایی استاندارد نیاز دارد. یک حساب سرویس نمی تواند درخواست های API پرس و جو را به طور مستقیم انجام دهد. برای استفاده از حساب سرویس برای انجام پرس و جوها، تفویض اختیار در سراسر دامنه Google Workspace را تنظیم کنید.

درخواست HTTP

POST https://cloudsearch.googleapis.com/v1/query/search

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
فیلدها
requestOptions

object ( RequestOptions )

گزینه‌هایی مانند برنامه جستجو و منطقه زمانی کاربر را درخواست کنید.

query

string

رشته پرس و جو خام. اپراتورهای جستجوی پشتیبانی شده را در قسمت جستجوی خود را با عملگرها محدود کنید

pageSize

integer

حداکثر تعداد نتایج جستجو برای بازگشت در یک صفحه. مقادیر معتبر شامل 1 تا 100 است. مقدار پیش‌فرض 10 است. حداقل مقدار 50 است که نتایجی بیش از 2000 درخواست شود.

start

integer

شاخص شروع نتایج.

dataSourceRestrictions[]

object ( DataSourceRestriction )

منابع مورد استفاده برای پرس و جو اگر مشخص نشده باشد، همه منابع داده از برنامه جستجوی فعلی استفاده می شود.

facetOptions[]

object ( FacetOptions )

sortOptions

object ( SortOptions )

گزینه هایی برای مرتب سازی نتایج جستجو

queryInterpretationOptions

object ( QueryInterpretationOptions )

گزینه هایی برای تفسیر پرس و جو کاربر

contextAttributes[]

object ( ContextAttribute )

ویژگی های زمینه برای درخواست که برای تنظیم رتبه بندی نتایج جستجو استفاده می شود. حداکثر تعداد عناصر 10 است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه‌ای از SearchResponse است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

،

Cloud Search query API روش جستجو را ارائه می دهد که مرتبط ترین نتایج را از یک درخواست کاربر برمی گرداند. نتایج می‌توانند از برنامه‌های Google Workspace، مانند Gmail یا Google Drive، یا از داده‌هایی که شما از شخص ثالث ایندکس کرده‌اید به دست آیند.

توجه: این API برای اجرا به یک حساب کاربری نهایی استاندارد نیاز دارد. یک حساب سرویس نمی تواند درخواست های API پرس و جو را به طور مستقیم انجام دهد. برای استفاده از حساب سرویس برای انجام پرس و جوها، تفویض اختیار در سراسر دامنه Google Workspace را تنظیم کنید.

درخواست HTTP

POST https://cloudsearch.googleapis.com/v1/query/search

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
فیلدها
requestOptions

object ( RequestOptions )

گزینه‌هایی مانند برنامه جستجو و منطقه زمانی کاربر را درخواست کنید.

query

string

رشته پرس و جو خام. اپراتورهای جستجوی پشتیبانی شده را در قسمت جستجوی خود را با عملگرها محدود کنید

pageSize

integer

حداکثر تعداد نتایج جستجو برای بازگشت در یک صفحه. مقادیر معتبر شامل 1 تا 100 است. مقدار پیش‌فرض 10 است. حداقل مقدار 50 است که نتایجی بیش از 2000 درخواست شود.

start

integer

شاخص شروع نتایج.

dataSourceRestrictions[]

object ( DataSourceRestriction )

منابع مورد استفاده برای پرس و جو اگر مشخص نشده باشد، همه منابع داده از برنامه جستجوی فعلی استفاده می شود.

facetOptions[]

object ( FacetOptions )

sortOptions

object ( SortOptions )

گزینه هایی برای مرتب سازی نتایج جستجو

queryInterpretationOptions

object ( QueryInterpretationOptions )

گزینه هایی برای تفسیر پرس و جو کاربر

contextAttributes[]

object ( ContextAttribute )

ویژگی های زمینه برای درخواست که برای تنظیم رتبه بندی نتایج جستجو استفاده می شود. حداکثر تعداد عناصر 10 است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه‌ای از SearchResponse است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.