REST Resource: settings.searchapplications

資源：SearchApplication

搜尋應用程式

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
欄位
name

string

搜尋應用程式的名稱。

格式：searchapplications/{applicationId}。
displayName

string

搜尋應用程式的顯示名稱。長度上限為 300 個字元。
dataSourceRestrictions[]

object (DataSourceRestriction)

將設定套用至設定。元素數量上限為 10 個。
sourceConfig[]

object (SourceConfig)

在 DataSourceRestrictions 中指定的來源設定。
scoringConfig

object (ScoringConfig)

排名結果設定。
defaultSortOptions

object (SortOptions)

搜尋結果的排序選項
defaultFacetOptions[]

object (FacetOptions)

傳回商情項目結果的預設欄位。此處指定的來源也已納入上述的dataSourceRestrictions中。
returnResultThumbnailUrls

boolean

每一項結果都應傳回縮圖的 URI (如適用)
operationIds[]

string

僅供輸出。針對這個結構定義執行的長時間執行作業 (LRO) ID。僅限輸出欄位。
enableAuditLog

boolean

指出是否針對查詢查詢 API 搜尋應用程式的要求開啟/關閉稽核記錄。
queryInterpretationConfig

object (QueryInterpretationConfig)

查詢解譯的預設選項

資料來源限制

資料來源限制。

JSON 表示法 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
欄位
source

object (Source)

限制的來源。
filterOptions[]

object (FilterOptions)

用來限制結果的篩選器選項。如果有多個篩選器，系統會依物件類型將篩選器分組，然後再加入群組。系統會結合彙整相同物件類型的篩選條件，然後將產生的運算式合併在一起。

元素數量上限為 20 個。

注意：建議 API 目前只支援少數篩選器：「objecttype」、「type」和「mimetype」。目前，結構定義特定的篩選器無法用於篩選建議。

資料來源

定義建議/搜尋 API 的來源。

JSON 表示法 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
欄位

聯集欄位 source。

source 只能是下列其中一個值：
name

string

Indexing API 建立索引的內容來源名稱。
predefinedSource

enum (Source.PredefinedSource)

Google Apps 的預先定義內容來源。

Source.預先定義來源

預先定義的來源：

列舉
NONE
QUERY_HISTORY 提供使用者過去提出的查詢建議。這個 API 僅適用於建議 API，在查詢 API 中使用時忽略這個屬性。
PERSON 建議機構中的使用者。這個 API 僅適用於建議 API，在查詢 API 中使用時會產生錯誤。
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

篩選器選項

要套用至查詢的篩選器選項。

JSON 表示法 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
欄位
objectType

string

如果已設定 objectType，則只會傳回該類型的物件。此名稱應對應到在結構定義中定義的註冊物件名稱。長度上限為 256 個字元。
filter

object (Filter)

用於限制搜尋的一般篩選器，例如 lang:en、site:xyz。

篩選

一個在查詢中表示篩選器的一般方法，可支援下列兩種方法：

1. 設定 ValueFilter。這個名稱必須與資料來源架構中定義的運算子名稱相符。

2. 設定複合式篩選器。系統會使用邏輯運算子來評估篩選器。頂層運算子只能是 AND 或 NOT。且只能出現在最頂層。或者只能出現在頂層 AND 底下。

JSON 表示法 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
欄位

聯集欄位 filter。

filter 只能是下列其中一個值：
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

篩選器值

JSON 表示法 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
欄位
operatorName

string

套用至查詢的 operatorName，例如 price_greater_than。篩選器可以根據資料來源結構定義中所定義的兩種篩選器類型運作：

  1. operatorName，其中查詢會根據符合該值的屬性篩選結果。

  2. 結構定義中的 greaterThanOperatorName 或 lessThanOperatorName。查詢會篩選結果中，超過或低於查詢中所提供值的屬性值。
value

object (Value)

要比較的值。

值

具有一般類型的單一值定義。

JSON 表示法 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
欄位
聯集欄位 value。已命名屬性的值。value 只能是下列其中一項：
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

RFC3339 UTC 的「Zulu」格式的時間戳記，單位為奈秒解析度，最多可達 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
booleanValue

boolean
dateValue

object (Date)

篩選器.複合篩選器

JSON 表示法 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
欄位
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

子篩選器的邏輯運算子。
subFilters[]

object (Filter)

子篩選器。

Filter.CompositeFilter.LogicOperator

列舉
AND 邏輯運算子，只能套用至子篩選器。
OR
NOT 「無法」套用於單一子篩選器。

SourceConfig

在處理 query.search 或 query.suggest 要求時，來源的設定。

JSON 表示法 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
欄位
source

object (Source)

要使用的設定來源。
scoringConfig

object (SourceScoringConfig)

來源的評分設定。
crowdingConfig

object (SourceCrowdingConfig)

來源的擁擠設定。

SourceScoringConfig

調整分數設定。這可讓您修改來源的結果排名。

JSON 表示法 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
欄位
sourceImportance

enum (SourceScoringConfig.SourceImportance)

來源的重要性。

SourceScoringConfig.SourceImportance

來源的重要性，可用來表示是否要將特定來源優先度優先於其他來源。

列舉
DEFAULT
LOW
HIGH

SourceCrowdingConfig

設定搜尋結果數量上限。「群眾外包」是指同一來源或主機的多個結果「剔除」其他結果，降低了搜尋品質。要在搜尋結果中獲得更好的搜尋品質和來源多元性，您可以設定條件，依來源減少重複的搜尋結果。

JSON 表示法 
{
  "numResults": integer,
  "numSuggestions": integer
}
欄位
numResults

integer

結果網頁上資料來源的數目上限，前提是其他來源的結果並未用盡。指定的值不得為負數。如果這個值等於 0，系統會使用預設值。如要停用擁擠功能，請將值設為 100 以上。
numSuggestions

integer

來源允許的建議數量上限。如果這個值小於或等於 0，則不會對結果設定數量限制。

計分設定

在處理 query.search 或 query.suggest 要求時，為來源計算分數。

JSON 表示法 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
欄位
disableFreshness

boolean

是否使用最新程度做為排名信號。根據預設，更新頻率是排名信號的參考依據。請注意，這項設定不適用於管理員使用者介面。
disablePersonalization

boolean

是否要將結果個人化。根據預設，系統會使用個人信號來提高廣告成效。

SortOptions

JSON 表示法 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
欄位
operatorName

string

與要排序的欄位對應的運算子名稱。對應的屬性必須標示為 sortable。
sortOrder

enum (SortOptions.SortOrder)

「遞增」是預設的排序順序

排序選項.SortOrder

列舉
ASCENDING
DESCENDING

FacetOptions

指定要傳回 face 結果的運算子。每個 sourceName/objectType/operatorName 組合會有一個 FacetResult。

JSON 表示法 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
欄位
sourceName

string

商情項目來源名稱。格式：datasources/{sourceId} 留空，系統將使用所有資料來源。
objectType

string

如果已設定 objectType，則只有該類型的物件會用來計算商情項目。如果留空，所有物件都會用於計算商情項目。
operatorName

string

為商情項目選擇的運算子名稱。@請參閱 cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

應針對此商情項目傳回的商情項目值區數目上限。預設值為 10。上限為 100。
integerFacetingOptions

object (IntegerFacetingOptions)

如果設定這個值，將說明指定整數屬性的整數商情項目選項。結構定義中對應的整數屬性應標示為 isFacetable。傳回的值區數量至少會和 numFacetBuckets 相同。

IntegerFacetingOptions

用於指定整數商情項目選項。

JSON 表示法 
{
  "integerBuckets": [
    string
  ]
}
欄位
integerBuckets[]

string (Int64Value format)

指定整數值的值區應依照遞增順序遞增。例如，如果提供的值是 (1,5,10,100)，那裡可能形成以下面分紙 {<1, [1,5), [5-10), [10-100), >=100}.

查詢解譯設定

用來解讀使用者查詢的預設選項。

JSON 表示法 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
欄位
forceVerbatimMode

boolean

啟用這個標記後，即可關閉所有內部最佳化作業，例如自然語言 (NL) 查詢、補充搜尋結果擷取，以及使用同義詞 (包括自訂查詢) 的同義詞。如果這個標記設為 True，系統會優先於「查詢」層級設定的選項。如果將預設值設為 False，查詢層級旗標將為逐字模式設定正確的解譯。
forceDisableSupplementalResults

boolean

設定此標記即可停用補充結果擷取功能，在這裡設定旗標並不會擷取與指定搜尋應用程式相關的查詢。如果這個標記設為 True，系統會優先於「查詢」層級設定的選項。如果預設值為 False，查詢層級旗標會針對補充結果設定正確的解讀。

方法

create

 建立搜尋應用程式。

delete

 刪除搜尋應用程式。

get

 取得指定搜尋應用程式。

list

 列出所有搜尋應用程式。

patch

 更新搜尋應用程式。

reset

 將搜尋應用程式重設為預設設定。

update

 更新搜尋應用程式。