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 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："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 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："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 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："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]。