Package maps.fleetengine.delivery.v1

Chỉ mục

DeliveryService

Dịch vụ giao hàng chặng cuối.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Tạo và trả về một nhóm đối tượng Task mới.
CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

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

rpc CreateTask(CreateTaskRequest) returns (Task)

Tạo và trả về một đối tượng Task mới.
DeleteDeliveryVehicle

rpc DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest) returns (Empty)

Xoá một DeliveryVehicle khỏi Fleet Engine.

Trả về FAILED_PRECONDITION nếu DeliveryVehicle có các Task ở trạng thái OPEN được chỉ định cho DeliveryVehicle đó.
DeleteTask

rpc DeleteTask(DeleteTaskRequest) returns (Empty)

Xoá một việc cần làm.

Trả về FAILED_PRECONDITION nếu Task có trạng thái OPEN và được chỉ định cho một DeliveryVehicle.
GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Trả về phiên bản DeliveryVehicle được chỉ định.
GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Lấy thông tin về Task.
GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Trả về phiên bản TaskTrackingInfo được chỉ định.
ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

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

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

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

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Ghi dữ liệu DeliveryVehicle đã cập nhật vào Fleet Engine và chỉ định Tasks cho DeliveryVehicle. Bạn không thể cập nhật tên của DeliveryVehicle. Bạn có thể cập nhật remaining_vehicle_journey_segments, nhưng phải chứa tất cả VehicleJourneySegment để duy trì trên DeliveryVehicle. task_id được truy xuất từ remaining_vehicle_journey_segments và Tasks tương ứng của chúng được chỉ định cho DeliveryVehicle nếu chúng chưa được chỉ định.
UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Cập nhật dữ liệu Task.

BatchCreateTasksRequest

Thông báo yêu cầu BatchCreateTask.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường. Lưu ý: Nếu bạn đặt trường này, thì trường tiêu đề trong thông báo CreateTaskRequest phải trống hoặc phải khớp với trường này.
parent

string

Bắt buộc. Tài nguyên gốc được chia sẻ bởi tất cả các tác vụ. Giá trị này phải có định dạng providers/{provider}. provider phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project. Trường mẹ trong thông báo CreateTaskRequest phải trống hoặc phải khớp với trường này.
requests[]

CreateTaskRequest

Bắt buộc. Thông báo yêu cầu chỉ định các tài nguyên cần tạo. Lưu ý: Bạn có thể tạo tối đa 500 việc cần làm trong một lô.

BatchCreateTasksResponse

Thông báo phản hồi BatchCreateTask.

Trường
tasks[]

Task

Việc cần làm đã tạo.

CreateDeliveryVehicleRequest

Thông báo yêu cầu CreateDeliveryVehicle.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
parent

string

Bắt buộc. Phải ở định dạng providers/{provider}. Nhà cung cấp phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project.
delivery_vehicle_id

string

Bắt buộc. Mã nhận dạng xe giao hàng phải là mã riêng biệt và tuân theo các quy định hạn chế sau:

  • Phải là một chuỗi Unicode hợp lệ.
  • Giới hạn độ dài tối đa là 64 ký tự.
  • Được chuẩn hoá theo Unicode Normalization Form C.
  • Không được chứa bất kỳ ký tự ASCII nào sau đây: "/", ":", "?", "," hoặc "#".
delivery_vehicle

DeliveryVehicle

Bắt buộc. Thực thể DeliveryVehicle cần tạo. Khi tạo một xe giao hàng mới, bạn có thể đặt các trường không bắt buộc sau:

  • loại
  • last_location
  • attributes

Lưu ý: Trường name của DeliveryVehicle sẽ bị bỏ qua. Bạn không được đặt tất cả các trường DeliveryVehicle khác; nếu không, hệ thống sẽ trả về lỗi.

CreateTaskRequest

Thông báo yêu cầu CreateTask.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
parent

string

Bắt buộc. Phải ở định dạng providers/{provider}. provider phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project.
task_id

string

Bắt buộc. Mã nhiệm vụ phải là mã riêng biệt, nhưng không được là mã theo dõi lô hàng. Để lưu trữ mã theo dõi lô hàng, hãy dùng trường tracking_id. Xin lưu ý rằng nhiều tác vụ có thể có cùng một tracking_id. Mã nhiệm vụ phải tuân theo các quy tắc hạn chế sau:

  • Phải là một chuỗi Unicode hợp lệ.
  • Giới hạn độ dài tối đa là 64 ký tự.
  • Được chuẩn hoá theo Unicode Normalization Form C.
  • Không được chứa bất kỳ ký tự ASCII nào sau đây: "/", ":", "?", "," hoặc "#".
task

Task

Bắt buộc. Thực thể Việc cần làm cần tạo. Khi tạo một Việc cần làm, bạn phải điền vào các trường sau:

  • type
  • state (phải được đặt thành OPEN)
  • tracking_id (bạn không được đặt cho các tác vụ UNAVAILABLE hoặc SCHEDULED_STOP, nhưng bắt buộc đối với tất cả các loại tác vụ khác)
  • planned_location (không bắt buộc đối với nhiệm vụ UNAVAILABLE)
  • task_duration

Bạn có thể tuỳ ý đặt các trường sau:

  • target_time_window
  • task_tracking_view_config
  • attributes

Lưu ý: Trường name của Task sẽ bị bỏ qua. Bạn không được đặt tất cả các trường Task khác; nếu không, hệ thống sẽ trả về lỗi.

DeleteDeliveryVehicleRequest

Thông báo yêu cầu DeleteDeliveryVehicle.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
name

string

Bắt buộc. Phải ở định dạng providers/{provider}/deliveryVehicles/{delivery_vehicle}. provider phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project.

DeleteTaskRequest

Thông báo yêu cầu DeleteTask.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
name

string

Bắt buộc. Phải ở định dạng providers/{provider}/tasks/{task}. provider phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project.

DeliveryRequestHeader

RequestHeader chứa các trường chung cho tất cả các yêu cầu Delivery RPC.

Trường
language_code

string

Mã ngôn ngữ BCP-47, chẳng hạn như en-US hoặc sr-Latn. Để biết thêm thông tin, hãy xem http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Nếu không có ngôn ngữ nào được chỉ định, thì phản hồi có thể bằng bất kỳ ngôn ngữ nào, ưu tiên tiếng Anh nếu có tên như vậy. Ví dụ về giá trị trường: en-US.
region_code

string

Bắt buộc. Mã vùng CLDR của khu vực nơi yêu cầu bắt nguồn. Ví dụ về giá trị trường: US.
sdk_version

string

Phiên bản của SDK gọi (nếu có). Định dạng phiên bản là "major.minor.patch", ví dụ: 1.1.2.
os_version

string

Phiên bản của hệ điều hành mà SDK gọi đang chạy. Ví dụ về giá trị của trường: 4.4.1, 12.1.
device_model

string

Mẫu thiết bị mà SDK gọi đang chạy. Ví dụ về giá trị của trường: iPhone12,1, SM-G920F.
sdk_type

SdkType

Loại SDK gửi yêu cầu.
maps_sdk_version

string

Phiên bản MapSDK mà SDK gọi phụ thuộc vào (nếu có). Định dạng phiên bản là "major.minor.patch", ví dụ: 5.2.1.
nav_sdk_version

string

Phiên bản NavSDK mà SDK gọi phụ thuộc vào (nếu có). Định dạng phiên bản là "major.minor.patch", ví dụ: 2.1.0.
platform

Platform

Nền tảng của SDK gọi.
manufacturer

string

Nhà sản xuất thiết bị Android từ SDK gọi, chỉ áp dụng cho các SDK Android. Ví dụ về giá trị trường: Samsung.
android_api_level

int32

Cấp API Android của SDK gọi, chỉ áp dụng cho các SDK Android. Ví dụ về giá trị trường: 23.
trace_id

string

Mã nhận dạng không bắt buộc mà bạn có thể cung cấp cho mục đích ghi nhật ký để xác định yêu cầu.

Nền tảng

Nền tảng của SDK gọi.

Enum
PLATFORM_UNSPECIFIED Giá trị mặc định. Giá trị này được dùng nếu bạn bỏ qua nền tảng.
ANDROID Yêu cầu đến từ Android.
IOS Yêu cầu đến từ iOS.
WEB Yêu cầu này đến từ web.

SdkType

Các loại SDK có thể có.

Enum
SDK_TYPE_UNSPECIFIED Giá trị mặc định. Giá trị này được dùng nếu bạn bỏ qua sdk_type.
CONSUMER SDK gọi là Consumer.
DRIVER SDK gọi là Trình điều khiển.
JAVASCRIPT SDK gọi là JavaScript.

DeliveryVehicle

Thông báo DeliveryVehicle. Xe giao hàng vận chuyển các lô hàng từ kho đến địa điểm giao hàng và từ địa điểm lấy hàng đến kho. Trong một số trường hợp, xe giao hàng cũng vận chuyển các lô hàng trực tiếp từ địa điểm lấy hàng đến địa điểm giao 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 đều đề cập đến cùng một trường.

Trường
name

string

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

DeliveryVehicleLocation

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

DeliveryVehicleLocation

Chỉ có đầu vào. Những vị trí mà Xe giao hàng này đã từng đến nhưng chưa được báo cáo cho Fleet Engine. Dịch vụ này được dùng trong UpdateDeliveryVehicleRequest để ghi lại những vị trí mà trước đây không gửi được đến máy chủ. Thông thường, điều này xảy ra khi Xe giao hàng không có kết nối Internet.
navigation_status

DeliveryVehicleNavigationStatus

Trạng thái điều hướng của Xe giao hàng.
current_route_segment

bytes

Đường nhiều đường được mã hoá chỉ định tuyến đường mà chế độ chỉ đường đề xuất để đi đến điểm tham chiếu tiếp theo. Ứng dụng dành cho tài xế sẽ cập nhật thông tin này khi bạn đến hoặc đi qua một điểm dừng và khi tính năng chỉ đường chuyển hướng. 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) cho tất cả các Task đang hoạt động được chỉ định cho Vehicle.

Có một số trường hợp mà bạn không thể dùng trường này để điền sẵ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 current_route_segment không khớp với DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) hoặc DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

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

  • Ứng dụng dành cho tài xế đã cập nhật thông tin vị trí gần đây, nhưng current_route_segment đã cũ và chỉ đến một điểm dừng xe trước đó.

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

LatLng

Vị trí kết thúc của current_route_segment. Ứng dụng dành cho tài xế hiện không điền sẵn thông tin này, nhưng bạn có thể cung cấp thông tin này trong các lệnh gọi UpdateDeliveryVehicle. Đó có thể là LatLng của trạm dừng xe sắp tới hoặc LatLng cuối cùng của current_route_segment. Sau đó, Fleet Engine sẽ cố gắng hết sức để suy đoán thành một VehicleStop thực tế.

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

Int32Value

Quãng đường lái xe còn lại cho current_route_segment. Ứng dụng Driver thường cung cấp trường này, nhưng trong 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 phần 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 current_route_segment trống.
remaining_duration

Duration

Thời gian lái xe còn lại cho current_route_segment. Ứng dụng Driver thường cung cấp trường này, nhưng trong 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 phần 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 current_route_segment trống.
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Các đ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 ListDeliveryVehicles.
attributes[]

DeliveryVehicleAttribute

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

DeliveryVehicleType

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

DeliveryVehicleType

Loại xe giao hàng.

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Giá trị này không được dùng.
AUTO Ô tô.
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 chuyển chạy bằng sức người.
PEDESTRIAN Một người vận chuyển, thường đi bộ hoặc chạy, di chuyển dọc theo đường dành cho người đi bộ.

DeliveryVehicleAttribute

Mô tả một thuộc tính của xe dưới dạng một cặp khoá-giá trị. Độ dài chuỗi "khoá:giá trị" không được vượt quá 256 ký tự.

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ể thuộc loại chuỗi, boolean hoặc double. delivery_vehicle_attribute_value chỉ có thể là một trong những trạng thái sau:
string_value

string

Giá trị thuộc tính có dạng chuỗi văn bản.

Lưu ý: Trường này giống hệt với trường value và cuối cùng 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 này, nhưng nên sử dụng string_value. Nếu bạn đặt cả string_value và value, thì chúng phải giống nhau, nếu không thì sẽ xảy ra lỗi. Cả hai trường đều được điền sẵn trong các phản hồi.
bool_value

bool

Giá trị thuộc tính có kiểu Boolean.
number_value

double

Giá trị thuộc tính có kiểu gấp đôi.

DeliveryVehicleLocation

Vị trí, tốc độ và hướng đi của xe tại một thời điểm.

Trường
location

LatLng

Vị trí của xe. Khi được gửi đến Fleet Engine, vị trí của xe là vị trí GPS. Khi bạn nhận được vị trí này trong một phản hồi, vị trí của xe có thể là vị trí GPS, vị trí bổ sung hoặc một số vị trí ước đoán khác. Nguồn được chỉ định trong location_sensor.
horizontal_accuracy
(deprecated)

DoubleValue

Không dùng nữa: Thay vào đó, hãy sử dụng latlng_accuracy.
latlng_accuracy

DoubleValue

Độ chính xác của location tính bằng mét theo bán kính.
heading

Int32Value

Hướng di chuyển của xe tính bằng độ. 0 biểu thị hướng Bắc. Phạm vi hợp lệ là [0,360).
bearing_accuracy
(deprecated)

DoubleValue

Không dùng nữa: Thay vào đó, hãy sử dụng heading_accuracy.
heading_accuracy

DoubleValue

Độ chính xác của heading tính bằng độ.
altitude

DoubleValue

Độ cao tính bằng mét so với WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Không dùng nữa: Thay vào đó, hãy sử dụng altitude_accuracy.
altitude_accuracy

DoubleValue

Độ chính xác là altitude mét.
speed_kmph
(deprecated)

Int32Value

Tốc độ của xe tính bằng km/giờ. Không dùng nữa: Thay vào đó, hãy sử dụng speed.
speed

DoubleValue

Tốc độ của xe tính bằng mét/giây
speed_accuracy

DoubleValue

Độ chính xác của speed tính bằng mét/giây.
update_time

Timestamp

Thời gian mà location được cảm biến báo cáo theo đồng hồ của cảm biến.
server_time

Timestamp

Chỉ có đầu ra. Thời gian máy chủ nhận được thông tin vị trí.
location_sensor

DeliveryVehicleLocationSensor

Nhà cung cấp dữ liệu vị trí (ví dụ: GPS).
is_road_snapped

BoolValue

location có được gắn vào một con đường hay không.
is_gps_sensor_enabled

BoolValue

Chỉ có đầu vào. Cho biết liệu cảm biến GPS có được bật trên thiết bị di động hay không.
time_since_update

Int32Value

Chỉ có đầu vào. Thời gian (tính bằng giây) kể từ khi vị trí này được gửi đến máy chủ lần đầu tiên. Giá trị này sẽ bằng 0 cho lần cập nhật đầu tiên. Nếu không xác định được thời gian (ví dụ: khi ứng dụng khởi động lại), giá trị này sẽ đặt lại thành 0.
num_stale_updates
(deprecated)

Int32Value

Chỉ có đầu vào. Không dùng nữa: Giờ đây, các tín hiệu khác được dùng để xác định xem một vị trí có còn mới hay không.
raw_location

LatLng

Vị trí thô của xe (chưa được xử lý bằng tính năng gắn vị trí vào đường).
raw_location_time

Timestamp

Dấu thời gian liên kết với vị trí thô.
raw_location_sensor

DeliveryVehicleLocationSensor

Nguồn của vị trí thô. Giá trị mặc định là GPS.
raw_location_accuracy

DoubleValue

Độ chính xác của raw_location dưới dạng bán kính, tính bằng mét.
flp_location

LatLng

Vị trí do Trình cung cấp vị trí kết hợp của Android cung cấp.
flp_update_time

Timestamp

Dấu thời gian cập nhật của flp_location
flp_latlng_accuracy_meters

DoubleValue

Độ chính xác của flp_location tính bằng mét theo bán kính.
flp_heading_degrees

Int32Value

Hướng di chuyển của xe theo độ, do Trình cung cấp vị trí kết hợp xác định. 0 biểu thị hướng Bắc. Phạm vi hợp lệ là [0,360).
supplemental_location

LatLng

Vị trí bổ sung do ứng dụng tích hợp cung cấp.
supplemental_location_time

Timestamp

Dấu thời gian liên kết với vị trí bổ sung.
supplemental_location_sensor

DeliveryVehicleLocationSensor

Nguồn của vị trí bổ sung. Giá trị mặc định là CUSTOMER_SUPPLIED_LOCATION.
supplemental_location_accuracy

DoubleValue

Độ chính xác của supplemental_location dưới dạng bán kính, tính bằng mét.
road_snapped
(deprecated)

bool

Không dùng nữa: Thay vào đó, hãy sử dụng is_road_snapped.

DeliveryVehicleLocationSensor

Cảm biến hoặc phương pháp được dùng để xác định vị trí.

Enum
UNKNOWN_SENSOR Cảm biến không được chỉ định hoặc không xác định.
GPS GPS hoặc GPS hỗ trợ.
NETWORK GPS hỗ trợ, mã nhận dạng trạm phát sóng hoặc điểm truy cập Wi-Fi.
PASSIVE Mã nhận dạng trạm phát sóng hoặc điểm truy cập Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Vị trí do thiết bị di động xác định là vị trí có khả năng cao nhất trên đường.
CUSTOMER_SUPPLIED_LOCATION Vị trí do khách hàng cung cấp từ một nguồn độc lập. Thông thường, giá trị này được dùng cho một vị trí do các nguồn khác cung cấp, không phải thiết bị di động đang chạy Driver SDK. Nếu nguồn ban đầu được mô tả bằng một trong các giá trị enum khác, hãy sử dụng giá trị đó. Vị trí được đánh dấu là CUSTOMER_SUPPLIED_LOCATION thường được cung cấp thông qua last_location.supplemental_location_sensor của DeliveryVehicle.
FLEET_ENGINE_LOCATION Vị trí do Fleet Engine tính toán dựa trên các tín hiệu có sẵn. Chỉ có đầu ra. Giá trị này sẽ bị từ chối nếu được nhận trong một yêu cầu.
FUSED_LOCATION_PROVIDER Trình cung cấp vị trí kết hợp của Android.
CORE_LOCATION Trình cung cấp vị trí trên hệ điều hành Apple.

DeliveryVehicleNavigationStatus

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

Enum
UNKNOWN_NAVIGATION_STATUS Trạng thái điều hướng không xác định.
NO_GUIDANCE Chế độ điều hướng của ứng dụng Driver là FREE_NAV.
ENROUTE_TO_DESTINATION Tính năng chỉ đường từng chặng hiện đã hoạt động và chế độ chỉ đường của ứng dụng Driver đã chuyển sang chế độ GUIDED_NAV.
OFF_ROUTE Xe đã đi sai tuyến đường được đề xuất.
ARRIVED_AT_DESTINATION Xe đang ở trong phạm vi khoảng 50 m tính từ điểm đến.

GetDeliveryVehicleRequest

Thông báo yêu cầu GetDeliveryVehicle.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
name

string

Bắt buộc. Phải ở định dạng providers/{provider}/deliveryVehicles/{delivery_vehicle}. provider phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project.

GetTaskRequest

Thông báo yêu cầu GetTask.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
name

string

Bắt buộc. Phải ở định dạng providers/{provider}/tasks/{task}. provider phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project.

GetTaskTrackingInfoRequest

Thông báo yêu cầu GetTaskTrackingInfoRequest.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
name

string

Bắt buộc. Phải ở định dạng providers/{provider}/taskTrackingInfo/{tracking_id}. provider phải là mã dự án trên Google Cloud và tracking_id phải là mã theo dõi được liên kết với tác vụ. Ví dụ: tên có thể là providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

ListDeliveryVehiclesRequest

Thông báo yêu cầu ListDeliveryVehicles.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
parent

string

Bắt buộc. Phải ở định dạng providers/{provider}. provider phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project.
page_size

int32

Không bắt buộc. Số lượng xe tối đa cần trả về. Dịch vụ có thể trả về ít hơn số này. Nếu bạn không chỉ định số này, thì máy chủ sẽ xác định số lượng kết quả cần trả về.
page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListDeliveryVehicles trước đó. Bạn phải cung cấp thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho ListDeliveryVehicles phải khớp với lệnh gọi đã cung cấp mã thông báo trang.
filter

string

Không bắt buộc. Một truy vấn bộ lọc để áp dụng khi liệt kê xe giao hàng. Hãy xem http://aip.dev/160 để biết ví dụ về cú pháp bộ lọc. Nếu bạn không chỉ định giá trị hoặc nếu bạn chỉ định một chuỗi trống cho bộ lọc, thì tất cả các xe giao hàng sẽ được trả về.

Xin lưu ý rằng chỉ những truy vấn về thuộc tính xe (ví dụ: attributes.<key> = <value> hoặc attributes.<key1> = <value1> AND attributes.<key2> = <value2>) mới được hỗ trợ cho ListDeliveryVehicles. Ngoài ra, tất cả thuộc tính đều được lưu trữ dưới dạng chuỗi, nên chỉ có so sánh chuỗi mới được hỗ trợ đối với các thuộc tính. Để so sánh với các giá trị số hoặc boolean, bạn phải đặt các giá trị trong dấu ngoặc kép một cách rõ ràng để được coi là chuỗi (ví dụ: attributes.<key> = "10" hoặc attributes.<key> = "true").

Số lượng hạn chế tối đa được phép trong một truy vấn bộ lọc là 50. Hạn chế là một phần của truy vấn có dạng attribute.<KEY> <COMPARATOR> <VALUE>, ví dụ: attributes.foo = bar là 1 hạn chế.
viewport

Viewport

Không bắt buộc. Một bộ lọc giới hạn số lượng xe được trả về ở những xe có vị trí đã biết gần đây nhất nằm trong khu vực hình chữ nhật do khung hiển thị xác định.

ListDeliveryVehiclesResponse

Thông báo phản hồi ListDeliveryVehicles.

Trường
delivery_vehicles[]

DeliveryVehicle

Tập hợp các xe giao hàng đáp ứng tiêu chí lọc được yêu cầu. Khi bạn không chỉ định bộ lọc nào, yêu cầu sẽ trả về tất cả xe giao hàng. Phản hồi thành công cũng có thể trống. Phản hồi trống cho biết không tìm thấy xe giao hàng nào đáp ứng tiêu chí lọc được yêu cầu.
next_page_token

string

Bạn có thể truyền mã thông báo này trong ListDeliveryVehiclesRequest để tiếp tục liệt kê kết quả. Khi tất cả kết quả được trả về, trường này sẽ không có trong phản hồi hoặc sẽ là một chuỗi trống.
total_size

int64

Tổng số xe giao hàng đáp ứng tiêu chí của yêu cầu trên tất cả các trang.

ListTasksRequest

Thông báo yêu cầu ListTasks.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
parent

string

Bắt buộc. Phải ở định dạng providers/{provider}. provider phải là mã dự án trên Google Cloud. Ví dụ: sample-cloud-project.
page_size

int32

Không bắt buộc. Số lượng tối đa các việc cần làm cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định giá trị này, thì máy chủ sẽ xác định số lượng kết quả cần trả về.
page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListTasks trước đó. Bạn có thể cung cấp thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho ListTasks phải khớp với lệnh gọi đã cung cấp mã thông báo trang.
filter

string

Không bắt buộc. Một cụm từ tìm kiếm bộ lọc để áp dụng khi liệt kê các Việc cần làm. Hãy xem http://aip.dev/160 để biết ví dụ về cú pháp bộ lọc. Nếu bạn không chỉ định giá trị hoặc nếu bạn lọc theo một chuỗi trống, thì tất cả các Tasks sẽ được trả về. Để biết thông tin về các thuộc tính của Việc cần làm mà bạn có thể lọc, hãy xem phần Liệt kê việc cần làm.

ListTasksResponse

Phản hồi ListTasks chứa tập hợp các Nhiệm vụ đáp ứng tiêu chí lọc trong ListTasksRequest.

Trường
tasks[]

Task

Tập hợp các việc cần làm đáp ứng tiêu chí lọc được yêu cầu. Khi bạn không chỉ định bộ lọc, yêu cầu sẽ trả về tất cả các việc cần làm. Phản hồi thành công cũng có thể trống. Một phản hồi trống cho biết không tìm thấy Task nào đáp ứng tiêu chí lọc được yêu cầu.
next_page_token

string

Truyền mã thông báo này trong ListTasksRequest để tiếp tục liệt kê kết quả. Nếu tất cả kết quả đã được trả về, thì trường này sẽ là một chuỗi trống hoặc không xuất hiện trong phản hồi.
total_size

int64

Tổng số Nhiệm vụ đáp ứng tiêu chí của yêu cầu trên tất cả các trang.

LocationInfo

Một vị trí có bất kỳ giá trị nhận dạng bổ sung nào.

Trường
point

LatLng

Toạ độ của vị trí. Bạn phải chỉ định point hoặc place làm dữ liệu đầu vào. Nếu bạn chỉ định cả hai, thì point sẽ được dùng để định tuyến và place sẽ được dùng cho siêu dữ liệu. Nếu chỉ có place được chỉ định làm đầu vào, thì point sẽ được tính từ place và được đưa vào đầu ra.
place

string

Tên tài nguyên của địa điểm đại diện cho vị trí này. Định dạng là places/{place_id}. Bạn phải chỉ định point hoặc place làm dữ liệu đầu vào. Nếu bạn chỉ định cả hai, thì point sẽ được dùng để định tuyến và place sẽ được dùng cho siêu dữ liệu. place chỉ được đưa vào đầu ra nếu được đưa vào đầu vào, tức là không có hoạt động tra cứu place nào từ LatLng được thực hiện.

Đây là tính năng thử nghiệm.
point_location_source

PointSource

Chỉ có đầu ra. Nguồn của trường latlng point. Đây là một phần của tính năng thử nghiệm.

PointSource

Cho biết nguồn của LatLng.

Enum
POINT_SOURCE_UNSPECIFIED Chưa xác định nguồn điểm.
POINT_SOURCE_DEVELOPER_PROVIDED Nhà phát triển đã cung cấp rõ ràng LatLng.
POINT_SOURCE_CALCULATED_FROM_PLACE LatLng được tính từ địa điểm được cung cấp.

Việc cần làm

Một Task trong Delivery API đại diện cho một hành động duy nhất cần theo dõi. Nhìn chung, có sự khác biệt giữa các Nhiệm vụ liên quan đến lô hàng và Nhiệm vụ tách biệt. Một lô hàng có thể liên kết với nhiều Việc cần làm. Ví dụ: có thể có một Nhiệm vụ cho việc lấy hàng và một Nhiệm vụ cho việc giao hàng hoặc chuyển hàng. Ngoài ra, nhiều Xe có thể xử lý nhiều Việc cần làm cho một lô hàng nhất định. Ví dụ: một xe có thể xử lý việc lấy hàng, lái hàng đến trung tâm, trong khi một xe khác lái cùng một lô hàng từ trung tâm đến địa điểm giao 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 Task.journey_sharing_info trong API gRPC và trường Task.journeySharingInfo trong API REST đều đề cập đến cùng một trường.

Trường
name

string

Phải ở định dạng providers/{provider}/tasks/{task}.
type

Type

Bắt buộc. Không thể thay đổi. Xác định loại Nhiệm vụ. Ví dụ: khoảng thời gian nghỉ hoặc lô hàng.
state

State

Bắt buộc. Trạng thái thực thi hiện tại của Tác vụ.
task_outcome

TaskOutcome

Kết quả của việc cần làm.
task_outcome_time

Timestamp

Dấu thời gian cho biết thời điểm nhà cung cấp đặt kết quả của Task.
task_outcome_location

LocationInfo

Vị trí đặt kết quả của Task. Giá trị này được cập nhật trong UpdateTask. Nếu nhà cung cấp không cập nhật giá trị này một cách rõ ràng, thì theo mặc định, Fleet Engine sẽ điền giá trị này bằng vị trí đã biết gần đây nhất của xe (vị trí thô).
task_outcome_location_source

TaskOutcomeLocationSource

Cho biết giá trị của task_outcome_location đến từ đâu.
tracking_id

string

Không thể thay đổi. Trường này giúp lưu trữ một mã nhận dạng để bạn có thể tránh sử dụng mối liên kết phức tạp. Bạn không thể đặt tracking_id cho Việc cần làm thuộc loại UNAVAILABLE và SCHEDULED_STOP. Các mã nhận dạng này phải tuân thủ những quy định hạn chế sau:

  • Phải là một chuỗi Unicode hợp lệ.
  • Giới hạn độ dài tối đa là 64 ký tự.
  • Được chuẩn hoá theo Unicode Normalization Form C.
  • Không được chứa bất kỳ ký tự ASCII nào sau đây: "/", ":", "?", "," hoặc "#".
delivery_vehicle_id

string

Chỉ có đầu ra. Mã của xe đang thực hiện Thao tác này. Mã nhận dạng xe giao hàng phải tuân thủ các hạn chế sau:

  • Phải là một chuỗi Unicode hợp lệ.
  • Giới hạn độ dài tối đa là 64 ký tự.
  • Được chuẩn hoá theo Unicode Normalization Form C.
  • Không được chứa bất kỳ ký tự ASCII nào sau đây: "/", ":", "?", "," hoặc "#".
planned_location

LocationInfo

Không thể thay đổi. Vị trí hoàn thành việc cần làm. Không bắt buộc đối với UNAVAILABLE Công việc, nhưng bắt buộc đối với tất cả các Công việc khác.
task_duration

Duration

Bắt buộc. Không thể thay đổi. Thời gian cần thiết để thực hiện một Nhiệm vụ tại vị trí này.
target_time_window

TimeWindow

Khung thời gian mà bạn cần hoàn thành việc cần làm.
journey_sharing_info

JourneySharingInfo

Chỉ có đầu ra. Các trường dành riêng cho tính năng chia sẻ hành trình. Không được điền sẵn khi trạng thái là CLOSED.
task_tracking_view_config

TaskTrackingViewConfig

Cấu hình để theo dõi tác vụ, trong đó chỉ định những phần tử dữ liệu mà người dùng cuối có thể thấy trong những trường hợp nào.
attributes[]

TaskAttribute

Danh sách các thuộc tính tuỳ chỉnh của Nhiệm vụ. Mỗi thuộc tính phải có một khoá riêng biệt.

JourneySharingInfo

Các trường cụ thể để chia sẻ hành trình.

Trường
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Thông tin theo dõi về các điểm dừng mà xe được chỉ định sẽ ghé qua trước khi hoàn thành Nhiệm vụ này. Xin lưu ý rằng danh sách này có thể chứa các điểm dừng của những việc cần làm khác.

Đoạn đường đầu tiên, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) hoặc Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), chứa thông tin về tuyến đường từ vị trí gần đây nhất đã biết của người lái xe đến VehicleStop sắp tới. Thông tin về tuyến đường hiện tại thường đến từ ứng dụng dành cho người lái xe, ngoại trừ một số trường hợp được nêu trong tài liệu về DeliveryVehicle.current_route_segment. Các phân đoạn khác trong Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) hoặc Task.journeySharingInfo.remainingVehicleJourneySegments (REST) do Fleet Engine điền sẵn. Các điểm này cung cấp thông tin về tuyến đường giữa các VehicleStops còn lại.
last_location

DeliveryVehicleLocation

Cho biết vị trí được báo cáo gần đây nhất của xe được chỉ định.
last_location_snappable

bool

Cho biết liệu lastLocation của xe có thể được điều chỉnh cho khớp với current_route_segment hay không. Giá trị này là False nếu last_location hoặc current_route_segment không tồn tại. Giá trị này do Fleet Engine tính toán. Nội dung cập nhật của các ứng dụng sẽ bị bỏ qua.

Tiểu bang

Trạng thái của một việc cần làm. Chỉ số này cho biết tiến trình của Nhiệm vụ.

Enum
STATE_UNSPECIFIED Mặc định. Dùng cho trạng thái Task không xác định hoặc không nhận dạng được.
OPEN Việc cần làm chưa được giao cho xe giao hàng hoặc xe giao hàng chưa đến điểm dừng được giao của xe Task.
CLOSED Khi xe đi qua điểm dừng xe cho Nhiệm vụ này.

TaskOutcome

Kết quả của việc cố gắng thực thi một Tác vụ. Khi TaskState đóng, TaskOutcome cho biết liệu thao tác có hoàn tất thành công hay không.

Enum
TASK_OUTCOME_UNSPECIFIED Kết quả của Tác vụ trước khi giá trị được đặt.
SUCCEEDED Đã hoàn tất việc cần làm.
FAILED Không hoàn tất được Thao tác hoặc Thao tác đã bị huỷ.

TaskOutcomeLocationSource

Danh tính của nguồn đã điền sẵn task_outcome_location.

Enum
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Kết quả của việc cần làm trước khi được đặt.
PROVIDER Nhà cung cấp đã chỉ định task_outcome_location.
LAST_VEHICLE_LOCATION Nhà cung cấp không chỉ định task_outcome_location, nên Fleet Engine đã sử dụng vị trí gần đây nhất được ghi nhận của xe.

Loại

Loại việc cần làm.

Enum
TYPE_UNSPECIFIED Theo mặc định, loại Việc cần làm là không xác định.
PICKUP Nhiệm vụ lấy hàng là hành động lấy một lô hàng từ khách hàng. Xe đón tại kho hoặc xe trung chuyển nên sử dụng loại SCHEDULED_STOP.
DELIVERY Nhiệm vụ giao hàng là hành động được thực hiện để giao một lô hàng cho khách hàng cuối. Xe thả hàng tại kho hoặc xe trung chuyển nên sử dụng loại SCHEDULED_STOP.
SCHEDULED_STOP Nhiệm vụ dừng theo lịch được dùng cho mục đích lập kế hoạch. Ví dụ: nó có thể biểu thị việc lấy hoặc giao hàng từ các phương tiện hoặc kho trung chuyển. Bạn không nên sử dụng thông tin này cho bất kỳ lô hàng nào mà khách hàng cuối đến lấy hoặc gửi.
UNAVAILABLE Một nhiệm vụ có nghĩa là Xe không có sẵn để bảo dưỡng. Ví dụ: điều này có thể xảy ra khi người lái xe nghỉ ngơi hoặc khi xe đang được tiếp nhiên liệu.

TaskAttribute

Mô tả một thuộc tính của tác vụ dưới dạng một cặp khoá-giá trị. Độ dài chuỗi "khoá:giá trị" không được vượt quá 256 ký tự.

Trường
key

string

Khoá của thuộc tính. Khoá không được chứa ký tự dấu hai chấm (:).
Trường nhóm task_attribute_value. Giá trị của thuộc tính có thể thuộc loại chuỗi, boolean hoặc double. Nếu không có giá trị nào được đặt, string_value TaskAttribute sẽ được lưu trữ dưới dạng chuỗi trống "". task_attribute_value chỉ có thể là một trong những giá trị sau:
string_value

string

Giá trị thuộc tính có dạng chuỗi văn bản.
bool_value

bool

Giá trị thuộc tính có kiểu Boolean.
number_value

double

Giá trị thuộc tính có kiểu gấp đôi.

TaskTrackingInfo

Thông báo TaskTrackingInfo. Thông báo này chứa thông tin theo dõi nhiệm vụ sẽ được dùng để hiển thị. Nếu một mã theo dõi được liên kết với nhiều Nhiệm vụ, Fleet Engine sẽ sử dụng một phương pháp phỏng đoán để quyết định chọn TaskTrackingInfo của Nhiệm vụ nào.

Trường
name

string

Phải có định dạng providers/{provider}/taskTrackingInfo/{tracking}, trong đó tracking đại diện cho mã theo dõi.
tracking_id

string

Không thể thay đổi. Mã theo dõi của một Việc cần làm. * Phải là một chuỗi Unicode hợp lệ. * Giới hạn độ dài tối đa là 64 ký tự. * Chuẩn hoá theo Unicode Normalization Form C. * Không được chứa bất kỳ ký tự ASCII nào sau đây: "/", ":", "?", "," hoặc "#".
vehicle_location

DeliveryVehicleLocation

Vị trí gần đây nhất của xe.
route_polyline_points[]

LatLng

Danh sách các điểm khi được kết nối sẽ tạo thành một đường nhiều đoạn của tuyến đường dự kiến của xe đến vị trí của nhiệm vụ này.
remaining_stop_count

Int32Value

Cho biết số điểm dừng còn lại của xe cho đến khi đạt đến điểm dừng của nhiệm vụ, bao gồm cả điểm dừng của nhiệm vụ. Ví dụ: nếu điểm dừng tiếp theo của xe là điểm dừng của nhiệm vụ, thì giá trị sẽ là 1.
remaining_driving_distance_meters

Int32Value

Tổng quãng đường còn lại (tính bằng mét) đến VehicleStop mà bạn quan tâm.
estimated_arrival_time

Timestamp

Dấu thời gian cho biết thời gian đến dự kiến tại vị trí của trạm dừng.
estimated_task_completion_time

Timestamp

Dấu thời gian cho biết thời gian hoàn thành ước tính của một Việc cần làm.
state

State

Trạng thái thực thi hiện tại của Tác vụ.
task_outcome

TaskOutcome

Kết quả của việc cố gắng thực thi một Tác vụ.
task_outcome_time

Timestamp

Dấu thời gian cho biết thời điểm nhà cung cấp đặt kết quả của Task.
planned_location

LocationInfo

Không thể thay đổi. Vị trí hoàn thành việc cần làm.
target_time_window

TimeWindow

Khung thời gian mà bạn cần hoàn thành việc cần làm.
attributes[]

TaskAttribute

Các thuộc tính tuỳ chỉnh được đặt cho việc cần làm.

TaskTrackingViewConfig

Thông báo cấu hình xác định thời điểm người dùng cuối có thể nhìn thấy một phần tử dữ liệu của một Nhiệm vụ.

Trường
route_polyline_points_visibility

VisibilityOption

Trường chỉ định thời điểm các điểm đường đa tuyến có thể xuất hiện. Nếu bạn không chỉ định trường này, hệ thống sẽ sử dụng cấu hình mặc định về khả năng hiển thị ở cấp dự án cho dữ liệu này.
estimated_arrival_time_visibility

VisibilityOption

Trường chỉ định thời điểm có thể hiển thị thời gian đến dự kiến. Nếu bạn không chỉ định trường này, hệ thống sẽ sử dụng cấu hình mặc định về khả năng hiển thị ở cấp dự án cho dữ liệu này.
estimated_task_completion_time_visibility

VisibilityOption

Trường chỉ định thời điểm có thể xem thời gian hoàn thành ước tính của việc cần làm. Nếu bạn không chỉ định trường này, hệ thống sẽ sử dụng cấu hình mặc định về khả năng hiển thị ở cấp dự án cho dữ liệu này.
remaining_driving_distance_visibility

VisibilityOption

Trường chỉ định thời điểm có thể nhìn thấy khoảng cách lái xe còn lại. Nếu bạn không chỉ định trường này, hệ thống sẽ sử dụng cấu hình mặc định về khả năng hiển thị ở cấp dự án cho dữ liệu này.
remaining_stop_count_visibility

VisibilityOption

Trường chỉ định thời điểm có thể xem số điểm dừng còn lại. Nếu bạn không chỉ định trường này, hệ thống sẽ sử dụng cấu hình mặc định về khả năng hiển thị ở cấp dự án cho dữ liệu này.
vehicle_location_visibility

VisibilityOption

Trường chỉ định thời điểm có thể xem được vị trí của xe. Nếu bạn không chỉ định trường này, hệ thống sẽ sử dụng cấu hình mặc định về khả năng hiển thị ở cấp dự án cho dữ liệu này.

VisibilityOption

Thông báo về lựa chọn xác định thời điểm người dùng cuối có thể nhìn thấy một phần tử dữ liệu.

Trường
Trường nhóm visibility_option. Chế độ hiển thị cụ thể được chọn. visibility_option chỉ có thể là một trong những trạng thái sau:
remaining_stop_count_threshold

int32

Người dùng cuối có thể nhìn thấy phần tử dữ liệu này nếu số điểm dừng còn lại <= remaining_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

Người dùng cuối có thể nhìn thấy phần tử dữ liệu này nếu ETA đến điểm dừng <= duration_until_estimated_arrival_time_threshold.
remaining_driving_distance_meters_threshold

int32

Người dùng cuối có thể thấy phần tử dữ liệu này nếu khoảng cách lái xe còn lại (tính bằng mét) <= remaining_driving_distance_meters_threshold.
always

bool

Nếu bạn đặt thành true, thì người dùng cuối sẽ luôn nhìn thấy phần tử dữ liệu này mà không có ngưỡng. Không thể đặt trường này thành false.
never

bool

Nếu bạn đặt chính sách này thành true, thì phần tử dữ liệu này sẽ luôn bị ẩn đối với người dùng cuối mà không có ngưỡng. Không thể đặt trường này thành false.

TimeWindow

Một phạm vi thời gian.

Trường
start_time

Timestamp

Bắt buộc. Thời gian bắt đầu của khung thời gian (bao gồm cả giá trị đầu và giá trị cuối).
end_time

Timestamp

Bắt buộc. Thời gian kết thúc của khung thời gian (bao gồm cả giá trị đầu và giá trị cuối).

UpdateDeliveryVehicleRequest

Thông báo yêu cầu UpdateDeliveryVehicle.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
delivery_vehicle

DeliveryVehicle

Bắt buộc. Bản cập nhật thực thể DeliveryVehicle cần áp dụng. Lưu ý: Bạn không thể cập nhật tên của DeliveryVehicle.
update_mask

FieldMask

Bắt buộc. Một mặt nạ cho trường cho biết những trường DeliveryVehicle cần cập nhật. Xin lưu ý rằng update_mask phải chứa ít nhất một trường.

Đây là danh sách tên đủ điều kiện của các trường được phân tách bằng dấu phẩy. Ví dụ: "remaining_vehicle_journey_segments"

UpdateTaskRequest

Thông báo yêu cầu UpdateTask.

Trường
header

DeliveryRequestHeader

Không bắt buộc. Tiêu đề yêu cầu Delivery API thông thường.
task

Task

Bắt buộc. Việc cần làm liên quan đến nội dung cập nhật. Fleet Engine duy trì các trường sau. Không cập nhật các giá trị này bằng Task.update.

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

Lưu ý: Bạn không thể thay đổi giá trị của task_outcome sau khi đặt.

Nếu bạn đã chỉ định một Xe giao hàng cho Nhiệm vụ, thì đừng đặt trạng thái Nhiệm vụ thành ĐÃ ĐÓNG bằng cách sử dụng Task.update. Thay vào đó, hãy xoá VehicleStop chứa Task khỏi xe giao hàng. Thao tác này sẽ tự động đặt trạng thái của Task thành CLOSED.
update_mask

FieldMask

Bắt buộc. Mặt nạ trường cho biết những trường Task cần cập nhật. Lưu ý: update_mask phải chứa ít nhất một trường.

Đây là danh sách tên đủ điều kiện của các trường được phân tách bằng dấu phẩy. Ví dụ: "task_outcome,task_outcome_time,task_outcome_location"

VehicleJourneySegment

Biểu thị đoạn đường di chuyển của Xe – từ điểm dừng trước đó đến điểm dừng hiện tại. Nếu đây là điểm dừng đang hoạt động đầu tiên, thì đó là từ vị trí hiện tại của Xe đến điểm dừng này.

Trường
stop

VehicleStop

Chỉ định vị trí dừng, cùng với (các) Task liên kết với điểm dừng. Một số trường của VehicleStop có thể không xuất hiện nếu phân đoạn hành trình này thuộc JourneySharingInfo.
driving_distance_meters

Int32Value

Chỉ có đầu ra. Khoảng cách di chuyển từ điểm dừng trước đến điểm dừng này. Nếu điểm dừng hiện tại là điểm dừng đầu tiên trong danh sách các đoạn đường, thì điểm bắt đầu là vị trí của xe được ghi lại tại thời điểm điểm dừng này được thêm vào danh sách. Trường này có thể không xuất hiện nếu phân đoạn hành trình này thuộc JourneySharingInfo.
driving_duration

Duration

Chỉ có đầu ra. Thời gian di chuyển từ điểm dừng trước đến điểm dừng này. Nếu điểm dừng hiện tại là điểm dừng đầu tiên trong danh sách các đoạn đường, thì điểm bắt đầu là vị trí của Xe được ghi lại tại thời điểm điểm dừng này được thêm vào danh sách.

Nếu trường này được xác định trong đường dẫn Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) hoặc Task.remainingVehicleJourneySegments[0].drivingDuration (REST), thì trường này có thể được điền sẵn giá trị từ DeliveryVehicle.remaining_duration (gRPC) hoặc DeliveryVehicle.remainingDuration (REST). Thông tin này cung cấp thời gian lái xe còn lại từ vị trí đã biết gần đây nhất của ứng dụng dành cho tài xế thay vì thời gian lái xe từ điểm dừng trước đó.
path[]

LatLng

Chỉ có đầu ra. Đường đi từ trạm dừng trước đến trạm dừng này. Nếu điểm dừng hiện tại là điểm dừng đầu tiên trong danh sách các đoạn đường, thì đây là đường đi từ vị trí hiện tại của xe đến điểm dừng này tại thời điểm điểm dừng được thêm vào danh sách. Trường này có thể không xuất hiện nếu phân đoạn hành trình này thuộc JourneySharingInfo.

Nếu trường này được xác định trong đường dẫn Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) hoặc Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST), thì trường này có thể được điền bằng LatLng được giải mã từ DeliveryVehicle.current_route_segment (gRPC) hoặc DeliveryVehicle.currentRouteSegment (REST). Thao tác này sẽ cung cấp đường lái xe từ vị trí đã biết gần đây nhất của ứng dụng dành cho tài xế thay vì đường đi từ điểm dừng trước đó.

VehicleStop

Mô tả một điểm mà Xe dừng lại để thực hiện một hoặc nhiều Task.

Trường
planned_location

LocationInfo

Bắt buộc. Vị trí của điểm dừng. Xin lưu ý rằng các vị trí trong Task có thể không hoàn toàn trùng khớp với vị trí này, nhưng sẽ nằm trong phạm vi gần. Trường này sẽ không được điền trong phản hồi của lệnh gọi GetTask.
tasks[]

TaskInfo

Danh sách Task cần thực hiện tại điểm dừng này. Trường này sẽ không được điền trong phản hồi của lệnh gọi GetTask.
state

State

Trạng thái của VehicleStop. Trường này sẽ không được điền trong phản hồi của lệnh gọi GetTask.

Tiểu bang

Trạng thái hiện tại của VehicleStop.

Enum
STATE_UNSPECIFIED Không xác định.
NEW Đã tạo nhưng không chủ động định tuyến.
ENROUTE Đã được chỉ định và đang được định tuyến.
ARRIVED Đã đến điểm dừng. Giả định rằng khi Xe đang đi đến trạm dừng tiếp theo, tất cả các trạm dừng trước đó đã hoàn tất.

TaskInfo

Thông tin bổ sung về Nhiệm vụ được thực hiện tại điểm dừng này.

Trường
task_id

string

Mã việc cần làm. Trường này sẽ không được điền trong phản hồi của lệnh gọi GetTask. Mã nhiệm vụ phải tuân theo các quy tắc hạn chế sau:

  • Phải là một chuỗi Unicode hợp lệ.
  • Giới hạn độ dài tối đa là 64 ký tự.
  • Được chuẩn hoá theo Unicode Normalization Form C.
  • Không được chứa bất kỳ ký tự ASCII nào sau đây: "/", ":", "?", "," hoặc "#".
task_duration

Duration

Chỉ có đầu ra. Thời gian cần thiết để thực hiện Việc cần làm.
target_time_window

TimeWindow

Chỉ có đầu ra. Khung thời gian mà bạn cần hoàn thành việc cần làm. Tham số này chỉ được đặt trong phản hồi cho GetDeliveryVehicle.