Method: query.suggest

پیشنهادهایی برای تکمیل خودکار پرس و جو ارائه می دهد.

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

درخواست HTTP

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

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

درخواست بدن

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

نمایندگی JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
فیلدها
requestOptions

object ( RequestOptions )

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

query

string

جستار جزئی که پیشنهادات تکمیل خودکار برای آن نشان داده خواهد شد. به عنوان مثال، اگر پرس و جو "دریا" باشد، سرور ممکن است "season"، "search"، "seagull" و غیره را برگرداند.

dataSourceRestrictions[]

object ( DataSourceRestriction )

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

توجه: پیشنهادات فقط برای منابع زیر پشتیبانی می شوند:

  • منابع داده شخص ثالث
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

بدن پاسخگو

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

پاسخ API پیشنهادی.

نمایندگی JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
فیلدها
suggestResults[]

object ( SuggestResult )

لیست پیشنهادات

محدوده مجوز

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

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

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

پیشنهاد نتیجه

نتیجه یک پیشنهاد

نمایندگی JSON 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
فیلدها
suggestedQuery

string

پرس و جوی پیشنهادی که برای جستجو استفاده می شود، زمانی که کاربر روی پیشنهاد کلیک می کند

source

object ( Source )

منبع پیشنهاد.

suggestion میدانی اتحادیه حاوی فراداده اضافی در مورد درخواست پیشنهادی است. همچنین نوع درخواست پیشنهادی را نشان می دهد. به عنوان مثال، اگر PeopleSuggestion وجود داشته باشد، نشان می دهد که suggested_query یک پیشنهاد شخصی است. suggestion تنها می تواند یکی از موارد زیر باشد:
querySuggestion

object ( QuerySuggestion )

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

peopleSuggestion

object ( PeopleSuggestion )

این زمانی وجود دارد که پیشنهاد یک شخص را نشان می دهد. این شامل اطلاعات بیشتری درباره شخص است - مانند شناسه ایمیل، نام و غیره.

Query Suggestion

این فیلد در حال حاضر حاوی هیچ چیزی نیست و فقط به عنوان نشانگر این است که نتیجه پیشنهادی تکمیل عبارت بوده است.

پیشنهاد مردم

این فیلد حاوی اطلاعاتی درباره فرد پیشنهاد شده است.

نمایندگی JSON 
{
  "person": {
    object (Person)
  }
}
فیلدها
person

object ( Person )

فرد پیشنهادی همه فیلدهای شی شخص ممکن است پر نشده باشند.