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 của 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 mà 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 xe.
maximumCapacity

integer

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

object (VehicleAttribute)

Danh sách thuộc tính xe. Một 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á riêng biệ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 thời gian đến dự kiến và cách tính tuyến đường.
licensePlate

object (LicensePlate)

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

object (TerminalLocation)

Không dùng nữa: Hãy sử dụng Vehicle.waypoints.
currentRouteSegment

string

Đường đa tuyến chỉ định tuyến đường mà ứng dụng trình điều khiển dự định đi đến điểm trung gian 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. Chưa hỗ trợ giải mã.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Chỉ nhập. Công cụ quản lý đội xe 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.
currentRouteSegmentVersion

string (Timestamp format)

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

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
currentRouteSegmentEndPoint

object (TripWaypoint)

Điểm trung gian mà currentRouteSegment kết thúc. Trình điều khiển có thể cung cấp thông tin này trên các lệnh gọi vehicles.update dưới dạng điểm trung gian của toàn bộ chuyến đi, điểm trung gian LatLng hoặc dưới dạng LatLng cuối cùng của currentRouteSegment. Sau đó, Công cụ của đội xe sẽ cố gắng nội suy đến một điểm trung gian thực tế nếu điểm trung gian đó chưa đượ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

Khoảng cách 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ị này không được chỉ định nếu trường currentRouteSegment trống.
etaToFirstWaypoint

string (Timestamp format)

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

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

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
remainingTimeSeconds

integer

Chỉ nhập. Thời gian lái xe còn lại cho currentRouteSegment. Giá trị này không được chỉ định nếu trường waypoints 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 đều sử dụng cùng một đồng hồ.

Khi cập nhật 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 trung gian 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 phải lưu giá trị này vào bộ nhớ đệm và truyền giá trị đó trong GetVehicleRequest để đảm bảo trường waypoints chỉ được trả về nếu được cập nhật.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
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 true, vehicles.search có thể bao gồm cả 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 điều hướng của xe.
deviceSettings

object (DeviceSettings)

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

VehicleState

Trạng thái của Vehicle.

Enum
UNKNOWN_VEHICLE_STATE Mặc định, dùng cho các trạng thái xe không xác định hoặc không được nhận dạng.
OFFLINE Xe không 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 tất chuyến đi được chỉ định.
ONLINE Xe đang nhận các chuyến đi mới.

VehicleAttribute

Mô tả một thuộc tính của xe dưới dạng một cặp khoá-giá trị. Chiều dài chuỗi "khoá:giá trị" 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 hợp nhất vehicle_attribute_value. Giá trị của thuộc tính có thể ở dạng chuỗi, bool hoặc double. vehicle_attribute_value chỉ có thể là một trong những giá trị sau:
stringValue

string

Giá trị thuộc tính được nhập dưới dạng chuỗi.

Lưu ý: Trường này giống với trường value mà cuối cùng sẽ không được dùng nữa. Đố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 này, nhưng bạn nên sử dụng stringValue. Nếu bạn đặt cả stringValue và value, thì các giá trị này phải giống 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 đượ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 được nhận dạng.
AUTO Một chiếc ô tô.
TAXI Mọi loại xe hoạt động như xe taxi (thường được cấp phép hoặc quản lý).
TRUCK 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 phương tiện hai bánh khác
BICYCLE Phương tiện vận tải do con người vận hành.
PEDESTRIAN Phương tiện vận chuyển người, thường là đi bộ hoặc chạy, di chuyển dọc theo đường đi bộ.

LicensePlate

Thông tin biển số xe. Để tránh lưu trữ thông tin nhận dạng cá nhân, chỉ lưu trữ thông tin tối thiểu về biển số xe trong 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ố hoặc "-1" để biểu thị không có giá trị số trong 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)

Một đường đa tuyến thể hiện tốc độ giao thông của tất cả các khu vực dọc theo một đoạn đường của chuyến đi của khách hàng.

VisualTrafficReportPolylineRendering

Mô tả cách ứng dụng tô màu một phần của đường đa tuyến 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. Các đoạn đường cần kết xuất dọc theo đường đa giác. Các đoạn đường được đảm bảo không trùng lặp và không nhất thiết phải trải dài toàn bộ tuyến đường.

Nếu không có đoạn đường để tạo kiểu, ứng dụng khách phải áp dụng kiểu mặc định cho tuyến đường.

RoadStretch

Một đoạn đường cần 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ày phải được áp dụng giữa [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

Bắt buộc. Chiều dài của đường dẫn để á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ó á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)
  }
}
Trường
locationPowerSaveMode

enum (LocationPowerSaveMode)

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

boolean

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

boolean

Liệu thiết bị có ở 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 định cấu hình các tính năng vị trí để 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ị đ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 không được ảnh hưởng đến trì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 Nhà cung cấp vị trí dựa trên GPS phải bị tắt khi chế độ 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 Tất cả nhà cung cấp vị trí phải bị tắt khi chế độ 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 vị trí sẽ vẫn hoạt động, nhưng chỉ các ứng dụng trên nền trước mới được cung cấp bản sửa lỗi vị trí.
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 đến các 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 của pin, liệu 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 của pin, liệu pin đã đầ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 sạc.
BATTERY_STATUS_DISCHARGING Pin đang xả.
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 đang được dùng để sạc pin.

Enum
UNKNOWN_POWER_SOURCE Không xác định nguồn điện.
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 Pin đã rút phích cắm.

Phương thức

create

 Tạo bản sao cho một 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ả về một xe từ Công cụ quản lý đội xe.

list

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

update

 Ghi dữ liệu xe đã cập nhật vào Công cụ quản lý đội xe.

updateAttributes

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