TaskLog

  • The Task resource log in the Deliveries API records the progression and outcome of a task, including its type, state, outcome, location, and timing details.

  • It also includes journey sharing information like remaining vehicle journey segments, last location, and task tracking view configuration for data visibility.

  • The task tracking view configuration determines when certain data points, such as route polyline points and estimated arrival time, are visible to end-users based on predefined thresholds or settings.

  • Task attributes can be included as key-value pairs with string, boolean, or number values for customization and tracking specific task details.

The log of a Task resource in the Deliveries API.

JSON representation 
{
  "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)
    }
  ]
}
Fields
name

string

The task resource name in the format of providers/{providerId}/tasks/{taskId}.
type

enum (TaskTypeLog)

The task type.
state

enum (TaskStateLog)

The state of a Task indicating its progression.
taskOutcome

enum (TaskOutcomeLog)

The outcome of attempting to execute a task. When TaskState is closed, this indicates whether it was completed successfully.
taskOutcomeTime

string (Timestamp format)

The timestamp of when the task's outcome was set (from provider).

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
taskOutcomeLocation

object (LocationInfoLog)

Location where the task's outcome was set.
taskOutcomeLocationSource

enum (TaskOutcomeLocationSourceLog)

Indicates where the value of the taskOutcomeLocation came from.
trackingId

string

This field facilitates the storing of an ID for the customer to avoid unnecessary or complicated mapping.
deliveryVehicleId

string

The ID of the vehicle performing this Task.
plannedLocation

object (LocationInfoLog)

The location where the task is completed.
taskDuration

string (Duration format)

Additional time to perform an action at this location.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
targetTimeWindow

object (TimeWindowLog)

The time window during which the task should be completed.
journeySharingInfo

object (JourneySharingInfoLog)

Journey sharing specific fields.
taskTrackingViewConfig

object (TaskTrackingViewConfigLog)

The configuration for task tracking that specifies which data elements are visible to the end users under what circumstances.
attributes[]

object (TaskAttributeLog)

A list of custom Task attributes. Each attribute must have a unique key.

JourneySharingInfoLog

Journey sharing specific fields.

JSON representation 
{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegmentLog)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocationLog)
  },
  "lastLocationSnappable": boolean
}
Fields
remainingVehicleJourneySegments[]

object (VehicleJourneySegmentLog)

Tracking information for each stop that the assigned vehicle will travel to before completing this task. This list may contain stops from other tasks.
lastLocation

object (DeliveryVehicleLocationLog)

The last reported location of the vehicle.
lastLocationSnappable

boolean

Indicates whether the vehicle's lastLocation can be snapped to the currentRouteSegment. False if lastLocation or currentRouteSegment do not exist.

TaskTrackingViewConfigLog

The configuration message that defines when a data element of a Task should be visible to the end users.

JSON representation 
{
  "routePolylinePointsVisibility": {
    object (VisibilityOptionLog)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOptionLog)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOptionLog)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOptionLog)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOptionLog)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOptionLog)
  }
}
Fields
routePolylinePointsVisibility

object (VisibilityOptionLog)

The field that specifies when route polyline points can be visible. If this field is not specified, the project level default visibility configuration for this data will be used.
estimatedArrivalTimeVisibility

object (VisibilityOptionLog)

The field that specifies when estimated arrival time can be visible. If this field is not specified, the project level default visibility configuration for this data will be used.
estimatedTaskCompletionTimeVisibility

object (VisibilityOptionLog)

The field that specifies when estimated task completion time can be visible. If this field is not specified, the project level default visibility configuration for this data will be used.
remainingDrivingDistanceVisibility

object (VisibilityOptionLog)

The field that specifies when remaining driving distance can be visible. If this field is not specified, the project level default visibility configuration for this data will be used.
remainingStopCountVisibility

object (VisibilityOptionLog)

The field that specifies when remaining stop count can be visible. If this field is not specified, the project level default visibility configuration for this data will be used.
vehicleLocationVisibility

object (VisibilityOptionLog)

The field that specifies when vehicle location can be visible. If this field is not specified, the project level default visibility configuration for this data will be used.

VisibilityOptionLog

The option message that defines when a data element should be visible to the end users.

JSON representation 
{

  // 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.
}
Fields

Union field visibility_option.

visibility_option can be only one of the following:
remainingStopCountThreshold

integer

This data element is visible to the end users if the remaining stop count <= remainingStopCountThreshold.
durationUntilEstimatedArrivalTimeThreshold

string (Duration format)

This data element is visible to the end users if the ETA to the stop <= durationUntilEstimatedArrivalTimeThreshold.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
remainingDrivingDistanceMetersThreshold

integer

This data element is visible to the end users if the remaining driving distance in meters <= remainingDrivingDistanceMetersThreshold.
always

boolean

If set to true, this data element is always visible to the end users with no thresholds.
never

boolean

If set to true, this data element is always hidden from the end users with no thresholds.

TaskAttributeLog

Describes a task attribute as a key-value pair. The "key:value" string length cannot exceed 256 characters.

JSON representation 
{
  "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.
}
Fields
key

string

The attribute's key. Keys may not contain the colon character (:).
Union field task_attribute_value. The attribute's value, can be in string, bool, or double type. If none are set the TaskAttribute string_value will be stored as the empty string "". task_attribute_value can be only one of the following:
stringValue

string

String typed attribute value.
boolValue

boolean

Boolean typed attribute value.
numberValue

number

Double typed attribute value.