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 chiếc xe này. Định dạng là providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

Trạng thái của 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 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ố hành khách trên xe này. 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 khoá duy nhất.
vehicleType

object (VehicleType)

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

object (LicensePlate)

Thông tin về biển số xe của xe.
route[]
(deprecated)

object (TerminalLocation)

Không dùng nữa: Chuyển sang 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 định đi đến đ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ả 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 sử dụng. 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 tính năng chia sẻ hành trình. Lưu ý: Trường này chỉ dành cho SDK trình điều khiển sử dụng.
currentRouteSegmentVersion

string (Timestamp format)

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

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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 kết thúc currentRouteSegment. 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 vào một điểm tham chiếu thực tế nếu điểm đó 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ề bằng Trip.remaining_distance_meters cho tất cả chuyến đi đang hoạt động được chỉ định cho xe. Bạn không chỉ định giá trị này nếu trường currentRouteSegment trống.
etaToFirstWaypoint

string (Timestamp format)

Giờ đến dự kiến cho mục đầu tiên trong trường waypoints. Bạn không thể chỉ định giá trị nếu trường waypoints trống hoặc trường Vehicle.current_route_segment trống.

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

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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 cho currentRouteSegment. Bạn không thể chỉ định giá trị 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 sử dụng cùng một đồng hồ.

Khi cập nhật một chiếc xe, 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 đâ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 cập nhật.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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 tài xế có chấp nhận các chuyến đi khứ hồi hay không. Nếu là true, vehicles.search có thể bao gồm chiếc xe này ngay cả khi chiếc xe này 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 đi theo chỉ dẫn 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 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 chấp nhận 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.
ONLINE Xe đ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ị. "key:value" độ dài chuỗi 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 kết 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 đây:
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 mà sau này sẽ không được dùng nữa. Đố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ì hai thuộc tính này phải giống hệt nhau, nếu không thì sẽ xảy ra lỗi. Cả hai trường đều được điền sẵn câu trả lời.
boolValue

boolean

Giá trị thuộc tính được nhập bằng Boolean.
numberValue

number

Giá trị thuộc tính được nhập hai lần.

VehicleType

Loại xe.

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 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 thuộc diện quản lý).
TRUCK Thông thường là xe có dung tích chứa lớn.
TWO_WHEELER Xe mô tô, xe máy hoặc các phương tiện 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 chuyên chở người, thường đi bộ hoặc chạy dọc theo đường dành cho người đi bộ.

LicensePlate

Thông tin về 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ữ 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 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ố xe.

  • "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 nhiều đường thể hiện tốc độ giao thông cho tất cả các khu vực trên một đoạn đường của khách hàng.

VisualTrafficReportPolylineRendering

Mô tả cách khách hàng nên 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. Đoạn đường sẽ được hiển thị dọc theo hình nhiều đường. Các đoạn kéo dài được đảm bảo không chồng chéo 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, ứng dụng khách nên áp dụng giá trị mặc định cho tuyến đường.

RoadStretch

Một đoạn đường cần được hiển thị.

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 nên áp dụng.
offsetMeters

integer

Bắt buộc. Kiểu phải được áp dụng trong khoảng thời gian [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 Lưu lượng truy cập đang chậm lại.
TRAFFIC_JAM Có tắc đườ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)
  }
}
Trường
locationPowerSaveMode

enum (LocationPowerSaveMode)

Cách các tính năng vị trí 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ị hiện có đang ở chế độ tiết kiệm điện năng hay không.
isInteractive

boolean

Xem 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 các thiết bị đó "trình tiết kiệm pin" đã bật. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enum
UNKNOWN_LOCATION_POWER_SAVE_MODE Vị trí PowerSaveMode không xác định
LOCATION_MODE_NO_CHANGE Trình tiết kiệm pin sẽ không bị ảnh hưởng bởi trình tiết kiệm pin hoặc trình tiết kiệm pin sẽ 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 bật trình tiết kiệm pin 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 Mọi trình cung cấp vị trí sẽ được cung cấp, nhưng chỉ nên cung cấp bản sửa lỗi vị trí 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 bị tắt, nhưng LocationManager sẽ điều tiết tất cả các yêu cầu cho 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
}
Trường
batteryStatus

enum (BatteryStatus)

Trạng thái pin, pin đầ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, pin đầy hay đang sạc, v.v.

Enum
UNKNOWN_BATTERY_STATUS Không rõ tình trạng pin.
BATTERY_STATUS_CHARGING Pin đang được sạc.
BATTERY_STATUS_DISCHARGING Pin đang sạc.
BATTERY_STATUS_FULL Pin đã đầy.
BATTERY_STATUS_NOT_CHARGING Pin đang không sạc.
BATTERY_STATUS_POWER_LOW Pin yếu.

PowerSource

Loại bộ sạc đang được sử 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à một cổng USB.
POWER_SOURCE_WIRELESS Nguồn điện là không dây.
POWER_SOURCE_UNPLUGGED Chưa cắm pin.

Phương thức

create

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

get

 Trả về phương tiện từ Fleet Engine.

list

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

update

 Ghi dữ liệu mới về phương tiện vào Fleet Engine.

updateAttributes

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