Consumer SDK scheduled tasks overview
Stay organized with collections
Save and categorize content based on your preferences.
Tailor the consumer experience for scheduled tasks by allowing consumers to
follow the progress of their scheduled deliveries or service orders.
What is the Consumer SDK for scheduled tasks?
The Consumer SDK is a feature of Fleet Engine for scheduled tasks that also
includes toolkits to create the consumer experience. These toolkits let you
create map-based displays to visualize a driver's
progress and show the status of the task associated with a scheduled stop. It's
designed for two primary audiences:
- Consumer end users who want to know delivery status for an individual
shipment order. This document covers how to implement that
consumer experience with the Consumer SDK in JavaScript, which provides the
FleetEngineShipmentLocationProvider class and associated interfaces.
- Fleet operators who want to track the delivery and vehicle status for an
entire fleet of vehicles. For information about tracking fleets, see the
Fleet tracking guide.
Why use the Consumer SDK for scheduled tasks?
Integrating the Consumer SDK into your scheduled tasks consumer applications
lets you provide a comprehensive consumer experience, with near real-time
location updates and road-snapped positions. Your consumers can see the delivery
vehicle's location and progress details that help them understand where their
shipment is.
What can you do with the Consumer SDK?
Use the Consumer SDK to share the following shipment information with your
consumers:
- Delivery vehicle's real-time position on a map.
- ETA for package arrival, adjusted for changing circumstances, such as
traffic.
- Route the vehicle is taking.
- Distance and number of stops remaining before their shipment is delivered.
You can also create other seamless geo-enabled consumer experiences inside your
consumer app or website based on location information from the Driver SDK. For
details about the Driver SDK, see the
Driver SDK scheduled tasks overview.
Consumer SDK components
The JavaScript Consumer SDK contains the following components:
- A JavaScript map component that is a drop-in replacement for a standard
google.maps.Map entity.
- Data components to connect with Fleet Engine.
- Components for visualization of the vehicle and route as it progresses to a
destination.
- Raw data feeds for a driver's ETA or the remaining distance to drive.
The following table describes the components.
| Component |
Description |
| Map view |
The map view illustrates the progress of
the vehicle, updating the view as the vehicle moves along its route. |
| Shipment location provider |
The shipment tracking provider provides a location feed so that
the map can display useful information about the shipment, such as the pickup
or delivery location of the shipment and the location and route
of the delivery vehicle.
|
| Authentication token fetcher |
The authentication token fetcher gets JSON Web Tokens (JWTs) from your
backend server to authenticate access to the location data stored in Fleet
Engine. You implement an authentication token fetcher as part of your web
application using the JavaScript Journey Sharing Library. Note that you must
also implement a JSON Web Token (JWT) creation service for Fleet Engine on your
backend server. |
| Map style options |
You can use custom styling options to change the default styling of your
map to match the styling of your web application. |
How to use the Consumer SDK
What's next
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-18 UTC."],[[["\u003cp\u003eThe Consumer SDK enables businesses to provide customers with real-time visibility into the location and progress of their scheduled deliveries or service orders.\u003c/p\u003e\n"],["\u003cp\u003eThis SDK offers tools for creating map-based displays within consumer applications, showing the driver's location, estimated time of arrival, and route information.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can integrate the Consumer SDK to create a comprehensive and seamless delivery tracking experience for their customers, improving transparency and satisfaction.\u003c/p\u003e\n"],["\u003cp\u003eKey components of the SDK include a map view, a location provider, authentication mechanisms, and customizable styling options to tailor the experience.\u003c/p\u003e\n"],["\u003cp\u003eTo begin, developers need to set up the JavaScript Consumer SDK, follow a specific shipment for tracking, and customize the map interface as desired.\u003c/p\u003e\n"]]],[],null,["Tailor the consumer experience for scheduled tasks by allowing consumers to\nfollow the progress of their scheduled deliveries or service orders.\n\nWhat is the Consumer SDK for scheduled tasks?\n\nThe Consumer SDK is a feature of Fleet Engine for scheduled tasks that also\nincludes toolkits to create the consumer experience. These toolkits let you\ncreate map-based displays to visualize a driver's\nprogress and show the status of the task associated with a scheduled stop. It's\ndesigned for two primary audiences:\n\n- **Consumer end users** who want to know delivery status for an individual shipment order. This document covers how to implement that consumer experience with the Consumer SDK in JavaScript, which provides the `FleetEngineShipmentLocationProvider` class and associated interfaces.\n- **Fleet operators** who want to track the delivery and vehicle status for an entire fleet of vehicles. For information about tracking fleets, see the [Fleet tracking guide](/maps/documentation/mobility/operations/fleet-tracking).\n\nWhy use the Consumer SDK for scheduled tasks?\n\nIntegrating the Consumer SDK into your scheduled tasks consumer applications\nlets you provide a comprehensive consumer experience, with near real-time\nlocation updates and road-snapped positions. Your consumers can see the delivery\nvehicle's location and progress details that help them understand where their\nshipment is.\n\nWhat can you do with the Consumer SDK?\n\nUse the Consumer SDK to share the following shipment information with your\nconsumers:\n\n- Delivery vehicle's real-time position on a map.\n- ETA for package arrival, adjusted for changing circumstances, such as traffic.\n- Route the vehicle is taking.\n- Distance and number of stops remaining before their shipment is delivered.\n\nYou can also create other seamless geo-enabled consumer experiences inside your\nconsumer app or website based on location information from the Driver SDK. For\ndetails about the Driver SDK, see the\n[Driver SDK scheduled tasks overview](/maps/documentation/mobility/driver-sdk/scheduled).\n\nConsumer SDK components\n\nThe JavaScript Consumer SDK contains the following components:\n\n- A JavaScript map component that is a drop-in replacement for a standard `google.maps.Map` entity.\n- Data components to connect with Fleet Engine.\n- Components for visualization of the vehicle and route as it progresses to a destination.\n- Raw data feeds for a driver's ETA or the remaining distance to drive.\n\nThe following table describes the components.\n\n| Component | Description |\n|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Map view | The map view illustrates the progress of the vehicle, updating the view as the vehicle moves along its route. |\n| Shipment location provider | The shipment tracking provider provides a location feed so that the map can display useful information about the shipment, such as the pickup or delivery location of the shipment and the location and route of the delivery vehicle. |\n| Authentication token fetcher | The authentication token fetcher gets JSON Web Tokens (JWTs) from your backend server to authenticate access to the location data stored in Fleet Engine. You implement an authentication token fetcher as part of your web application using the JavaScript Journey Sharing Library. Note that you must also implement a JSON Web Token (JWT) creation service for Fleet Engine on your backend server. |\n| Map style options | You can use custom styling options to change the default styling of your map to match the styling of your web application. |\n\nHow to use the Consumer SDK\n\n|---|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1 | **Set up the JavaScript Consumer SDK** | For more information, see [Set up the JavaScript Consumer SDK](/maps/documentation/mobility/journey-sharing/scheduled/shipment-tracking/setup). |\n| 2 | **Follow a shipment** | Learn how to initialize the map, start following a shipment, and stop following with appropriate clean up. See [Follow a shipment](/maps/documentation/mobility/journey-sharing/scheduled/shipment-tracking/follow). |\n| 3 | **Customize the map interface** | You can use the JavaScript Consumer SDK for scheduled tasks to customize the map interface, provide marker customization, or style polylines. See [Style a map](/maps/documentation/mobility/journey-sharing/scheduled/shipment-tracking/style-map), [Customize markers](/maps/documentation/mobility/journey-sharing/scheduled/shipment-tracking/customize-markers), and [Customize polylines](/maps/documentation/mobility/journey-sharing/scheduled/shipment-tracking/customize-polylines). |\n\nWhat's next\n\n- [Set up the JavaScript Consumer SDK](/maps/documentation/mobility/journey-sharing/scheduled/shipment-tracking/setup)"]]
