REST Resource: providers.deliveryVehicles

Tài nguyên: Deliveryvehicle

Tin nhắn DeliveryVehicle. Xe giao hàng sẽ vận chuyển các gói hàng từ tổng kho đến địa điểm giao hàng và từ một vị trí đón đến kho. Trong một số trường hợp, xe giao hàng cũng vận chuyển trực tiếp các gói hàng từ vị trí đến lấy hàng.

Lưu ý: API gRPC và REST sử dụng các quy ước đặt tên trường khác nhau. Ví dụ: trường DeliveryVehicle.current_route_segment trong API gRPC và trường DeliveryVehicle.currentRouteSegment trong API REST tham chiếu đến cùng một trường.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "navigationStatus": enum (DeliveryVehicleNavigationStatus),
  "currentRouteSegment": string,
  "currentRouteSegmentEndPoint": {
    object (LatLng)
  },
  "remainingDistanceMeters": integer,
  "remainingDuration": string,
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "attributes": [
    {
      object (DeliveryVehicleAttribute)
    }
  ],
  "type": enum (DeliveryVehicleType)
}
Trường
name

string

Tên riêng biệt của Xe giao hàng này. Định dạng là providers/{provider}/deliveryVehicles/{vehicle}.

lastLocation

object (DeliveryVehicleLocation)

Vị trí được báo cáo gần đây nhất của Xe giao hàng.

navigationStatus

enum (DeliveryVehicleNavigationStatus)

Trạng thái đi theo chỉ dẫn của Xe giao hàng.

currentRouteSegment

string (bytes format)

Hình nhiều đường được mã hoá chỉ định tuyến đường mà tính năng điều hướng đề xuất đi đến điểm tham chiếu tiếp theo. Ứng dụng trình điều khiển sẽ cập nhật thông tin này khi đạt hoặc vượt qua một điểm dừng và khi việc định tuyến lại. Các LatLng này sẽ được trả về trong Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) hoặc Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) cho mọi Nhiệm vụ đang hoạt động được giao cho Xe.

Có một vài trường hợp mà trường này có thể không được dùng để điền Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) hoặc Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • Điểm cuối của currentRouteSegment không khớp với DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) hoặc DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • Ứng dụng trình điều khiển chưa cập nhật vị trí gần đây, vì vậy, giá trị được cập nhật gần đây nhất cho trường này có thể đã cũ.

  • Gần đây, ứng dụng người lái xe đã cập nhật vị trí, nhưng currentRouteSegment đã lỗi thời và trỏ đến một điểm dừng xe trước đó.

Trong những trường hợp này, Fleet Engine sẽ điền vào trường này một tuyến đường từ xe VehicleStop đã vượt qua gần đây nhất đến VehicleStop sắp tới để đảm bảo rằng người tiêu dùng trong trường này có thông tin phù hợp nhất về lộ trình hiện tại của Xe giao hàng.

Chuỗi được mã hoá base64.

currentRouteSegmentEndPoint

object (LatLng)

Vị trí kết thúc currentRouteSegment. Thông tin này hiện chưa được ứng dụng trình điều khiển điền sẵn, nhưng bạn có thể cung cấp mã này trong các lệnh gọi deliveryVehicles.patch. Đó là LatLng từ trạm xe sắp tới 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 VehicleStop thực tế.

Trường này sẽ bị bỏ qua trong các lệnh gọi deliveryVehicles.patch nếu trường currentRouteSegment trống.

remainingDistanceMeters

integer

Quãng đường lái xe còn lại của currentRouteSegment. Ứng dụng Driver thường cung cấp trường này, nhưng có một số trường hợp, Fleet Engine sẽ ghi đè giá trị do ứng dụng gửi. Để biết thêm thông tin, hãy xem DeliveryVehicle.current_route_segment. Trường này được trả về trong Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) hoặc Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) cho tất cả Task đang hoạt động được chỉ định cho Xe giao hàng.

Fleet Engine bỏ qua trường này trong UpdateDeliveryVehicleRequest nếu trường currentRouteSegment trống.

remainingDuration

string (Duration format)

Thời gian lái xe còn lại cho currentRouteSegment. Ứng dụng Driver thường cung cấp trường này, nhưng có một số trường hợp, Fleet Engine sẽ ghi đè giá trị do ứng dụng gửi. Để biết thêm thông tin, hãy xem DeliveryVehicle.current_route_segment. Trường này được trả về trong Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) hoặc Task.remainingVehicleJourneySegments[0].drivingDuration (REST) cho tất cả các nhiệm vụ đang hoạt động được giao cho Xe giao hàng.

Fleet Engine bỏ qua trường này trong UpdateDeliveryVehicleRequest nếu trường currentRouteSegment trống.

Thời lượng tính bằng giây với tối đa 9 chữ số phân số, kết thúc bằng "s". Ví dụ: "3.5s".

remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Những đoạn đường được chỉ định cho Xe giao hàng này, bắt đầu từ vị trí được báo cáo gần đây nhất của Xe. Trường này sẽ không được điền sẵn trong phản hồi của deliveryVehicles.list.

attributes[]

object (DeliveryVehicleAttribute)

Danh sách các thuộc tính xe giao hàng tuỳ chỉnh. Xe giao hàng 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.

type

enum (DeliveryVehicleType)

Loại xe giao hàng này. Nếu bạn không đặt chính sách này, giá trị mặc định sẽ là AUTO.

DeliveryVehicleNavigationStatus

Trạng thái đi theo chỉ dẫn của xe.

Enum
UNKNOWN_NAVIGATION_STATUS Trạng thái điều hướng chưa được chỉ định.
NO_GUIDANCE Tính năng điều hướng của ứng dụng Trình điều khiển đang ở chế độ FREE_NAV.
ENROUTE_TO_DESTINATION Tính năng đi theo chỉ dẫn từng chặng có sẵn và tính năng đi theo chỉ dẫn trong ứng dụng Tài xế đã chuyển sang chế độ GUIDED_NAV.
OFF_ROUTE Xe đã đi sai tuyến đường được đề xuất.
ARRIVED_AT_DESTINATION Xe cách điểm đến khoảng 50 m.

DeliveryVehicleAttribute

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 delivery_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
  // delivery_vehicle_attribute_value.
}
Trường
key

string

Khoá của thuộc tính.

value

string

Giá trị của thuộc tính.

Trường kết hợp delivery_vehicle_attribute_value. Giá trị của thuộc tính có thể ở dạng chuỗi, bool hoặc kiểu kép. delivery_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ả stringValuevalue thì hai thuộc tính 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 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.

DeliveryVehicleType

Loại xe giao hàng.

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Giá trị này không được dùng.
AUTO Một chiếc ô tô.
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 chuyển 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ộ.

Phương thức

create

Tạo và trả về một DeliveryVehicle mới.

get

Trả về phiên bản DeliveryVehicle đã chỉ định.

list

Lấy tất cả DeliveryVehicle đáp ứng tiêu chí lọc đã chỉ định.

patch

Ghi dữ liệu DeliveryVehicle đã cập nhật vào Fleet Engine và chỉ định Tasks cho DeliveryVehicle.