REST Resource: providers.deliveryVehicles

Tài nguyên: Giao hàng

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

Lưu ý: Các 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)
}
Các 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ều hướng của Xe giao hàng.
currentRouteSegment

string (bytes format)

Hình nhiều đường được mã hoá xác định tuyến đường mà điều hướng đề xuất đi đến điểm tham chiếu tiếp theo. Ứng dụng lái xe sẽ cập nhật thông tin này khi bạn đến một điểm dừng hoặc vượt qua một điểm dừng, cũng như khi lộ trình chuyển tuyến. Các LatLng này được trả về trong Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) hoặc Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) đối với mọi Nhiệm vụ đang hoạt động được chỉ định 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 vào 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, do đó giá trị cập nhật gần đây nhất cho trường này có thể đã cũ.

  • Gần đây, ứng dụng dành cho 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 các trường hợp này, Fleet Engine sẽ điền sẵn tuyến đường từ CustomerStop được thông qua gần đây nhất đến CarsStop sắp tới để đảm bảo rằng người dùng của trường này có thông tin sẵn có tốt nhất về đường dẫn hiện tại của Xe giao hàng.

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

object (LatLng)

Vị trí mà currentRouteSegment kết thúc. Hiện tại, mã này 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ừ điểm dừng 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 ra 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 cho currentRouteSegment. Ứng dụng Trình điều khiển thường cung cấp trường này, nhưng có một số trường hợp trong đó 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) đối với mọi Task đang hoạt động được chỉ định cho Xe giao hàng.

Fleet Engine sẽ 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 của currentRouteSegment. Ứng dụng Trình điều khiển thường cung cấp trường này, nhưng có một số trường hợp trong đó 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) đối với tất cả các nhiệm vụ đang hoạt động được giao cho Xe giao hàng.

Fleet Engine sẽ 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 có tối đa 9 chữ số phân số, kết thúc bằng 's'. Ví dụ: "3.5s".
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Đoạn hành trình đượ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 theo 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 thì chế độ mặc định sẽ là AUTO.

DeliveryVehicleNavigationStatus

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

Enum
UNKNOWN_NAVIGATION_STATUS Trạng thái di chuyển chưa được chỉ định.
NO_GUIDANCE Tính năng chỉ đường của ứng dụng Driver đang ở chế độ FREE_NAV.
ENROUTE_TO_DESTINATION Hiện đã có tính năng chỉ đường từng chặng và tính năng đi theo chỉ dẫn trong ứng dụng Người lái xe đã chuyển sang chế độ GUIDED_NAV.
OFF_ROUTE Xe đã đi khỏi tuyến đường đề xuất.
ARRIVED_AT_DESTINATION Xe sẽ cách đích đến khoảng 50 m.

DeliveryVehicleAttribute

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 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.
}
Các trường
key

string

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

string

Giá trị của thuộc tính.
Trường nhóm delivery_vehicle_attribute_value. Giá trị của thuộc tính có thể ở dạng chuỗi, bool hoặc kiểu double. 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 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.

DeliveryVehicleType

Loại xe giao hàng.

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Giá trị này chưa được sử dụng.
AUTO Một chiếc ô tô.
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ộ.

Phương thức

create

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

get

 Trả về thực thể 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, rồi chỉ định Tasks cho DeliveryVehicle.