资源:任务
Delivery API 中的任务表示要跟踪的单个操作。一般来说,与运单相关的任务和中断任务是有区别的。一个运单可以有多个与之关联的任务。例如,可以有一个针对上车点的任务,以及一个针对下车点或中转站的任务。此外,给定货物的不同任务可以由不同的车辆处理。例如,一辆车可以负责处理取货,将货物送往枢纽,而另一辆车则会将同一货物从交通枢纽驱动到下车点。
注意:gRPC 和 REST API 使用不同的字段命名惯例。例如,gRPC API 中的 Task.journey_sharing_info
字段和 REST API 中的 Task.journeySharingInfo
字段指的是同一个字段。
JSON 表示法 |
---|
{ "name": string, "type": enum ( |
字段 | |
---|---|
name |
必须采用 |
type |
必需。不可变。定义任务的类型。例如,中断期或运单。 |
state |
必需。Task 的当前执行状态。 |
taskOutcome |
任务的结果。 |
taskOutcomeTime |
指明提供程序设置 采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例: |
taskOutcomeLocation |
设置 |
taskOutcomeLocationSource |
指示 |
trackingId |
不可变。此字段便于 ID 的存储,让您可以避免使用复杂的映射。您无法为
|
deliveryVehicleId |
仅限输出。执行此 Task 的车辆的 ID。送货车辆 ID 受到以下限制:
|
plannedLocation |
不可变。完成任务的位置。 |
taskDuration |
必需。不可变。在此位置执行任务所需的时间。 此时长以秒为单位,最多包含九个小数位,以“ |
targetTimeWindow |
应完成任务的时间范围。 |
journeySharingInfo |
仅限输出。行程共享专用字段。当状态为 |
taskTrackingViewConfig |
任务跟踪的配置,用于指定在什么情况下最终用户可以看到哪些数据元素。 |
attributes[] |
自定义 Task 属性列表。每个属性必须具有唯一的键。 |
类型
Task 的类型。
枚举 | |
---|---|
TYPE_UNSPECIFIED |
默认情况下,任务类型未知。 |
PICKUP |
提货任务是指从客户那里提货的操作。仓库或供给车辆取车点应使用 SCHEDULED_STOP 类型。 |
DELIVERY |
交付任务是为最终客户交付货物而执行的操作。仓库或供给车辆下车点应使用 SCHEDULED_STOP 类型。 |
SCHEDULED_STOP |
计划停止任务用于规划目的。例如,它可能表示从供给车辆或仓库中提货。它不应用于最终客户取货或送出的任何货物。 |
UNAVAILABLE |
表示车辆无法维修的任务。例如,当驾驶员休息或给车辆加油时可能会发生这种情况。 |
TaskOutcomeLocationSource
填充了 taskOutcomeLocation
的来源的身份。
枚举 | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
设置之前的任务结果。 |
PROVIDER |
提供方指定的 taskOutcomeLocation 。 |
LAST_VEHICLE_LOCATION |
提供程序未指定 taskOutcomeLocation ,因此 Fleet Engine 使用最近一次的已知车辆位置。 |
JourneySharingInfo
分享特定字段的历程。
JSON 表示法 |
---|
{ "remainingVehicleJourneySegments": [ { object ( |
字段 | |
---|---|
remainingVehicleJourneySegments[] |
跟踪分配车辆在完成此任务之前将到达的站点的信息。请注意,此列表可以包含来自其他任务的站点。 第一个路段 |
lastLocation |
指明上次报告所分配车辆的位置。 |
lastLocationSnappable |
指示车辆的 lastLocation 能否与 |
TaskTrackingViewConfig
用于定义何时应向最终用户显示 Task 数据元素的配置消息。
JSON 表示法 |
---|
{ "routePolylinePointsVisibility": { object ( |
字段 | |
---|---|
routePolylinePointsVisibility |
用于指定路线多段线点何时可显示的字段。如果未指定此字段,则将使用此数据的项目级默认可见性配置。 |
estimatedArrivalTimeVisibility |
用于指定何时可显示预计到达时间的字段。如果未指定此字段,则将使用此数据的项目级默认可见性配置。 |
estimatedTaskCompletionTimeVisibility |
用于指定何时可显示预计任务完成时间的字段。如果未指定此字段,则将使用此数据的项目级默认可见性配置。 |
remainingDrivingDistanceVisibility |
用于指定剩余行车距离何时可见的字段。如果未指定此字段,则将使用此数据的项目级默认可见性配置。 |
remainingStopCountVisibility |
用于指定剩余停车点何时可见的字段。如果未指定此字段,则将使用此数据的项目级默认可见性配置。 |
vehicleLocationVisibility |
用于指定何时可显示车辆位置信息的字段。如果未指定此字段,则将使用此数据的项目级默认可见性配置。 |
VisibilityOption
用于定义何时应向最终用户显示数据元素的选项消息。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 visibility_option 。所选的特定公开范围选项。visibility_option 只能是下列其中一项: |
|
remainingStopCountThreshold |
如果剩余停靠站数 <= remainingStopCountThreshold 时,该数据元素将向最终用户显示。 |
durationUntilEstimatedArrivalTimeThreshold |
如果相应经停点的预计到达时间 <= durationUntilEstimatedArrivalTimeThreshold,则最终用户可以看到此数据元素。 此时长以秒为单位,最多包含九个小数位,以“ |
remainingDrivingDistanceMetersThreshold |
如果剩余行车距离(以米为单位)<= remainingDrivingDistanceMetersThreshold,则此数据元素对最终用户可见。 |
always |
如果设置为 true,则此数据元素始终对最终用户可见,且没有阈值。此字段不能设为 false。 |
never |
如果设置为 true,系统会始终对最终用户隐藏此数据元素,并且未设置阈值。此字段不能设为 false。 |
方法 |
|
---|---|
|
创建并返回一批新的 Task 对象。 |
|
创建并返回一个新的 Task 对象。 |
|
获取有关 Task 的信息。 |
|
获取满足指定过滤条件的所有 Task 。 |
|
更新 Task 数据。 |