Method: query.debugSearch

اطلاعات اشکال زدایی را برای پرس و جوی Cloud Search برمی گرداند API روش جستجو را ارائه می دهد.

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

درخواست HTTP

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

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 است.

بدن پاسخگو

پاسخ query.search اشکال زدایی.

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

نمایندگی JSON 
{
  "searchResponse": {
    object (SearchResponse)
  },
  "gsrRequest": string,
  "gsrResponse": string
}
فیلدها
searchResponse

object ( SearchResponse )

پاسخ Query.Search.

gsrRequest

string ( bytes format)

رشته سریال درخواست GenericSearch.

رشته ای با کد base64.

gsrResponse

string ( bytes format)

رشته سریال GenericSearchResponse.

رشته ای با کد base64.

محدوده مجوز

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

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

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