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)DeleteDeliveryVehicleRequest
(thông báo)DeleteTaskRequest
(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 chặng cuối.
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 |
DeleteDeliveryVehicle |
---|
Xoá DeliveryVehicle khỏi Công cụ quản lý đội xe. Trả về FAILED_PRECONDITION nếu DeliveryVehicle có các Tác vụ MỞ được chỉ định. |
DeleteTask |
---|
Xoá một Việc cần làm. Trả về FAILED_PRECONDITION nếu Task (Tác vụ) ở trạng thái OPEN (MỞ) và được chỉ định cho một DeliveryVehicle. |
GetDeliveryVehicle |
---|
Trả về thực thể |
GetTask |
---|
Lấy thông tin về |
GetTaskTrackingInfo |
---|
Trả về thực thể |
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
Thông báo yêu cầu BatchCreateTask
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề yêu cầu API phân phối chuẩn. Lưu ý: Nếu bạn đặt trường này, thì trường tiêu đề trong thông báo |
parent |
Bắt buộc. Tài nguyên mẹ được tất cả tác vụ chia sẻ. Giá trị này phải ở định dạng |
requests[] |
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[] |
Các Việc cần làm đã tạo. |
CreateDeliveryVehicleRequest
Thông báo yêu cầu CreateDeliveryVehicle
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề 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à duy nhất và tuân theo các quy định hạn chế sau:
|
delivery_vehicle |
Bắt buộc. Thực thể
Lưu ý: Trường |
CreateTaskRequest
Thông báo yêu cầu CreateTask
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề 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ã công việc phải là mã duy nhất, nhưng không được là mã vận đơn. Để lưu trữ mã vận đơn, hãy sử dụng trường
|
task |
Bắt buộc. Thực thể Task (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:
Bạn có thể tuỳ ý đặt các trường sau:
Lưu ý: Trường |
DeleteDeliveryVehicleRequest
Tin nhắn yêu cầu DeleteDeliveryVehicle.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề yêu cầu API phân phối chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
DeleteTaskRequest
Thông báo yêu cầu DeleteTask.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề yêu cầu API phân phối chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
DeliveryRequestHeader
RequestHeader chứa các trường phổ biến 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 xem http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Nếu không có tên nào được chỉ định, câu trả lờ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: |
region_code |
Bắt buộc. Mã vùng CLDR của khu vực phát sinh 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 |
Mẫ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 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 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 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 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 sử 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 tải 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 hàng hoá 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 tham chiếu đến cùng một trường.
Trường | |
---|---|
name |
Tên duy nhất của Xe phân phối này. Định dạng là |
last_location |
Vị trí gần đây nhất được báo cáo của Xe giao hàng. |
past_locations[] |
Chỉ nhập. Những địa điểm mà Xe giao hàng này đã từng đến nhưng chưa được báo cáo cho Công cụ quản lý đội xe. Phương thức này được dùng trong |
navigation_status |
Trạng thái chỉ đường của Xe giao hàng. |
current_route_segment |
Hình đa tuyến được mã hoá chỉ định tuyến đường mà tính năng chỉ đường đề xuất đi đến điểm trung gian tiếp theo. Ứng dụng trình điều khiển 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 chỉ đường định tuyến lại. Các Có một số trường hợp trường này có thể không được dùng để điền sẵn
Trong những trường hợp này, Công cụ quản lý đội xe sẽ điền sẵn vào trường này một tuyến đường từ VehicleStop đã đi qua gần đây nhất đến VehicleStop sắp tới để đảm bảo rằng người dùng của trường này có thông tin tốt nhất hiện có về đường dẫn 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 |
Khoảng cách lái xe còn lại cho Công cụ của Fleet sẽ bỏ qua trường này trong |
remaining_duration |
Thời gian lái xe còn lại cho Công cụ của Fleet sẽ bỏ qua trường này trong |
remaining_vehicle_journey_segments[] |
Các đ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 trong phản hồi của |
attributes[] |
Danh sách các thuộc tính tuỳ chỉnh của Xe giao hàng. Một Xe phân phối 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 biệt. |
type |
Loại xe giao hàng này. Nếu bạn không đặt, 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 |
Một chiếc ô 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 tải do con người vận hành. |
PEDESTRIAN |
Phương tiện vận chuyển con người, thường là đi bộ hoặc chạy dọc theo đường đ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ị. Chiều dài chuỗi "khoá:giá trị" 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 hợp nhất delivery_vehicle_attribute_value . Giá trị của thuộc tính có thể ở dạng chuỗi, bool hoặc double. delivery_vehicle_attribute_value chỉ có thể là một trong những loại sau: |
|
string_value |
Giá trị thuộc tính được nhập dưới dạng 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 một xe tại một thời điểm.
Trường | |
---|---|
location |
Vị trí của xe. Khi được gửi đến Công cụ quản lý đội xe, vị trí của xe là vị trí GPS. Khi bạn nhận được thông tin 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 tính khác. Nguồn được chỉ định trong |
horizontal_accuracy |
Không dùng nữa: Hãy sử dụng |
latlng_accuracy |
Độ chính xác của |
heading |
Hướng xe đang di chuyển tính bằng độ. 0 thể hiện hướng Bắc. Phạm vi hợp lệ là [0,360). |
bearing_accuracy |
Không dùng nữa: Hãy sử 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: Hãy sử 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: Hãy sử dụng |
speed |
Tốc độ của xe tính bằng mét/giây |
speed_accuracy |
Độ chính xác của |
update_time |
Thời gian 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 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ừ lần đầu tiên vị trí này được gửi đến máy chủ. Giá trị này sẽ là 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 về 0. |
num_stale_updates |
Chỉ nhập. Ngừng sử dụng: 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 xử lý bằng công cụ chụp đường). |
raw_location_time |
Dấu thời gian 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: Hãy sử 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 không được chỉ định hoặc không xác định. |
GPS |
GPS hoặc GPS được hỗ trợ. |
NETWORK |
GPS hỗ trợ, mã trạm phát sóng hoặc điểm truy cập Wi-Fi. |
PASSIVE |
Mã tháp phát sóng di độ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í đườ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ác ngoài 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ị đó. Các 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 Công cụ quản lý đội xe 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 các hệ điều hành của Apple. |
GetDeliveryVehicleRequest
Thông báo yêu cầu GetDeliveryVehicle
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề yêu cầu API phân phối chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
GetTaskRequest
Thông báo yêu cầu GetTask
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề yêu cầu API phân phối chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
GetTaskTrackingInfoRequest
Thông báo yêu cầu GetTaskTrackingInfoRequest
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề yêu cầu API phân phối chuẩn. |
name |
Bắt buộc. Phải ở định dạng |
ListDeliveryVehiclesRequest
Thông báo yêu cầu ListDeliveryVehicles
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề 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 xe tối đa cần trả về. Dịch vụ có thể trả về ít hơn số lượng này. Nếu bạn không chỉ định số lượng 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. Truy vấn bộ lọc để áp dụng khi đăng 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 phương tiện phân phối 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 truy vấn bộ lọc là 50. Hạn chế là một phần của truy vấn có dạng |
viewport |
Không bắt buộc. Bộ lọc giới hạn các xe được trả về ở những vị trí đã biết gần đây nhất nằm trong khu vực hình chữ nhật do khung nhìn xác định. |
ListDeliveryVehiclesResponse
Thông báo phản hồi ListDeliveryVehicles
.
Trường | |
---|---|
delivery_vehicles[] |
Tập hợp các phương tiện phân phối đáp ứng tiêu chí lọc đã yêu cầu. Khi không chỉ định bộ lọc nào, yêu cầu sẽ trả về tất cả các phương tiện phân phối. Một phản hồi thành công cũng có thể trống. Nội dung 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ể truyền mã thông báo này trong |
total_size |
Tổng số phương tiện phân phối khớp với tiêu chí 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 |
Không bắt buộc. Tiêu đề 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. 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. Truy vấn bộ lọc để áp dụng khi liệt kê 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 Việc cần làm sẽ đượ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 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 Tác vụ đáp ứng tiêu chí lọc trong ListTasksRequest
.
Trường | |
---|---|
tasks[] |
Tập hợp các Tác vụ đáp ứng tiêu chí lọc đã yêu cầu. Khi không chỉ định bộ lọc nào, yêu cầu sẽ trả về tất cả các tác vụ. Một 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 Công việc 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 trong |
total_size |
Tổng số Tác vụ khớp với tiêu chí yêu cầu trên tất cả các trang. |
LocationInfo
Vị trí có bất kỳ giá trị nhận dạng bổ sung nào.
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 đại diện cho một hành động cần theo dõi. Nhìn chung, có sự khác biệt giữa Tác vụ liên quan đến lô hàng và Tác vụ nghỉ giải lao. 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 Tác vụ cho việc nhận hàng và một Tác vụ cho việc giao hàng hoặc chuyển hàng. Ngoài ra, các Nhiệm vụ khác nhau cho một lô hàng nhất định có thể được xử lý bằng các phương tiện khác nhau. Ví dụ: một xe có thể xử lý việc lấy hàng, vận chuyển lô hàng đến trung tâm, trong khi một xe khác vận chuyển 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 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ụ: một lần nghỉ hoặc một lô 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 việc cần làm. |
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 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 mối 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 thi Tác vụ này. Mã xe giao hàng phải tuân thủ các quy định hạn chế sau:
|
planned_location |
Không thể thay đổi. Vị trí mà Việc cần làm sẽ được hoàn thành. Không bắt buộc đối với Tác vụ |
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 cần hoàn thành tác vụ. |
journey_sharing_info |
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 khi trạng thái là |
task_tracking_view_config |
Cấu hình theo dõi tác vụ chỉ định những phần tử dữ liệu mà người dùng cuối có thể nhìn thấy trong những 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á riêng biệt. |
JourneySharingInfo
Các trường cụ thể khi chia sẻ hành trình.
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ẽ thực hiện trước khi hoàn tất Tác 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 công việc khác. Phân đ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 có thể chụp nhanh lastLocation của xe vào |
Tiểu bang
Trạng thái của một Việc cần làm. Đây là chỉ báo tiến trình của Tasks.
Enum | |
---|---|
STATE_UNSPECIFIED |
Mặc định. Dùng cho trạng thái Việc cần làm không xác định hoặc không được nhận dạng. |
OPEN |
Việc cần làm chưa được chỉ định cho xe tải hoặc xe tải chưa đi qua điểm dừng xe được chỉ định của Task . |
CLOSED |
Khi xe đi qua điểm dừng xe cho Tác 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 quá trình này đã hoàn tất thành công hay chưa.
Enum | |
---|---|
TASK_OUTCOME_UNSPECIFIED |
Kết quả của Tác vụ trước khi đặt giá trị. |
SUCCEEDED |
Đã hoàn tất tác vụ. |
FAILED |
Không thể hoàn tất hoặc đã huỷ Việc cần làm. |
TaskOutcomeLocationSource
Giá trị nhận dạng 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 , vì vậy, Công cụ quản lý đội xe đã sử dụng vị trí xe gần đây nhất được biết. |
Loại
Loại công việc.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Theo mặc định, Loại tác vụ là không xác định. |
PICKUP |
Công việc lấy hàng là hành động được thực hiện để lấy hàng của khách hàng. Bạn nên sử dụng loại SCHEDULED_STOP cho các điểm lấy hàng tại kho hoặc xe trung chuyển. |
DELIVERY |
Tác 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. Điểm trả xe tại kho hoặc điểm trung chuyển phải sử dụng loại SCHEDULED_STOP . |
SCHEDULED_STOP |
Tác vụ dừng theo lịch được dùng cho mục đích lập kế hoạch. Ví dụ: điểm này có thể thể hiện việc lấy hàng hoặc trả hàng từ các xe trung chuyển hoặc kho. Bạn không nên sử dụng phương thức này cho bất kỳ lô hàng nào được khách hàng cuối đến lấy hoặc giao đến. |
UNAVAILABLE |
Một Tác vụ có nghĩa là Xe không thể được 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 đổ xăng. |
TaskAttribute
Mô tả thuộc tính công việc dưới dạng cặp khoá-giá trị. Chiều dài chuỗi "khoá:giá trị" 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 hợp nhất task_attribute_value . Giá trị của thuộc tính có thể ở dạng chuỗi, bool hoặc double. Nếu không đặt giá trị nào, string_value của 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 |
Giá trị thuộc tính được nhập dưới dạng 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
Thông báo 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 Tác vụ, thì Công cụ của đội xe sẽ sử dụng phương pháp phỏng đoán để quyết định chọn TaskTrackingInfo của Tác vụ nào.
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ự. * Đã chuẩn hoá theo Dạng 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 kết nối sẽ tạo thành một đa tuyế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 |
Cho biết số điểm dừng còn lại của xe cho đến khi đến điểm dừng của công việc, bao gồm cả điểm dừng của công việc. Ví dụ: nếu điểm dừng tiếp theo của xe là điểm dừng công việc, 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 tại vị trí điểm 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à Việc cần làm sẽ được hoàn thành. |
target_time_window |
Khoảng thời gian cần hoàn thành tác vụ. |
attributes[] |
Các thuộc tính tuỳ chỉnh được đặt trên 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 nhìn thấy một phần tử dữ liệu của một Tác vụ.
Trường | |
---|---|
route_polyline_points_visibility |
Trường chỉ định thời điểm các điểm của đường đa tuyến của tuyến đường 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 có thể hiển thị thời gian đến dự kiến. 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 có thể hiển thị số lượng đ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ị 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 nhìn thấy một phần tử dữ liệu.
Trường | |
---|---|
Trường hợp hợp nhất visibility_option . Chế độ hiển thị cụ thể đã chọn. visibility_option chỉ có thể là một trong những loại sau: |
|
remaining_stop_count_threshold |
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 |
Người dùng cuối sẽ 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 |
Người dùng cuối có thể 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 <= remaining_driving_distance_meters_threshold. |
always |
Nếu bạn đặt thành đúng, người dùng cuối sẽ luôn thấy phần tử dữ liệu này mà không có ngưỡng nào. Không thể đặt trường này thành false. |
never |
Nếu bạn đặt thành đúng, thì phần tử dữ liệu này sẽ luôn bị ẩn khỏi người dùng cuối mà không có ngưỡng nào. Không thể đặt trường này thành false. |
TimeWindow
Một phạm vi thời gian.
UpdateDeliveryVehicleRequest
Thông báo yêu cầu UpdateDeliveryVehicle
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề yêu cầu API phân phối chuẩn. |
delivery_vehicle |
Bắt buộc. Nội dung cập nhật thực thể |
update_mask |
Bắt buộc. Mặt nạ trường cho biế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ụ: |
UpdateTaskRequest
Thông báo yêu cầu UpdateTask
.
Trường | |
---|---|
header |
Không bắt buộc. Tiêu đề yêu cầu API phân phối chuẩn. |
task |
Bắt buộc. Việc cần làm liên kết với nội dung cập nhật. Các trường sau đây do Công cụ của đội xe duy trì. Không cập nhật các tệp này bằng
Lưu ý: Bạn không thể thay đổi giá trị của Nếu Tác vụ đã được chỉ định cho một xe giao hàng, thì đừng đặt trạng thái Tác vụ thành ĐÃ ĐÓNG bằng |
update_mask |
Bắt buộc. Mặt nạ trường cho biết những trường Task (Việc cần làm) cần cập nhật. Lưu ý: Đâ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ụ: |
VehicleJourneySegment
Biểu thị một đoạn hành trình 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ì điểm dừng này sẽ 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í điểm dừng, cùng với các |
driving_distance_meters |
Chỉ có đầu ra. Khoảng cách di chuyển từ trạm trước đến trạm 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 hành trình, 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ừ trạm trước đến trạm 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 hành trình, 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 trường này được xác định trong đường dẫn |
path[] |
Chỉ có đầu ra. Đường dẫ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 hành trình, 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 trường này được xác định trong đường dẫn |
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 |
Bắt buộc. Vị trí của điểm dừng. Xin lưu ý rằng các vị trí trong |
tasks[] |
Danh sách |
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 định tuyến. |
ARRIVED |
Đã đến điểm dừng. Giả định rằng khi Xe đang định tuyến đến điểm dừng tiếp theo, tất cả các điểm dừng trước đó đều đã 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 |
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
|
task_duration |
Chỉ có đầu ra. Thời gian cần thiết để thực hiện Tác vụ. |
target_time_window |
Chỉ có đầu ra. Khoảng thời gian cần hoàn thành tác vụ. Giá trị này chỉ được đặt trong phản hồi cho |