Method: providers.vehicles.search

object (RequestHeader)

标准 Fleet Engine 请求标头。

object (TerminalLocation)

必需。要搜索附近的自提点。

object (TerminalLocation)

客户的预期下车点。如果 tripTypes 包含 TripType.SHARED，则该字段为必需字段。

integer

必需。定义上车点周围的车辆搜索半径。只会返回搜索半径范围内的车辆。值必须介于 400 到 10,000 米之间（包括这两个数值）。

integer

必需。指定要返回的最大车辆数。该值必须介于 1 到 50 之间（包括这两个数值）。

integer

必需。指定要考虑的乘客人数。该值必须大于或等于 1。载客量值不计入驾驶员。

enum (TripType)

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

string (Duration format)

将搜索范围限制为仅包含在指定时段内向 Fleet Engine 发送过位置信息更新的车辆。仍在传输位置信息的静态车辆不会被视为已过时。如果未设置此字段，服务器会将 5 分钟用作默认值。

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

object (VehicleType)

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

object (VehicleAttribute)

调用方可以使用 requiredAttributes、requiredOneOfAttributes 和 requiredOneOfAttributeSets 字段的任意组合形成复杂的逻辑操作。

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。这与车辆允许的属性数量上限一致。

object (VehicleAttributeList)

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

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 集合中的包含析取/或运算。

enum (VehicleMatchOrder)

必需。指定所需的结果排序标准。

boolean

指明只有一个有效行程的车辆是否符合此搜索条件。仅当 currentTripsPresent 未指定时才会用到此字段。如果未指定 currentTripsPresent，并且此字段为 false，则搜索结果中会排除已分配行程的车辆。如果未指定 currentTripsPresent 且此字段为 true，则搜索结果可包含具有 1 个有效行程且状态为 ENROUTE_TO_DROPOFF 的车辆。指定 currentTripsPresent 后，此字段无法设置为 true。

默认值为 false。

string

表示与此 SearchVehicleRequest 关联的行程。

enum (CurrentTripsPresent)

此列指明包含有效行程的车辆是否符合此搜索条件。如果 tripType 包含 SHARED，则该字段必须设置为 CURRENT_TRIPS_PRESENT_UNSPECIFIED 以外的值。

string

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

此字段旨在替换 requiredAttributes、requiredOneOfAttributes 和 required_one_of_attributes_sets 字段。如果在此处指定了非空值，则以下字段必须为空：requiredAttributes、requiredOneOfAttributes 和 required_one_of_attributes_sets。

此过滤条件充当具有其他约束条件（例如 minimumCapacity 或 vehicleTypes）的 AND 子句。

请注意，仅支持针对车辆属性（例如 attributes.<key> = <value> 或 attributes.<key1> = <value1> AND attributes.<key2> = <value2>）的查询。一个过滤器查询中允许的限制数量上限为 50。

此外，所有属性均存储为字符串，因此唯一支持的属性比较是字符串比较。若要与数字或布尔值进行比较，必须明确用引号括起这些值，以便将其视为字符串（例如 attributes.<key> = "10" 或 attributes.<key> = "true"）。