Method: providers.vehicles.list

返回与提供商关联的与请求选项匹配的车辆的分页列表。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

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

查询参数

参数
header

object (RequestHeader)

标准 Fleet Engine 请求标头。
pageSize

integer

要退回的车辆数量上限。默认值：100。
pageToken

string

之前对 vehicles.list 的调用提供的 nextPageToken 值，以便对车辆组进行分页。如果请求的过滤条件与之前调用 vehicles.list 的过滤条件不同，则该值未定义。
minimumCapacity

integer

指定所需的最小车辆容量。所有返回车辆的 maximumCapacity 均大于或等于此值。如果设置，则必须大于或等于 0。
tripTypes[]

enum (TripType)

将响应限制为至少支持一种指定行程类型的车辆。
maximumStaleness

string (Duration format)

将响应限制为在指定时长内向 Fleet Engine 发送位置信息更新的车辆。仍在传输位置信息的静止车辆不会被视为过时。如果存在，必须为有效的正时长。

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

enum (Category)

必需。将响应限制为某个指定类型类别的车辆。不允许UNKNOWN。
requiredAttributes[]

string

调用方可以使用 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。这与车辆允许的属性数量上限一致。每个重复的字符串都应采用“key:value”格式。
requiredOneOfAttributes[]

string

将响应限制为在每个 VehicleAttributeList 中至少具有一个指定属性的车辆。在每个列表中，车辆必须至少匹配一个属性。此字段是每个 VehicleAttributeList 中的包含析取/或运算以及 VehicleAttributeList 集合中的合取/与运算。每个重复的字符串都应采用以下格式："key1:value1|key2:value2|key3:value3"。
requiredOneOfAttributeSets[]

string

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 集合中的包含析取/或运算。每个重复的字符串都应采用以下格式："key1:value1|key2:value2|key3:value3"。
vehicleState

enum (VehicleState)

将响应限制为具有此车辆状态的车辆。
onTripOnly

boolean

仅归还当前行程的车辆。
filter

string

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

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

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

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

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

object (Viewport)

可选。此过滤器可将返回的车辆限制为最近一次已知位置位于视口定义的矩形区域内的车辆。

请求正文

请求正文必须为空。

响应正文

vehicles.list 响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
字段
vehicles[]

object (Vehicle)

与请求中的条件相符的车辆。返回的最大车辆数由请求中的 pageSize 字段确定。
nextPageToken

string

用于检索下一页车辆的令牌。如果不再有符合请求条件的车辆，则为空。
totalSize

string (int64 format)

必需。所有页面中符合请求条件的车辆总数。

视口

经纬度视口，表示为两个对角线相对的 low 和 high 点。视口被视为封闭区域，即包含其边界。纬度边界必须介于 -90 度和 90 度（含）之间，经度边界必须介于 -180 度（含）180 度（含）之间。各种情况包括：

  • 如果 low = high，视口由该单点组成。

  • 如果 low.longitude >high.longitude，则经度范围会反转（视口与 180 度经度线相交）。

  • 如果 low.longitude = -180 度，high.longitude = 180 度，视口将包含所有经度。

  • 如果 low.longitude = 180 度，high.longitude = -180 度，则经度范围为空。

  • 如果 low.latitude >high.latitude，纬度范围为空。

low 和 high 都必须填充，并且表示的框不能为空（如上述定义所指定）。视口为空会导致错误。

例如，以下视口将纽约市完全包围：

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

JSON 表示法 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
字段
low

object (LatLng)

必需。视口的低点。
high

object (LatLng)

必需。视口的高点。