Task interface
google.maps.journeySharing.Task
interface
The details for a task returned by Fleet Engine.
Properties | |
---|---|
attributes |
Type:
Object<string, *> Attributes assigned to the task. |
name |
Type:
string The task name in the format "providers/{provider_id}/tasks/{task_id}". The task_id must be a unique identifier and not a tracking ID. To store a tracking ID of a shipment, use the tracking_id field. Multiple tasks can have the same tracking_id. |
remainingVehicleJourneySegments |
Type:
Array<VehicleJourneySegment> Information about the segments left to be completed for this task. |
status |
Type:
string The current execution state of the task. |
type |
Type:
string The task type; for example, a break or shipment. |
estimatedCompletionTime optional |
Type:
Date optional The timestamp of the estimated completion time of the task. |
latestVehicleLocationUpdate optional |
Type:
VehicleLocationUpdate optional Information specific to the last location update. |
outcome optional |
Type:
string optional The outcome of the task. |
outcomeLocation optional |
Type:
LatLngLiteral optional The location where the task was completed (from provider). |
outcomeLocationSource optional |
Type:
string optional The setter of the task outcome location ('PROVIDER' or 'LAST_VEHICLE_LOCATION'). |
outcomeTime optional |
Type:
Date optional The timestamp of when the task's outcome was set (from provider). |
plannedLocation optional |
Type:
LatLngLiteral optional The location where the task is to be completed. |
targetTimeWindow optional |
Type:
TimeWindow optional The time window during which the task should be completed. |
trackingId optional |
Type:
string optional The tracking ID of the shipment. |
vehicleId optional |
Type:
string optional The ID of the vehicle performing this task. |
TaskTrackingInfo interface
google.maps.journeySharing.TaskTrackingInfo
interface
The details for a task tracking info object returned by Fleet Engine.
Properties | |
---|---|
attributes |
Type:
Object<string, *> Attributes assigned to the task. |
name |
Type:
string The name in the format "providers/{provider_id}/taskTrackingInfo/{tracking_id}", where tracking_id represents the tracking ID. |
trackingId |
Type:
string The tracking ID of a Task.
|
estimatedArrivalTime optional |
Type:
Date optional The estimated arrival time to the stop location. |
estimatedTaskCompletionTime optional |
Type:
Date optional The estimated completion time of a Task. |
latestVehicleLocationUpdate optional |
Type:
VehicleLocationUpdate optional Information specific to the last location update. |
plannedLocation optional |
Type:
LatLng optional The location where the Task will be completed. |
remainingDrivingDistanceMeters optional |
Type:
number optional The total remaining distance in meters to the VehicleStop of interest. |
remainingStopCount optional |
Type:
number optional Indicates the number of stops the vehicle remaining until the task stop is reached, including the task stop. For example, if the vehicle's next stop is the task stop, the value will be 1. |
routePolylinePoints optional |
A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task. |
state optional |
Type:
string optional The current execution state of the Task. |
targetTimeWindow optional |
Type:
TimeWindow optional The time window during which the task should be completed. |
taskOutcome optional |
Type:
string optional The outcome of attempting to execute a Task. |
taskOutcomeTime optional |
Type:
Date optional The time when the Task's outcome was set by the provider. |
Trip interface
google.maps.journeySharing.Trip
interface
The details for a trip returned by Fleet Engine.
Properties | |
---|---|
name |
Type:
string In the format "providers/{provider_id}/trips/{trip_id}". The trip_id must be a unique identifier. |
passengerCount |
Type:
number Number of passengers on this trip; does not include the driver. |
remainingWaypoints |
Type:
Array<VehicleWaypoint> An array of waypoints indicating the path from the current location to the drop-off point. |
status |
Type:
string Current status of the trip. Possible values are UNKNOWN_TRIP_STATUS, NEW, ENROUTE_TO_PICKUP, ARRIVED_AT_PICKUP, ARRIVED_AT_INTERMEDIATE_DESTINATION, ENROUTE_TO_INTERMEDIATE_DESTINATION, ENROUTE_TO_DROPOFF, COMPLETE, or CANCELED. |
type |
Type:
string The type of the trip. Possible values are UNKNOWN_TRIP_TYPE, SHARED or EXCLUSIVE. |
vehicleId |
Type:
string ID of the vehicle making this trip. |
actualDropOffLocation optional |
Type:
LatLngLiteral optional Location where the customer was dropped off. |
actualPickupLocation optional |
Type:
LatLngLiteral optional Location where the customer was picked up. |
dropOffTime optional |
Type:
Date optional The estimated future time when the passengers will be dropped off, or the actual time when they were dropped off. |
latestVehicleLocationUpdate optional |
Type:
VehicleLocationUpdate optional Information specific to the last location update. |
pickupTime optional |
Type:
Date optional The estimated future time when the passengers will be picked up, or the actual time when they were picked up. |
plannedDropOffLocation optional |
Type:
LatLngLiteral optional Location where the customer indicates they will be dropped off. |
plannedPickupLocation optional |
Type:
LatLngLiteral optional Location where customer indicates they will be picked up. |
DeliveryVehicle interface
google.maps.journeySharing.DeliveryVehicle
interface
The details for a delivery vehicle returned by Fleet Engine.
Properties | |
---|---|
attributes |
Type:
Object<string, string optional> Custom delivery vehicle attributes. |
name |
Type:
string In the format "providers/{provider_id}/deliveryVehicles/{delivery_vehicle_id}". The delivery_vehicle_id must be a unique identifier. |
navigationStatus |
Type:
string The current navigation status of the vehicle. |
remainingDistanceMeters |
Type:
number The remaining driving distance in the current route segment, in meters. |
remainingVehicleJourneySegments |
Type:
Array<VehicleJourneySegment> The journey segments assigned to this delivery vehicle, starting from the vehicle's most recently reported location. |
currentRouteSegmentEndPoint optional |
Type:
LatLngLiteral optional The location where the current route segment ends. |
latestVehicleLocationUpdate optional |
Type:
VehicleLocationUpdate optional The last reported location of the delivery vehicle. |
remainingDurationMillis optional |
Type:
number optional The remaining driving duration in the current route segment, in milliseconds. |
DeliveryVehicleStop interface
google.maps.journeySharing.DeliveryVehicleStop
interface
DeliveryVehicleStop type
Properties | |
---|---|
tasks |
Type:
Array<{ The list of Tasks to be performed at this stop.
|
DeliveryVehicleStopState constants
google.maps.journeySharing.DeliveryVehicleStopState
constants
The current state of a DeliveryVehicleStop
.
Access by calling const {DeliveryVehicleStopState} = await google.maps.importLibrary("journeySharing")
. See Libraries in the Maps JavaScript API.
Constants | |
---|---|
ARRIVED |
Arrived at stop. Assumes that when the vehicle is routing to the next stop, that all previous stops have been completed. |
ENROUTE |
Assigned and actively routing. |
NEW |
Created, but not actively routing. |
UNSPECIFIED |
Unknown. |
VehicleJourneySegment interface
google.maps.journeySharing.VehicleJourneySegment
interface
VehicleJourneySegment type
Properties | |
---|---|
drivingDistanceMeters optional |
Type:
number optional The travel distance from the previous stop to this stop, in meters. |
drivingDurationMillis optional |
Type:
number optional The travel time from the previous stop this stop, in milliseconds. |
path optional |
Type:
Array<LatLngLiteral> optional The path from the previous stop (or the vehicle's current location, if this stop is the first in the list of stops) to this stop. |
stop optional |
Type:
DeliveryVehicleStop optional Information about the stop. |
VehicleLocationUpdate interface
google.maps.journeySharing.VehicleLocationUpdate
interface
VehicleLocationUpdate type
Properties | |
---|---|
heading optional |
Type:
number optional The heading of the update. 0 corresponds to north, 180 to south. |
location optional |
Type:
LatLngLiteral|LatLng optional The location of the update. |
speedKilometersPerHour optional |
Type:
number optional The speed in kilometers per hour. |
time optional |
Type:
Date optional The time this update was received from the vehicle. |
VehicleWaypoint interface
google.maps.journeySharing.VehicleWaypoint
interface
VehicleWaypoint type.
Properties | |
---|---|
distanceMeters optional |
Type:
number optional The path distance between the previous waypoint (or the vehicle's current location, if this waypoint is the first in the list of waypoints) to this waypoint in meters. |
durationMillis optional |
Type:
number optional Travel time between the previous waypoint (or the vehicle's current location, if this waypoint is the first in the list of waypoints) to this waypoint in milliseconds. |
location optional |
Type:
LatLngLiteral optional The location of the waypoint. |
path optional |
Type:
Array<LatLngLiteral> optional The path from the previous waypoint (or the vehicle's current location, if this waypoint is the first in the list of waypoints) to this waypoint. |
TimeWindow interface
google.maps.journeySharing.TimeWindow
interface
A time range.
Properties | |
---|---|
endTime |
Type:
Date The end time of the time window (inclusive). |
startTime |
Type:
Date The start time of the time window (inclusive). |