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

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

表示用户可以对此属性执行通配符搜索。仅支持 Text 属性。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

指示查询中隔离整数属性所需的运算符名称。例如,如果运算符 Name 为 Priority 且属性名称为 priorityVal,则 priority:<value> 之类的查询仅当名为 PriorityVal 的属性值与 <value> 相符时,才会显示结果。相反,如果在没有运算符的情况下使用相同的 &lt;value&gt;,则会返回 &lt;value&gt; 与项的内容字段内任何字符串属性的值或文本匹配的所有项。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

指示查询中为了隔离时间戳属性而需要的运算符名称。例如,如果 OperationsName 为 closedon 且属性名称为 closeDate,则类似 closedon:<value> 的查询仅显示当名为 closeDate 的属性值与 <value> 匹配时的结果。相反,如果在没有运算符的情况下使用相同的 &lt;value&gt;,则会返回 &lt;value&gt; 与项的内容字段内任何字符串属性的值或文本匹配的所有项。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

lessThanOperatorName

string

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

greaterThanOperatorName

string

指示查询中所需的运算符名称,以便使用大于运算符隔离时间戳属性。例如,如果大于或等于 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

指示查询中隔离布尔值属性所需的运算符名称。例如,如果运算符 Name 为 closed 且属性名称为 isClosed,则 closed:<value> 之类的查询仅显示当名为 isClosed 的属性值与 <value> 匹配时的结果。相反,如果在没有运算符的情况下使用相同的 &lt;value&gt;,则会返回 &lt;value&gt; 与项的内容字段内任何字符串属性的值或文本匹配的所有项。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

ObjectPropertyOptions

对象属性的选项。

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

object (PropertyDefinition)

子对象的属性。这些属性代表一个嵌套对象。例如,如果此属性表示邮政地址,则 subobjectProperties 可能被命名为 streetcitystate。元素数量上限为 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)

用于指定枚举的有序排名,以确定如何使用可能的 EnumValuePairs 中提供的整数值对结果进行排名。如果指定,则必须为此属性指定的所有可能的 EnumValuePair 值提供整数值。仅当 isRepeatable 为 false 时才可使用。

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

如果设置了此字段,则说明应将枚举用作搜索运算符。

EnumPropertyOptions.EnumValuePair

枚举值对定义了两项内容:必需的字符串值和可选的整数值。字符串值定义了检索该项目所需的必要查询字词,如 p0 表示优先级项目。整数值用于确定该字符串值相对于同一属性的其他枚举值的排名。例如,您可以将 p00 相关联,并定义另一个枚举对,例如 p11。您必须结合使用整数值与 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 运算符可让用户将查询限制为与要搜索的项目类型相关的特定字段。例如,如果您不为可能值为 p0p1 priority 枚举属性提供运算符,则包含字词 p0 的查询会返回 priority 属性值为 p0 的项,以及在其他字段中包含字符串 p0 的所有项。如果您为枚举提供运算符名称(例如 priority),则搜索用户可以使用该运算符通过查询 priority:p0 将结果细化为值为 p0 作为此属性的值的项。

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

string

指示查询中隔离枚举属性所需的运算符名称。例如,如果运算符 Name 为 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

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

greaterThanOperatorName

string

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

指示查询中隔离文本属性所需的运算符名称。例如,如果 actionsName 为 subject 且属性名称为 subjectLine,则 subject:<value> 等查询仅当名为 subjectLine 的属性的值与 <value> 相符时才显示相关结果。相反,如果在没有运算符的情况下使用相同的 &lt;value&gt;,则会返回 &lt;value&gt; 与项的内容字段中任何文本属性的值或文本值匹配的所有项。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

exactMatchWithOperator

boolean

如果为 true,则文本值在运算符搜索和构面匹配中会被标记化为一个原子值。例如,如果运营商名称是“genre”值是“science-槽”查询限制“genre:science”和“genre:Activity”与所售商品不符;“genre:science- Test”用途。文本值匹配区分大小写,并且不会移除特殊字符。如果为 false,则对文本进行词法单元化处理。例如,如果值为“science- ID”,查询“genre:science”和“genre:Activity”与该项匹配。

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 属性而需要的运算符名称。例如,如果 actionsName 为 subject 且属性名称为 subjectLine,则 subject:<value> 等查询仅当名为 subjectLine 的属性的值与 <value> 相符时才显示相关结果。相反,如果在没有运算符的情况下使用相同的 &lt;value&gt;,则会返回 &lt;value&gt; 与项的内容字段中任何 html 属性的值或文本的值匹配的所有项。运算符名称只能包含小写字母 (a-z)。最大长度为 32 个字符。

PropertyDisplayOptions

媒体资源的显示选项。

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

string

属性的用户友好标签,当属性被指定为在 ObjectDisplayOptions 中显示时所使用的标签。如果提供了显示标签,则当属性是对象显示选项的一部分时,显示标签会显示在属性值前面。例如,如果属性值为“1”,则该值本身对用户而言可能不是有用的上下文。如果指定的显示名称为“优先级”,则用户会看到“优先级 : 1”出现在搜索结果中,以便为搜索用户提供明确的背景信息。此字段是选填字段;如果未指定,则仅显示属性值。长度上限为 64 个字符。