REST Resource: providers.vehicles

资源：车辆

车辆元数据。

JSON 表示法 
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "pastLocations": [
    {
      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)

车辆上次报告的位置。
pastLocations[]

object (VehicleLocation)

仅限输入。此车辆过去曾到过但尚未向车队引擎报告的位置。此方法在 UpdateVehicleRequest 中用于记录之前无法发送到服务器的位置。通常，当车辆无法连接到互联网时，就会出现这种情况。
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 中返回此列表。

注意：此字段仅供 Driver SDK 使用。尚不支持解码。
currentRouteSegmentTraffic

object (TrafficPolylineData)

仅限输入。Fleet Engine 会使用这些信息来改进行程分享功能。注意：此字段仅供 Driver SDK 使用。
currentRouteSegmentVersion

string (Timestamp format)

仅限输出。设置 currentRouteSegment 的时间。客户端可以存储此 ID，并在未来的 vehicles.get 请求中传递，以防止返回未更改的路线。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。也接受除“Z”以外的偏移量。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
currentRouteSegmentEndPoint

object (TripWaypoint)

currentRouteSegment 结束的航点。驾驶员可以在 vehicles.update 调用中提供此信息，可以是完整的行程航点、航点 LatLng，也可以是 currentRouteSegment 的最后一个 LatLng。然后，如果未完全指定实际航点，车队引擎会尽力插值到实际航点。在 vehicles.update 调用中，除非同时指定了 currentRouteSegment，否则系统会忽略此字段。
remainingDistanceMeters

integer

currentRouteSegment 的剩余行驶距离。对于分配给车辆的所有有效行程，Trip.remaining_distance_meters 中也会返回此值。如果 currentRouteSegment 字段为空，则值未指定。
etaToFirstWaypoint

string (Timestamp format)

waypoints 字段中第一个条目的预计到达时间。如果 waypoints 字段或 Vehicle.current_route_segment 字段为空，则值为未指定。

更新车辆时，在同一请求中，remainingTimeSeconds 优先于 etaToFirstWaypoint。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。也接受除“Z”以外的偏移量。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
remainingTimeSeconds

integer

仅限输入。currentRouteSegment 的剩余行驶时间。如果 waypoints 字段或 Vehicle.current_route_segment 字段为空，则值为未指定。如果所有方使用相同的时钟，此值应与 etaToFirstWaypoint - current_time 一致。

更新车辆时，在同一请求中，remainingTimeSeconds 优先于 etaToFirstWaypoint。
waypoints[]

object (TripWaypoint)

分配给此车辆的其余航点。
waypointsVersion

string (Timestamp format)

仅限输出。waypoints 字段上次更新的时间。客户端应缓存此值并将其传递给 GetVehicleRequest，以确保仅在 waypoints 字段更新时返回该字段。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。也接受除“Z”以外的偏移量。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
backToBackEnabled

boolean

指示驾驶员是否接受接连行程。如果为 true，vehicles.search 可能会包含该车辆，即使该车辆当前已分配给某个行程也是如此。默认值为 false。
navigationStatus

enum (NavigationStatus)

车辆的导航状态。
deviceSettings

object (DeviceSettings)

仅限输入。与驾驶员所用移动设备中的设置相关的信息。

VehicleState

Vehicle 的状态。

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

VehicleAttribute

将车辆属性描述为键值对。“键值对”字符串的长度不得超过 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 有交通堵塞。

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

 实例化与按需共享车辆或配送服务提供商关联的新车辆。

delete

 从车队引擎中删除车辆。

get

 从车队引擎返回车辆。

list

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

update

 将更新后的车辆数据写入 Fleet Engine。

updateAttributes

 部分更新车辆的属性。