Schema

資料來源的結構定義。

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

object (ObjectDefinition)

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

string

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

物件定義

資料來源中物件的定義。

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 個。

物件選項

物件的選項。

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"。

物件顯示選項

物件的顯示選項。

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 個。

物件顯示選項.顯示屬性

物件中頂層屬性的參照，要顯示在搜尋結果。所選屬性的值將顯示在搜尋結果中，以及該屬性的 display label (如有指定)。如果未指定顯示標籤，則只會顯示值。

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

string

在物件的屬性定義中定義的頂層屬性名稱。如果名稱並非結構定義中的已定義屬性，就會嘗試嘗試更新結構定義。

屬性定義

物件中屬性的定義。

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。請使用此名稱做為物件屬性的識別碼。註冊為物件的屬性後，您就無法將該物件中的另一個屬性重複使用這個名稱。名稱開頭須為英文字母，而且只能包含字母 (A-Z、a-z) 或數字 (0-9)。長度上限為 256 個字元。
isReturnable

boolean

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

boolean

表示該屬性允許多個值。舉例來說，一個文件只能含有一項說明，但可以有一則註解。屬性不能為布林值屬性，不得為 True。如果設為 false，如果屬性包含多個值，會導致該項目的索引要求遭到拒絕。
isSortable

boolean

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

boolean

表示這項屬性可用於產生商情項目。如果屬性為物件，則不得為 true。IsReturnable 必須為 true 才能設定此選項。僅適用於布林值、列舉、整數和文字屬性。
isSuggestable

boolean

表示這個屬性可用來產生查詢建議。
isWildcardSearchable

boolean

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

object (PropertyDisplayOptions)

指定在 Cloud 搜尋結果網頁上顯示屬性時的選項 (如果已指定在物件的 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

指出查詢中必須涵蓋的運算子名稱，以便區隔整數屬性。舉例來說，如果運算子名稱是 priority，且屬性名稱為 priorityVal，則 priority:<value> 等查詢只有在結果中顯示 priorityVal 屬性值與 <value> 相符時，才會傳回結果。相較之下，如果搜尋與 <value> 相同，且所有 [value> 的值都符合內容欄位內任何字串字串或文字的值，系統就會傳回該項目。運算子名稱只能包含小寫英文字母 (a 至 z)。長度上限為 32 個字元。
lessThanOperatorName

string

指出查詢中所需的運算子名稱，以便使用小於的運算子來分隔整數屬性。舉例來說，如果較少的 TTTOperatorOperator 優先順序為，且屬性名稱是 priorityVal，則 priorityunder:<value> 之類的查詢只會顯示 priorityVal 屬性小於 <value> 的結果。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。
greaterThanOperatorName

string

指出查詢中所需的運算子名稱，以便使用大於大於運算子的整數屬性。舉例來說，如果 largeThanOperatorName 為 priority above，且屬性名稱為 priorityVal，則 priority above:<value> 等查詢會顯示結果，前提是屬性 priorityVal 的值大於 <value>。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。

DoubleProperty 選項

雙重屬性的選項。

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

object (DoublePropertyOptions.DoubleOperatorOptions)

如果設定這項政策，請提供要如何使用搜尋運算子的雙精度浮點值。

DoublePropertyOptions.DoubleOperatorOptions

用於提供雙元資源的搜尋運算子。這是選擇性的。query.search 運算子可讓使用者將查詢限制於與搜尋項目類型相關的特定欄位。

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

string

表示查詢中必須含有運算子名稱，才能在排序或以商情項目上使用 Double 屬性。運算子名稱只能包含小寫英文字母 (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

指出查詢中所需的運算子名稱，以隔離時間戳記屬性。舉例來說，如果運算子名稱是 closedon，而屬性名稱是 closeDate，那麼 closedon:<value> 之類的查詢就只會在名為 closeDate 屬性的值符合 <value> 的情況下顯示結果。相較之下，如果搜尋與 <value> 相同，但不含運算子中的 <value> 與內容欄位中任何字串屬性或文字相符，系統就會傳回該項目。運算子名稱只能包含小寫英文字母 (a 至 z)。長度上限為 32 個字元。
lessThanOperatorName

string

指出查詢中所需的運算子名稱，以便使用小於的運算子來區分時間戳記屬性。舉例來說，如果較少的變數是 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

指出查詢中所需的運算子名稱，以便隔離布林值屬性。舉例來說，如果運算子名稱是 closed，且屬性名稱是 isClosed，那麼只有在 isClosed 屬性的值符合 <value> 的情況下，結果才會傳回結果。相較之下，如果搜尋與 <value> 相同，且不含運算子的 <value> 與內容欄位中任何 String 屬性或文字的值相符，系統就會傳回該項目。運算子名稱只能包含小寫英文字母 (a 至 z)。長度上限為 32 個字元。

物件屬性選項

物件屬性的選項。

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

object (PropertyDefinition)

子物件的屬性。這些屬性代表一個巢狀物件。舉例來說，如果這項屬性代表的是郵寄地址，則子物件屬性的名稱可能為 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 指定一個整數值，那麼所有可能的 EnumValuePairs 都必須提供一個整數值。在所有的可能值中，字串值與整數值皆不得重複。設定後即無法移除或修改的值。如果您提供排序順序，並且認為日後可能會插入其他列舉值，請在初始整數值之間留下間隔，以允許在先前註冊的值之間新增值。元素數量上限為 100 個。
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

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

object (EnumPropertyOptions.EnumOperatorOptions)

設定後，請說明該如何將列舉當做搜尋運算子使用。

EnumPropertyOptions.EnumValuePair

列舉值會定義兩個項目：必要字串值和選用的整數值。字串值會定義擷取商品所需的必要查詢字詞，例如優先項目的 p0。此整數值會決定該字串值相對於相同屬性其他列舉值的排名。舉例來說，您可以將 p0 與 0 建立關聯，並定義另一個列舉組合，例如 p1 和 1。您必須將整數值與 ordered ranking 結合使用，才能設定指定值在相同屬性名稱與其他列舉值之間的排名。在這裡，D 屬性的 DESCENDING 排名順序在為 p0 值的項目與 p1 建立索引的項目相比會增加排名。如果沒有指定的排名順序，則整數值不會影響項目排名。

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

string

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

integer

EnumValuePair 的整數值必須為非負數。選用。

EnumPropertyOptions.OrderedRanking

用來指定 EnumValuePair 整數相對於其他 EnumValuePair 整數值的排名方向。對部分屬性而言，較低的整數值代表重要性較高，在其他屬性中，整數則代表重要性較高。

列舉
NO_ORDER 飯店沒有排序順序。結果不會依此屬性值調整。
ASCENDING 這個資源是依遞增順序排列。值越低表示排名較低。
DESCENDING 此屬性將依遞減順序排列。值越低表示排名越高。

EnumPropertyOptions.EnumOperatorOptions

用於為列舉屬性提供搜尋運算子。這是選擇性的。query.search 運算子可讓使用者將查詢限制於與搜尋項目類型相關的特定欄位。舉例來說，如果您沒有為優先順序 p0 和 p1 的 priority 列舉屬性提供運算子，則包含 p0 字詞的查詢會傳回 p0 做為 priority 屬性值，以及在其他欄位中包含字串 p0 的項目。如果您為列舉提供運算子名稱 (例如 priority)，搜尋使用者就可以利用這個運算子將結果修正為具有 p0 屬性值的項目，並搭配 priority:p0 查詢。

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

string

指出查詢中所需的運算子名稱，以便隔離 enum 屬性。舉例來說，如果運算子名稱是 priority，且屬性名稱為 priorityVal，則 priority:<value> 等查詢只有在結果中顯示 priorityVal 屬性值與 <value> 相符時，才會傳回結果。相較之下，如果搜尋與 <value> 相同，且所有 [value> 的值都符合內容欄位內任何字串字串或文字的值，系統就會傳回該項目。運算子名稱只能包含小寫英文字母 (a 至 z)。長度上限為 32 個字元。

日期屬性選項

日期屬性的選項。

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

object (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

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

string

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

文字屬性選項

文字屬性的選項。

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

object (RetrievalImportance)

用於指定欄位中的符記品質，用於擷取時使用。
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

如果設定此屬性，請說明應如何將此屬性用做搜尋運算子。

擷取重要性

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

指出查詢中所需的運算子名稱，以便區隔文字屬性。舉例來說，如果運算子名稱是 subject，屬性名稱是 subjectLine，那麼 subject:<value> 等查詢就只會針對名為 subjectLine 的屬性值符合 <value> 的結果顯示結果。相較之下，如果搜尋與 <value> 相同，但不含 <value> 與項目內容欄位中任何文字屬性或文字相符的項目，系統就會傳回該項目。運算子名稱只能包含小寫英文字母 (a 至 z)。長度上限為 32 個字元。
exactMatchWithOperator

boolean

如果為 true，文字值在運算子搜尋和商情項目比對中會代碼化為一個不可部分的值。舉例來說，如果運算子名稱是「types」，而值是「Science-科幻」，則查詢「限制類型」和「類型：小說」將與項目不符；而「types:Science-科幻」與項目不符。文字值比對須區分大小寫，而且不會移除特殊字元。如果為 false，文字會代碼化。例如，如果值是「Science-科幻」，那麼「types:Science」和「types:科幻」這個字詞就符合項目。

HTML 屬性選項

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 屬性。舉例來說，如果運算子名稱是 subject，屬性名稱是 subjectLine，那麼 subject:<value> 等查詢就只會在名為 subjectLine 的屬性值符合 <value> 時顯示結果。相反地，如果搜尋 <value> 未含運算子，系統就會傳回其內容欄位中所有 HTML 屬性或文字的值。運算子名稱只能包含小寫英文字母 (a 至 z)。長度上限為 32 個字元。

屬性顯示選項

資源的顯示選項。

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

string

在「ObjectDisplayOptions」中指定屬性時，使用者應使用的屬性標籤。如果屬性含有物件顯示選項的一部分，系統會在屬性值前方顯示顯示標籤。舉例來說，如果屬性值是「1」，則這個值本身可能對使用者沒有幫助。如果指定顯示名稱為「priority」，使用者會在搜尋結果中看到「priority : 1」，藉此提供清楚的背景資訊。這是選用屬性，如未指定，系統只會顯示屬性值。長度上限為 64 個字元。