REST Resource: providers.vehicles

• 资源：车辆
  • JSON 表示法
• VehicleState
• VehicleAttribute
  • JSON 表示法
• VehicleType
  • JSON 表示法
• 类别
• LicensePlate
  • JSON 表示法
• TrafficPolylineData
  • JSON 表示法
• VisualTrafficReportPolylineRendering
  • JSON 表示法
• RoadStretch
  • JSON 表示法
• 样式
• NavigationStatus
• DeviceSettings
  • JSON 表示法
• LocationPowerSaveMode
• BatteryInfo
  • JSON 表示法
• BatteryStatus
• PowerSource
• 方法

资源：Vehicle

车辆元数据。

JSON 表示法

{ "name": string, "vehicleState": enum (VehicleState), "supportedTripTypes": [ enum (TripType) ], "currentTrips": [ string ], "lastLocation": { object (VehicleLocation) }, "maximumCapacity": integer, "attributes": [ { object (VehicleAttribute) } ], "vehicleType": { object (VehicleType) }, "licensePlate": { object (LicensePlate) }, "route": [ { object (TerminalLocation) } ], "currentRouteSegment": string, "currentRouteSegmentTraffic": { object (TrafficPolylineData) }, "currentRouteSegmentVersion": string, "currentRouteSegmentEndPoint": { object (TripWaypoint) }, "remainingDistanceMeters": integer, "etaToFirstWaypoint": string, "remainingTimeSeconds": integer, "waypoints": [ { object (TripWaypoint) } ], "waypointsVersion": string, "backToBackEnabled": boolean, "navigationStatus": enum (NavigationStatus), "deviceSettings": { object (DeviceSettings) } }

字段
name	string 仅限输出。此车辆的唯一名称。格式为 providers/{provider}/vehicles/{vehicle}。
vehicleState	enum (VehicleState) 车辆状态。
supportedTripTypes[]	enum (TripType) 此车辆支持的行程类型。
currentTrips[]	string 仅限输出。当前分配给这辆车的行程的“tripId”列表。
lastLocation	object (VehicleLocation) 上次报告的车辆位置。
maximumCapacity	integer 这辆车可载的总乘客人数。此值不考虑驱动程序。此值必须大于或等于 1。
attributes[]	object (VehicleAttribute) 车辆属性列表。一辆车最多可以有 100 个属性，并且每个属性都必须具有唯一的键。
vehicleType	object (VehicleType) 必需。此车辆的类型。可用于过滤 vehicles.search 结果中的车辆。还会影响预计到达时间和路线计算。
licensePlate	object (LicensePlate) 车辆的车牌信息。
route[] (deprecated)	object (TerminalLocation) 此项已弃用！ 已弃用：请改用 Vehicle.waypoints。
currentRouteSegment	string 用于指定驾驶员应用打算前往下一个航路点的路线的多段线。对于分配给车辆的所有有效行程，系统也会在 Trip.current_route_segment 中返回此列表。 注意：此字段仅供驱动程序 SDK 使用。尚不支持解码。
currentRouteSegmentTraffic	object (TrafficPolylineData) 仅限输入。Fleet Engine 会使用这些信息来改进行程分享功能。注意：此字段仅供 Driver SDK 使用。
currentRouteSegmentVersion	string (Timestamp format) 仅限输出。currentRouteSegment 的设置时间。客户端可以存储此 ID，并在未来的 vehicles.get 请求中传递，以防止返回未更改的路线。 时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
currentRouteSegmentEndPoint	object (TripWaypoint) currentRouteSegment 结束的航点。驾驶员可以在 vehicles.update 调用中提供此信息，可以是完整的行程航点、航点 LatLng，也可以是 currentRouteSegment 的最后一个 LatLng。然后，Fleet Engine 会尽力将其插入实际路标（如果未完全指定）。在 vehicles.update 调用中，除非同时指定了 currentRouteSegment，否则系统会忽略此字段。
remainingDistanceMeters	integer currentRouteSegment 的剩余行驶距离。对于分配给车辆的所有有效行程，Trip.remaining_distance_meters 中也会返回此值。如果 currentRouteSegment 字段为空，则未指定此值。
etaToFirstWaypoint	string (Timestamp format) waypoints 字段中第一个条目的预计到达时间。如果 waypoints 字段或 Vehicle.current_route_segment 字段为空，则值为未指定。 更新车辆时，在同一请求中，remainingTimeSeconds 优先于 etaToFirstWaypoint。 时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
remainingTimeSeconds	integer 仅限输入。currentRouteSegment 的剩余行驶时间。如果 waypoints 字段或 Vehicle.current_route_segment 字段为空，则值为未指定。如果所有方使用相同的时钟，此值应与 etaToFirstWaypoint - current_time 一致。 更新车辆时，在同一请求中，remainingTimeSeconds 的优先级高于 etaToFirstWaypoint。
waypoints[]	object (TripWaypoint) 分配给此车辆的其余航点。
waypointsVersion	string (Timestamp format) 仅限输出。waypoints 字段的上次更新时间。客户端应缓存此值并将其传入 GetVehicleRequest，以确保仅在 waypoints 字段更新时才会返回此值。 时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
backToBackEnabled	boolean 指示驾驶员是否接受往返行程。如果为 true，vehicles.search 可能会包含该车辆，即使该车辆目前已分配给某个行程也是如此。默认值为 false。
navigationStatus	enum (NavigationStatus) 车辆的导航状态。
deviceSettings	object (DeviceSettings) 仅限输入。有关驾驶员使用的移动设备中的设置的信息。

VehicleState

Vehicle 的状态。

枚举
UNKNOWN_VEHICLE_STATE	默认值，用于未指定或无法识别的车辆状态。
OFFLINE	车辆不接受新行程。注意：在完成分配给它的行程时，车辆可能会继续在此状态下运行。
ONLINE	车辆正在接受新的行程。

VehicleAttribute

将车辆属性描述为键值对。“key:value”字符串的长度不能超过 256 个字符。

JSON 表示法
{ "key": string, "value": string, // Union field vehicle_attribute_value can be only one of the following: "stringValue": string, "boolValue": boolean, "numberValue": number // End of list of possible types for union field vehicle_attribute_value. }

字段
key	string 属性的键。键不得包含冒号字符 (:)。
value	string 属性的值。
联合字段 vehicle_attribute_value。属性的值可以是字符串、布尔值或双精度类型。vehicle_attribute_value 只能是下列其中一项：
stringValue	string 字符串类型的属性值。 注意：这与最终会被弃用的 value 字段相同。对于创建或更新方法，可以使用任一字段，但强烈建议使用 stringValue。如果同时设置了 stringValue 和 value，它们必须相同，否则系统会抛出错误。响应中会填充这两个字段。
boolValue	boolean 布尔类型的属性值。
numberValue	number 双精度属性值。

VehicleType

车辆类型。

JSON 表示法
{ "category": enum (Category) }

字段
category	enum (Category) 车辆类型类别

类别

车辆类型类别

枚举
UNKNOWN	默认值，用于未指定或无法识别的车辆类别。
AUTO	汽车。
TAXI	充当出租车的任何车辆（通常持牌或受监管的车辆）。
TRUCK	通常是指存储容量较大的车辆。
TWO_WHEELER	摩托车、轻便摩托车或其他双轮机动车
BICYCLE	人类的交通。
PEDESTRIAN	沿人行道行驶的交通工具，通常是行走或跑步。

LicensePlate

车辆的车牌信息。为避免存储个人身份信息，只有关于车牌的最少信息会作为实体的一部分存储。

JSON 表示法
{ "countryCode": string, "lastCharacter": string }

字段
countryCode	string 必需。CLDR 国家/地区代码。例如，US 表示美国，IN 表示印度。
lastCharacter	string 车牌的最后一位数，或用“-1”表示车牌中没有数值。 “ABC 1234”->“4” “AB 123 CD” -> “3” “ABCDEF”->“-1”

TrafficPolylineData

预计车辆行驶路线上的路况。

JSON 表示法
{ "trafficRendering": { object (VisualTrafficReportPolylineRendering) } }

字段
trafficRendering	object (VisualTrafficReportPolylineRendering) 一个多段线，用于渲染客户行程中某一段路线上所有区域的交通速度。

VisualTrafficReportPolylineRendering

描述客户端应如何对路线中多段线的一部分着色。

JSON 表示法
{ "roadStretch": [ { object (RoadStretch) } ] }

字段
roadStretch[]	object (RoadStretch) 可选。应沿多段线渲染的道路路段。路段保证不会重叠，但不一定涵盖整个路线。 如果没有要设置样式的道路路段，客户端应为相应路线应用默认样式。

RoadStretch

一条应渲染的道路延伸区。

JSON 表示法
{ "style": enum (Style), "offsetMeters": integer, "lengthMeters": integer }

字段
style	enum (Style) 必需。要应用的样式。
offsetMeters	integer 必需。此样式应在 [offsetMeters, offsetMeters + lengthMeters) 之间应用。
lengthMeters	integer 必需。要应用样式的路径长度。

样式

交通样式，表示交通速度。

枚举
STYLE_UNSPECIFIED	未选择任何样式。
SLOWER_TRAFFIC	流量正在下降。
TRAFFIC_JAM	交通堵塞。

NavigationStatus

车辆的导航状态。

枚举
UNKNOWN_NAVIGATION_STATUS	未指定的导航状态。
NO_GUIDANCE	Driver 应用的导航处于 FREE_NAV 模式。
ENROUTE_TO_DESTINATION	精细导航功能可用，并且“驾驶员”应用导航已进入 GUIDED_NAV 模式。
OFF_ROUTE	车辆偏离了建议的路线。
ARRIVED_AT_DESTINATION	车辆距离目的地约 50 米。

DeviceSettings

与移动设备上的各种设置相关的信息。

JSON 表示法
{ "locationPowerSaveMode": enum (LocationPowerSaveMode), "isPowerSaveMode": boolean, "isInteractive": boolean, "batteryInfo": { object (BatteryInfo) } }

字段
locationPowerSaveMode	enum (LocationPowerSaveMode) 在省电模式开启时，设备上位置信息功能的行为方式。
isPowerSaveMode	boolean 设备当前是否处于节能模式。
isInteractive	boolean 设备是否处于交互状态。
batteryInfo	object (BatteryInfo) 电池状态的相关信息。

LocationPowerSaveMode

在设备的“省电模式”功能处于开启状态时，位置信息功能在移动设备上的行为方式配置。(https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

枚举
UNKNOWN_LOCATION_POWER_SAVE_MODE	未定义 LocationPowerSaveMode
LOCATION_MODE_NO_CHANGE	位置信息提供程序应该不受省电模式的影响，或者省电模式已关闭。
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF	当省电模式开启且设备处于非交互状态时，应停用基于 GPS 的位置信息提供程序。
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF	当省电模式开启且设备处于非互动状态时，应停用所有位置信息提供程序。
LOCATION_MODE_FOREGROUND_ONLY	所有位置信息提供程序都将保持可用，但位置信息修正应仅提供给前台应用。
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF	位置信息服务不会关闭，但当设备处于非互动状态时，LocationManager 会限制向提供程序发出的所有请求。

BatteryInfo

与设备电池相关的信息。

JSON 表示法
{ "batteryStatus": enum (BatteryStatus), "powerSource": enum (PowerSource), "batteryPercentage": number }

字段
batteryStatus	enum (BatteryStatus) 电池状态，是充满还是正在充电等
powerSource	enum (PowerSource) 电池电源的状态。
batteryPercentage	number 当前电池电量百分比 [0-100]。

BatteryStatus

电池状态，是充满还是正在充电等

枚举
UNKNOWN_BATTERY_STATUS	电池状态未知。
BATTERY_STATUS_CHARGING	电池正在充电。
BATTERY_STATUS_DISCHARGING	电池正在放电。
BATTERY_STATUS_FULL	电池电量已满。
BATTERY_STATUS_NOT_CHARGING	电池未在充电。
BATTERY_STATUS_POWER_LOW	电池电量不足。

PowerSource

为电池充电的充电器类型。

枚举
UNKNOWN_POWER_SOURCE	电源未知。
POWER_SOURCE_AC	电源是交流电源充电器。
POWER_SOURCE_USB	电源是 USB 端口。
POWER_SOURCE_WIRELESS	电源为无线。
POWER_SOURCE_UNPLUGGED	电池已拔下。

方法
create	实例化与按需共享车辆或配送服务提供商关联的新车辆。
get	从车队引擎返回车辆。
list	返回与请求选项匹配且与提供商相关联的车辆的分页列表。
search	返回与请求选项匹配的车辆列表。
update	将更新后的车辆数据写入 Fleet Engine。
updateAttributes	部分更新车辆的属性。