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](https://maven.google.com/web/index.html?q=navigation#com.google.android.libraries.navigation:navigation).
You can add the SDK to your project using either your Gradle `build.gradle` or
Maven `pom.xml` configuration.

> [!NOTE]
> **Note:** This method is incompatible with some libraries that depend on Navigation SDK through the prior artifact ID. This includes releases of the Driver SDK v4.4 or earlier.

1. 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>

   > [!NOTE]
   > **Note:** If you are a Mobility Services customer upgrading from the original private Maven repository, note that the group and artifact names have changed, and the `com.google.cloud.artifactregistry.gradle-plugin` plugin is no longer necessary.

2. 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 to make sure 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 add `android.useDeprecatedNdk=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**
  1. Set `minSdkVersion` to 24 or higher.
  2. Set `targetSdkVersion` to 36 or higher.
  3. Add a `dexOptions` setting that increases the `javaMaxHeapSize`.
  4. Set the location for additional libraries.
  5. Add the `repositories` and `dependencies` for the Navigation SDK.
  6. Replace the version numbers in the dependencies with the latest available versions.

  **Optional settings to decrease build time**
  - Enable [code shrinking and resource shrinking](https://developer.android.com/studio/build/shrink-code.html) 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](https://developer.android.com/studio/build/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, set `resConfigs` 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](https://developer.android.com/studio/write/java8-support#library-desugaring) for more information. See the example build script snippet below for how compile and dependency options.
  - Use the Gradle, Android Gradle plugin (AGP), and Desugar library versions that match your Navigation SDK version. See the following table.
  - The Desugar library needs to be enabled for the `app` module and any module that directly depends on the Navigation SDK.

The following table lists the Gradle, AGP, and Desugar library versions
required for each Navigation SDK version.

| Navigation SDK version | Gradle version | AGP version | Desugar library |
|---|---|---|---|
| 8.0.0 and higher | 9.1.0 | 9.0.1 | `com.android.tools:desugar_jdk_libs_nio:2.1.5` |
| 7.7.0 to 7.9.0 | 8.13 | 8.13.2 | `com.android.tools:desugar_jdk_libs_nio:2.1.5` |
| 7.3.0 to 7.6.0 | 8.11.1 | 8.10.0 | `com.android.tools:desugar_jdk_libs_nio:2.0.3` |

Below is an example of the Gradle build script for the application. Check the
[sample apps](https://developers.google.com/maps/documentation/navigation/android-sdk/try-demo) 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.1.5'
    }

### 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 shouldn't check your API key into your version
control system, so we recommend storing it in a
`secrets.properties` file in the root directory of your project and
excluding that file from version control. For more information about Gradle
properties files, see
[Gradle properties files](https://developer.android.com/studio/build#properties-files).

To simplify this task, we recommend that you use the
[Secrets Gradle Plugin for Android](https://github.com/google/secrets-gradle-plugin).

To install the Secrets Gradle Plugin for Android and store your API key:

1. In Android Studio, open your top-level `build.gradle.kts` or `build.gradle` file and add the following code to the `plugins` block.

   ### Kotlin

   ```kotlin
   plugins {
       // ...
       id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") version "2.0.1" apply false
   }
   ```

   ### Groovy

   ```groovy
   plugins {
       // ...
       id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
   }
   ```
2. Open your module-level `build.gradle.kts` or `build.gradle` file and add the following code to the `plugins` element.

   ### Kotlin

   ```kotlin
   plugins {
       id("com.android.application")
       // ...
       id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
   }
   ```

   ### Groovy

   ```groovy
   plugins {
       id 'com.android.application'
       // ...
       id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
   }
   ```
3. If you use Android Studio, [sync your
   project with Gradle](https://developer.android.com/studio/build#sync-files).
4. Open the `secrets.properties` file in your top-level directory, and then add the following code. Replace `YOUR_API_KEY` with your API key. Make sure to add `secrets.properties` to your `.gitignore` file (or otherwise exclude it from your version control system) so that you don't check your API key into version control.

   > [!NOTE]
   > **Note:** If the `secrets.properties` file doesn't exist, create it in the same folder as the `local.properties` file.

   ```
   MAPS_API_KEY=YOUR_API_KEY
   ```
5. Create the `local.defaults.properties` file in your top-level
   directory, the same folder as the `secrets.properties` file, and
   then add the following code.

   > [!NOTE]
   > **Note:** Enter the code as shown. Don't replace `DEFAULT_API_KEY` with your API key.

   ```
   MAPS_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 isn't found so that builds
   don't fail. This can happen if you clone the app from a version control
   system that omits `secrets.properties` and you haven't yet
   created a `secrets.properties` file locally to provide your API
   key.
6. You can either add the API key to your `AndroidManifest.xml` file or provide the API key programmatically.
   - Add your API key to `AndroidManifest.xml`:

     ```html
     <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 name `com.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.
   - Provide the API key programmatically: The Secrets Gradle Plugin makes the key available in the `BuildConfig` class.
     In your app's initialization (for example, in your `Application.onCreate()` method),
     call the method as follows:

     ### Kotlin

     1. Add the following import statements:

        ```kotlin
        import com.google.android.libraries.navigation.NavigationApi
        ```
     2. Add the following to your `Application.onCreate()` method:

        ```kotlin
        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)
        ```

     ### Java

     1. Add the following import statements:

        ```java
        import com.google.android.libraries.navigation.NavigationApi;
        ```
     2. Add the following to your `Application.onCreate()` method:

        ```java
        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY);
        ```
     **Note:** When using `setApiKey()`, keep the following in mind:
     - Provide a non-null, non-empty API key.
     - Call `setApiKey()` only once during your application's lifetime. The method throws an `IllegalStateException` if called more than once.
     - Call `setApiKey()` before initializing any other Navigation SDK components, such as `Navigator`.
     - The key you provide with this method overrides any API key in your `AndroidManifest.xml`.
     - Use Navigation SDK version 7.6 or higher.
7. In Android Studio, open your module-level `build.gradle.kts`
   or `build.gradle` file and edit the `secrets`
   property. If the `secrets` property doesn't exist, add it.

   Edit the properties of the plugin to set `propertiesFileName`
   to `"secrets.properties"`, set
   `defaultPropertiesFileName` to
   `"local.defaults.properties"`, and set any other properties.

   ### Kotlin

   ```kotlin
   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root 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"
   }
   ```

   ### Groovy

   ```groovy
   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root 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"
   }
   ```

## 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.
Key point: To include the attributions, add them as an independent menu item
or an item on an About menu.

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](https://developers.google.com/maps/documentation/transportation-logistics-terms/mobility/set-up-billing),
[Record billable transactions](https://developers.google.com/maps/documentation/transportation-logistics-terms/mobility/set-up-billing#billable transactions),
[Reporting](https://developers.google.com/maps/documentation/transportation-logistics-terms/mobility/reporting-requirements), and
[Record billable transactions (Android)](https://developers.google.com/maps/documentation/transportation-logistics-terms/mobility/associate-service-usage#record-trans-android).

### Manual dependencies (non-Gradle/Maven)

If your build system does not resolve transitive dependencies (such as Bazel), or if you integrate the AAR manually, you must add these dependencies to your project. Gradle and Maven resolve them automatically.

- `androidx.datastore:datastore-core`
- `androidx.datastore:datastore-guava`
- `com.google.guava:listenablefuture`
- `androidx.concurrent:concurrent-futures`