返回与提供商相关联且与请求选项匹配的车辆的分页列表。
HTTP 请求
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
parent |
必需。必须采用 |
查询参数
参数 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
pageSize |
要返回的车辆数量上限。默认值:100。 |
pageToken |
之前调用 |
minimumCapacity |
指定车辆所需的最小容量。所有返回的车辆的 |
tripTypes[] |
将响应限制为至少支持一种指定行程类型的车辆。 |
maximumStaleness |
将响应限制为在指定持续时间内向 Fleet Engine 发送位置更新的车辆。仍在传输其位置的静止车辆不会被视为过时。如果存在,则必须是有效的正数持续时间。 时长以秒为单位,最多包含九个小数位,以“ |
vehicleTypeCategories[] |
必需。将响应限制为具有某一指定类型类别的车辆。不允许 |
requiredAttributes[] |
调用方可以使用
将响应限制为具有指定属性的车辆。此字段是结合/AND 运算。最多允许 50 个 requiredAttributes。这符合车辆上允许的属性数量上限。每个重复的字符串的格式应为“key:value”。 |
requiredOneOfAttributes[] |
将响应限制为在每个 |
requiredOneOfAttributeSets[] |
与
将响应限制为与 |
vehicleState |
将响应限制为具有此车辆状态的车辆。 |
onTripOnly |
仅退回包含当前行程的车辆。 |
filter |
可选。列出车辆时应用的过滤条件查询。如需查看过滤器语法的示例,请参阅 http://aip.dev/160。 此字段旨在取代 此过滤条件充当具有其他约束条件(如 请注意,仅支持针对车辆属性的查询(例如 此外,所有属性都存储为字符串,因此仅支持对属性进行字符串比较。为了与数值或布尔值进行比较,这些值必须用显式引号引起来,才会被视为字符串(例如, |
viewport |
可选。一个过滤器,用于限制系统返回最后已知位置在视口所定义的矩形区域内的车辆。 |
请求正文
请求正文必须为空。
响应正文
vehicles.list
响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"vehicles": [
{
object ( |
字段 | |
---|---|
vehicles[] |
符合请求条件的车辆。返回的最大车辆数量由请求中的 |
nextPageToken |
用于检索下一页车辆的令牌。如果没有更多符合请求条件的车辆,则为空。 |
totalSize |
必需。所有页面中符合请求条件的车辆总数。 |
视口
纬度-经度视口,表示为两个对角线方向的 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 ( |
字段 | |
---|---|
low |
必需。视口的低点。 |
high |
必需。视口的高点。 |