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 字段设置为此值。例如,如果 nameDocument,则针对 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 typedate 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)

元线显示的属性列表。房源数量上限为 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

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

lessThanOperatorName

string

指示查询中需要的运算符名称,以便使用小于运算符隔离整数属性。例如,如果 lessThanOperatorName 为 prioritybelow,并且属性的名称为 priorityVal,则 prioritybelow:<value> 等查询仅会显示名称为 priorityVal 的属性的值小于 <value> 的结果。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

greaterThanOperatorName

string

指示查询中需要的运算符名称,以便使用大于运算符隔离整数属性。例如,如果 greaterThanOperatorName 为 priorityabove,并且属性的名称为 priorityVal,则 priorityabove:<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

指示查询中需要的运算符名称,以便隔离时间戳属性。例如,如果 operatorName 为 closedon,并且属性的名称为 closeDate,则 closedon:<value> 等查询仅会显示名称为 closeDate 的属性的值与 <value> 匹配的结果。相比之下,如果搜索使用相同的 <value> 但不使用运算符,则会返回 <value> 与项内容字段中的任何字符串属性或文本值匹配的所有项。运营商名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

ObjectPropertyOptions

对象属性的选项。

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

object (PropertyDefinition)

子对象的属性。这些属性表示嵌套对象。例如,如果此属性表示邮政地址,则子对象属性可能命名为街道城市州/省/直辖市。元素数量上限为 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。整数值决定了该字符串值相对于同一属性的其他枚举值的排名。例如,您可以将 p00 相关联,并定义另一个枚举对,例如 p11。您必须将整数值与 ordered ranking 结合使用,才能设置给定值相对于同一属性名称的其他枚举值的排名。在这里,如果“优先级”属性的排名顺序为“降序”,则与索引值为 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 运算符,用户可以将查询限制为与所搜索内容类型相关的特定字段。例如,如果您未为可能的值为 p0p1priority 枚举属性提供运算符,则包含字词 p0 的查询会返回 priority 属性值为 p0 的项,以及其他字段中包含字符串 p0 的任何项。如果您为枚举提供运算符名称(例如 priority),则搜索用户可以使用该运算符通过查询 priority:p0 将结果限定为仅包含此属性值为 p0 的项。

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

string

指示查询中需要的运算符名称,以便隔离枚举属性。例如,如果 operatorName 为 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 的属性,用于指定 operatorName 为 closedon 的运算符。如果对这些数据进行搜索,则 closedon:<value> 等查询仅会显示 closeDate 属性的值与 <value> 匹配的结果。相比之下,如果搜索时使用相同的 <value> 但不使用运算符,则会返回 <value> 与索引编制数据源的 content 字段中的任何字符串属性或文本值匹配的所有项。运营商名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

lessThanOperatorName

string

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

greaterThanOperatorName

string

指示查询中需要的运算符名称,以便使用大于运算符隔离日期属性。例如,如果 greaterThanOperatorName 为 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> 匹配的结果。相比之下,如果搜索使用相同的 <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 属性。例如,如果 operatorName 为 subject,并且属性的名称为 subjectLine,则 subject:<value> 等查询仅会显示名称为 subjectLine 的属性的值与 <value> 匹配的结果。相比之下,如果搜索使用相同的 <value> 但不使用运算符,则会返回 <value> 与内容字段中的任何 HTML 属性或文本的值匹配的所有项。运营商名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

PropertyDisplayOptions

房源的显示选项。

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

string

属性的用户友好型标签。如果指定将属性显示在 ObjectDisplayOptions 中,则系统会使用此标签。如果已提供,则当属性属于对象显示选项时,显示标签会显示在属性值前面。例如,如果属性值为“1”,该值本身可能对用户而言不是有用的上下文。如果指定的显示名称为“priority”,则用户会在搜索结果中看到“priority : 1”,这会向搜索用户提供清晰的上下文。此属性为可选属性;如果未指定,则仅显示房源值。长度上限为 64 个字符。