Schema

資料來源的結構定義。

JSON 表示法 
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
欄位
objectDefinitions[]

object (ObjectDefinition)

資料來源的頂層物件清單。元素的數量上限為 10 個。
operationIds[]

string

目前針對這個結構定義執行的長時間執行作業 (LRO) ID。修改結構定義之後，請等待作業完成，再為其他內容建立索引。

ObjectDefinition

資料來源中物件的定義。

JSON 表示法 
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
欄位
name

string

物件名稱，該名稱會定義其類型。項目索引要求的「objectType」欄位應設為這個值。舉例來說，如果 name 是「Document」，那麼針對「文件」類型的項目建立索引的要求應將 objectType 設為「文件」。在結構定義中，每個物件定義皆不得重複。名稱開頭須為英文字母，而且只能使用英文字母 (A-Z、a-z) 或數字 (0-9)。長度上限為 256 個半形字元。
options

object (ObjectOptions)

選用的物件特定選項。
propertyDefinitions[]

object (PropertyDefinition)

物件的屬性定義。元素數量上限為 1000 個。

ObjectOptions

物件的選項。

JSON 表示法 
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
欄位
freshnessOptions

object (ObjectOptions.FreshnessOptions)

物件的更新間隔選項。
displayOptions

object (ObjectDisplayOptions)

決定物件在 Cloud Search 結果頁面中顯示方式的選項。
suggestionFilteringOperators[]

string

可用來篩選建議的運算子。如果是 query.suggest API，只有此處提到的運算子會在 FilterOptions 中有效。僅支援 TEXT 和 ENUM 運算子。

注意：「objecttype」、「type」和「mimetype」。此屬性可設定結構定義專屬運算子。

雖然這是陣列，但只能指定一個運算子。這個陣列可用於日後的擴充性。

系統不支援對應至相同物件中的多個屬性的運算子。如果運算子橫跨不同的物件類型，就必須為每個物件定義設定一次此選項。

ObjectOptions.FreshnessOptions

指出調整項目搜尋排名時要使用的更新間隔屬性。日期越近越好，表示品質越高。使用最適合您資料的更新間隔屬性屬性。檔案共用文件的上次修改時間最為相關。至於日曆活動資料，事件發生時間是更具關聯性的即時性指標。如此一來，距離搜尋查詢時間近一點的日曆活動就會被視為品質較佳，並據此排名。

JSON 表示法 
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
欄位
freshnessProperty

string

這個屬性表示索引中物件的更新程度。如要設定，這個屬性必須是 property definitions 中的頂層屬性，且必須是 timestamp type 或 date type。否則，Indexing API 會使用 updateTime 做為更新間隔指標。長度上限為 256 個半形字元。

如果使用屬性計算更新間隔，該值會預設為目前時間的 2 年後。
freshnessDuration

string (Duration format)

系統會將物件視為過時的時間。預設值是 180 天 (以秒為單位)。

持續時間以秒為單位，最多 9 個小數位數，結尾為「s」。範例："3.5s"。

ObjectDisplayOptions

物件的顯示選項。

JSON 表示法 
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
欄位
objectDisplayLabel

string

使用者容易閱讀的標籤，用於表示項目類型。選用：如果沒有提供，則物件標籤就不會顯示在搜尋結果的內容行。長度上限為 64 個半形字元。
metalines[]

object (ObjectDisplayOptions.Metaline)

定義在搜尋結果中繼線中顯示的屬性。屬性值會按照這裡指定的順序顯示。如果屬性具有多個值，系統會將所有值顯示在下一個屬性之前。因此，建議您在這份清單中的重複屬性之前指定單一屬性。所有屬性都必須將 isReturnable 設為 true。中繼線的數量上限為 3 個。

ObjectDisplayOptions.Metaline

中繼線是會與搜尋結果一併顯示的屬性清單，以提供背景資訊。

JSON 表示法 
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
欄位
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

顯示的中繼屬性清單。屬性數量上限為 5 個。

ObjectDisplayOptions.DisplayedProperty

對要顯示在搜尋結果中的物件之頂層屬性的參照。如果有指定屬性的值，則會在搜尋結果中同時顯示所選屬性的值和 display label。如果未指定顯示標籤，則只會顯示值。

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

string

在物件的屬性定義中定義的頂層屬性名稱。如果名稱不是結構定義中已定義的屬性，則嘗試更新結構定義時就會發生錯誤。

PropertyDefinition

物件內的屬性定義。

JSON 表示法 
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
欄位
name

string

屬性的名稱。傳送至 Indexing API 的項目索引要求應將 property name 設為這個值。例如，如果名稱是 subject_line，那麼對於含有主旨欄位的文件項目索引要求，該欄位的 name 應設為等於 subject_line。使用名稱做為物件屬性的 ID。在註冊為物件的屬性之後，您就無法將該名稱重複用於該物件中的其他資源。名稱開頭須為英文字母，而且只能使用英文字母 (A-Z、a-z) 或數字 (0-9)。長度上限為 256 個半形字元。
isReturnable

boolean

表示屬性指出應透過 Query API 在搜尋結果中傳回的資料。如果設為 true，表示 Query API 使用者可以在結果中使用相符的屬性欄位。不過，儲存欄位需要分配較多空間，且搜尋查詢會使用較多頻寬，這會影響大型資料集的效能。只有在搜尋結果需要該欄位時才設為 true。類型為物件的屬性不可為 true。
isRepeatable

boolean

表示屬性可以有多個值。舉例來說，一份文件只有一種說明，但可加入多則註解。如果屬性的類型為布林值，則無法設為 true。如果設為 False，含有多個值的屬性將導致該項目的索引建立要求遭拒。
isSortable

boolean

表示屬性可用於排序。可重複屬性不可為 true。類型為物件的屬性不可為 true。IsReturnable 必須為 true，才能設定這個選項。僅支援布林值、日期、雙精度、整數和時間戳記屬性。
isFacetable

boolean

表示屬性可用於產生 facet。類型為物件的屬性不可為 true。IsReturnable 必須為 true，才能設定這個選項。僅支援布林值、列舉、整數和文字屬性。
isSuggestable

boolean

表示該屬性可用於產生查詢建議。
isWildcardSearchable

boolean

表示使用者可以對這個屬性執行萬用字元搜尋。僅支援文字屬性。IsReturnable 必須為 true，才能設定這個選項。在特定資料來源中，最多可以將 5 個資源標示為 isWildcardSearchable。詳情請參閱「定義物件屬性」。
displayOptions

object (PropertyDisplayOptions)

這些選項可決定屬性在 Cloud Search 結果頁面中的顯示方式 (如果已指定在物件的 display options 中顯示)。
聯集欄位 property_options。決定屬性建立索引和使用方式的類型專屬選項。如果該選項為某類型的預設選項，則此欄位仍必須設為其中一種類型。如未設定這個欄位，系統會拒絕結構定義更新。property_options 只能是下列其中一項：
integerPropertyOptions

object (IntegerPropertyOptions)
doublePropertyOptions

object (DoublePropertyOptions)
timestampPropertyOptions

object (TimestampPropertyOptions)
booleanPropertyOptions

object (BooleanPropertyOptions)
objectPropertyOptions

object (ObjectPropertyOptions)
enumPropertyOptions

object (EnumPropertyOptions)
datePropertyOptions

object (DatePropertyOptions)
textPropertyOptions

object (TextPropertyOptions)
htmlPropertyOptions

object (HtmlPropertyOptions)

IntegerPropertyOptions

整數屬性的選項。

JSON 表示法 
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
欄位
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

用於指定整數的排序排名。只有在 isRepeatable 為 false 時才能使用。
minimumValue

string (Int64Value format)

屬性的最小值。系統會根據 ordered ranking 的最小值和最大值為結果排名。系統會接受值低於下限的索引要求，並依據針對最低值建立索引的項目，採用相同的權重排名。
maximumValue

string (Int64Value format)

屬性的最大值。系統會根據 ordered ranking 的最小值和最大值為結果排名。系統會接受值大於上限的索引要求，並依據針對最大值建立索引的項目同等權重來排名。
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

如果已設定，請說明應如何使用整數做為搜尋運算子。
integerFacetingOptions

object (IntegerFacetingOptions)

如果設定，則會說明指定整數屬性的整數商情項目選項。對應的整數屬性應標示為 isFacetable。

IntegerPropertyOptions.OrderedRanking

用於指定整數值相對於其他值的排名方式。排名順序較高的整數表示重要性較高。舉例來說，在某些資料來源中，優先順序較低的資料來源代表重要性較高，其他來源則代表重要性越高。

列舉
NO_ORDER 這項資源沒有排名順序。結果不會根據這個屬性的值調整。
ASCENDING 這項屬性是依遞增順序排序。值越小表示排名越低。
DESCENDING 這項資源是按遞減順序排序。值越小，表示排名越高。

IntegerPropertyOptions.IntegerOperatorOptions

用於提供整數屬性的搜尋運算子。。query.search 運算子可讓使用者將查詢限制在與搜尋項目類型相關的特定欄位。

JSON 表示法 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
欄位
operatorName

string

表示查詢中需要的運算子名稱，才能隔離整數屬性。例如，如果 OperatorName 為 priority，而房源名稱是 priorityVal，則類似 priority:<value> 的查詢只會顯示符合 priorityVal 屬性值會讓結果顯示的結果<value>。相反地，如果搜尋使用相同的 &lt;value&gt; 但不使用運算子，則會傳回所有項目，當 &lt;value&gt; 與該項目內容欄位內任何字串屬性的值或文字相符。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。
lessThanOperatorName

string

表示查詢中所需的運算子名稱，以便使用「小於」運算子隔離整數屬性。舉例來說，如果 smallThanOperatorName 為 below，且屬性名稱是 priorityVal，則像 priority below:<value> 這樣的查詢只會顯示名為 priorityVal 屬性值小於 <value> 的結果。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。
greaterThanOperatorName

string

表示查詢中所需的運算子名稱，以便使用大於運算子分隔整數屬性。舉例來說，如果 moreThanOperatorName 是「Priority above」，房源名稱為 priorityVal，則像 Priority above:<value> 這樣的查詢只會顯示在 priorityVal 屬性值大於 <value> 時的結果。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。

DoublePropertyOptions

雙精度屬性的選項。

JSON 表示法 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
欄位
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

如果已設定，請說明使用雙精準數做為搜尋運算子的方式。

DoublePropertyOptions.DoubleOperatorOptions

用於提供雙精度屬性的搜尋運算子。。query.search 運算子可讓使用者將查詢限制在與搜尋項目類型相關的特定欄位。

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

string

指出查詢中所需的運算子名稱，以便使用雙屬性進行排序或做為 facet。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。

TimestampPropertyOptions

時間戳記屬性的選項。

JSON 表示法 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
欄位
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

如有設定，則會說明時間戳記應如何做為搜尋運算子。

TimestampPropertyOptions.TimestampOperatorOptions

用於提供時間戳記屬性的搜尋運算子。。query.search 運算子可讓使用者將查詢限制在與搜尋項目類型相關的特定欄位。

JSON 表示法 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
欄位
operatorName

string

表示查詢中需要的運算子名稱，才能隔離時間戳記屬性。例如，如果 OperatorName 是 closedon，且屬性名稱是 closeDate，那麼 closedon:<value> 這樣的查詢只會在 closeDate 屬性值與 <value> 相符時顯示結果。相反地，如果搜尋使用相同的 &lt;value&gt; 但不使用運算子，則會傳回所有項目，當 &lt;value&gt; 與該項目內容欄位內任何字串屬性的值或文字相符。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。
lessThanOperatorName

string

表示查詢中所需的運算子名稱，以便使用「小於」運算子區隔時間戳記屬性。例如，如果 smallThanOperatorName 為 closedbefore，而資源名稱為 closeDate，則 closedbefore:<value> 這樣的查詢只會在 closeDate 屬性值早於 <value> 時顯示的結果。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。
greaterThanOperatorName

string

表示查詢中所需的運算子名稱，以便使用大於運算子區隔時間戳記屬性。例如，如果 largeThanOperatorName 為 closedafter，且屬性名稱是 closeDate，則 closedafter:<value> 這類查詢只會顯示 closeDate 屬性值晚於 <value> 的結果。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。

BooleanPropertyOptions

布林屬性的選項。

JSON 表示法 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
欄位
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

如有設定，並說明應如何使用布林值做為搜尋運算子。

BooleanPropertyOptions.BooleanOperatorOptions

用於為布林屬性提供搜尋運算子。。query.search 運算子可讓使用者將查詢限制在與搜尋項目類型相關的特定欄位。

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

string

表示查詢中需要的運算子名稱，才能隔離布林屬性。例如，如果 OperatorName 為 closed，而資源名稱為 isClosed，則像 closed:<value> 這樣的查詢就只會顯示名為 isClosed 的屬性值符合 <value> 的結果。相反地，如果搜尋使用相同的 &lt;value&gt; 但不使用運算子，則會傳回所有項目，當 &lt;value&gt; 與該項目內容欄位內任何字串屬性的值或文字相符。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。

ObjectPropertyOptions

物件屬性的選項。

JSON 表示法 
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
欄位
subobjectProperties[]

object (PropertyDefinition)

子物件的屬性。這些屬性代表巢狀物件。舉例來說，如果這個屬性代表郵寄地址，子 objectProperties 的名稱可能是 street、city 和 state。元素數量上限為 1000 個。

EnumPropertyOptions

列舉屬性的選項，可讓您定義一組限用字串來比對使用者查詢、為這些字串值設定排名，以及定義要與這些字串配對的運算子名稱，讓使用者可縮小結果範圍，以便只查看具有特定值的項目。例如，對於具有優先順序資訊的要求追蹤系統中的項目，您可以將 p0 定義為允許的列舉值，並將此列舉繫結至運算子名稱 priority，讓搜尋使用者可以在查詢中加入 priority:p0，將結果限制為只傳回以 p0 值編入索引的項目。

JSON 表示法 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
欄位
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

列舉屬性的可能值清單。所有 EnumValuePair 都必須提供字串值。如果您為一個 EnumValuePair 指定整數值，則所有可能的 EnumValuePair 都必須提供整數值。在所有可能的值中，字串值和整數值都不得重複。設定後即無法移除或修改可能的值。如果提供已排序的排名，且認為日後可能會插入其他列舉值，請將初始整數值中的缺口留出，允許在先前註冊的值之間增加值。元素數量上限為 100 個。
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

用於指定列舉的排序排名，這可決定列舉的 EnumValuePair 所提供的整數值如何用來將結果排名。如有指定，必須為此屬性指定的所有可能 EnumValuePair 值提供整數值。只有在 isRepeatable 為 false 時才能使用。
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

如有設定，請說明列舉應如何做為搜尋運算子使用。

EnumPropertyOptions.EnumValuePair

列舉值組合定義了兩個內容：必要字串值和選用的整數值。字串值定義擷取該項目所需的查詢字詞，例如優先項目使用 p0。整數值決定該字串值相對於相同屬性其他列舉值的排名。舉例來說，您可以將 p0 與 0 建立關聯，然後定義另一個列舉組合，例如 p1 和 1。您必須使用整數值與 ordered ranking 搭配使用，才能為相同屬性名稱的其他列舉值設定特定值的排名。在這個範例中，Priority 屬性的 DESCENDING 排序結果，是指相較於索引為 p1 的項目，索引值為 p0 的項目在排名上會提高。在沒有指定排名順序的情況下，整數值不會影響項目排名。

JSON 表示法 
{
  "stringValue": string,
  "integerValue": integer
}
欄位
stringValue

string

EnumValuePair 的字串值。長度上限為 32 個字元。
integerValue

integer

EnumValuePair 的整數值，不得為負數。選填。

EnumPropertyOptions.OrderedRanking

用於指定 EnumValuePair 整數相對於其他 EnumValuePair 整數值的排名方向。對某些屬性來說，整數值越小表示重要性越高，在其他屬性中，整數值則代表重要性較高。

列舉
NO_ORDER 這項資源沒有排名順序。結果不會依此屬性的值調整。
ASCENDING 這項屬性是依遞增順序排序。值越小表示排名越低。
DESCENDING 這項資源是按遞減順序排序。值越小，表示排名越高。

EnumPropertyOptions.EnumOperatorOptions

用於提供列舉屬性的搜尋運算子。。query.search 運算子可讓使用者將查詢限制在與搜尋項目類型相關的特定欄位。舉例來說，如果您沒有為 priority 列舉屬性提供可能值為 p0 和 p1 的運算子，則包含字詞 p0 的查詢會傳回在 priority 屬性值擁有 p0 的項目，以及其他欄位中含有 p0 字串的項目。如果您為列舉提供運算子名稱 (例如 Priority)，則搜尋使用者可使用該運算子，只傳回含有 p0 這個屬性值的項目，查詢方式為 priority:p0。

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

string

表示查詢中需要的運算子名稱，才能隔離列舉屬性。例如，如果 OperatorName 為 priority，而房源名稱是 priorityVal，則類似 priority:<value> 的查詢只會顯示符合 priorityVal 屬性值會讓結果顯示的結果<value>。相反地，如果搜尋使用相同的 &lt;value&gt; 但不使用運算子，則會傳回所有項目，當 &lt;value&gt; 與該項目內容欄位內任何字串屬性的值或文字相符。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。

DatePropertyOptions

日期屬性的選項。

JSON 表示法 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
欄位
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

如果已設定，請說明使用日期做為搜尋運算子的方式。

DatePropertyOptions.DateOperatorOptions

選用設定。提供日期屬性的搜尋運算子。query.search 運算子可讓使用者將查詢限制在與搜尋項目類型相關的特定欄位。

JSON 表示法 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
欄位
operatorName

string

表示在查詢中要隔離日期屬性所需的實際字串。舉例來說，假設問題追蹤結構定義物件的屬性名為 closeDate，其中指定運算子名稱為 closedon 的運算子。針對這項資料的搜尋，closedon:&lt;value&gt; 這樣的查詢只會顯示 closedon:&lt;value&gt; 屬性值與 closedon:&lt;value&gt; 相符的結果。相反地，如果搜尋使用相同的 &lt;value&gt; 但不使用運算子，則會傳回所有項目，當 &lt;value&gt; 與索引資料來源內容欄位中任何字串屬性值或文字相符。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。
lessThanOperatorName

string

表示查詢中所需的運算子名稱，以便使用「小於」運算子分隔日期屬性。例如，如果 smallThanOperatorName 為 closedbefore，而資源名稱為 closeDate，則 closedbefore:<value> 這樣的查詢只會在 closeDate 屬性值早於 <value> 時顯示的結果。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。
greaterThanOperatorName

string

表示查詢中所需的運算子名稱，以便使用大於運算子找出日期屬性。例如，如果 largeThanOperatorName 為 closedafter，且屬性名稱是 closeDate，則 closedafter:<value> 這類查詢只會顯示 closeDate 屬性值晚於 <value> 的結果。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。

TextPropertyOptions

文字屬性的選項。

JSON 表示法 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
欄位
retrievalImportance

object (RetrievalImportance)

表示在擷取時，欄位中符記的搜尋品質重要性。
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

如果有設定，請說明使用屬性做為搜尋運算子的方式。

RetrievalImportance

JSON 表示法 
{
  "importance": enum (RetrievalImportance.Importance)
}
欄位
importance

enum (RetrievalImportance.Importance)

用於表示在擷取期間，與屬性相符的排名重要性。設定後，即無法變更屬性的符記重要性。

RetrievalImportance.Importance

列舉
DEFAULT 視為相符內容的處理方式。
HIGHEST 將相符項目視為與項目標題進行比對。
HIGH 請將相符項目的優先順序設為高於內文。
LOW 以低於內文文字的重要性來篩選相符項目。
NONE 擷取時請勿與這個欄位進行比對。這個屬性仍可用於運算子比對、商情項目和建議 (如有需要)。

TextPropertyOptions.TextOperatorOptions

用於提供文字屬性的搜尋運算子。。query.search 運算子可讓使用者將查詢限制在與搜尋項目類型相關的特定欄位。

JSON 表示法 
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
欄位
operatorName

string

表示查詢中需要的運算子名稱，才能隔離文字屬性。例如，如果 OperatorName 為 subject，且屬性名稱是 subjectLine，那麼 subject:<value> 這樣的查詢就只會顯示 subjectLine 屬性值與 <value> 相符的結果。相反地，如果搜尋使用相同的 &lt;value&gt; 但不使用運算子，則會傳回所有項目，當 &lt;value&gt; 與項目內容欄位中任何文字屬性的值或文字相符。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。
exactMatchWithOperator

boolean

如果設為 true，則在運算子搜尋與 facet 比對中，文字值會代碼化為一個不可分割的值。舉例來說，如果運算子名稱為「類型」，並將值設為「science-的情況」查詢限制「Type:science」以及「類型:虛構」與該項目不符；「類型:科幻」確實如此文字值比對會區分大小寫，且不會移除特殊字元。如果為 false，則為代碼化文字。例如，如果值為「science-cpm」"Type:science" 查詢。以及「類型:虛構」符合項目。

HtmlPropertyOptions

HTML 屬性的選項。

JSON 表示法 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
欄位
retrievalImportance

object (RetrievalImportance)

表示在擷取時，欄位中符記的搜尋品質重要性。只能設為「DEFAULT」或「NONE」。
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

如果有設定，請說明使用屬性做為搜尋運算子的方式。

HtmlPropertyOptions.HtmlOperatorOptions

用於提供 html 屬性的搜尋運算子。。query.search 運算子可讓使用者將查詢限制在與搜尋項目類型相關的特定欄位。

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

string

表示查詢中需要的運算子名稱，才能隔離 HTML 屬性。例如，如果 OperatorName 為 subject，且屬性名稱是 subjectLine，那麼 subject:<value> 這樣的查詢就只會顯示 subjectLine 屬性值與 <value> 相符的結果。相反地，如果搜尋使用相同的 &lt;value&gt; 但不使用運算子，則會傳回所有項目，當 &lt;value&gt; 與項目內容欄位中任何 html 屬性的值或文字相符。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。

PropertyDisplayOptions

屬性的顯示選項。

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

string

屬性的易用標籤 (屬性指定在 ObjectDisplayOptions 中顯示時)。如有提供，當屬性是物件顯示選項的一部分時，顯示標籤會顯示在屬性值前方。舉例來說，如果屬性值是「1」，則該值本身對於使用者來說可能不是有用的情境。如果指定的顯示名稱是「priority」，則使用者會看到「priority : 1」能為搜尋使用者提供清楚的背景資訊。選用：如未指定，則只會顯示屬性值。長度上限為 64 個半形字元。