TaskLog

Deliveries API 中任务资源的日志。

JSON 表示法
{
  "name": string,
  "type": enum (TaskTypeLog),
  "state": enum (TaskStateLog),
  "taskOutcome": enum (TaskOutcomeLog),
  "taskOutcomeTime": string,
  "taskOutcomeLocation": {
    object (LocationInfoLog)
  },
  "taskOutcomeLocationSource": enum (TaskOutcomeLocationSourceLog),
  "trackingId": string,
  "deliveryVehicleId": string,
  "plannedLocation": {
    object (LocationInfoLog)
  },
  "taskDuration": string,
  "targetTimeWindow": {
    object (TimeWindowLog)
  },
  "journeySharingInfo": {
    object (JourneySharingInfoLog)
  },
  "taskTrackingViewConfig": {
    object (TaskTrackingViewConfigLog)
  },
  "attributes": [
    {
      object (TaskAttributeLog)
    }
  ]
}
字段
name

string

任务资源名称,格式为 providers/{providerId}/tasks/{taskId}

type

enum (TaskTypeLog)

任务类型。

state

enum (TaskStateLog)

任务的状态,表示其进度。

taskOutcome

enum (TaskOutcomeLog)

尝试执行任务的结果。关闭 TaskState 时,表示其是否已成功完成。

taskOutcomeTime

string (Timestamp format)

设置任务结果的时间戳(来自提供方)。

采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。也接受除“Z”以外的偏移量。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

taskOutcomeLocation

object (LocationInfoLog)

设置任务结果的位置。

taskOutcomeLocationSource

enum (TaskOutcomeLocationSourceLog)

指示 taskOutcomeLocation 的值的来源。

trackingId

string

此字段有助于为客户存储 ID,以避免不必要或复杂的映射。

deliveryVehicleId

string

执行此任务的车辆的 ID。

plannedLocation

object (LocationInfoLog)

任务完成的位置。

taskDuration

string (Duration format)

在相应位置执行操作的额外时间。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

targetTimeWindow

object (TimeWindowLog)

任务应完成的时间范围。

journeySharingInfo

object (JourneySharingInfoLog)

历程共享特定字段。

taskTrackingViewConfig

object (TaskTrackingViewConfigLog)

任务跟踪的配置,用于指定在哪些情况下哪些数据元素可供最终用户查看。

attributes[]

object (TaskAttributeLog)

自定义任务属性的列表。每个属性都必须具有唯一键。

JourneySharingInfoLog

历程共享特定字段。

JSON 表示法
{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegmentLog)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocationLog)
  },
  "lastLocationSnappable": boolean
}
字段
remainingVehicleJourneySegments[]

object (VehicleJourneySegmentLog)

分配的车辆在完成此任务之前将前往的每个经停点的跟踪信息。此列表可能包含其他任务的停止点。

lastLocation

object (DeliveryVehicleLocationLog)

车辆上次报告的位置。

lastLocationSnappable

boolean

指示车辆的 lastLocation 是否可以贴靠到 currentRouteSegment。如果 lastLocationcurrentRouteSegment 不存在,则为 False

TaskTrackingViewConfigLog

配置消息,用于定义何时应向最终用户显示任务的数据元素。

JSON 表示法
{
  "routePolylinePointsVisibility": {
    object (VisibilityOptionLog)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOptionLog)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOptionLog)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOptionLog)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOptionLog)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOptionLog)
  }
}
字段
routePolylinePointsVisibility

object (VisibilityOptionLog)

用于指定路线多段线点何时可见的字段。如果未指定此字段,系统将使用此数据的项目级默认公开范围配置。

estimatedArrivalTimeVisibility

object (VisibilityOptionLog)

用于指定何时可以显示预计到达时间的字段。如果未指定此字段,系统将使用此数据的项目级默认公开范围配置。

estimatedTaskCompletionTimeVisibility

object (VisibilityOptionLog)

用于指定何时可以显示预计任务完成时间的字段。如果未指定此字段,系统将使用此数据的项目级默认公开范围配置。

remainingDrivingDistanceVisibility

object (VisibilityOptionLog)

用于指定何时可以显示剩余行驶距离的字段。如果未指定此字段,系统将使用此数据的项目级默认公开范围配置。

remainingStopCountVisibility

object (VisibilityOptionLog)

用于指定何时可以显示剩余经停点数的字段。如果未指定此字段,系统将使用此数据的项目级默认公开范围配置。

vehicleLocationVisibility

object (VisibilityOptionLog)

用于指定何时可以显示车辆位置信息的字段。如果未指定此字段,系统将使用此数据的项目级默认公开范围配置。

VisibilityOptionLog

用于定义何时应向最终用户显示数据元素的选项消息。

JSON 表示法
{

  // Union field visibility_option can be only one of the following:
  "remainingStopCountThreshold": integer,
  "durationUntilEstimatedArrivalTimeThreshold": string,
  "remainingDrivingDistanceMetersThreshold": integer,
  "always": boolean,
  "never": boolean
  // End of list of possible types for union field visibility_option.
}
字段

联合字段 visibility_option

visibility_option 只能是下列其中一项:

remainingStopCountThreshold

integer

如果剩余经停次数小于等于 remainingStopCountThreshold,最终用户会看到此数据元素。

durationUntilEstimatedArrivalTimeThreshold

string (Duration format)

如果相应经停点的预计到达时间 <= durationUntilEstimatedArrivalTimeThreshold,则此数据元素会向最终用户显示。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

remainingDrivingDistanceMetersThreshold

integer

如果剩余行驶距离(以米为单位)小于等于 remainingDrivingDistanceMetersThreshold,最终用户会看到此数据元素。

always

boolean

如果设置为 true,则最终用户始终可以看到此数据元素,无需达到最低阈值。

never

boolean

如果设为 true,则系统会始终向最终用户隐藏此数据元素,且不设阈值。

TaskAttributeLog

以键值对的形式描述任务属性。“键值对”字符串的长度不得超过 256 个字符。

JSON 表示法
{
  "key": string,

  // Union field task_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field task_attribute_value.
}
字段
key

string

属性的键。键不得包含英文冒号字符 (:)。

联合字段 task_attribute_value。属性的值可以是字符串、布尔值或双精度类型。如果未设置任何值,TaskAttribute 的 string_value 将存储为空字符串“”。task_attribute_value 只能是以下其中一项:
stringValue

string

字符串类型的属性值。

boolValue

boolean

布尔类型的属性值。

numberValue

number

双精度属性值。