Method: query.suggest

提供自動完成查詢的建議。

注意：執行這個 API 需要標準使用者帳戶。服務帳戶無法直接執行查詢 API 要求。如要使用服務帳戶執行查詢，請設定 Google Workspace 全網域委派權限。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
欄位
requestOptions

object (RequestOptions)

請求選項，例如搜尋應用程式和使用者時區。
query

string

系統會顯示部分查詢的自動完成建議。舉例來說，如果查詢是「sea」，伺服器可能會傳回「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

詳情請參閱授權指南。

SuggestResult

一個建議結果。

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)

當建議內容是某位聯絡人時，就會顯示這個圖示。這類資訊包含使用者的更多資訊，例如電子郵件 ID、姓名等。

QuerySuggestion

這個類型沒有任何欄位。

這個欄位目前不包含任何內容，僅用於指出建議結果是字詞完成。

PeopleSuggestion

這個欄位包含建議對象的相關資訊。

JSON 表示法 
{
  "person": {
    object (Person)
  }
}
欄位
person

object (Person)

建議的使用者。可能不會填入人員物件中的所有欄位。