Method: query.search

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

注意：執行這個 API 需要標準使用者帳戶。服務帳戶無法直接執行查詢 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 之間 (含 1 和 100)。預設值為 10。如要要求超過 2000 筆結果，最小值為 50。
start

integer

結果的起始索引。
dataSourceRestrictions[]

object (DataSourceRestriction)

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

object (FacetOptions)
sortOptions

object (SortOptions)

排序搜尋結果的選項
queryInterpretationOptions

object (QueryInterpretationOptions)

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

object (ContextAttribute)

要求的內容屬性，用於調整搜尋結果的排名。元素數量上限為 10。

回應主體

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

Search 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 可停用自然語言解讀功能。自然語言解讀功能僅適用於預先定義的資料來源。
enableVerbatimMode

boolean

啟用這個標記可關閉所有內部最佳化功能，例如查詢的自然語言 (NL) 解讀、附加結果擷取，以及同義詞 (包括自訂同義詞) 的使用。如果這兩個標記中的任一標記為 true，系統就會停用 Nl 解讀。
disableSupplementalResults

boolean

使用這個旗標可停用查詢的補充結果。如果設為 True，系統會優先採用在 SearchApplication 層級所選取的補充結果設定。

QueryInterpretation

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

string

搜尋中使用的查詢解讀方式。舉例來說，如果查詢含有自然語言意圖 (例如「來自 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 原始查詢的結果會與其他結果混合。下方的「Reason」欄位會填入將這些其他結果與原始查詢結果混合的原因。
REPLACE 原始查詢的結果會遭到取代。系統會在下方的「Reason」欄位中填入取代原始查詢結果的原因。

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

相符的程式碼片段範圍 ([start, end])。

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」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

搜尋結果中物件上次修改的日期。如果未在項目中設定，則此處傳回的值為空白。如果 updateTime 用於計算新鮮度，但未設定，則這個值預設為從目前時間算起的 2 年。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："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

顯示查詢結果的欄位

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

來源專屬面向回應

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

string

傳回面向維度的來源名稱。不會為空白。
objectType

string

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

string

用於切面的運算子名稱。@see cloudsearch.SchemaPropertyOptions
buckets[]

object (FacetBucket)

回應中值的 FacetBuckets，其中至少包含一個相應篩選器的結果。

FacetBucket

面向的值區是運算的基本單位。取樣區塊可以包含單一值或相鄰的值範圍，取決於取樣欄位的類型。FacetBucket 目前只用於傳回回應物件。

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

integer

符合值範圍值的結果數量。只有在確保計數準確度時，系統才會針對搜尋傳回計數。Cloud Search 無法保證任何查詢的面向計數，而且即使是相同的查詢，面向計數也可能只會間歇性顯示。請勿依據切面的計數存在情況建立依附元件，而是使用一律會傳回的切面計數百分比。
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)

這個來源的確切結果數量。