提供自動完成查詢的建議。
注意:您必須執行標準使用者帳戶,才能執行這個 API。服務帳戶無法直接執行 Query API 要求。如要使用服務帳戶執行查詢,請設定 Google Workspace 全網域授權委派。
HTTP 要求
POST https://cloudsearch.googleapis.com/v1/query/suggest
這個網址使用 gRPC 轉碼語法。
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "requestOptions": { object ( |
欄位 | |
---|---|
requestOptions |
要求選項,例如搜尋應用程式和使用者時區。 |
query |
顯示自動完成建議的部分查詢。舉例來說,如果查詢是「sea」,伺服器可能會傳回「season」、「search」、「seagull」等。 |
dataSourceRestrictions[] |
提供建議的來源。如未指定,系統會從目前的搜尋應用程式取得資料來源。 注意:系統僅支援下列來源的建議:
|
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
建議 API 的回應。
JSON 表示法 |
---|
{
"suggestResults": [
{
object ( |
欄位 | |
---|---|
suggestResults[] |
建議清單。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
詳情請參閱授權指南。
SuggestResult
找到一項建議結果。
JSON 表示法 |
---|
{ "suggestedQuery": string, "source": { object ( |
欄位 | |
---|---|
suggestedQuery |
使用者點選建議項目時,系統執行搜尋時使用的建議查詢 |
source |
建議來源。 |
聯集欄位 suggestion 。包含建議查詢的其他中繼資料。以及建議的查詢類型。例如,如果人物建議有使用者建議,其中就會指出 Suggested_query 為推薦人選。suggestion 只能是下列其中一項: |
|
querySuggestion |
如果建議的查詢為字詞/詞組,系統就會顯示這個欄位。 |
peopleSuggestion |
當建議項目指出使用者時,就會顯示這個圖示。其中包含該名使用者的更多資訊,例如電子郵件 ID、姓名等。 |
QuerySuggestion
這個欄位目前不含任何內容,僅供用來表示建議結果屬於詞組。
PeopleSuggestion
這個欄位包含建議使用者的相關資訊。
JSON 表示法 |
---|
{
"person": {
object ( |
欄位 | |
---|---|
person |
建議的使用者。可能不會填入人物物件的所有欄位。 |