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 等於「Document」。每個物件定義在結構定義中都必須具有獨特的名稱。名稱開頭必須是英文字母，後面只能包含英文字母 (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

表示屬性可用來產生商情項目。若屬性類型為物件，則無法設為 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

指出查詢中需要的運算子名稱，以便隔離整數屬性。舉例來說，如果運算子 Name 為 Priority，且屬性的名稱是 PriorityVal，則 Priority:<value> 之類的查詢只會顯示位於 Priority:<value> 的屬性值與 <value> 相符的結果。相對地，如果搜尋使用相同 <value> 的屬性值，且沒有運算子，則會傳回所有 <value> 與內容欄位中任何字串屬性或文字相符的項目。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。
lessThanOperatorName

string

指出查詢中所需的運算子名稱，以便使用小於運算子分隔整數屬性。舉例來說，如果 leftThanOperatorName 是 Priority below，且屬性的名稱是 PriorityVal，則 Priority 低:<value> 之類的查詢只會顯示符合下列條件的結果：名稱為 PriorityVal 的屬性值小於 <value> 時。運算子名稱只能使用小寫英文字母 (a-z)。長度上限為 32 個字元。
greaterThanOperatorName

string

指出查詢中所需的運算子名稱，以便使用大於的運算子隔離整數屬性。舉例來說，如果大於 grThanOperatorName 的「Priority above」，且屬性的名稱是 PriorityVal，則 Priority above:<value> 查詢只會顯示在 leftVal 屬性值大於 <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

指出查詢中為了區隔時間戳記屬性所需的運算子名稱。舉例來說，如果運算子 Name 為 closedon，且屬性的名稱是 closeDate，則 closedon:<value> 這類查詢只會傳回 closeDate 屬性值與 <value> 相符的結果。相反地，如果搜尋使用相同 <value> 且沒有運算子，則會傳回所有 <value> 與內容欄位中任何字串屬性或文字相符的項目。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。
lessThanOperatorName

string

指出查詢中所需的運算子名稱，以便使用小於運算子分隔時間戳記屬性。舉例來說，如果 leftThanOperatorName 設為 closedbefore，且屬性的名稱是 closeDate，則 closedbefore:<value> 之類的查詢只會顯示在 closeDate 屬性的值早於 <value> 時的結果。運算子名稱只能使用小寫英文字母 (a-z)。長度上限為 32 個字元。
greaterThanOperatorName

string

指出查詢中所需的運算子名稱，以便使用大於的運算子分隔時間戳記屬性。舉例來說，如果大於更大的 ThanOperatorName 且屬性名稱是 closeDate，且屬性名稱是 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

指出查詢中為了隔離布林屬性所需的運算子名稱。舉例來說，如果運算子 Name 為 closed，且屬性的名稱為 isClosed，則 closed:<value> 這類查詢只會顯示 isClosed 屬性值與 <value> 相符的結果。相反地，如果搜尋使用相同 <value> 且沒有運算子，則會傳回所有 <value> 與內容欄位中任何字串屬性或文字相符的項目。運算子名稱只能使用小寫英文字母 (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)

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

enum (EnumPropertyOptions.OrderedRanking)

用於指定列舉的排序排名，藉此決定在可能的 EnumValuePairs 中提供的整數值如何用於排名結果。如有指定，您必須為此屬性為所有可能的 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 字詞的查詢會傳回具有 p0 做為 Priority 屬性值的項目，以及其他欄位中含有 p0 字串的項目。如果您為列舉提供運算子名稱 (例如 Priority)，搜尋使用者就可以使用該運算子，將結果縮小為以 p0 做為屬性值，且查詢 Priority:p0。

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

string

指出查詢中為了隔離列舉屬性所需的運算子名稱。舉例來說，如果運算子 Name 為 Priority，且屬性的名稱是 PriorityVal，則 Priority:<value> 之類的查詢只會顯示位於 Priority:<value> 的屬性值與 <value> 相符的結果。相對地，如果搜尋使用相同 <value> 的屬性值，且沒有運算子，則會傳回所有 <value> 與內容欄位中任何字串屬性或文字相符的項目。運算子名稱只能使用小寫英文字母 (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:<value> 等查詢只會列出 closeDate 屬性值與 <value> 相符的結果。相對來說，如果搜尋使用相同 <value> 且不含運算子，會傳回所有項目，其中 <value> 會與已建立索引資料來源的內容欄位中任何字串屬性或文字相符。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。
lessThanOperatorName

string

指出查詢中所需的運算子名稱，以便使用小於運算子分隔日期屬性。舉例來說，如果 leftThanOperatorName 設為 closedbefore，且屬性的名稱是 closeDate，則 closedbefore:<value> 之類的查詢只會顯示在 closeDate 屬性的值早於 <value> 時的結果。運算子名稱只能使用小寫英文字母 (a-z)。長度上限為 32 個字元。
greaterThanOperatorName

string

指出查詢中所需的運算子名稱，以便使用大於的運算子分隔日期屬性。舉例來說，如果大於更大的 ThanOperatorName 且屬性名稱是 closeDate，且屬性名稱是 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

指出查詢中為了隔離文字屬性所需的運算子名稱。舉例來說，如果運算子 Name 是 subject，屬性的名稱是 subjectLine，那麼 subject:<value> 這類查詢就只會顯示名為 subjectLine 的屬性值與 <value> 相符的結果。相反地，如果搜尋的 <value> 與項目內容欄位的值相同，則系統會傳回所有 <value> 與該項目內容值相符的項目。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。
exactMatchWithOperator

boolean

如為 true，則在運算子搜尋和 Facet 比對中，文字值會代碼化為單一不可部分的值。舉例來說，如果運算子名稱為「類」，而值是「science-辨識」；查詢限制「類型：科學」和「類型：虛構」則與項目不符，而「類型：science-這類內容」。比對文字值時區分大小寫，且不會移除特殊字元。如果為 false，則會權杖化文字。舉例來說，如果值是「science-science」，「type:science」和「type:material」查詢會比對該項目。

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 屬性所需的運算子名稱。舉例來說，如果運算子 Name 是 subject，屬性的名稱是 subjectLine，那麼 subject:<value> 這類查詢就只會顯示名為 subjectLine 的屬性值與 <value> 相符的結果。相反地，如果搜尋作業與 <value> 的值相同，且 <value> 與項目內容欄位中任何 html 屬性或文字相符，則會傳回所有結果。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。

PropertyDisplayOptions

屬性的顯示選項。

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

string

如果指定在 ObjectDisplayOptions 中顯示屬性，會使用的屬性容易理解的標籤。如有提供，當該屬性屬於物件顯示選項時，顯示標籤會顯示在屬性值前面。舉例來說，如果屬性值是「1」，那麼這個值本身本身就不實用，對使用者而言可能沒有幫助。如果顯示名稱的為「優先順序」，使用者在搜尋結果中看到「優先順序 : 1」時，會為搜尋使用者提供清楚的背景資訊。這是選用項目，如未指定，只會顯示屬性值。長度上限為 64 個半形字元。