提供自動完成查詢的建議。
注意:這個 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
找到 1 項建議結果。
JSON 表示法 |
---|
{ "suggestedQuery": string, "source": { object ( |
欄位 | |
---|---|
suggestedQuery |
當使用者點選建議時,系統搜尋時會使用的建議查詢 |
source |
建議來源。 |
聯集欄位 suggestion 。包含建議查詢的其他中繼資料。也會指出建議查詢的類型。例如:如果有 PeopleSuggestion,代表翻譯建議為「建議_query」。suggestion 只能是下列其中一項: |
|
querySuggestion |
如果建議查詢為字詞/詞組完成,就會顯示這個欄位。 |
peopleSuggestion |
如果系統提供的建議回覆了某位使用者,就會顯示這個圖示。內含聯絡人的詳細資訊,例如電子郵件 ID、姓名等。 |
QuerySuggestion
這個欄位目前不含任何內容,只會用來做為建議結果已完成詞組的指標。
PeopleSuggestion
這個欄位包含建議對象的相關資訊。
JSON 表示法 |
---|
{
"person": {
object ( |
欄位 | |
---|---|
person |
建議人選。系統可能不會填入個人物件的所有欄位。 |