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 中傳回。

注意：這個欄位僅供 Driver SDK 使用。尚未支援解碼。

object (TrafficPolylineData)

僅限輸入。Fleet Engine 會使用這些資訊改善行程分享功能。注意：這個欄位僅供 Driver 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]。