Method: providers.vehicles.searchFuzzed

已废弃:请改用 vehicles.search

HTTP 请求

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:searchFuzzed

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。必须采用 providers/{provider} 格式。提供方必须是进行此调用的服务帐号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}
字段
header

object (RequestHeader)

标准 Fleet Engine 请求标头。

pickupPoint

object (TerminalLocation)

必需。要在附近搜索的上车点。

dropoffPoint

object (TerminalLocation)

客户的预定下车点。如果 tripTypes 包含 TripType.SHARED,则此字段为必填字段。

pickupRadiusMeters

integer

必需。定义上车点周围的车辆搜索半径。只会返回搜索半径范围内的车辆。该值必须介于 400 米(含)到 10000 米(含)之间。

count

integer

必需。指定要返回的车辆数量上限。该值必须介于 1 到 50 之间(含 1 和 50)。

minimumCapacity

integer

必需。指定行程所考虑的乘客人数。该值必须大于或等于 1。容量值未考虑驱动程序。

tripTypes[]

enum (TripType)

必需。表示建议的行程的类型。只能包含一种类型。不允许使用“UNKNOWN_TRIP_TYPE”。将搜索范围限制为支持相应行程类型的车辆。

maximumStaleness

string (Duration format)

将搜索范围限制为在指定持续时间内向 Fleet Engine 发送位置更新的车辆。仍在传输其位置的静止车辆不会被视为过时。如果未设置此字段,服务器会将 5 分钟用作默认值。

时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

vehicleTypes[]

object (VehicleType)

必需。将搜索范围限制为具有某一指定类型的车辆。必须指定至少一种交通工具类型。不允许使用类别为“UNKNOWN”的 VehicleType。

requiredAttributes[]

object (VehicleAttribute)

调用方可以使用 requiredAttributesrequiredOneOfAttributesrequiredOneOfAttributeSets 字段的任意组合形成复杂的逻辑运算。

requiredAttributes 是一个列表;requiredOneOfAttributes 使用允许列表列表的消息。通过结合使用这两个字段,可以组合此表达式:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

将搜索范围限制为具有指定属性的车辆。此字段是结合/AND 运算。最多允许 50 个 requiredAttributes。这符合车辆上允许的属性数量上限。

requiredOneOfAttributes[]

object (VehicleAttributeList)

将搜索范围限制为在每个 VehicleAttributeList 中至少具有一个指定属性的车辆。在每个列表中,车辆必须至少匹配一个属性。此字段是一个包含各个 VehicleAttributeList 的析取/OR 运算,以及一个 VehicleAttributeList 集合中的合取/AND 运算。

requiredOneOfAttributeSets[]

object (VehicleAttributeList)

requiredOneOfAttributeSets 提供额外的功能。

requiredOneOfAttributes 类似,requiredOneOfAttributeSets 使用的消息允许列表列表,并且允许使用如下表达式:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

将搜索范围限制为仅包含 VehicleAttributeList 中所有属性的车辆。在每个列表中,车辆必须与所有属性匹配。此字段是每个 VehicleAttributeList 中的合取/AND 运算,以及跨 VehicleAttributeList 集合的包含析取/或 运算。

orderBy

enum (VehicleMatchOrder)

必需。指定所需的结果排序条件。

includeBackToBack

boolean

用于指明只有一次有效行程的车辆是否有资格执行此搜索。只有在未指定 currentTripsPresent 时,才会使用此字段。如果未指定 currentTripsPresent 且此字段为 false,系统会从搜索结果中移除已分配行程的车辆。如果未指定 currentTripsPresent 且此字段为 true,搜索结果可能会包含一次有效行程的状态为 ENROUTE_TO_DROPOFF 的车辆。指定 currentTripsPresent 时,此字段不能设为 true。

默认值为 false

tripId

string

指示与此 SearchVehicleRequest 关联的行程。

currentTripsPresent

enum (CurrentTripsPresent)

用于指明有效行程的车辆是否可以执行此搜索。如果 tripType 包含 SHARED,则必须将其设置为 CURRENT_TRIPS_PRESENT_UNSPECIFIED 以外的值。

filter

string

可选。搜索车辆时应用的过滤条件查询。如需查看过滤器语法的示例,请参阅 http://aip.dev/160

此字段旨在取代 requiredAttributesrequiredOneOfAttributesrequired_one_of_attributes_sets 字段。如果在此处指定了非空值,则以下字段必须为空:requiredAttributesrequiredOneOfAttributesrequired_one_of_attributes_sets

此过滤条件充当具有其他约束条件(如 minimumCapacityvehicleTypes)的 AND 子句。

请注意,仅支持针对车辆属性的查询(例如 attributes.<key> = <value>attributes.<key1> = <value1> AND attributes.<key2> = <value2>)。一个过滤条件查询允许的限制数上限为 50 个。

此外,所有属性都存储为字符串,因此仅支持对属性进行字符串比较。为了与数值或布尔值进行比较,这些值必须用显式引号引起来,才会被视为字符串(例如,attributes.<key> = "10"attributes.<key> = "true")。

响应正文

如果成功,则响应正文包含一个 SearchVehiclesResponse 实例。