REST Resource: providers.vehicles

Tài nguyên: Xe

Siêu dữ liệu về xe.

Biểu diễn dưới dạng JSON 
{
  "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)
  }
}
Các trường
name

string

Chỉ có đầu ra. Tên dành riêng cho xe này. Định dạng là providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

Trạng thái phương tiện.
supportedTripTypes[]

enum (TripType)

Các loại chuyến đi được xe này hỗ trợ.
currentTrips[]

string

Chỉ có đầu ra. Danh sách của tripId cho các chuyến đi hiện được chỉ định cho xe này.
lastLocation

object (VehicleLocation)

Vị trí được báo cáo gần đây nhất của xe.
maximumCapacity

integer

Tổng số người lái mà chiếc xe này có thể chở. Trình điều khiển không được xem xét trong giá trị này. Giá trị này phải lớn hơn hoặc bằng 1.
attributes[]

object (VehicleAttribute)

Danh sách các thuộc tính của xe. Một chiếc xe có thể có tối đa 100 thuộc tính và mỗi thuộc tính phải có một chìa khoá duy nhất.
vehicleType

object (VehicleType)

Bắt buộc. Loại xe này. Có thể dùng để lọc thông tin về xe trong vehicles.search kết quả. Cũng ảnh hưởng đến việc tính toán tuyến đường và giờ đến dự kiến.
licensePlate

object (LicensePlate)

Thông tin biển số xe.
route[]
(deprecated)

object (TerminalLocation)

Không dùng nữa: Thay vào đó, hãy dùng Vehicle.waypoints.
currentRouteSegment

string

Hình nhiều đường xác định tuyến mà ứng dụng trình điều khiển dự định đi tới điểm tham chiếu tiếp theo. Danh sách này cũng được trả về trong Trip.current_route_segment cho tất cả các chuyến đi đang hoạt động được chỉ định cho xe.

Lưu ý: Trường này chỉ dành cho SDK trình điều khiển. Tính năng giải mã chưa được hỗ trợ.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Chỉ nhập. Fleet Engine sử dụng thông tin này để cải thiện hoạt động chia sẻ hành trình. Lưu ý: Trường này chỉ dành cho SDK trình điều khiển.
currentRouteSegmentVersion

string (Timestamp format)

Chỉ có đầu ra. Thời điểm bạn đã đặt currentRouteSegment. Ứng dụng có thể lưu trữ thông tin này và chuyển đi trong các yêu cầu vehicles.get trong tương lai để ngăn việc trả về các tuyến chưa thay đổi.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentEndPoint

object (TripWaypoint)

Điểm tham chiếu nơi currentRouteSegment kết thúc. Người lái xe có thể cung cấp giá trị này trong các lệnh gọi vehicles.update dưới dạng điểm tham chiếu đầy đủ, điểm tham chiếu LatLng hoặc LatLng cuối cùng của currentRouteSegment. Sau đó, Fleet Engine sẽ cố gắng hết sức để nội suy tới một điểm tham chiếu thực tế nếu điểm đó không được chỉ định đầy đủ. Trường này bị bỏ qua trong các lệnh gọi vehicles.update, trừ phi bạn cũng chỉ định currentRouteSegment.
remainingDistanceMeters

integer

Quãng đường lái xe còn lại cho currentRouteSegment. Giá trị này cũng được trả về trong Trip.remaining_distance_meters cho tất cả các chuyến đi đang hoạt động được chỉ định cho xe. Giá trị không được chỉ định nếu trường currentRouteSegment trống.
etaToFirstWaypoint

string (Timestamp format)

Thời gian đến dự kiến cho mục nhập đầu tiên trong trường waypoints. Giá trị sẽ không được chỉ định nếu trường waypoints trống hoặc trường Vehicle.current_route_segment trống.

Khi cập nhật một phương tiện, remainingTimeSeconds sẽ được ưu tiên hơn etaToFirstWaypoint trong cùng một yêu cầu.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
remainingTimeSeconds

integer

Chỉ nhập. Thời gian lái xe còn lại của currentRouteSegment. Giá trị sẽ không được chỉ định nếu trường waypoints trống hoặc trường Vehicle.current_route_segment trống. Giá trị này phải khớp với etaToFirstWaypoint – current_time nếu tất cả các bên đang sử dụng cùng một đồng hồ.

Khi cập nhật một phương tiện, remainingTimeSeconds sẽ được ưu tiên hơn etaToFirstWaypoint trong cùng một yêu cầu.
waypoints[]

object (TripWaypoint)

Các điểm tham chiếu còn lại được chỉ định cho Xe này.
waypointsVersion

string (Timestamp format)

Chỉ có đầu ra. Lần gần nhất cập nhật trường waypoints. Ứng dụng phải lưu giá trị này vào bộ nhớ đệm và truyền giá trị này vào GetVehicleRequest để đảm bảo trường waypoints chỉ được trả về nếu giá trị đó được cập nhật.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
backToBackEnabled

boolean

Cho biết liệu tài xế có chấp nhận các chuyến đi liên tiếp hay không. Nếu giá trị là true, vehicles.search có thể bao gồm xe ngay cả khi xe đang được chỉ định cho chuyến đi. Giá trị mặc định là false.
navigationStatus

enum (NavigationStatus)

Trạng thái điều hướng của xe.
deviceSettings

object (DeviceSettings)

Chỉ nhập. Thông tin về các chế độ cài đặt trong thiết bị di động mà người lái xe đang sử dụng.

VehicleState

Trạng thái của Vehicle.

Enum
UNKNOWN_VEHICLE_STATE Mặc định, dùng cho trạng thái xe không xác định hoặc không nhận dạng được.
OFFLINE Xe này không nhận các chuyến đi mới. Lưu ý: xe có thể tiếp tục hoạt động ở trạng thái này trong khi hoàn tất chuyến đi được chỉ định cho xe.
ONLINE Xe này đang chấp nhận các chuyến đi mới.

VehicleAttribute

Mô tả thuộc tính xe dưới dạng một cặp khoá-giá trị. Độ dài chuỗi "key:value" không được vượt quá 256 ký tự.

Biểu diễn dưới dạng 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.
}
Các trường
key

string

Khoá của thuộc tính. Khoá không được chứa ký tự dấu hai chấm (:).
value

string

Giá trị của thuộc tính.
Trường nhóm vehicle_attribute_value. Giá trị của thuộc tính có thể ở dạng chuỗi, bool hoặc kiểu double. vehicle_attribute_value chỉ có thể là một trong những trạng thái sau đây:
stringValue

string

Giá trị thuộc tính đã nhập chuỗi.

Lưu ý: Trường hợp này giống với trường value (sắp ngừng hoạt động). Đối với các phương thức tạo hoặc cập nhật, bạn có thể sử dụng một trong hai trường, nhưng bạn nên dùng stringValue. Nếu bạn đặt cả stringValue và value, thì chúng phải giống hệt nhau, nếu không sẽ xảy ra lỗi. Cả hai trường đều được điền sẵn trong phản hồi.
boolValue

boolean

Giá trị thuộc tính đã nhập là Boolean.
numberValue

number

Giá trị thuộc tính đã nhập 2 lần.

VehicleType

Loại phương tiện.

Biểu diễn dưới dạng JSON 
{
  "category": enum (Category)
}
Các trường
category

enum (Category)

Danh mục loại xe

Danh mục

Danh mục loại xe

Enum
UNKNOWN Mặc định, dùng cho các danh mục xe không xác định hoặc không nhận dạng được.
AUTO Một chiếc ô tô.
TAXI Bất kỳ phương tiện nào hoạt động như taxi (thường được cấp phép hoặc được quản lý).
TRUCK Đây thường là một chiếc xe có dung lượng lưu trữ lớn.
TWO_WHEELER Xe mô tô, xe máy hoặc xe mô tô hai bánh khác
BICYCLE Phương tiện vận tải do con người làm ra.
PEDESTRIAN Phương tiện giao thông của con người, thường là đi bộ hoặc chạy, đi dọc theo các đường dành cho người đi bộ.

LicensePlate

Thông tin biển số xe của xe. Để tránh lưu trữ thông tin nhận dạng cá nhân, chỉ thông tin tối thiểu về biển số xe được lưu trữ dưới dạng một phần của pháp nhân.

Biểu diễn dưới dạng JSON 
{
  "countryCode": string,
  "lastCharacter": string
}
Các trường
countryCode

string

Bắt buộc. Mã quốc gia/vùng CLDR. Ví dụ: US cho Hoa Kỳ hoặc IN cho Ấn Độ.
lastCharacter

string

Chữ số cuối cùng của biển số xe hoặc "-1" để biểu thị không có giá trị số nào trên biển số đó.

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

TrafficPolylineData

Tình trạng giao thông dọc theo tuyến đường dự kiến cho xe.

Biểu diễn dưới dạng JSON 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
Các trường
trafficRendering

object (VisualTrafficReportPolylineRendering)

Hình nhiều đường thể hiện tốc độ giao thông của tất cả các khu vực trong một chuyến đi của khách hàng.

VisualTrafficReportPolylineRendering

Mô tả cách khách hàng sẽ tô màu một phần của hình nhiều đường dọc theo tuyến đường.

Biểu diễn dưới dạng JSON 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
Các trường
roadStretch[]

object (RoadStretch)

Không bắt buộc. Đường kéo dài cần được kết xuất dọc theo hình nhiều đường. Các đoạn kéo giãn được đảm bảo không chồng chéo nhau và không nhất thiết phải kéo dài toàn bộ tuyến đường.

Trong trường hợp không có đường kéo dài để tạo kiểu, khách hàng nên áp dụng giá trị mặc định cho tuyến đường này.

RoadStretch

Một đoạn đường cần được kết xuất.

Biểu diễn dưới dạng JSON 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
Các trường
style

enum (Style)

Bắt buộc. Kiểu áp dụng.
offsetMeters

integer

Bắt buộc. Kiểu nên được áp dụng trong khoảng từ [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

Bắt buộc. Độ dài của đường dẫn nơi áp dụng kiểu.

Phong cách

Kiểu giao thông, cho biết tốc độ giao thông.

Enum
STYLE_UNSPECIFIED Chưa chọn kiểu nào.
SLOWER_TRAFFIC Giao thông đang chậm lại.
TRAFFIC_JAM Có ách tắc giao thông.

DeviceSettings

Thông tin về nhiều chế độ cài đặt trên thiết bị di động.

Biểu diễn dưới dạng JSON 
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
Các trường
locationPowerSaveMode

enum (LocationPowerSaveMode)

Cách thiết lập hoạt động của các tính năng vị trí trên thiết bị khi trình tiết kiệm pin đang bật.
isPowerSaveMode

boolean

Thiết bị có đang ở chế độ tiết kiệm điện năng hay không.
isInteractive

boolean

Thiết bị có đang ở trạng thái tương tác hay không.
batteryInfo

object (BatteryInfo)

Thông tin về trạng thái pin.

LocationPowerSaveMode

Cách các tính năng vị trí được định cấu hình để hoạt động trên thiết bị di động khi tính năng "trình tiết kiệm pin" của thiết bị đang bật. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enum
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode không xác định
LOCATION_MODE_NO_CHANGE Trình tiết kiệm pin sẽ không ảnh hưởng đến nhà cung cấp vị trí hoặc trình tiết kiệm pin đang tắt.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Bạn nên tắt trình cung cấp vị trí dựa trên GPS khi trình tiết kiệm pin đang bật và thiết bị không tương tác.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Bạn nên tắt tất cả các trình cung cấp vị trí khi trình tiết kiệm pin đang bật và thiết bị không tương tác.
LOCATION_MODE_FOREGROUND_ONLY Tất cả các trình cung cấp vị trí sẽ được giữ nguyên, nhưng bản sửa lỗi vị trí chỉ nên được cung cấp cho các ứng dụng trên nền trước.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF Dịch vụ vị trí sẽ không tắt, nhưng LocationManager sẽ chặn tất cả yêu cầu đến nhà cung cấp khi thiết bị không tương tác.

BatteryInfo

Thông tin về pin của thiết bị.

Biểu diễn dưới dạng JSON 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
Các trường
batteryStatus

enum (BatteryStatus)

Trạng thái pin, cho dù là đầy hay đang sạc, v.v.
powerSource

enum (PowerSource)

Trạng thái của nguồn pin.
batteryPercentage

number

Phần trăm pin hiện tại [0-100].

BatteryStatus

Trạng thái pin, cho dù là đầy hay đang sạc, v.v.

Enum
UNKNOWN_BATTERY_STATUS Trạng thái pin không xác định.
BATTERY_STATUS_CHARGING Pin đang được sạc.
BATTERY_STATUS_DISCHARGING Pin sắp hết.
BATTERY_STATUS_FULL Pin đầy.
BATTERY_STATUS_NOT_CHARGING Pin không sạc.
BATTERY_STATUS_POWER_LOW Pin yếu.

PowerSource

Loại bộ sạc được dùng để sạc pin.

Enum
UNKNOWN_POWER_SOURCE Nguồn điện không xác định.
POWER_SOURCE_AC Nguồn điện là bộ sạc AC.
POWER_SOURCE_USB Nguồn điện là cổng USB.
POWER_SOURCE_WIRELESS Nguồn điện là không dây.
POWER_SOURCE_UNPLUGGED Đã rút pin ra khỏi nguồn điện.

Phương thức

create

 Tạo thực thể cho một chiếc xe mới liên kết với một nhà cung cấp dịch vụ đi chung xe hoặc giao hàng theo yêu cầu.

get

 Trả lại một chiếc xe từ Fleet Engine.

list

 Trả về danh sách các xe đã phân trang liên kết với một nhà cung cấp khớp với các lựa chọn cho yêu cầu.
Trả về danh sách xe phù hợp với các lựa chọn yêu cầu.

searchFuzzed
(deprecated)

 Không dùng nữa: Thay vào đó, hãy dùng SearchVehicles.

update

 Ghi dữ liệu cập nhật về xe vào Fleet Engine.

updateAttributes

 Cập nhật một phần các thuộc tính của xe.

updateLocation
(deprecated)

 Không dùng nữa: Thay vào đó, hãy dùng phương thức UpdateVehicle.