This page explains how to integrate the Navigation SDK into your development project.
Add the Navigation SDK to your project
The Navigation SDK is available through the Google
Maven
Repository.
You can add the SDK to your project using either your Gradle build.gradle
or
Maven pom.xml
configuration.
Add the following dependency to your Gradle or Maven configuration, substituting the
VERSION_NUMBER
placeholder for the desired version of Navigation SDK for Android.Gradle
Add the following to your module-level
build.gradle
:dependencies { ... implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER' }
Maven
Add the following to your
pom.xml
:<dependencies> ... <dependency> <groupId>com.google.android.libraries.navigation</groupId> <artifactId>navigation</artifactId> <version>VERSION_NUMBER</version> </dependency> </dependencies>
If you have any dependencies that use the Maps SDK, you have to exclude the dependency in each declared dependency that relies on the Maps SDK.
Gradle
Add the following to your top-level
build.gradle
:allprojects { ... // Required: you must exclude the Google Play service Maps SDK from // your transitive dependencies. This is to ensure there won't be // multiple copies of Google Maps SDK in your binary, as the Navigation // SDK already bundles the Google Maps SDK. configurations { implementation { exclude group: 'com.google.android.gms', module: 'play-services-maps' } } }
Maven
Add the following to your
pom.xml
:<dependencies> <dependency> <groupId>project.that.brings.in.maps</groupId> <artifactId>MapsConsumer</artifactId> <version>1.0</version> <exclusions> <!-- Navigation SDK already bundles Maps SDK. You must exclude it to prevent duplication--> <exclusion> <!-- declare the exclusion here --> <groupId>com.google.android.gms</groupId> <artifactId>play-services-maps</artifactId> </exclusion> </exclusions> </dependency> </dependencies>
Configure the build
After you have created the project, you can configure the settings for a successful build and use of the Navigation SDK.
Update local properties
- In the Gradle Scripts folder, open the
local.properties
file and addandroid.useDeprecatedNdk=true
.
Update gradle properties
In the Gradle Scripts folder, open the
gradle.properties
file and add the following if they are not already present:android.useAndroidX=true
android.enableJetifier=true
Update the Gradle build script
Open the
build.gradle (Module:app)
file and use the following guidelines to update the settings to meet the requirements for Navigation SDK and consider setting the optimization options as well.Required settings for Navigation SDK
- Set
minSdkVersion
to 23 or higher. - Set
targetSdkVersion
to 34 or higher. - Add a
dexOptions
setting that increases thejavaMaxHeapSize
. - Set the location for additional libraries.
- Add the
repositories
anddependencies
for the Navigation SDK. - Replace the version numbers in the dependencies with the latest available versions.
Optional settings to decrease build time
- Enable code shrinking and resource shrinking using R8/ProGuard to remove unused code and resources from dependencies. If the R8/ProGuard step takes too much time to run, consider enabling multidex for development work.
- Reduce the number of language translations included in the build: Set
resConfigs
for one language during development. For the final build, setresConfigs
for languages you actually use. By default, Gradle includes resource strings for all languages supported by the Navigation SDK.
Add desugaring for Java8 support
- If you're building your app using the Android Gradle plugin 4.0.0 or higher, the plugin extends support for using a number of Java 8 language APIs. See Java 8 desugaring support for more information. See the example build script snippet below for how compile and dependency options.
- We recommend using Gradle 8.4, the Android Gradle plugin version
8.3.0, and the Desugar library
com.android.tools:desugar_jdk_libs_nio:2.0.3
. This setup is compatible with the Navigation SDK for Android version 6.0.0 and higher. - The Desugar library needs to be enabled for the
app
module and any module that directly depends on the Navigation SDK.
- Set
Below is an example of the Gradle build script for the application. Check the sample apps for updated sets of dependencies, as the version of Navigation SDK you are using may be slightly ahead or behind this documentation.
apply plugin: 'com.android.application'
ext {
navSdk = "__NAVSDK_VERSION__"
}
android {
compileSdk 33
buildToolsVersion='28.0.3'
defaultConfig {
applicationId "<your id>"
// Navigation SDK supports SDK 23 and later.
minSdkVersion 23
targetSdkVersion 34
versionCode 1
versionName "1.0"
// Set this to the languages you actually use, otherwise you'll include resource strings
// for all languages supported by the Navigation SDK.
resConfigs "en"
multiDexEnabled true
}
dexOptions {
// This increases the amount of memory available to the dexer. This is required to build
// apps using the Navigation SDK.
javaMaxHeapSize "4g"
}
buildTypes {
// Run ProGuard. Note that the Navigation SDK includes its own ProGuard configuration.
// The configuration is included transitively by depending on the Navigation SDK.
// If the ProGuard step takes too long, consider enabling multidex for development work
// instead.
all {
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
compileOptions {
// Flag to enable support for the new language APIs
coreLibraryDesugaringEnabled true
// Sets Java compatibility to Java 8
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
repositories {
// Navigation SDK for Android and other libraries are hosted on Google's Maven repository.
google()
}
dependencies {
// Include the Google Navigation SDK.
// Note: remember to exclude Google Play service Maps SDK from your transitive
// dependencies to avoid duplicate copies of the Google Maps SDK.
api "com.google.android.libraries.navigation:navigation:${navSdk}"
// Declare other dependencies for your app here.
annotationProcessor "androidx.annotation:annotation:1.7.0"
coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs_nio:2.0.3'
}
Add the API key to your app
This section describes how to store your API key so that it can be securely referenced by
your app. You should not check your API key into your version control system, so we recommend
storing it in the secrets.properties
file, which is located in the root directory of your
project. For more information about the secrets.properties
file, see
Gradle properties files.
To streamline this task, we recommend that you use the Secrets Gradle Plugin for Android.
To install the Secrets Gradle Plugin for Android in your Google Maps project:
-
In Android Studio, open your top-level
build.gradle.kts
orbuild.gradle
file and add the following code to thedependencies
element underbuildscript
.Kotlin
buildscript { dependencies { classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1") } }
Groovy
buildscript { dependencies { classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1" } }
-
Open your module-level
build.gradle.kts
orbuild.gradle
file and add the following code to theplugins
element.Kotlin
plugins { // ... id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
Groovy
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
- In your module-level
build.gradle.kts
orbuild.gradle
file, ensure thattargetSdk
andcompileSdk
are set to 34. - Save the file and sync your project with Gradle.
-
Open the
secrets.properties
file in your top-level directory, and then add the following code. ReplaceYOUR_API_KEY
with your API key. Store your key in this file becausesecrets.properties
is excluded from being checked into a version control system.NAV_API_KEY=YOUR_API_KEY
- Save the file.
-
Create the
local.defaults.properties
file in your top-level directory, the same folder as thesecrets.properties
file, and then add the following code.NAV_API_KEY=DEFAULT_API_KEY
The purpose of this file is to provide a backup location for the API key if the
secrets.properties
file is not found so that builds don't fail. This can happen if you clone the app from a version control system which omitssecrets.properties
and you have not yet created asecrets.properties
file locally to provide your API key. - Save the file.
-
In your
AndroidManifest.xml
file, go tocom.google.android.geo.API_KEY
and update theandroid:value attribute
. If the<meta-data>
tag does not exist, create it as a child of the<application>
tag.<meta-data android:name="com.google.android.geo.API_KEY" android:value="${MAPS_API_KEY}" />
Note:
com.google.android.geo.API_KEY
is the recommended metadata name for the API key. A key with this name can be used to authenticate to multiple Google Maps-based APIs on the Android platform, including the Navigation SDK for Android. For backwards compatibility, the API also supports the namecom.google.android.maps.v2.API_KEY
. This legacy name allows authentication to the Android Maps API v2 only. An application can specify only one of the API key metadata names. If both are specified, the API throws an exception. -
In Android Studio, open your module-level
build.gradle.kts
orbuild.gradle
file and edit thesecrets
property. If thesecrets
property does not exist, add it.Edit the properties of the plugin to set
propertiesFileName
tosecrets.properties
, setdefaultPropertiesFileName
tolocal.defaults.properties
, and set any other properties.Kotlin
secrets { // To add your Maps API key to this project: // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file. // 2. Add this line, where YOUR_API_KEY is your API key: // MAPS_API_KEY=YOUR_API_KEY propertiesFileName = "secrets.properties" // A properties file containing default secret values. This file can be // checked in version control. defaultPropertiesFileName = "local.defaults.properties" // Configure which keys should be ignored by the plugin by providing regular expressions. // "sdk.dir" is ignored by default. ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore" ignoreList.add("sdk.*") // Ignore all keys matching the regexp "sdk.*" }
Groovy
secrets { // To add your Maps API key to this project: // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file. // 2. Add this line, where YOUR_API_KEY is your API key: // MAPS_API_KEY=YOUR_API_KEY propertiesFileName = "secrets.properties" // A properties file containing default secret values. This file can be // checked in version control. defaultPropertiesFileName = "local.defaults.properties" // Configure which keys should be ignored by the plugin by providing regular expressions. // "sdk.dir" is ignored by default. ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore" ignoreList.add("sdk.*") // Ignore all keys matching the regexp "sdk.*" }
Include the required attributions in your app
If you use the Navigation SDK for Android in your app, you must include attribution text and open source licenses as part of your app's legal notices section.
You can find the required attribution text and open source licenses in the Navigation SDK for Android zip file:
NOTICE.txt
LICENSES.txt
If you are a Mobility or Fleet Engine Deliveries customer
If you are a Mobility or Fleet Engine Deliveries customer, learn about billing in the Mobility documentation. For more information about recording transactions, see Set up billing, Record billable transactions, Reporting, and Record billable transactions (Android).