Shipment Tracking

FleetEngineShipmentLocationProvider class

google.maps.journeySharing.FleetEngineShipmentLocationProvider class

Shipment location provider.

This class extends LocationProvider.

Requires the &libraries=journeySharing URL parameter. See Libraries in the Maps JavaScript API.

FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Parameters: 
Creates a new location provider for Fleet Engine shipment tracking.
trackingId
Type:  string
The tracking ID for the task that this location provider observes. Set this field to begin tracking.
getTask
getTask()
Parameters:  None
Return Value:  Task|null
Returns the currently tracked task.
refresh
refresh()
Parameters:  None
Return Value:  void
Explicitly refreshes the tracked location.
Inherited: addListener
error
function(event)
Arguments: 
Event that is triggered when the location provider encounters an error.
update
function(event)
Event that is triggered when a Fleet Engine data update request has finished.

FleetEngineShipmentLocationProviderOptions interface

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions interface

Options for shipment location provider.

Requires the &libraries=journeySharing URL parameter. See Libraries in the Maps JavaScript API.

authTokenFetcher
Provides JSON Web Tokens for authenticating the client to Fleet Engine.
projectId
Type:  string
The consumer's project ID from Google Cloud Console.
deliveryVehicleMarkerCustomization optional
Type:  function(ShipmentMarkerCustomizationFunctionParams): void optional
Customization function that is applied to the delivery vehicle marker.

Use this function to specify custom styling (such as marker icon) and interactivity (such as click handling). This function is invoked once when the marker is created, before it is added to the map view. (On this invocation, the isNew parameter in the function parameters object is set to true.) Additionally, this function is invoked when the location provider receives data from Fleet Engine, regardless of whether the data corresponding to this marker have changed.

See ShipmentMarkerCustomizationFunctionParams for a list of supplied parameters and their uses.

destinationMarkerCustomization optional
Type:  function(ShipmentMarkerCustomizationFunctionParams): void optional
Customization function that is applied to the destination marker.

Use this function to specify custom styling (such as marker icon) and interactivity (such as click handling). This function is invoked once when the marker is created, before it is added to the map view. (On this invocation, the isNew parameter in the function parameters object is set to true.) Additionally, this function is invoked when the location provider receives data from Fleet Engine, regardless of whether the data corresponding to this marker have changed.

See ShipmentMarkerCustomizationFunctionParams for a list of supplied parameters and their uses.

pollingIntervalMillis optional
Type:  number optional
Minimum time between fetching location updates in milliseconds. If it takes longer than pollingIntervalMillis to fetch a location update, the next location update is not started until the current one finishes.

Setting this value to 0 disables recurring location updates. A new location update is fetched if any of the parameters observed by the location provider changes.

The default polling interval is 5000 milliseconds, the minimum interval. If you set the polling interval to a lower non-zero value, 5000 is used.

trackingId optional
Type:  string optional
The tracking ID of the task to track immediately after the location provider is instantiated. If not specified, the location provider does not start tracking any task; use FleetEngineShipmentLocationProvider.trackingId to set the tracking ID and begin tracking.

FleetEngineShipmentLocationProviderUpdateEvent interface

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent interface

Event object returned by the shipment location provider's update event.

Requires the &libraries=journeySharing URL parameter. See Libraries in the Maps JavaScript API.

task optional
Type:  Task optional
The task structure returned by the update. Unmodifiable.