- 資源:SearchApplication
- DataSourceRestriction
- 來源
- Source.PredefinedSource
- FilterOptions
- 篩選器
- Filter.ValueFilter
- Value
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- 方法
資源:SearchApplication
SearchApplication
JSON 表示法 |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
欄位 | |
---|---|
name |
搜尋應用程式的名稱。 格式:searchapplications/{applicationId}。 |
displayName |
搜尋應用程式的顯示名稱。長度上限為 300 個半形字元。 |
dataSourceRestrictions[] |
套用至設定的重試動作。元素數量上限為 10 個。 |
sourceConfig[] |
dataSourceLimit 中指定的來源設定。 |
scoringConfig |
排名結果設定。 |
defaultSortOptions |
搜尋結果的預設排序選項 |
defaultFacetOptions[] |
傳回 facet 結果的預設欄位。此處指定的來源也已包含在上方的 |
returnResultThumbnailUrls |
針對每個結果,我們應該傳回縮圖的 URI (如適用) |
operationIds[] |
僅供輸出。目前針對此結構定義執行的長時間執行的作業 (LRO) ID。僅限輸出的欄位。 |
enableAuditLog |
指出是否針對查詢 API 中的搜尋應用程式要求,開啟/關閉稽核記錄。 |
queryInterpretationConfig |
查詢解讀的預設選項 |
DataSourceRestriction
資料來源的限制。
JSON 表示法 |
---|
{ "source": { object ( |
欄位 | |
---|---|
source |
限制來源。 |
filterOptions[] |
篩選選項來限制結果。如有多個篩選器,系統會在彙整前先按照物件類型分組。相同物件類型的篩選器會接連地合併,然後產生的運算式會斷定地合併。 元素數量上限為 20 個。 注意:Suggest API 目前僅支援「objecttype」、「type」和「mimetype」。目前無法使用結構定義專屬的篩選器來篩選建議。 |
來源
定義 make/search API 的來源。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位
|
|
name |
由 |
predefinedSource |
Google Apps 的預先定義內容來源。 |
Source.PredefinedSource
預先定義的來源:
列舉 | |
---|---|
NONE |
|
QUERY_HISTORY |
顯示使用者過去發出的查詢建議。只有在與建議 API 搭配使用時才有效。在查詢 API 中使用時忽略。 |
PERSON |
推薦機構中的使用者。只有在與建議 API 搭配使用時才有效。在查詢 API 中使用時會導致錯誤。 |
GOOGLE_DRIVE |
|
GOOGLE_GMAIL |
|
GOOGLE_SITES |
|
GOOGLE_GROUPS |
|
GOOGLE_CALENDAR |
|
GOOGLE_KEEP |
FilterOptions
要在查詢中套用的篩選器選項。
JSON 表示法 |
---|
{
"objectType": string,
"filter": {
object ( |
欄位 | |
---|---|
objectType |
如果設定了 objectType,系統只會傳回該類型的物件。這個值必須與在結構定義定義的物件名稱對應。長度上限為 256 個半形字元。 |
filter |
限制搜尋的一般篩選器,例如 |
篩選器
在查詢中表示篩選器的一般方式,支援以下兩種方法:
1. 設定 ValueFilter。這個名稱必須與資料來源結構定義中定義的 OperatorName 相符。
2. 設定 CompositeFilter系統會使用邏輯運算子評估篩選器。頂層運算子只能使用 AND 或 NOT。AND 只能顯示在頂層。OR 只能顯示在頂層「且」下。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
JSON 表示法 |
---|
{
"operatorName": string,
"value": {
object ( |
欄位 | |
---|---|
operatorName |
套用至查詢的
|
value |
要用來比較的值。 |
值
使用一般類型的單一值定義。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 value 。具名屬性的值。value 只能是下列其中一項: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
JSON 表示法 |
---|
{ "logicOperator": enum ( |
欄位 | |
---|---|
logicOperator |
子篩選器的邏輯運算子。 |
subFilters[] |
子篩選器。 |
Filter.CompositeFilter.LogicOperator
列舉 | |
---|---|
AND |
邏輯運算子,只能套用至子篩選器。 |
OR |
|
NOT |
「不」只能套用於單一子篩選器。 |
SourceConfig
處理 query.search
或 query.suggest
要求時的來源設定。
JSON 表示法 |
---|
{ "source": { object ( |
欄位 | |
---|---|
source |
這項設定要使用的來源。 |
scoringConfig |
來源的評分設定。 |
crowdingConfig |
來源的聚集設定。 |
SourceScoringConfig
設定評分設定。這麼做可讓你修改來源的搜尋結果排名。
JSON 表示法 |
---|
{
"sourceImportance": enum ( |
欄位 | |
---|---|
sourceImportance |
來源的重要性。 |
SourceScoringConfig.SourceImportance
指出是否應優先提高特定來源的排名。
列舉 | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
設定搜尋結果的數量上限。「擁擠」是指來自相同來源或主機的多個結果「超出」其他結果,進而降低使用者的搜尋品質。如要提升搜尋品質及來源多元性,你可以設定條件,減少依來源分類的重複結果。
JSON 表示法 |
---|
{ "numResults": integer, "numSuggestions": integer } |
欄位 | |
---|---|
numResults |
結果網頁上的資料來源允許的最大結果數 (前提是其他來源的結果除外)。指定的值不得為負數。如果這個值等於 0,系統會使用預設值。如要停用群眾功能,請將值設為大於 100。 |
numSuggestions |
單一來源允許的建議數量上限。如果這個值小於或等於 0,結果就不會設定任何限制。 |
ScoringConfig
處理 query.search
或 query.suggest
要求時,匯總來源設定。
JSON 表示法 |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
欄位 | |
---|---|
disableFreshness |
是否使用即時性做為排名信號。根據預設,更新頻率會做為排名信號使用。請注意,這項設定無法在管理員 UI 中找到。 |
disablePersonalization |
是否要個人化結果。根據預設,系統會使用個人信號提升成效。 |
SortOptions
JSON 表示法 |
---|
{
"operatorName": string,
"sortOrder": enum ( |
欄位 | |
---|---|
operatorName |
要排序的欄位的對應運算子名稱。對應的屬性必須標示為 |
sortOrder |
「遞增」是預設的排序順序 |
SortOptions.SortOrder
列舉 | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
指定要傳回 facet 結果的運算子。每個 sourceName/objectType/operatorName 組合都有一個 FacetResult。
JSON 表示法 |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
欄位 | |
---|---|
sourceName |
要開啟 facet 的來源名稱。格式:datasources/{sourceId} 如果留空,系統會使用所有資料來源。 |
objectType |
如果設定了 objectType,系統只會使用該類型的物件計算 facet。如果留空,所有物件都會用於計算 facet。 |
operatorName |
選擇用於 facet 處理的運算子名稱。@see cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
應針對此 Facet 傳回的 facet 值區數量上限。預設值為 10。最大值為 100。 |
integerFacetingOptions |
設定之後,會說明指定整數屬性的整數商情項目選項。結構定義中對應的整數屬性應標示為 isFacetable。傳回的值區數量會是這個值區與 numFacetbuckets 的最小值。 |
IntegerFacetingOptions
用於指定整數 facet 選項。
JSON 表示法 |
---|
{ "integerBuckets": [ string ] } |
欄位 | |
---|---|
integerBuckets[] |
指定整數值的值區應嚴格按照遞增順序排列。例如,如果提供的值為 (1,5,10,100),則下列商情項目值區將組成 {<1, [1,5), [5-10), [10-100), >=100}, |
QueryInterpretationConfig
解讀使用者查詢內容的預設選項。
JSON 表示法 |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
欄位 | |
---|---|
forceVerbatimMode |
啟用這個旗標即可關閉所有內部最佳化功能,例如查詢查詢的自然語言 (NL) 解讀、補充結果擷取,以及同義詞 (包括自訂) 的使用方式。如果這個旗標設為 True,優先順序將高於在查詢層級設定的選項。預設值為 False,查詢層級標記會為完整模式設定正確的解釋。 |
forceDisableSupplementalResults |
設定這個旗標即可停用補充結果擷取功能;在這裡設定旗標,並不會針對與指定搜尋應用程式相關聯的查詢擷取補充結果。如果這個旗標設為 True,優先順序將高於在查詢層級設定的選項。使用預設值 False 時,查詢層級標記會為補充結果設定正確的解讀方式。 |
方法 |
|
---|---|
|
建立搜尋應用程式。 |
|
刪除搜尋應用程式。 |
|
取得指定的搜尋應用程式。 |
|
列出所有搜尋應用程式。 |
|
更新搜尋應用程式。 |
|
將搜尋應用程式重設為預設設定。 |
|
更新搜尋應用程式。 |