REST Resource: providers.vehicles

{
  "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)
  }
}

string

仅限输出。此车辆的唯一名称。格式为 providers/{provider}/vehicles/{vehicle}。

enum (VehicleState)

车辆状态。

enum (TripType)

此车辆支持的行程类型。

string

仅限输出。当前分配给这辆车的行程的“tripId”列表。

object (VehicleLocation)

上次报告的车辆位置。

integer

这辆车可载的总乘客人数。此值不考虑驱动程序。此值必须大于或等于 1。

object (VehicleAttribute)

车辆属性列表。一辆车最多可以有 100 个属性，并且每个属性都必须具有唯一的键。

object (VehicleType)

必需。此车辆的类型。可用于过滤 vehicles.search 结果中的车辆。还会影响预计到达时间和路线计算。

object (LicensePlate)

车辆的车牌信息。

object (TerminalLocation)

已弃用：请改用 Vehicle.waypoints。

string

用于指定驾驶员应用打算前往下一个航路点的路线的多段线。对于分配给车辆的所有有效行程，系统也会在 Trip.current_route_segment 中返回此列表。

注意：此字段仅供驱动程序 SDK 使用。尚不支持解码。

object (TrafficPolylineData)

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

string (Timestamp format)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

object (TripWaypoint)

currentRouteSegment 结束的航点。驾驶员可以在 vehicles.update 调用中提供此信息，可以是完整的行程航点、航点 LatLng，也可以是 currentRouteSegment 的最后一个 LatLng。然后，Fleet Engine 会尽力将其插入实际路标（如果未完全指定）。在 vehicles.update 调用中，除非同时指定了 currentRouteSegment，否则系统会忽略此字段。

integer

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

string (Timestamp format)

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

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

integer

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

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

object (TripWaypoint)

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

string (Timestamp format)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

boolean

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

enum (NavigationStatus)

车辆的导航状态。

object (DeviceSettings)

仅限输入。有关驾驶员使用的移动设备中的设置的信息。

{
  "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.
}

string

属性的键。键不得包含冒号字符 (:)。

string

属性的值。

string

字符串类型的属性值。

注意：这与最终会被弃用的 value 字段相同。对于创建或更新方法，可以使用任一字段，但强烈建议使用 stringValue。如果同时设置了 stringValue 和 value，它们必须相同，否则系统会抛出错误。响应中会填充这两个字段。

boolean

布尔类型的属性值。

number

双精度属性值。

{
  "category": enum (Category)
}

enum (Category)

车辆类型类别

{
  "countryCode": string,
  "lastCharacter": string
}

string

必需。CLDR 国家/地区代码。例如，US 表示美国，IN 表示印度。

string

车牌的最后一位数，或用“-1”表示车牌中没有数值。

• “ABC 1234”->“4”
• “AB 123 CD” -> “3”
• “ABCDEF”->“-1”

{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}

object (VisualTrafficReportPolylineRendering)

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

{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}

object (RoadStretch)

可选。应沿多段线渲染的道路路段。路段保证不会重叠，但不一定涵盖整个路线。

如果没有要设置样式的道路路段，客户端应为相应路线应用默认样式。

{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}

enum (Style)

必需。要应用的样式。

integer

必需。此样式应在 [offsetMeters, offsetMeters + lengthMeters) 之间应用。

integer

必需。要应用样式的路径长度。

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

enum (LocationPowerSaveMode)

在省电模式开启时，设备上位置信息功能的行为方式。

boolean

设备当前是否处于节能模式。

boolean

设备是否处于交互状态。

object (BatteryInfo)

电池状态的相关信息。

{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}

enum (BatteryStatus)

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

enum (PowerSource)

电池电源的状态。

number

当前电池电量百分比 [0-100]。