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，那么针对 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 天（以秒为单位）。

时长以秒为单位，最多包含九个小数位，以“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)

针对 Metaline 显示的属性列表。属性的数量不得超过 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。使用名称作为对象属性的标识符。该名称一旦注册为对象的属性，便无法再用于该对象中的其他属性。名称必须以字母开头，且只能包含字母（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)

一些选项，用于确定在对象的 display options 中显示属性时，该属性在 Cloud Search 搜索结果页中的显示方式。
联合字段 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

指示查询中要隔离整数属性所需的运算符名称。例如，如果 consoleName 为 priority 且属性的名称为 priorityVal，则类似 priority:<value> 的查询仅显示名为 priorityVal 的属性值与 <value> 匹配的结果。相比之下，如果搜索使用相同的 <value> 而不使用运算符，则会返回 <value> 与该内容中任何字符串字段属性或文本中的项目值匹配的所有项目。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。
lessThanOperatorName

string

指示查询中所需的运算符名称，以便使用小于运算符来隔离整数属性。例如，如果 shouldshThanOperatorName 为 priority below 且属性名称为 priorityVal，则类似 priority 下文:<value> 的查询仅显示在名为 priorityVal 的属性值小于 <value> 时的结果。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。
greaterThanOperatorName

string

指示查询中所需的运算符名称，以便使用大于运算符来隔离整数属性。例如，如果 aboveThanOperatorName 为 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

指示查询中为了在排序中使用双精度属性或将其用作分面而需要的运算符名称。运算符名称只能包含小写字母 (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

指示查询中所需的运算符名称，以便使用小于运算符来隔离时间戳属性。例如，如果 smallThanOperatorName 为 closedbefore，并且属性名称为 closeDate，则类似 closedbefore:<value> 的查询只会显示名为 closeDate 的属性的值早于 <value> 的结果。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。
greaterThanOperatorName

string

指示查询中所需的运算符名称，以便使用大于运算符来隔离时间戳属性。例如，如果 aboveThanOperatorName 为 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，则类似 closed:<value> 的查询只会显示名为 isClosed 的属性的值与 <value> 匹配的结果。相比之下，如果搜索使用相同的 <value> 而不包含运算符，则会返回 <value> 与内容字段中任何字符串字段属性或文本中的值匹配的所有项。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

ObjectPropertyOptions

对象属性的选项。

JSON 表示法 
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
字段
subobjectProperties[]

object (PropertyDefinition)

子对象的属性。这些属性代表一个嵌套对象。例如，如果此属性表示邮政地址，则 subobjectProperties 可以命名为街道、城市和州。元素数量上限为 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 结合使用，才能设置给定值相对于同一属性名称的其他枚举值的排名。在此示例中，优先级属性的排名顺序为 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 的查询会返回 priority 属性的值为 p0 的项目，以及在其他字段中包含字符串 p0 的所有项目。如果您为枚举提供运算符名称（如 priority），则搜索用户可以使用该运算符优化结果，使结果仅显示此属性值为 p0 的项，并使用查询 Priority:p0。

JSON 表示法 
{
  "operatorName": string
}
字段
operatorName

string

指示查询中为了隔离枚举属性所需的运算符名称。例如，如果 consoleName 为 priority 且属性的名称为 priorityVal，则类似 priority:<value> 的查询仅显示名为 priorityVal 的属性值与 <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

指示查询中所需的运算符名称，以便使用小于运算符来隔离日期属性。例如，如果 smallThanOperatorName 为 closedbefore，并且属性名称为 closeDate，则类似 closedbefore:<value> 的查询只会显示名为 closeDate 的属性的值早于 <value> 的结果。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。
greaterThanOperatorName

string

指示查询中所需的运算符名称，以便使用大于运算符来隔离日期属性。例如，如果 aboveThanOperatorName 为 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

指示查询中为了隔离文本属性所需的运算符名称。例如，如果运算符名称为 subject 且属性名称为 subjectLine，则类似 subject:<value> 的查询只会显示名为 subjectLine 属性的值与 <value> 匹配的结果。相比之下，使用相同 <value> 且不带运算符的搜索将返回 <value> 与相应内容字段中任何文本属性或文本内任何文本的值匹配的所有项。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。
exactMatchWithOperator

boolean

如果为 true，文本值在运算符搜索和分面匹配中会令牌化为一个原子值。例如，如果运算符名称为“genre”且值为“science-fiction”，则查询限制“genre:science”和“genre:fiction”不匹配相应的项，而“genre:science-fiction”不匹配。文本值匹配区分大小写，并且不会移除特殊字符。如果为 false，文本将令牌化。例如，如果值为“science-fiction”，则查询“genre:science”和“genre:fiction”将与相应的项匹配。

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 属性。例如，如果运算符名称为 subject 且属性名称为 subjectLine，则类似 subject:<value> 的查询只会显示名为 subjectLine 属性的值与 <value> 匹配的结果。相比之下，使用相同 <value> 且不带运算符的搜索将返回 <value> 与该内容字段中任何 HTML 属性或文本中任何项的值匹配的所有项。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

PropertyDisplayOptions

资源的显示选项。

JSON 表示法 
{
  "displayLabel": string
}
字段
displayLabel

string

属性的用户友好标签，在指定属性显示在 ObjectDisplayOptions 中时使用。如果提供，当属性是对象显示选项的一部分时，显示标签会显示在属性值的前面。例如，如果属性值为“1”，那么该值本身可能对用户没有用处。如果指定的显示名称为“优先级”，用户便会在搜索结果中看到“优先级：1”，从而为搜索用户提供明确的上下文信息。这是可选字段；如果未指定，则仅显示属性值。最大长度为 64 个字符。