Configurer votre projet Android Studio

Cette page explique comment intégrer le SDK Navigation à votre projet de développement.

Ajouter le SDK Navigation à votre projet

Le SDK Navigation est disponible via le Google Maven Repository. Vous pouvez l'ajouter à votre projet à l'aide de la configuration build.gradle de Gradle ou pom.xml de Maven.

Ajoutez la dépendance suivante à votre configuration Gradle ou Maven, en remplaçant l'espace réservé VERSION_NUMBER par la version souhaitée du SDK Navigation pour Android.
Gradle
Ajoutez les éléments suivants à votre build.gradle au niveau du module :
```
dependencies {
        ...
        implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
}
```
Maven
Ajoutez les éléments suivants à votre pom.xml :
```
<dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.navigation</groupId>
    <artifactId>navigation</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
</dependencies>
```
Remarque : Si vous êtes un client Mobility Services et que vous effectuez une mise à niveau à partir du dépôt Maven privé d'origine, notez que les noms de groupe et d'artefact ont changé et que le plug-in com.google.cloud.artifactregistry.gradle-plugin n'est plus nécessaire.

Si vous avez des dépendances qui utilisent le SDK Maps, vous devez exclure la dépendance dans chaque dépendance déclarée qui s'appuie sur le SDK Maps.

Gradle

Ajoutez les éléments suivants à votre build.gradle de premier niveau :

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

Ajoutez les éléments suivants à votre 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>

Configurer la compilation

Une fois le projet créé, vous pouvez configurer les paramètres pour une compilation réussie et utiliser le SDK Navigation.

Mettre à jour les propriétés locales

Dans le dossier Gradle Scripts, ouvrez le fichier local.properties et ajoutez android.useDeprecatedNdk=true.

Mettre à jour le script de compilation Gradle

Ouvrez le fichier build.gradle (Module:app) et suivez les consignes ci-dessous pour mettre à jour les paramètres afin de répondre aux exigences du SDK Navigation. Vous pouvez également envisager de définir les options d'optimisation.

Paramètres requis pour le SDK Navigation
1. Définissez minSdkVersion sur 24 ou une version ultérieure.
2. Définissez targetSdkVersion sur 36 ou une version ultérieure.
3. Ajoutez un paramètre dexOptions qui augmente la valeur de javaMaxHeapSize.
4. Définissez l'emplacement des bibliothèques supplémentaires.
5. Ajoutez les éléments repositories et dependencies pour le SDK Navigation.
6. Remplacez les numéros de version dans les dépendances par les dernières versions disponibles.
Paramètres facultatifs pour réduire le temps de compilation
- Activez la minification du code et la minification des ressources à l'aide de R8/ProGuard pour supprimer le code et les ressources inutilisés des dépendances. Si l'exécution de l'étape R8/ProGuard prend trop de temps, envisagez d'activer multidex pour le travail de développement.
- Réduisez le nombre de traductions linguistiques incluses dans la compilation : définissez resConfigs pour une seule langue lors du développement. Pour la compilation finale, définissez resConfigs pour les langues que vous utilisez réellement. Par défaut, Gradle inclut des chaînes de ressources pour toutes les langues compatibles avec le SDK Navigation.
Ajouter la désucrification pour la prise en charge de Java 8
- Si vous compilez votre appli à l'aide du plug-in Android Gradle 4.0.0 ou version ultérieure, vous pouvez utiliser un certain nombre d'API en langage Java 8. Pour en savoir plus, consultez la section Prise en charge de la désucrification Java 8. Pour savoir comment compiler et définir les options de dépendance, consultez l'exemple d'extrait de script de compilation ci-dessous.
- Pour Android version 7.3.0 et ultérieure, vous devez utiliser Gradle 8.11.1, le plug-in Android Gradle version 8.10.0 et la bibliothèque Desugar com.android.tools:desugar_jdk_libs_nio:2.0.3.
- La bibliothèque Desugar doit être activée pour le module app et tout module qui dépend directement du SDK Navigation.

Vous trouverez ci-dessous un exemple de script de compilation Gradle pour l'application. Consultez les exemples d'applications pour obtenir des ensembles de dépendances mis à jour, car la version du SDK Navigation que vous utilisez peut être légèrement en avance ou en retard par rapport à cette 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'
}

Ajouter la clé API à votre application

Cette section explique comment stocker votre clé API pour qu'elle puisse être référencée de manière sécurisée par votre application. Vous ne devez pas enregistrer votre clé API dans votre système de contrôle des versions. Nous vous recommandons donc de la stocker dans le fichier secrets.properties, qui se trouve dans le répertoire racine de votre projet. Pour en savoir plus sur le fichier secrets.properties, consultez Fichiers de propriétés Gradle.

Pour vous faciliter la tâche, nous vous recommandons d'utiliser le plug-in Secrets Gradle pour Android.

Pour installer le plug-in Secrets Gradle pour Android et stocker votre clé API :

Dans Android Studio, ouvrez votre fichier build.gradle au niveau racine et ajoutez le code suivant à l'élément dependencies sous buildscript.

Groovy

buildscript {
    dependencies {
        // ...
        classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
    }
}

Kotlin

buildscript {
    dependencies {
        // ...
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}

Ouvrez votre fichier build.gradle au niveau de l'application et ajoutez le code suivant à l'élément plugins.

Groovy

plugins {
    id 'com.android.application'
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}

Kotlin

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

Si vous utilisez Android Studio, synchronisez votre projet avec Gradle.
Ouvrez local.properties dans votre répertoire au niveau du projet, puis ajoutez le code suivant. Remplacez YOUR_API_KEY par votre clé API.
```
MAPS_API_KEY=YOUR_API_KEY
```
Vous pouvez ajouter la clé API à votre fichier AndroidManifest.xml ou la fournir par programmatique.
- Ajoutez votre clé API à AndroidManifest.xml :
```
<meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />
        
```
  Remarque com.google.android.geo.API_KEY est le nom de métadonnées recommandé pour la clé API. Une clé portant ce nom peut être utilisée pour l'authentification auprès de diverses API basées sur Google Maps et s'exécutant sur la plate-forme Android, y compris le SDK Navigation pour Android. Pour assurer la rétrocompatibilité, l'API prend en charge également le nom com.google.android.maps.v2.API_KEY. Cet ancien nom autorise l'authentification auprès de l'API Google Maps Android v2 uniquement. Une application ne peut spécifier qu'un seul des noms de métadonnées de clé API. Si les deux noms sont spécifiés, l'API génère une exception.
- Fournissez la clé API par programmatique :
  Le plug-in Secrets Gradle rend la clé disponible dans la classe BuildConfig. Lors de l'initialisation de votre application (par exemple, dans votre méthode Application.onCreate()), appelez la méthode comme suit :
  Kotlin
  1. Ajoutez les déclarations d'importation suivantes :
    import com.google.android.libraries.navigation.NavigationApi
  2. Ajoutez les éléments suivants à votre méthode Application.onCreate() :
    NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)
  Java
  1. Ajoutez les déclarations d'importation suivantes :
    import com.google.android.libraries.navigation.NavigationApi;
  2. Ajoutez les éléments suivants à votre méthode Application.onCreate() :
    NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY);
  Remarque : Lorsque vous utilisez setApiKey(), gardez les points suivants à l'esprit :
  - Fournissez une clé API non nulle et non vide.
  - N'appelez setApiKey() qu'une seule fois pendant la durée de vie de votre application. La méthode génère une IllegalStateException si elle est appelée plus d'une fois.
  - Appelez setApiKey() avant d'initialiser d'autres composants du SDK Navigation, tels que Navigator.
  - La clé que vous fournissez avec cette méthode remplace toute clé API dans votre AndroidManifest.xml.
  - Utilisez le SDK Navigation version 7.6 ou ultérieure.

Inclure les attributions requises dans votre application

Si vous utilisez le SDK Navigation pour Android dans votre application, vous devez inclure le texte d'attribution et les licences Open Source dans la section des mentions légales de votre application.

Vous trouverez le texte d'attribution requis et les licences Open Source dans le fichier ZIP du SDK Navigation pour Android :

NOTICE.txt
LICENSES.txt

Si vous êtes client Mobility ou Fleet Engine Deliveries

Si vous êtes client Mobility ou Fleet Engine Deliveries, découvrez la facturation dans la documentation Mobility. Pour en savoir plus sur l'enregistrement des transactions, consultez Configurer la facturation, Enregistrer les transactions facturables, Créer des rapports et Enregistrer les transactions facturables (Android).

Configurer votre projet Android Studio Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Ajouter le SDK Navigation à votre projet

Gradle

Maven

Gradle

Maven

Configurer la compilation

Mettre à jour les propriétés locales

Mettre à jour le script de compilation Gradle

Ajouter la clé API à votre application

Groovy

Kotlin

Groovy

Kotlin

Kotlin

Java

Inclure les attributions requises dans votre application

Si vous êtes client Mobility ou Fleet Engine Deliveries

Configurer votre projet Android Studio