获取满足指定过滤条件的所有 DeliveryVehicle
。
HTTP 请求
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
parent |
必需。必须采用 |
查询参数
参数 | |
---|---|
header |
可选。标准 Delivery API 请求标头。 |
pageSize |
可选。要返回的车辆数量上限。服务返回的数量可能少于此数量。如果您未指定此数字,则服务器会确定要返回的结果数。 |
pageToken |
可选。从之前的 进行分页时,提供给 |
filter |
可选。列出送货车辆时应用的过滤条件查询。如需查看过滤器语法的示例,请参阅 http://aip.dev/160。如果您未指定值,或者为过滤条件指定了空字符串,则系统会返回所有送货车辆。 请注意, 一个过滤器查询中允许的最大限制数量为 50。限制是查询的一部分,格式为 |
viewport |
可选。一个过滤器,用于限制系统返回最后已知位置在视口所定义的矩形区域内的车辆。 |
请求正文
请求正文必须为空。
响应正文
deliveryVehicles.list
响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"deliveryVehicles": [
{
object ( |
字段 | |
---|---|
deliveryVehicles[] |
符合所要求过滤条件的一组送货车辆。如果未指定任何过滤条件,则请求会返回所有送货车辆。成功的响应也可以为空。空响应表示未找到符合所请求的过滤条件的送货车辆。 |
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 |
必需。视口的高点。 |