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)
  }
}
Trường
name

string

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

enum (VehicleState)

Trạng thái xe.
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 chiếc xe.
maximumCapacity

integer

Tổng số ngườ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. 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 xe trong kết quả vehicles.search. Đồng thời cũng ảnh hưởng đến giờ đến dự kiến và việc tính toán tuyến đường.
licensePlate

object (LicensePlate)

Thông tin biển số xe của 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 chỉ định tuyến đường 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 mọi 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. Chưa hỗ trợ tính năng giải mã.
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 đặt currentRouteSegment. Ứng dụng có thể lưu trữ thông tin này và chuyển trong các yêu cầu vehicles.get trong tương lai để ngăn việc trả về những tuyến đường 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 tham chiếu đó không được chỉ định đầy đủ. Trường này sẽ 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 của currentRouteSegment. Giá trị này cũng được trả về trong Trip.remaining_distance_meters cho mọi 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)

ETA cho mục nhập đầu tiên trong trường waypoints. Giá trị 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 xe, remainingTimeSeconds đượ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ị 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 xe, remainingTimeSeconds đượ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 đây nhất trường waypoints được cập nhật. Ứng dụng nên 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 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 ngược chiều hay không. Nếu giá trị là true, thì vehicles.search có thể bao gồm xe ngay cả khi xe đó hiện được chỉ định cho một chuyến đi. Giá trị mặc định là false.
navigationStatus

enum (NavigationStatus)

Trạng thái chỉ đườ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 sử dụng.

VehicleState

Trạng thái của Vehicle.

Enum
UNKNOWN_VEHICLE_STATE Giá trị 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 thành 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ị. 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.
}
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 hợp vehicle_attribute_value. Giá trị của thuộc tính có thể ở dạng chuỗi, bool hoặc kiểu kép. vehicle_attribute_value chỉ có thể là một trong những trạng thái sau:
stringValue

string

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

Lưu ý: Trường này giống với trường value (sắp ngừng hoạt động). Đối với 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 sử dụng stringValue. Nếu bạn đặt cả stringValue và value, thì các phần tử này 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 vào câu trả lời.
boolValue

boolean

Giá trị thuộc tính đã nhập 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)
}
Trường
category

enum (Category)

Danh mục loại xe

Danh mục

Danh mục loại xe

Enum
UNKNOWN Giá trị 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 Ô tô.
TAXI Bất kỳ loại xe nào hoạt động như taxi (thường được cấp phép hoặc quản lý).
TRUCK Thường là loại xe có dung lượng chứa lớn.
TWO_WHEELER Xe mô tô, xe đạp gắn máy hoặc xe hai bánh khác
BICYCLE Phương tiện vận tải sử dụng con người.
PEDESTRIAN Phương tiện vận chuyển 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 việc 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ữ như một phần của thực thể.

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

string

Bắt buộc. Mã quốc gia/khu vực CLDR. Ví dụ: US đối với Hoa Kỳ hoặc IN đối với Ấ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 của xe.

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

object (VisualTrafficReportPolylineRendering)

Hình ảnh hiển thị nhiều đường thể hiện tốc độ của lưu lượng truy cập ở tất cả các khu vực dọc theo một đoạn đường trong chuyến đi của khách hàng.

VisualTrafficReportPolylineRendering

Mô tả cách ứng dụng khách 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)
    }
  ]
}
Trường
roadStretch[]

object (RoadStretch)

Không bắt buộc. Đường kéo dài sẽ được hiển thị dọc theo hình nhiều đường. Các đoạn đường được đảm bảo sẽ không chồng chéo nhau, và không nhất thiết phải trải dài trên toàn bộ tuyến đường.

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

RoadStretch

Một đoạn đường kéo dài sẽ được kết xuất.

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

enum (Style)

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

integer

Bắt buộc. Kiểu nên được áp dụng trong khoảng [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ề các 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)
  }
}
Trường
locationPowerSaveMode

enum (LocationPowerSaveMode)

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

boolean

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

boolean

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

object (BatteryInfo)

Thông tin về tình trạng 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 "tiết kiệm pin" của thiết bị được 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 phải 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 nhà cung cấp dịch vụ 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 ứng dụng trên nền trước.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF Dịch vụ vị trí sẽ không bị tắt, nhưng LocationManager sẽ điều tiết mọi yêu cầu đến nhà cung cấp khi thiết bị không có tính 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
}
Trường
batteryStatus

enum (BatteryStatus)

Trạng thái của 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

Tỷ lệ phần trăm pin hiện tại [0-100].

BatteryStatus

Trạng thái của 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 đang hết.
BATTERY_STATUS_FULL Pin đã đầy.
BATTERY_STATUS_NOT_CHARGING Không sạc pin.
BATTERY_STATUS_POWER_LOW Pin yếu.

PowerSource

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

Enum
UNKNOWN_POWER_SOURCE Không rõ nguồn điện.
POWER_SOURCE_AC Nguồn điện là bộ sạc AC.
POWER_SOURCE_USB Nguồn điện là một 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 loại 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 xe từ Fleet Engine.

list

 Trả về danh sách xe được 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 của yêu cầu.

update

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

updateAttributes

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