Method: query.search

Cloud Search Query API 提供搜尋方法，可透過使用者查詢傳回最相關的結果。搜尋結果可能來自 Google Workspace 應用程式 (例如 Gmail 或 Google 雲端硬碟) 或您從第三方建立索引的資料。

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

HTTP 要求

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

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

要求主體

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

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。要求的結果數量超過 2,000 個時，最小值為 50。
start

integer

結果的起始索引。
dataSourceRestrictions[]

object (DataSourceRestriction)

用於查詢的來源。如果未指定，則會使用目前搜尋應用程式中的所有資料來源。
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

搜尋結果排序選項
queryInterpretationOptions

object (QueryInterpretationOptions)

解讀使用者查詢的選項
contextAttributes[]

object (ContextAttribute)

要求的特色屬性，用來調整搜尋結果排名。元素的數量上限為 10 個。

回應主體

如果成功，回應主體會含有以下結構的資料：

搜尋 API 回應。

JSON 表示法 
{
  "queryInterpretation": {
    object (QueryInterpretation)
  },
  "results": [
    {
      object (SearchResult)
    }
  ],
  "structuredResults": [
    {
      object (StructuredResult)
    }
  ],
  "spellResults": [
    {
      object (SpellResult)
    }
  ],
  "facetResults": [
    {
      object (FacetResult)
    }
  ],
  "hasMoreResults": boolean,
  "debugInfo": {
    object (ResponseDebugInfo)
  },
  "errorInfo": {
    object (ErrorInfo)
  },
  "resultCounts": {
    object (ResultCounts)
  },

  // Union field result_count can be only one of the following:
  "resultCountEstimate": string,
  "resultCountExact": string
  // End of list of possible types for union field result_count.
}
欄位
queryInterpretation

object (QueryInterpretation)

查詢使用者查詢的解讀結果。如果查詢解讀功能已停用，則為空白。
results[]

object (SearchResult)

搜尋查詢的結果。
structuredResults[]

object (StructuredResult)

使用者查詢的結構化結果。這些結果不會計入 pageSize。
spellResults[]

object (SpellResult)

查詢的拼寫建議。
facetResults[]

object (FacetResult)

重複的 facet 結果。
hasMoreResults

boolean

是否還有其他與查詢相符的搜尋結果。
debugInfo

object (ResponseDebugInfo)

對回應的偵錯資訊。
errorInfo

object (ErrorInfo)

回應相關錯誤資訊。
resultCounts

object (ResultCounts)

已展開的結果計數資訊。

聯集欄位 result_count。所有要求資料來源的結果總數。如果查詢的資料來源集中包含預先定義的來源，則省略。在下列情況中，系統可能會傳回結果計數 (而非確切值)：

  • 查詢的詞組中包含超過 2 個字詞時，例如「結果計數完全」。

  • 當要評估的不重複搜尋結果 ACL 數量過大，而無法在合理的延遲時間內計算。

在極少數的情況下，當系統無法搜尋所有文件時，請重新執行查詢。result_count 只能採用下列其中一種設定：
resultCountEstimate

string (int64 format)

這項查詢的預估結果數量。
resultCountExact

string (int64 format)

這項查詢的確切結果數量。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。

QueryInterpretationOptions

解讀使用者查詢的選項

JSON 表示法 
{
  "disableNlInterpretation": boolean,
  "enableVerbatimMode": boolean,
  "disableSupplementalResults": boolean
}
欄位
disableNlInterpretation

boolean

此標記可停用查詢的自然語言 (NL) 解讀功能。預設值為 false。設為 true 即可停用自然語言翻譯功能。NL 解讀僅適用於預先定義的資料來源。
enableVerbatimMode

boolean

啟用此旗標即可關閉所有內部最佳化功能，例如：自然語言 (NL) 解讀查詢、補充結果擷取，以及使用同義詞 (包含自訂) 的同義詞。如果其中一個標記為 true，系統會停用 Nl 解讀功能。
disableSupplementalResults

boolean

使用這個旗標可以停用查詢的補充結果功能。如果設為 True，則在 SearchApplication 層級選擇的補充結果設定會優先顯示。

QueryInterpretation

JSON 表示法 
{
  "interpretedQuery": string,
  "interpretationType": enum (QueryInterpretation.InterpretationType),
  "reason": enum (QueryInterpretation.Reason)
}
欄位
interpretedQuery

string

搜尋所使用查詢的解讀。例如，具有自然語言意圖 (例如「email from john」) 的查詢。會解讀為「from:john source:mail」。如果原因為「NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY」，則不會填寫此欄位。
interpretationType

enum (QueryInterpretation.InterpretationType)
reason

enum (QueryInterpretation.Reason)

解讀查詢的原因。如果解讀類型非「NONE」，這個欄位就不會「UNSPECIFIED」。

QueryInterpretation.InterpretationType

列舉
NONE 無論是自然語言翻譯，還是擷取搜尋結果使用範圍更廣的查詢，
BLEND 原始查詢的結果與其他結果混合。在「原因」中填入這些其他結果與原始查詢的結果欄位。
REPLACE 系統會取代原始查詢的結果。「原因」欄已填入取代原始查詢結果的原因欄位。

QueryInterpretation.Reason

列舉
UNSPECIFIED
QUERY_HAS_NATURAL_LANGUAGE_INTENT 系統會運用自然語言解讀查詢來擷取搜尋結果。
NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY 因為使用者查詢找不到足夠的結果，所以會使用查詢和文件字詞的相似度來選擇性擴大查詢範圍，以擷取其他搜尋結果。在這個案例中，解讀後的查詢將為空白。

SearchResult

包含文件索引資訊的結果。

JSON 表示法 
{
  "title": string,
  "url": string,
  "snippet": {
    object (Snippet)
  },
  "metadata": {
    object (Metadata)
  },
  "clusteredResults": [
    {
      object (SearchResult)
    }
  ],
  "debugInfo": {
    object (ResultDebugInfo)
  }
}
欄位
title

string

搜尋結果的標題。
url

string

搜尋結果的網址。網址中包含 Google 重新導向至實際項目的網址。這個網址已經過簽署，不應變更。
snippet

object (Snippet)

這個結果的所有摘要 (摘要) 的串連。
metadata

object (Metadata)

搜尋結果的中繼資料
clusteredResults[]

object (SearchResult)

如果來源已叢集，請提供叢集結果清單。系統只會建立一個層級的叢集結果。如果目前的來源未啟用分群功能，這個欄位會留空。
debugInfo

object (ResultDebugInfo)

對這個搜尋結果的資訊進行偵錯。

文字片段

搜尋結果的片段，會概述結果網頁的內容。

JSON 表示法 
{
  "snippet": string,
  "matchRanges": [
    {
      object (MatchRange)
    }
  ]
}
欄位
snippet

string

文件的文字片段。文件的文字片段。可能包含轉譯前未逸出的 HTML 字元。
matchRanges[]

object (MatchRange)

片段中相符的範圍。

MatchRange

程式碼片段的相符範圍 [開始、結束]。

JSON 表示法 
{
  "start": integer,
  "end": integer
}
欄位
start

integer

片段中相符項目的起始位置。
end

integer

程式碼片段中比對相符項目的結尾。

中繼資料

相符搜尋結果的中繼資料

JSON 表示法 
{
  "source": {
    object (Source)
  },
  "mimeType": string,
  "thumbnailUrl": string,
  "owner": {
    object (Person)
  },
  "createTime": string,
  "updateTime": string,
  "fields": [
    {
      object (NamedProperty)
    }
  ],
  "displayOptions": {
    object (ResultDisplayMetadata)
  },
  "objectType": string
}
欄位
source

object (Source)

結果的指定來源，例如 Gmail。
mimeType

string

搜尋結果的 Mime 類型。
thumbnailUrl

string

搜尋結果的縮圖網址。
owner

object (Person)

擁有者 (通常為建立者)。
createTime

string (Timestamp format)

搜尋結果中此文件或物件的建立時間。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

搜尋結果中物件上次修改的日期。如未在商品中設定，則此處傳回的值會是空白。如果 updateTime 用於計算更新間隔且未設定，這個值會預設為目前時間的 2 年。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
fields[]

object (NamedProperty)

結構化資料中已建立索引的欄位，會以一般具名屬性傳回。
displayOptions

object (ResultDisplayMetadata)

指定如何顯示結構化資料搜尋結果的選項。
objectType

string

搜尋結果的物件類型。

ResultDisplayMetadata

JSON 表示法 
{
  "objectTypeLabel": string,
  "metalines": [
    {
      object (ResultDisplayMetadata.ResultDisplayLine)
    }
  ]
}
欄位
objectTypeLabel

string

物件的顯示標籤。
metalines[]

object (ResultDisplayMetadata.ResultDisplayLine)

要在結果中顯示的中繼內容。

ResultDisplayMetadata.ResultDisplayLine

組成顯示行的欄位集合

JSON 表示法 
{
  "fields": [
    {
      object (ResultDisplayMetadata.ResultDisplayField)
    }
  ]
}
欄位
fields[]

object (ResultDisplayMetadata.ResultDisplayField)

ResultDisplayMetadata.ResultDisplayField

顯示 query.search 結果的欄位

JSON 表示法 
{
  "label": string,
  "operatorName": string,
  "property": {
    object (NamedProperty)
  }
}
欄位
label

string

資源的顯示標籤。
operatorName

string

屬性的運算子名稱。
property

object (NamedProperty)

屬性的名稱值配對。

ResultDebugInfo

偵錯結果相關資訊。

JSON 表示法 
{
  "formattedDebugInfo": string
}
欄位
formattedDebugInfo

string

顯示格式的一般偵錯資訊。

StructuredResult

搜尋要求中傳回的結構化結果。

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

object (Person)

人物的表示法

SpellResult

JSON 表示法 
{
  "suggestedQuery": string
}
欄位
suggestedQuery

string

查詢的建議拼法。

FacetResult

來源特定的 facet 回應

JSON 表示法 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "buckets": [
    {
      object (FacetBucket)
    }
  ]
}
欄位
sourceName

string

傳回 Facet 結果的來源名稱。這個值不得留空。
objectType

string

傳回 facet 結果的物件類型。可為空白。
operatorName

string

為 facet 選擇的運算子名稱。@see cloudsearch.SchemaPropertyOptions
buckets[]

object (FacetBucket)

回應中值的 FacetBucket，至少包含一個符合對應篩選器的單一結果。

FacetBucket

facet 中的值區是作業的基本單位。視值區的欄位類型而定，值區可以包含單一值「或」連續的值範圍。FacetBucket 目前僅適用於傳回回應物件。

JSON 表示法 
{
  "count": integer,
  "percentage": integer,
  "filter": {
    object (Filter)
  },
  "value": {
    object (Value)
  }
}
欄位
count

integer

符合值區值的結果數。只有在必須確定計數準確度時，系統才會針對搜尋傳回計數。Cloud Search 不保證任何查詢的商情項目計數，而且 Facet 計數可能只會間歇顯示，即使是相同的查詢也一樣。不要在 facet 計數上建構依附元件；而是一律使用一律傳回的 facet 忽略百分比
percentage

integer

符合值區值的結果百分比。傳回的值介於 (0 到 100) 之間。如果為小數，則系統會將其四捨五入為整數。如果值未明確傳回，則代表四捨五入到 0 的百分比值。系統會針對所有搜尋傳回百分比，但這是預估值。由於系統一律會傳回百分比，因此建議您顯示百分比，而非計數。
filter

object (Filter)

選取對應的值區時，要在搜尋要求中傳送的篩選器。
value

object (Value)

ResponseDebugInfo

對回應的偵錯資訊。

JSON 表示法 
{
  "formattedDebugInfo": string
}
欄位
formattedDebugInfo

string

顯示格式的一般偵錯資訊。

ErrorInfo

回應相關錯誤資訊。

JSON 表示法 
{
  "errorMessages": [
    {
      object (ErrorMessage)
    }
  ]
}
欄位
errorMessages[]

object (ErrorMessage)

ErrorMessage

每個來源回應的錯誤訊息。

JSON 表示法 
{
  "source": {
    object (Source)
  },
  "errorMessage": string
}
欄位
source

object (Source)
errorMessage

string

ResultCounts

結果數量資訊

JSON 表示法 
{
  "sourceResultCounts": [
    {
      object (SourceResultCount)
    }
  ]
}
欄位
sourceResultCounts[]

object (SourceResultCount)

每個含有結果的來源的結果數量資訊。

SourceResultCount

每項來源的結果計數資訊。

JSON 表示法 
{
  "source": {
    object (Source)
  },
  "hasMoreResults": boolean,

  // Union field result_count can be only one of the following:
  "resultCountEstimate": string,
  "resultCountExact": string
  // End of list of possible types for union field result_count.
}
欄位
source

object (Source)

與結果計數資訊相關聯的來源，
hasMoreResults

boolean

是否還有其他與這個來源相關的搜尋結果。

聯集欄位 result_count。

result_count 只能採用下列其中一種設定：
resultCountEstimate

string (int64 format)

這個來源的預估結果數量。
resultCountExact

string (int64 format)

這個來源的實際結果數量。