Chỉ mục
DeliveryService
(giao diện)BatchCreateTasksRequest
(thông báo)BatchCreateTasksResponse
(thông báo)CreateDeliveryVehicleRequest
(thông báo)CreateTaskRequest
(thông báo)DeliveryRequestHeader
(thông báo)DeliveryRequestHeader.Platform
(enum)DeliveryRequestHeader.SdkType
(enum)DeliveryVehicle
(thông báo)DeliveryVehicle.DeliveryVehicleType
(enum)DeliveryVehicleAttribute
(thông báo)DeliveryVehicleLocation
(thông báo)DeliveryVehicleLocationSensor
(enum)DeliveryVehicleNavigationStatus
(enum)GetDeliveryVehicleRequest
(thông báo)GetTaskRequest
(thông báo)GetTaskTrackingInfoRequest
(thông báo)ListDeliveryVehiclesRequest
(thông báo)ListDeliveryVehiclesResponse
(thông báo)ListTasksRequest
(thông báo)ListTasksResponse
(thông báo)LocationInfo
(thông báo)Task
(thông báo)Task.JourneySharingInfo
(thông báo)Task.State
(enum)Task.TaskOutcome
(enum)Task.TaskOutcomeLocationSource
(enum)Task.Type
(enum)TaskAttribute
(thông báo)TaskTrackingInfo
(thông báo)TaskTrackingViewConfig
(thông báo)TaskTrackingViewConfig.VisibilityOption
(thông báo)TimeWindow
(thông báo)UpdateDeliveryVehicleRequest
(thông báo)UpdateTaskRequest
(thông báo)VehicleJourneySegment
(thông báo)VehicleStop
(thông báo)VehicleStop.State
(enum)VehicleStop.TaskInfo
(thông báo)
DeliveryService
Dịch vụ giao hàng cho quãng đường cuối cùng.
BatchCreateTasks |
---|
Tạo và trả về một loạt đối tượng |
CreateDeliveryVehicle |
---|
Tạo và trả về một |
CreateTask |
---|
Tạo và trả về một đối tượng |
GetDeliveryVehicle |
---|
Trả về phiên bản |
GetTask |
---|
Lấy thông tin về |
GetTaskTrackingInfo |
---|
Trả về phiên bản |
ListDeliveryVehicles |
---|
Lấy tất cả |
ListTasks |
---|
Lấy tất cả |
UpdateDeliveryVehicle |
---|
Ghi dữ liệu |
UpdateTask |
---|
Cập nhật dữ liệu của |
BatchCreateTasksRequest
Nội dung yêu cầu BatchCreateTask
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. Lưu ý: Nếu bạn thiết lập trường này, thì trường tiêu đề trong thông báo |
parent |
Bắt buộc. Tài nguyên mẹ dùng chung cho tất cả việc cần làm. Giá trị này phải có định dạng |
requests[] |
Bắt buộc. Thông báo yêu cầu chỉ định 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 một lúc. |
BatchCreateTasksResponse
Tin nhắn phản hồi của BatchCreateTask
.
Trường | |
---|---|
tasks[] |
Các việc cần làm đã tạo. |
CreateDeliveryVehicleRequest
Nội dung yêu cầu CreateDeliveryVehicle
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. |
parent |
Bắt buộc. Phải ở định dạng |
delivery_vehicle_id |
Bắt buộc. Mã xe giao hàng phải là mã duy nhất và phải tuân thủ các quy định hạn chế sau:
|
delivery_vehicle |
Bắt buộc. Thực thể
Lưu ý: Trường |
CreateTaskRequest
Nội dung yêu cầu CreateTask
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. |
parent |
Bắt buộc. Phải ở định dạng |
task_id |
Bắt buộc. Mã việc cần làm phải là mã duy nhất, nhưng không được là mã theo dõi quá trình vận chuyển. Để lưu trữ mã theo dõi gói hàng, hãy sử dụng trường
|
task |
Bắt buộc. Thực thể Tasks cần tạo. Khi tạo một Việc cần làm, bạn phải điền các trường sau đây:
Lưu ý: Trường |
DeliveryRequestHeader
RequestHeader chứa các trường chung cho tất cả yêu cầu RPC phân phối.
Trường | |
---|---|
language_code |
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 truy cập vào http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Nếu bạn không chỉ định ngôn ngữ nào, thì câu trả lời có thể bằng bất kỳ ngôn ngữ nào, với lựa chọn ưu tiên là tiếng Anh nếu có tên như vậy. Ví dụ về giá trị trường: |
region_code |
Bắt buộc. Mã vùng CLDR của khu vực bắt nguồn yêu cầu. Ví dụ về giá trị trường: |
sdk_version |
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ụ: |
os_version |
Phiên bản hệ điều hành mà SDK gọi đang chạy. Ví dụ về giá trị trường: |
device_model |
Kiểu máy của thiết bị mà SDK gọi đang chạy. Ví dụ về giá trị trường: |
sdk_type |
Loại SDK gửi yêu cầu. |
maps_sdk_version |
Phiên bản của 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ụ: |
nav_sdk_version |
Phiên bản của 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ụ: |
platform |
Nền tảng của SDK gọi. |
manufacturer |
Nhà sản xuất thiết bị Android thông qua SDK gọi, chỉ áp dụng đối với SDK Android. Ví dụ về giá trị trường: |
android_api_level |
Cấp độ API Android của SDK gọi, chỉ áp dụng cho SDK Android. Ví dụ về giá trị trường: |
trace_id |
Mã nhận dạng không bắt buộc, có thể được 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 sử dụng nếu nền tảng bị bỏ qua. |
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ừ trên web. |
SdkType
Các loại SDK có thể có.
Enum | |
---|---|
SDK_TYPE_UNSPECIFIED |
Giá trị mặc định. Giá trị này được sử dụng nếu sdk_type bị bỏ qua. |
CONSUMER |
SDK gọi là Người tiêu dùng. |
DRIVER |
SDK gọi là Trình điều khiển. |
JAVASCRIPT |
SDK gọi là JavaScript. |
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.
Trường | |
---|---|
name |
Tên riêng biệt của Xe giao hàng này. Định dạng là |
last_location |
Vị trí được báo cáo gần đây nhất của Xe giao hàng. |
navigation_status |
Trạng thái đi theo chỉ dẫn của Xe giao hàng. |
current_route_segment |
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 Có một vài trường hợp mà trường này có thể không được dùng để điền
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. |
current_route_segment_end_point |
Vị trí kết thúc Trường này sẽ bị bỏ qua trong các lệnh gọi |
remaining_distance_meters |
Quãng đường lái xe còn lại của Fleet Engine bỏ qua trường này trong |
remaining_duration |
Thời gian lái xe còn lại cho Fleet Engine bỏ qua trường này trong |
remaining_vehicle_journey_segments[] |
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 |
attributes[] |
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 |
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à |
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ộ. |
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ự.
Trường | |
---|---|
key |
Khoá của thuộc tính. |
value |
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: |
|
string_value |
Giá trị thuộc tính đã nhập chuỗi. Lưu ý: Trường này giống với trường |
bool_value |
Giá trị thuộc tính được nhập bằng Boolean. |
number_value |
Giá trị thuộc tính được nhập hai lần. |
DeliveryVehicleLocation
Vị trí, tốc độ và hướng của xe tại một thời điểm.
Trường | |
---|---|
location |
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 thông tin đó trong 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 |
horizontal_accuracy |
Không dùng nữa: Chuyển sang dùng |
latlng_accuracy |
Độ chính xác theo bán kính là |
heading |
Hướng xe đang di chuyển theo độ. 0 biểu thị Bắc. Phạm vi hợp lệ là [0.360). |
bearing_accuracy |
Không dùng nữa: Chuyển sang dùng |
heading_accuracy |
Độ chính xác của |
altitude |
Cao độ tính bằng mét so với WGS84. |
vertical_accuracy |
Không dùng nữa: Chuyển sang dùng |
altitude_accuracy |
Độ chính xác là |
speed_kmph |
Tốc độ của xe tính bằng kilomet mỗi giờ. Không dùng nữa: Chuyển sang dùng |
speed |
Tốc độ của xe tính bằng mét/giây |
speed_accuracy |
Độ chính xác là |
update_time |
Thời điểm cảm biến báo cáo |
server_time |
Chỉ có đầu ra. Thời điểm máy chủ nhận được thông tin vị trí. |
location_sensor |
Nhà cung cấp dữ liệu vị trí (ví dụ: |
is_road_snapped |
Liệu |
is_gps_sensor_enabled |
Chỉ nhập. Cho biết cảm biến GPS có được bật trên thiết bị di động hay không. |
time_since_update |
Chỉ nhập. Thời gian (tính bằng giây) kể từ lần đầu tiên vị trí này được gửi đến máy chủ. Giá trị này sẽ bằng 0 đối với 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), thì giá trị này sẽ được đặt lại về 0. |
num_stale_updates |
Chỉ nhập. Không dùng nữa: Các tín hiệu khác hiện được dùng để xác định xem một vị trí đã lỗi thời hay chưa. |
raw_location |
Vị trí thô của xe (chưa được chụp ảnh đường phố xử lý). |
raw_location_time |
Dấu thời gian được liên kết với vị trí thô. |
raw_location_sensor |
Nguồn của vị trí thô. Giá trị mặc định là |
raw_location_accuracy |
Độ chính xác của |
supplemental_location |
Vị trí bổ sung do ứng dụng tích hợp cung cấp. |
supplemental_location_time |
Dấu thời gian liên kết với vị trí bổ sung. |
supplemental_location_sensor |
Nguồn của vị trí bổ sung. Giá trị mặc định là |
supplemental_location_accuracy |
Độ chính xác của |
road_snapped |
Không dùng nữa: Chuyển sang dùng |
DeliveryVehicleLocationSensor
Cảm biến hoặc phương pháp dùng để xác định vị trí.
Enum | |
---|---|
UNKNOWN_SENSOR |
Cảm biến chưa được xác định hoặc không xác định. |
GPS |
GPS hoặc Hệ thống định vị toàn cầu được hỗ trợ. |
NETWORK |
Có hỗ trợ GPS, mã trạm phát sóng hoặc điểm truy cập Wi-Fi. |
PASSIVE |
Mã trạm phát sóng hoặc điểm truy cập Wi-Fi. |
ROAD_SNAPPED_LOCATION_PROVIDER |
Vị trí được thiết bị di động xác định là vị trí đường có nhiều khả năng nhất. |
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 vị trí được cung cấp từ các nguồn không phải là thiết bị di động chạy SDK trình điều khiển. 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 qua last_location.supplemental_location_sensor của DeliveryXe. |
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 yêu cầu. |
FUSED_LOCATION_PROVIDER |
Trình cung cấp vị trí kết hợp của Android. |
CORE_LOCATION |
Nhà cung cấp vị trí trên hệ điều hành của Apple. |
GetDeliveryVehicleRequest
Nội dung yêu cầu GetDeliveryVehicle
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
GetTaskRequest
Nội dung yêu cầu GetTask
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
GetTaskTrackingInfoRequest
Nội dung yêu cầu GetTaskTrackingInfoRequest
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
ListDeliveryVehiclesRequest
Nội dung yêu cầu ListDeliveryVehicles
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. |
parent |
Bắt buộc. Phải ở định dạng |
page_size |
Không bắt buộc. Số lượng phương tiện tối đa cần trả lại. Dịch vụ có thể trả về ít hơn con 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 |
Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi Khi phân trang, tất cả các tham số khác được cung cấp cho |
filter |
Không bắt buộc. Cụm từ tìm kiếm để áp dụng khi đăng thông tin về 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ả xe giao hàng đều sẽ bị trả về. Xin lưu ý rằng các truy vấn duy nhất được hỗ trợ cho Số lượng giới hạn tối đa được phép trong một truy vấn bộ lọc là 50. Quy định hạn chế là một phần trong truy vấn của biểu mẫu |
viewport |
Không bắt buộc. Bộ lọc giới hạn những xe được đưa về là những xe có vị trí xác định gần đây nhất nằm trong khu vực hình chữ nhật mà khung nhìn xác định. |
ListDeliveryVehiclesResponse
Tin nhắn phản hồi của ListDeliveryVehicles
.
Trường | |
---|---|
delivery_vehicles[] |
Nhóm phương tiện giao hàng đáp ứng các 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ả xe giao hàng. Bạn cũng có thể để trống một phản hồi thành cô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í bộ lọc được yêu cầu. |
next_page_token |
Bạn có thể chuyển mã thông báo này vào |
total_size |
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
Nội dung yêu cầu ListTasks
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. |
parent |
Bắt buộc. Phải ở định dạng |
page_size |
Không bắt buộc. Số lượng Tác vụ tối đa 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 |
Không bắt buộc. Đã nhận được mã thông báo trang từ lệnh gọi Khi phân trang, tất cả các tham số khác được cung cấp cho |
filter |
Không bắt buộc. Truy vấn bộ lọc để áp dụng khi liệt kê Việc cần làm. Hãy tham khảo http://aip.dev/160 để xem 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 trên một chuỗi trống, thì tất cả Tác vụ đều được trả về. Để biết thông tin về các thuộc tính Việc cần làm mà bạn có thể lọc, hãy xem bài viết Liệt kê việc cần làm. |
ListTasksResponse
Phản hồi ListTasks
chứa nhóm Việc cần làm đáp ứng các tiêu chí lọc trong ListTasksRequest
.
Trường | |
---|---|
tasks[] |
Nhóm Tasks đáp ứng các tiêu chí lọc được yêu cầu. Khi không có bộ lọc nào được chỉ định, yêu cầu sẽ trả về tất cả tác vụ. Bạn cũng có thể để trống một phản hồi thành công. Phản hồi trống cho biết không tìm thấy Tasks nào đáp ứng tiêu chí lọc được yêu cầu. |
next_page_token |
Truyền mã thông báo này vào |
total_size |
Tổng số việc cần làm phù hợp với tiêu chí của yêu cầu trên tất cả các trang. |
LocationInfo
Một vị trí có mọi giá trị nhận dạng bổ sung.
Trường | |
---|---|
point |
Toạ độ của vị trí. |
Việc cần làm
Một Tác vụ trong API Phân phối biểu thị một hành động cần theo dõi. Nhìn chung, có sự khác biệt giữa Nhiệm vụ liên quan đến quá trình vận chuyển và Nhiệm vụ ngắt quãng. Một gói hàng có thể liên kết với nhiều Tasks. Ví dụ: Có thể có một Việc cần làm cho việc đến lấy hàng và một việc cần làm để trả khách hoặc chuyển xe. Ngoài ra, các Tasks khác nhau trong một lô hàng nhất định có thể do các loại xe khác nhau xử lý. Ví dụ: Một phương tiện có thể xử lý việc đến lấy hàng, đưa hàng đến trung tâm giao hàng, trong khi một phương tiện khác cũng vận chuyển lô hàng đó từ trung tâm đến điểm trả 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 tham chiếu đến cùng một trường.
Trường | |
---|---|
name |
Phải ở định dạng |
type |
Bắt buộc. Không thể thay đổi. Xác định loại Tác vụ. Ví dụ như nghỉ giải lao hoặc vận chuyển hàng. |
state |
Bắt buộc. Trạng thái thực thi hiện tại của Tác vụ. |
task_outcome |
Kết quả của Nhiệm vụ. |
task_outcome_time |
Dấu thời gian cho biết thời điểm nhà cung cấp đặt kết quả của |
task_outcome_location |
Vị trí đặt kết quả của |
task_outcome_location_source |
Cho biết nguồn gốc của giá trị của |
tracking_id |
Không thể thay đổi. Trường này hỗ trợ việc lưu trữ giấy tờ tuỳ thân để bạn có thể tránh sử dụng một mối liên kết phức tạp. Bạn không thể đặt
|
delivery_vehicle_id |
Chỉ có đầu ra. Mã nhận dạng của xe đang thực hiện Nhiệm vụ này. Mã xe giao hàng phải tuân theo các quy định hạn chế sau:
|
planned_location |
Không thể thay đổi. Vị trí nơi Nhiệm vụ sẽ được hoàn thành. Không bắt buộc đối với |
task_duration |
Bắt buộc. Không thể thay đổi. Thời gian cần thiết để thực thi một Tác vụ tại vị trí này. |
target_time_window |
Khoảng thời gian hoàn thành tác vụ. |
journey_sharing_info |
Chỉ có đầu ra. Các trường dành riêng cho việc chia sẻ hành trình. Không được điền khi trạng thái là |
task_tracking_view_config |
Cấu hình cho tính năng theo dõi công việc chỉ định những phần tử dữ liệu nào sẽ hiển thị cho người dùng cuối trong trường hợp nào. |
attributes[] |
Danh sách các thuộc tính tuỳ chỉnh của Tác vụ. Mỗi thuộc tính phải có một khoá duy nhất. |
JourneySharingInfo
Hành trình chia sẻ các trường cụ thể.
Trường | |
---|---|
remaining_vehicle_journey_segments[] |
Thông tin theo dõi về các điểm dừng mà xe được chỉ định sẽ dừng 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 điểm dừng từ các tác vụ khác. Đoạn đầu tiên, |
last_location |
Cho biết vị trí được báo cáo gần đây nhất của xe được chỉ định. |
last_location_snappable |
Cho biết liệu lastLocation của xe có thể được bám vào |
Tiểu bang
Trạng thái của một Việc cần làm. Phần này cho biết tiến trình của Tasks.
Enum | |
---|---|
STATE_UNSPECIFIED |
Mặc định. Dùng cho trạng thái Tác vụ không xác định hoặc không nhận dạng được. |
OPEN |
Nhiệm vụ chưa được giao cho xe giao hàng hoặc xe giao hàng chưa qua điểm dừng xe được chỉ định của Task . |
CLOSED |
Khi xe vượt qua điểm dừng xe cho Nhiệm vụ này. |
TaskOutcome
Kết quả khi người dùng cố gắng thực hiện một Tác vụ. Khi TaskState
đóng, TaskOutcome
cho biết hoạt động đó đã hoàn tất thành công hay chưa.
Enum | |
---|---|
TASK_OUTCOME_UNSPECIFIED |
Kết quả tác vụ trước khi đặt giá trị. |
SUCCEEDED |
Đã hoàn tất việc cần làm. |
FAILED |
Không thể hoàn tất Việc cần làm hoặc Việc cần làm đó đã bị huỷ. |
TaskOutcomeLocationSource
Thông tin nhận dạng của nguồn điền sẵn task_outcome_location
.
Enum | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
Kết quả tác vụ trước khi đặt. |
PROVIDER |
Trình cung cấp đã chỉ định task_outcome_location . |
LAST_VEHICLE_LOCATION |
Nhà cung cấp không chỉ định task_outcome_location , vì vậy Fleet Engine đã sử dụng vị trí xe đã biết gần đây nhất. |
Loại
Loại Việc cần làm.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Mặc định, loại Tác vụ là không xác định. |
PICKUP |
Nhiệm vụ đến lấy hàng là một hành động để khách hàng đến lấy hàng. Dịch vụ lấy hàng tại kho hàng hoặc xe trung chuyển phải sử dụng loại SCHEDULED_STOP . |
DELIVERY |
Nhiệm vụ giao hàng là hành động được thực hiện để giao hàng đến khách hàng cuối. Các yêu cầu để xe ra vào kho hàng hoặc trung chuyển nên sử dụng loại SCHEDULED_STOP . |
SCHEDULED_STOP |
Nhiệm vụ có điểm dừng đã lên lịch được dùng cho mục đích lập kế hoạch. Ví dụ: hành động chuyển đổi có thể thể hiện việc nhận hoặc bỏ hàng từ các xe trung chuyển hoặc kho hàng. Không được sử dụng mã này cho bất kỳ gói hàng nào do khách hàng cuối đến lấy hoặc giao. |
UNAVAILABLE |
Nhiệm vụ có nghĩa là Xe không hoạt động để bảo dưỡng. Ví dụ: tình trạng này có thể xảy ra khi người lái xe nghỉ giải lao hoặc khi xe đang đổ xăng. |
TaskAttribute
Mô tả thuộc tính công việc dưới dạng cặp khoá-giá trị. "key:value" độ dài chuỗi không được vượt quá 256 ký tự.
Trường | |
---|---|
key |
Khoá của thuộc tính. Khoá không được chứa ký tự dấu hai chấm (:). |
Trường kết hợp task_attribute_value . Giá trị của thuộc tính có thể ở dạng chuỗi, bool hoặc kiểu kép. Nếu bạn không đặt giá trị nào, thì TaskAttribute string_value 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 trạng thái sau đây: |
|
string_value |
Giá trị thuộc tính đã nhập chuỗi. |
bool_value |
Giá trị thuộc tính được nhập bằng Boolean. |
number_value |
Giá trị thuộc tính được nhập hai lần. |
TaskTrackingInfo
Tin nhắn TaskTrackingInfo
. Thông báo chứa thông tin theo dõi công việc sẽ được dùng để hiển thị. Nếu một mã theo dõi được liên kết với nhiều Tác vụ, thì Fleet Engine sẽ sử dụng phương pháp phỏng đoán để quyết định TaskTrackingInfo của Tác vụ cần chọn.
Trường | |
---|---|
name |
Phải ở định dạng |
tracking_id |
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ự. * Được chuẩn hóa theo Biểu mẫu chuẩn hóa Unicode C. * Không được chứa bất kỳ ký tự ASCII nào sau đây: '/', ':', '?', ',' hoặc '#'. |
vehicle_location |
Vị trí cuối cùng của xe. |
route_polyline_points[] |
Danh sách các điểm khi được kết nối sẽ tạo thành một hình nhiều đường trong tuyến đường dự kiến của xe đến vị trí của nhiệm vụ này. |
remaining_stop_count |
Cho biết số điểm dừng còn lại của xe cho đến khi đạt đến điểm dừng thực hiện nhiệm vụ, bao gồm cả điểm dừng thực hiện 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 |
Tổng quãng đường còn lại tính bằng mét đến |
estimated_arrival_time |
Dấu thời gian cho biết thời gian đến dự kiến đến vị trí dừng. |
estimated_task_completion_time |
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 |
Trạng thái thực thi hiện tại của Tác vụ. |
task_outcome |
Kết quả khi người dùng cố gắng thực hiện một Tác vụ. |
task_outcome_time |
Dấu thời gian cho biết thời điểm nhà cung cấp đặt kết quả của Tác vụ. |
planned_location |
Không thể thay đổi. Vị trí nơi Nhiệm vụ sẽ được hoàn thành. |
target_time_window |
Khoảng thời gian hoàn thành tác vụ. |
attributes[] |
Các thuộc tính tuỳ chỉnh được đặt cho tác vụ. |
TaskTrackingViewConfig
Thông báo cấu hình xác định thời điểm hiển thị một phần tử dữ liệu của Tác vụ đối với người dùng cuối.
Trường | |
---|---|
route_polyline_points_visibility |
Trường chỉ định thời điểm có thể nhìn thấy các điểm nhiều đường. Nếu bạn không chỉ định trường này, thì cấu hình chế độ hiển thị mặc định ở cấp dự án cho dữ liệu này sẽ được sử dụng. |
estimated_arrival_time_visibility |
Trường chỉ định thời gian đến dự kiến có thể hiển thị. Nếu bạn không chỉ định trường này, thì cấu hình chế độ hiển thị mặc định ở cấp dự án cho dữ liệu này sẽ được sử dụng. |
estimated_task_completion_time_visibility |
Trường chỉ định thời điểm có thể hiển thị thời gian hoàn thành công việc ước tính. Nếu bạn không chỉ định trường này, thì cấu hình chế độ hiển thị mặc định ở cấp dự án cho dữ liệu này sẽ được sử dụng. |
remaining_driving_distance_visibility |
Trường chỉ định thời điểm có thể hiển thị quãng đường lái xe còn lại. Nếu bạn không chỉ định trường này, thì cấu hình chế độ hiển thị mặc định ở cấp dự án cho dữ liệu này sẽ được sử dụng. |
remaining_stop_count_visibility |
Trường chỉ định thời điểm số lần dừng còn lại có thể hiển thị. Nếu bạn không chỉ định trường này, thì cấu hình chế độ hiển thị mặc định ở cấp dự án cho dữ liệu này sẽ được sử dụng. |
vehicle_location_visibility |
Trường chỉ định thời điểm có thể hiển thị thông tin vị trí của xe. Nếu bạn không chỉ định trường này, thì cấu hình chế độ hiển thị mặc định ở cấp dự án cho dữ liệu này sẽ được sử dụng. |
VisibilityOption
Thông báo về lựa chọn xác định thời điểm hiển thị một phần tử dữ liệu cho người dùng cuối.
Trường | |
---|---|
Trường kết hợp 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 đây: |
|
remaining_stop_count_threshold |
Người dùng cuối sẽ nhìn thấy phần tử dữ liệu này nếu số điểm dừng còn lại <=còn lại_dừng_count_threshold. |
duration_until_estimated_arrival_time_threshold |
Người dùng cuối sẽ nhìn thấy phần tử dữ liệu này nếu thời gian đến dự kiến đến điểm dừng <= duration_until_estimated_arrival_time_threshold. |
remaining_driving_distance_meters_threshold |
Người dùng cuối sẽ nhìn thấy phần tử dữ liệu này nếu quãng đường lái xe còn lại tính bằng mét <= còn lại_driving_distance_meters_threshold. |
always |
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 hiển thị cho người dùng cuối mà không bị đặt ngưỡng. Không thể đặt trường này thành false. |
never |
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 ẩn đối với người dùng cuối mà không đặt ngưỡng. Không thể đặt trường này thành false. |
TimeWindow
Phạm vi thời gian.
Trường | |
---|---|
start_time |
Bắt buộc. Thời gian bắt đầu của khoảng thời gian (bao gồm cả hai giá trị này). |
end_time |
Bắt buộc. Thời gian kết thúc của khoảng thời gian (bao gồm cả khoảng thời gian đó). |
UpdateDeliveryVehicleRequest
Nội dung yêu cầu UpdateDeliveryVehicle
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. |
delivery_vehicle |
Bắt buộc. Cập nhật thực thể |
update_mask |
Bắt buộc. Một mặt nạ trường cho biết những trường Đây là danh sách các tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: |
UpdateTaskRequest
Nội dung yêu cầu UpdateTask
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề của yêu cầu API phân phối chuẩn. |
task |
Bắt buộc. Việc cần làm liên quan đến bản cập nhật. Các lĩnh vực sau đây do Fleet Engine duy trì. Đừng dùng
Lưu ý: Bạn không thể thay đổi giá trị của Nếu Nhiệm vụ đã được giao cho một xe giao hàng, thì đừng đặt trạng thái của Nhiệm vụ thành ĐÃ ĐÓNG CỬA bằng |
update_mask |
Bắt buộc. Mặt nạ trường cho biết những trường Tác vụ nào cần cập nhật. Lưu ý: Đây là danh sách các tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: |
VehicleJourneySegment
Đại diện cho đoạn đường di chuyển của một chiếc 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 hoạt động đầu tiên, thì tức là từ vị trí hiện tại của xe đến điểm dừng này.
Trường | |
---|---|
stop |
Chỉ định vị trí dừng cùng với các |
driving_distance_meters |
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 xuất phát 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 trong hành trình này là một phần của |
driving_duration |
Chỉ có đầu ra. Thời gian đi 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 xuất phát 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 bạn xác định trường này trong đường dẫn |
path[] |
Chỉ có đầu ra. Con đường 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ì đâ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 trong hành trình này là một phần của Nếu bạn xác định trường này trong đường dẫn |
VehicleStop
Mô tả một điểm mà Xe dừng để thực hiện một hoặc nhiều Task
.
Trường | |
---|---|
planned_location |
Bắt buộc. Vị trí dừng. Lưu ý rằng các vị trí trong |
tasks[] |
Danh sách các |
state |
Trạng thái của |
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 |
Đã chỉ định và đang chủ động định tuyến. |
ARRIVED |
Đã đến điểm dừng. Giả sử rằng khi Xe đang đi đến điểm dừng tiếp theo, thì tất cả điểm dừng trước đó đã hoàn tất. |
TaskInfo
Thông tin bổ sung về Tác vụ được thực hiện tại điểm dừng này.
Trường | |
---|---|
task_id |
Mã việc cần làm. Trường này sẽ không được điền sẵn trong nội dung phản hồi của lệnh gọi
|
task_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 |
Chỉ có đầu ra. Khoảng thời gian hoàn thành tác vụ. Thuộc tính này chỉ được đặt trong phản hồi cho |