Task interface
google.maps.journeySharing.Task
interface
The details for a task returned by Fleet Engine.
Requires the &libraries=journeySharing
URL parameter. See Libraries in the Maps JavaScript API.
Properties | |
---|---|
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. |
name optional |
Type:
string optional 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. |
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. |
remainingVehicleJourneySegments optional |
Type:
Array<VehicleJourneySegment> optional Information about the segments left to be completed for this task. |
status optional |
Type:
string optional The current execution state of the task. |
trackingId optional |
Type:
string optional The tracking ID of the shipment. |
type optional |
Type:
string optional The task type; for example, a break or shipment. |
vehicleId optional |
Type:
string optional The ID of the vehicle performing this task. |
Trip interface
google.maps.journeySharing.Trip
interface
The details for a trip returned by Fleet Engine.
Requires the &libraries=journeySharing
URL parameter. See Libraries in the Maps JavaScript API.
Properties | |
---|---|
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. |
name optional |
Type:
string optional In the format "providers/{provider_id}/trips/{trip_id}". The trip_id must be a unique identifier. |
passengerCount optional |
Type:
number optional Number of passengers on this trip; does not include the driver. |
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. |
remainingWaypoints optional |
Type:
Array<VehicleWaypoint> optional An array of waypoints indicating the path from the current location to the drop-off point. |
status optional |
Type:
string optional 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 optional |
Type:
string optional The type of the trip. Possible values are UNKNOWN_TRIP_TYPE, SHARED or EXCLUSIVE. |
vehicleId optional |
Type:
string optional ID of the vehicle making this trip. |
DeliveryVehicle interface
google.maps.journeySharing.DeliveryVehicle
interface
The details for a delivery vehicle returned by Fleet Engine.
Requires the &libraries=journeySharing
URL parameter. See Libraries in the Maps JavaScript API.
Properties | |
---|---|
attributes |
Type:
Object<string, string optional> Custom delivery vehicle attributes. |
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. |
name optional |
Type:
string optional In the format "providers/{provider_id}/deliveryVehicles/{delivery_vehicle_id}". The delivery_vehicle_id must be a unique identifier. |
navigationStatus optional |
Type:
string optional The current navigation status of the vehicle. |
remainingDistanceMeters optional |
Type:
number optional The remaining driving distance in the current route segment, in meters. |
remainingDurationMillis optional |
Type:
number optional The remaining driving duration in the current route segment, in milliseconds. |
remainingVehicleJourneySegments optional |
Type:
Array<VehicleJourneySegment> optional The journey segments assigned to this delivery vehicle, starting from the vehicle's most recently reported location. |
VehicleJourneySegment interface
google.maps.journeySharing.VehicleJourneySegment
interface
VehicleJourneySegment type
Requires the &libraries=journeySharing
URL parameter. See Libraries in the Maps JavaScript API.
Properties | |
---|---|
distanceMeters optional |
Type:
number optional The travel distance from the previous stop to this stop, in meters. |
durationMillis optional |
Type:
number optional The travel time from the previous stop to this stop, in milliseconds. |
extraDurationMillis optional |
Type:
number optional The extra travel time due to the durations of the stop's tasks, in milliseconds. |
location optional |
Type:
LatLngLiteral optional The actual stop location. |
path optional |
Type:
Array<LatLngLiteral> optional The path from the previous stop to this stop. |
VehicleLocationUpdate interface
google.maps.journeySharing.VehicleLocationUpdate
interface
VehicleLocationUpdate type
Requires the &libraries=journeySharing
URL parameter. See Libraries in the Maps JavaScript API.
Properties | |
---|---|
heading optional |
Type:
number optional The heading of the update. 0 corresponds to north, 180 to south. |
location optional |
Type:
LatLngLiteral 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.
Requires the &libraries=journeySharing
URL parameter. See Libraries in the Maps JavaScript API.
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. |