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 会使用此信息来改进历程共享。注意：此字段仅供驱动程序 SDK 使用。

string (Timestamp format)

仅供输出。设置 currentRouteSegment 的时间。它可以由客户端存储，并在未来的 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 将尽可能插入未指定实际航点的值。除非还指定了 currentRouteSegment，否则在 vehicles.update 调用中，系统会忽略此字段。

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]。