Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring Google Maps API

Updated on May 18, 2021

Pega Field Service uses the Google Maps API to create locations, present map information, calculate drive time, and enable route optimization of daily and weekly trip schedules.

Before you begin:

Before using the Google Maps API, enter a Google license key in the Pega Field Service Admin portal settings, and then configure it. Google Maps API is licensed separately and is not included as part of the Pega Field Service application. A license must be procured from Google or an authorized Google reseller. For more information on registering and acquiring the license key, visit the Google Maps API page.

When you receive your key, follow these steps to configure and use Google Maps:

  1. Log in by using an administrator account. Dev Studio opens.

  2. Click LaunchField Service Admin portal.

  3. In the navigation pane, click Settings.

  4. To update or add the Google API key, in the Google Maps API field enter the license key values that you received.

    The following table lists the APIs that are used in the Pega Field Service application.
    Note: If an API key is configured with any restrictions under the Application restrictions type, you cannot use it for both the JavaScript API (Maps JavaScript API and Directions API) and server-side APIs (Geocoding API, Time Zone API, and Distance Matrix API). In addition, the API Documentation URL links and Connect REST URL links are subject to change.
    Google APIPortalUsageAPI DocumentationConnect REST URL
    Geocoding APIAdmin and DispatcherCaptures the latitude and longitude values for a given address. For example, the latitude and longitude of a customer location and a field worker’s address in the Admin portal.Geocoding API DocumentationGeocode API
    Time Zone APIAdminCaptures the time zone for a given address. For example, the time zone of a customer location and a field worker’s address.Timezone API DocumentationTimezone API
    Distance Matrix APIDispatcher and Interaction portalCaptures the distance and drive time for two or more locations.Distance Matrix API DocumentationDistance Matrix API
    Maps JavaScript APIDispatcher portalDisplays custom maps.Maps JavaScript API DocumentationJavaScript API
    Directions APIDispatcher portalCalculates optimized and unoptimized trip routes, captures directions between multiple locations, and renders the route directions on the custom map for a given set of locations.
    Note: This is used only for daily and weekly trip scheduling.
    Directions API DocumentationJavaScript API

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us