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 trọn dặm.
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 thể hiện |
GetTask |
---|
Lấy thông tin về |
GetTaskTrackingInfo |
---|
Trả về phiên bản thể hiệ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 |
BatchCreateTasksRequest
Tin nhắn 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 tiêu chuẩn. Lưu ý: Nếu bạn đặt trường này thì trường tiêu đề của thông báo |
parent |
Bắt buộc. Tài nguyên mẹ được tất cả công việc dùng chung. 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 trong một đợt. |
BatchCreateTasksResponse
Tin nhắn phản hồi BatchCreateTask
.
Trường | |
---|---|
tasks[] |
Việc cần làm đã tạo. |
CreateDeliveryVehicleRequest
Tin nhắn 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 tiêu 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à duy nhất và tuân theo các hạn chế sau:
|
delivery_vehicle |
Bắt buộc. Thực thể
Lưu ý: Trường |
CreateTaskRequest
Tin nhắn 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 tiêu chuẩn. |
parent |
Bắt buộc. Phải ở định dạng |
task_id |
Bắt buộc. Mã công việc phải là duy nhất, nhưng không được là mã theo dõi vận chuyển. Để lưu trữ mã theo dõi vận chuyển, hãy sử dụng trường
|
task |
Bắt buộc. Thực thể Nhiệm vụ cần tạo. Khi tạo Việc cần làm, bạn phải điền các trường sau:
Lưu ý: Trường |
DeliveryRequestHeader
RequestHeader chứa các trường phổ biến cho tất cả cá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 xem http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Nếu bạn không nêu rõ câu trả lời, thì câu trả lời có thể bằng ngôn ngữ bất kỳ và sẽ ưu tiên 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 vùng nơi yêu cầu bắt nguồn. 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 của hệ điều hành mà SDK gọi đang chạy. Ví dụ về giá trị trường: |
device_model |
Kiểu 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 từ SDK gọi, chỉ áp dụng cho 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 các 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ày đến từ Android. |
IOS |
Yêu cầu này đế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à Người tiêu dùng. |
DRIVER |
SDK gọi là Driver. |
JAVASCRIPT |
SDK gọi là JavaScript. |
DeliveryVehicle
Tin nhắn DeliveryVehicle
. Xe giao hàng vận chuyển các lô hàng từ một kho hàng đến một địa điểm giao hàng và từ một địa điểm nhận hàng tới kho chứa. Trong một số trường hợp, xe giao hàng cũng vận chuyển trực tiếp các lô hàng từ địa điểm nhận hàng đến địa điểm giao hàng.
Lưu ý: API gRPC và REST sử dụng 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 duy nhấ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 chỉ đường của xe giao hàng. |
current_route_segment |
Hình nhiều đường được mã hoá chỉ định tuyến đường mà thành phần điều hướng đề xuất đi tới điểm tham chiếu tiếp theo. Ứng dụng dành cho người 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 đã đi qua, cũng như khi lộ trình đi theo chỉ dẫ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 sẵn
Trong những trường hợp này, Fleet Engine sẽ điền một tuyến đường từ xe đã qua gần đây nhất đến CarsStop sắp tới để đảm bảo rằng khách hàng sử dụng 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 của 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 sẽ bỏ qua trường này trong |
remaining_duration |
Thời gian lái xe còn lại của Fleet Engine sẽ bỏ qua trường này trong |
remaining_vehicle_journey_segments[] |
Đ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 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 thì 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 sử dụng. |
AUTO |
Ô tô. |
TWO_WHEELER |
Xe mô tô, xe đạp gắn máy hoặc xe hai bánh khác |
BICYCLE |
Phương tiện vận tải sử dụng con người. |
PEDESTRIAN |
Phương tiện vận chuyển 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ộ. |
DeliveryVehicleAttribute
Mô tả thuộc tính xe dưới dạng một cặp khoá-giá trị. Chuỗi "key:value" 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 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: |
|
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 đã nhập Boolean. |
number_value |
Giá trị thuộc tính đã nhập 2 lần. |
DeliveryVehicleLocation
Vị trí, tốc độ và hướng đi 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, thông tin vị trí của xe sẽ là vị trí GPS. Khi bạn nhận được thông tin phản hồi, vị trí của xe có thể là vị trí GPS, vị trí bổ sung hoặc vị trí ước đoán khác. Nguồn này được chỉ định trong |
horizontal_accuracy |
Không dùng nữa: Thay vào đó, hãy dùng |
latlng_accuracy |
Độ chính xác của bán kính là |
heading |
Hướng xe đang di chuyển theo độ. 0 đại diện cho phía Bắc. Phạm vi hợp lệ là [0,360). |
bearing_accuracy |
Không dùng nữa: Thay vào đó, hãy dùng |
heading_accuracy |
Độ chính xác của |
altitude |
Độ cao tính bằng mét trên WGS84. |
vertical_accuracy |
Không dùng nữa: Thay vào đó, hãy dùng |
altitude_accuracy |
Độ chính xác của |
speed_kmph |
Tốc độ của xe tính bằng km/giờ. Không dùng nữa: Thay vào đó, hãy dùng |
speed |
Tốc độ của xe tính bằng mét/giây |
speed_accuracy |
Độ chính xác: |
update_time |
Thời điểm |
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 liệu 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ừ khi vị trí này được gửi lần đầu đến máy chủ. Giá trị này sẽ bằng 0 trong 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í có lỗi thời hay không. |
raw_location |
Vị trí thô của xe (chưa được giao dịch viên đường bộ xử lý). |
raw_location_time |
Dấu thời gian liên kết với vị trí thô. |
raw_location_sensor |
Nguồn 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: Thay vào đó, hãy 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 (Hệ thống định vị toàn cầu) hoặc GPS được hỗ trợ. |
NETWORK |
GPS được hỗ trợ, mã 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í được thiết bị di động xác định là vị trí có nhiều khả năng 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 vị trí do các nguồn không phải thiết bị di động chạy SDK trình điều khiển cung cấp. 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ị đó. Các vị trí được đánh dấu CUSTOMER_ áp dụngPLIED_LOCATION thường được cung cấp thông qua last_location.supplemental_location_sensor của DeliveryCar. |
FLEET_ENGINE_LOCATION |
Vị trí do Fleet Engine tính toán dựa trên tín hiệu có sẵn. Chỉ có đầu ra. Giá trị này sẽ bị từ chối nếu nhận được 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 dịch vụ vị trí trên các hệ điều hành của Apple. |
GetDeliveryVehicleRequest
Tin nhắn 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 tiêu chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
GetTaskRequest
Tin nhắn 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 tiêu chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
GetTaskTrackingInfoRequest
Tin nhắn 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 tiêu chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
ListDeliveryVehiclesRequest
Tin nhắn 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 tiêu chuẩn. |
parent |
Bắt buộc. Phải ở định dạng |
page_size |
Không bắt buộc. Số lượng xe tối đa có thể 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 |
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. Một cụm từ tìm kiếm bộ lọc sẽ áp dụng khi đăng thông tin về xe giao hàng. Hãy truy cập vào http://aip.dev/160 để xem các 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 sẽ được trả về. Xin lưu ý rằng các truy vấn duy nhất được hỗ trợ cho Số lượng quy tắc hạn chế tối đa được phép trong một cụm từ tìm kiếm của bộ lọc là 50. Hạn chế là một phần của truy vấn biểu mẫu |
viewport |
Không bắt buộc. Một bộ lọc giới hạn số xe được trả về cho những xe có vị trí xác định gần đây nhất là trong khu vực hình chữ nhật được xác định theo khung nhìn. |
ListDeliveryVehiclesResponse
Tin nhắn phản hồi ListDeliveryVehicles
.
Trường | |
---|---|
delivery_vehicles[] |
Nhóm xe giao hàng đáp ứng các tiêu chí lọc theo 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ả cá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 đã 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 phù hợp với tiêu chí yêu cầu trên tất cả các trang. |
ListTasksRequest
Tin nhắn 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 tiêu 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. 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 bộ lọc sẽ áp dụng khi liệt kê Tasks. Hãy truy cập vào http://aip.dev/160 để xem các 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ông việc sẽ được trả về. Để biết thông tin về thuộc tính Công việc mà bạn có thể lọc, hãy xem bài viết Công việc trong danh sách. |
ListTasksResponse
Phản hồi ListTasks
chứa tập hợp Tasks đáp ứng tiêu chí lọc trong ListTasksRequest
.
Trường | |
---|---|
tasks[] |
Nhóm việc cần làm đáp ứng tiêu chí lọc theo 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ụ. 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 Tasks nào đáp ứng tiêu chí lọ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í yêu cầu trên tất cả các trang. |
LocationInfo
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
Tác vụ trong API phân phối thể hiện một hành động cần theo dõi. Nói chung, có sự khác biệt giữa Tác vụ liên quan đến vận chuyển và Tác vụ phá vỡ. Một lô hàng có thể được liên kết với nhiều Tasks. Ví dụ: có thể có một Nhiệm vụ là đến lấy hàng và một Nhiệm vụ là để trả xe hoặc chuyển hàng. Ngoài ra, các loại xe khác nhau có thể xử lý các Nhiệm vụ khác nhau cho một lô hàng cụ thể. Ví dụ: Một xe có thể xử lý việc đến lấy hàng, chuyển kiện hàng đến trung tâm, trong khi một xe khác lại vận chuyển lô hàng đó từ trung tâm đến điểm trả xe.
Lưu ý: API gRPC và REST sử dụng 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ụ: 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 trì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 giá trị của |
tracking_id |
Không thể thay đổi. Trường này hỗ trợ việc lưu trữ mã nhận dạng để bạn có thể tránh sử dụng quá trình liên kết phức tạp. Bạn không thể đặt
|
delivery_vehicle_id |
Chỉ có đầu ra. Mã 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 hạn chế sau:
|
planned_location |
Không thể thay đổi. Vị trí mà 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 hiện một Tác vụ tại vị trí này. |
target_time_window |
Khoảng thời gian hoàn thành việc cần làm. |
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 mà người dùng cuối có thể nhìn thấy trong trường hợp nào. |
attributes[] |
Danh sách các thuộc tính tuỳ chỉnh của Việc cần làm. Mỗi thuộc tính phải có một khoá duy nhất. |
JourneySharingInfo
Các trường cụ thể của tính năng Chia sẻ hành trình.
Trường | |
---|---|
remaining_vehicle_journey_segments[] |
Theo dõi thông tin 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 các điểm dừng của các tác vụ khác. Đoạn đường đầu tiên, |
last_location |
Cho biết vị trí được báo cáo gần đây nhất cho xe được chỉ định của xe. |
last_location_snappable |
Cho biết liệu Vị trí cuối cùng của xe có thể được gắn với |
Tiểu bang
Trạng thái của một Nhiệm vụ. Mã 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 Nhiệm vụ không xác định hoặc không xác định. |
OPEN |
Nhiệm vụ chưa được giao cho xe giao hàng hoặc xe giao hàng chưa vượt qua điểm dừng xe được chỉ định của Task . |
CLOSED |
Khi xe đi qua trạm dừng xe để thực hiện 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 bạn đã hoàn tất thành công hay chưa.
Enum | |
---|---|
TASK_OUTCOME_UNSPECIFIED |
Kết quả của Nhiệm vụ trước khi giá trị của nó được đặt. |
SUCCEEDED |
Đã hoàn tất việc cần làm. |
FAILED |
Không thể hoàn thành 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 task_outcome_location
.
Enum | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
Kết quả của tác vụ trước khi đặt. |
PROVIDER |
Ứng dụng do ứng dụng cung cấp chỉ định task_outcome_location . |
LAST_VEHICLE_LOCATION |
Nhà cung cấp chưa chỉ định task_outcome_location , vì vậy, Fleet Engine đã sử dụng thông tin vị trí xác định gần đây nhất của xe. |
Loại
Loại Việc cần làm.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Mặc định, Loại tác vụ không xác định. |
PICKUP |
Nhiệm vụ đến lấy hàng là hành động được khách hàng thực hiện để lấy hàng. Xe bán 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 cho khách hàng cuối. Các chuyến trả xe tại kho hàng hoặc trung chuyển tuyến phải sử dụng loại SCHEDULED_STOP . |
SCHEDULED_STOP |
Việc cần làm dừng theo lịch sẽ được dùng để lập kế hoạch. Ví dụ: đó có thể thể hiện việc nhận hoặc trả hàng từ các xe trung chuyển hoặc kho chứa. Bạn không nên sử dụng thuộc tính này cho bất kỳ lô hàng nào được khách hàng cuối đến lấy hoặc gửi đi. |
UNAVAILABLE |
Một việc cần làm có nghĩa là Xe không thể hoạt độ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 được tiếp nhiên liệu. |
TaskAttribute
Mô tả thuộc tính của công việc dưới dạng một cặp khoá-giá trị. Chuỗi "key:value" 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 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 thuộc tính nào, thì TaskAttribute string_value sẽ được lưu trữ dưới dạng chuỗi trống "". task_attribute_value có thể chỉ là một trong các giá trị sau: |
|
string_value |
Giá trị thuộc tính đã nhập chuỗi. |
bool_value |
Giá trị thuộc tính đã nhập Boolean. |
number_value |
Giá trị thuộc tính đã nhập 2 lần. |
TaskTrackingInfo
Tin nhắn TaskTrackingInfo
. Thông báo này 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 Tasks, Fleet Engine sẽ sử dụng thông tin phỏng đoán để quyết định TaskTrackingInfo 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 hoá theo Biểu mẫu chuẩn hoá 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 nối tạo thành một hình nhiều đường thể hiện tuyến đường dự kiến của xe đến vị trí của công việc này. |
remaining_stop_count |
Cho biết số điểm dừng mà xe còn lại cho đến khi đạt đến điểm dừng làm việc, bao gồm cả điểm dừng thực hiện công việc đó. Ví dụ: nếu điểm dừng tiếp theo của chiếc xe là điểm dừng thực hiện nhiệm vụ, thì giá trị sẽ là 1. |
remaining_driving_distance_meters |
Tổng khoảng cách 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 tới 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ả của việc cố gắng thực thi 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í mà Nhiệm vụ sẽ được hoàn thành. |
target_time_window |
Khoảng thời gian hoàn thành việc cần làm. |
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 người dùng cuối sẽ 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 |
Trường chỉ định thời điểm các điểm nhiều đường định tuyế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_arrival_time_visibility |
Trường chỉ định thời điểm 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 thời gian hoàn thành việc cần làm ước tính 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. |
remaining_driving_distance_visibility |
Trường chỉ định thời điểm có thể nhìn thấy 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 có thể hiển thị số điểm dừng 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. |
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 tuỳ chọn xác định thời điểm người dùng cuối sẽ nhìn thấy một phần tử dữ liệu.
Trường | |
---|---|
Trường hợp visibility_option . Chế độ hiển thị cụ thể đã chọn. visibility_option chỉ có thể là một trong những trạng thái sau: |
|
remaining_stop_count_threshold |
Người dùng cuối có thể thấy thành phần dữ liệu này nếu số điểm dừng còn lại <= left_stop_count_threshold. |
duration_until_estimated_arrival_time_threshold |
Người dùng cuối sẽ nhìn thấy thành phần dữ liệu này nếu thời gian 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ẽ thấy thành phần 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_driving_distance_meters_threshold. |
always |
Nếu bạn đặt chính sách này 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 nào được áp dụ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 có ngưỡng nào được áp dụ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ả thời gian này). |
end_time |
Bắt buộc. Thời gian kết thúc của khung thời gian (bao gồm cả thời gian này). |
UpdateDeliveryVehicleRequest
Tin nhắn 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 tiêu chuẩn. |
delivery_vehicle |
Bắt buộc. Cập nhật thực thể |
update_mask |
Bắt buộc. Mặt nạ trường (field mask) 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
Tin nhắn 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 tiêu chuẩn. |
task |
Bắt buộc. Việc cần làm được liên kết với nội dung cập nhật. Các trường sau đây do Fleet Engine duy trì. Đừng cập nhật các thuộc tính này bằ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 Nhiệm vụ thành ĐÃ ĐÓNG bằng cách sử dụng |
update_mask |
Bắt buộc. Mặt nạ trường (field mask) cho biết các trường Tác vụ 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 xe, từ điểm dừng trước đó đến điểm dừng hiện tại. Nếu đó là điểm dừng đầu tiên hoạt động, thì tức là tính 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 |
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 đoạn đường đi, 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 đoạn hành trình này là một phần của |
driving_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 đoạn đường đi, 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 |
path[] |
Chỉ có đầu ra. Đường đ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 đoạn đường đi, 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 đoạn 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í của điểm 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à chủ động định tuyến. |
ARRIVED |
Đã đến nơi. Giả sử khi Xe đang đi đến điểm dừng tiếp theo, thì tất cả các điểm dừng trước đó đã hoàn tất. |
TaskInfo
Thông tin bổ sung về Việc cần làm đượ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 khi phản hồi lệnh gọi
|
task_duration |
Chỉ có đầu ra. Thời gian cần thiết để thực hiện Nhiệm vụ. |
target_time_window |
Chỉ có đầu ra. Khoảng thời gian hoàn thành việc cần làm. Thuộc tính này chỉ được đặt để phản hồi |