Rejoignez-nous pour notre prochain Google Maps Platform Developer Community Day à San Francisco en décembre ! Inscrivez-vous pour participer.

Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

Configurer votre projet – Version 4.99 et antérieure

Ce guide liste les exigences de configuration de compilation pour utiliser le SDK Navigation pour Android. Les instructions supposent que vous avez installé un IDE Android et que vous connaissez le développement Android.

Configuration minimale requise pour utiliser le SDK Navigation

Ces exigences s'appliquent au SDK Navigation pour Android version 4.99 et versions antérieures.

Console Google Cloud

avec le SDK Navigation activé. Pour le provisionnement, contactez votre représentant Google Maps Platform.
Votre application doit cibler le niveau d'API 30 ou supérieur.
Pour exécuter une application créée avec le SDK Navigation, les services Google Play doivent être installés et activés sur l'appareil Android.
Le texte d'attribution et de licence doit être ajouté à l'application.

Configurer vos projets : projet de la console Cloud et projet Android

Avant de pouvoir créer ou tester une application, vous devez créer un projet dans la console Cloud et ajouter des identifiants de clé API. Le projet doit être provisionné pour accéder au SDK Navigation. Toutes les clés du projet de la console Cloud bénéficient du même accès au SDK Navigation. Une clé peut être associée à plusieurs projets de développement. Si vous disposez déjà d'un projet de console, vous pouvez ajouter une clé à votre projet actuel.

Pour configurer

Dans votre navigateur Web préféré, connectez-vous à la console Cloud et créez votre projet console Cloud.
Dans votre IDE, tel qu'Android Studio, créez un projet de développement d'application Android et notez le nom du package.
Contactez votre représentant Google Maps Platform pour qu'il vous donne accès au SDK Navigation pour votre projet de la console Cloud.
Dans le tableau de bord de la console Cloud de votre navigateur Web, créez des identifiants pour générer une clé API avec des restrictions.
Sur la page Clé API, cliquez sur "Applications Android" dans la zone Restrictions relatives aux applications.
Cliquez sur Ajouter le nom du package et l'empreinte, puis saisissez le nom du package de votre projet de développement et l'empreinte SHA-1 de cette clé.
Cliquez sur Enregistrer.

Ajouter le SDK Navigation à votre projet

Le SDK Navigation est disponible via Maven ou sous forme de bundle AAR. Après avoir créé votre projet de développement, vous pouvez y intégrer le SDK en utilisant l'une des approches suivantes.

Utiliser Maven pour le SDK Navigation v4.5 et versions ultérieures (recommandé)

L'exemple suivant utilise le dépôt Maven google(), qui est le moyen le plus simple et recommandé d'ajouter le SDK Navigation à votre projet.

Ajoutez la dépendance suivante à votre configuration Gradle ou Maven, en remplaçant l'espace réservé VERSION_NUMBER par la version du SDK Navigation pour Android.

Gradle

Ajoutez le code suivant au fichier build.gradle au niveau du module :

dependencies {
...
implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
}

Si vous effectuez une mise à niveau à partir du dépôt Maven 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.

Ajoutez ensuite le code suivant à votre fichier build.gradle de premier niveau :

allprojects {
...
// Required: you must exclude the Google Play service Maps SDK from
// your transitive dependencies to make nsure 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 le code suivant à votre pom.xml :

<dependencies>
...
<dependency>
     <groupId>com.google.android.libraries.navigation</groupId>
     <artifactId>navigation</artifactId>
     <version>VERSION_NUMBER</version>
</dependency>
</dependencies>

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 repose sur le SDK Maps.

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

Utiliser Maven pour le SDK Navigation antérieur à la version 4.5 ou avec le SDK Driver

Le SDK Navigation reste disponible via le dépôt Maven d'origine pour le reste des versions v4. Il s'agit de la même bibliothèque, avec les mêmes mises à jour que la version ci-dessus. Elle assure la compatibilité avec le SDK Driver et d'autres bibliothèques pendant la transition. Pour utiliser cette dépendance, vous devez vous connecter à votre projet cloud à l'aide de gcloud lors de la compilation.

Configurez votre environnement pour accéder au dépôt Maven de Google, comme décrit dans la section Prérequis de la documentation du SDK Consumer. L'accès au SDK Navigation est contrôlé par un groupe Workspace.

Ajoutez la dépendance suivante à votre configuration Gradle ou Maven, en remplaçant l'espace réservé VERSION_NUMBER par la version du SDK Navigation.

Gradle

Ajoutez le code suivant au fichier build.gradle au niveau du module :

dependencies {
...
implementation 'com.google.android.maps:navsdk:VERSION_NUMBER'
}

Ajoutez ensuite le code suivant à votre fichier 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 le code suivant à votre pom.xml :

<dependencies>
...
<dependency>
     <groupId>com.google.android.maps</groupId>
     <artifactId>navsdk</artifactId>
     <version>VERSION_NUMBER</version>
</dependency>
</dependencies>

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 repose sur le SDK Maps.

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

Utiliser un bundle AAR téléchargé (non recommandé)

Le SDK Navigation est également disponible sous forme de bundle AAR. Après avoir créé le projet de développement, vous pouvez intégrer le SDK. Ces instructions supposent que vous utilisez Android Studio comme IDE.

Téléchargez la dernière version du SDK Navigation depuis le Google Drive partagé et extrayez-la. Si vous n'y avez pas accès, contactez votre représentant.
Dans Android Studio, ouvrez un projet et ajoutez le package services Google Play à l'aide de SDK Manager.
À partir du répertoire du fichier ZIP, copiez libs/google_navigation_navmap.aar dans le répertoire app/libs de votre projet.

Ajoutez le code suivant au fichier build.gradle au niveau du module :

implementation(name: 'google_navigation_navmap', ext: 'aar')

Ajoutez ensuite le code suivant à votre fichier 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'
       }
   }
}

Configurer la compilation

Une fois le projet créé, vous pouvez configurer les paramètres pour réussir la compilation et l'utilisation du 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. Envisagez également de définir les options d'optimisation.

Paramètres requis pour le SDK Navigation
1. Définissez minSdkVersion sur 23 ou plus.
2. Définissez targetSdkVersion sur 30 ou plus.
3. Ajoutez un paramètre dexOptions qui augmente la valeur de javaMaxHeapSize.
4. Définissez l'emplacement des bibliothèques supplémentaires.
5. Ajoutez repositories et dependencies pour le SDK Navigation.
6. Remplacez les numéros de version des dépendances par les dernières versions disponibles.
Paramètres facultatifs pour réduire le temps de compilation
- Activez la minification de code et la réduction des ressources à l'aide de R8/ProGuard pour supprimer le code et les ressources inutilisés des dépendances. Si l'étape R8/ProGuard prend trop de temps, envisagez d'activer multidex pour le travail de développement.
- Réduisez le nombre de traductions incluses dans la compilation : définissez resConfigs pour une langue pendant le 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.

Vous trouverez ci-dessous un exemple de script de compilation Gradle pour l'application. Consultez les applications exemples 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'
apply plugin: 'com.google.cloud.artifactregistry.gradle-plugin'

ext {
    androidxVersion = "1.0.0"
    lifecycle_version = "1.1.1"
}

android {
    compileSdkVersion 30
    buildToolsVersion '28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 30
        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 {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

// This tells Gradle where to look to find additional libraries - in this case, the
// google_navigation_navmap.aar file.
repositories {
    flatDir {
        dirs 'libs'
    }
    google()

    // Required for accessing the Navigation SDK on Google's Maven repository.
    maven {
        url "artifactregistry://us-west2-maven.pkg.dev/gmp-artifacts/transportation"
    }
}

dependencies {
    // Include the Google Navigation SDK
    implementation 'com.google.android.maps:navsdk:4.4.0'

    // The included AAR file under libs can be used instead of the Maven repository.
    // Uncomment the line below and comment out the previous dependency to use
    // the AAR file instead. Make sure that you add the AAR file to the libs directory.
    // implementation(name: 'google_navigation_navmap', ext: 'aar')

    // These dependencies are required for the Navigation SDK to function
    // properly at runtime.
    implementation 'org.chromium.net:cronet-fallback:69.3497.100'
    // Optional for Cronet users:
    // implementation 'org.chromium.net:cronet-api:69.3497.100'
    implementation 'androidx.appcompat:appcompat:${androidxVersion}'
    implementation 'androidx.cardview:cardview:${androidxVersion}'
    implementation 'com.google.android.material:material:${androidxVersion}'
    implementation 'androidx.mediarouter:mediarouter:${androidxVersion}'
    implementation 'androidx.preference:preference:${androidxVersion}'
    implementation 'androidx.recyclerview:recyclerview:${androidxVersion}'
    implementation 'androidx.legacy:legacy-support-v4:${androidxVersion}'
    implementation 'com.github.bumptech.glide:glide:4.9.0'
    implementation 'com.github.bumptech.glide:okhttp-integration:4.9.0'
    implementation 'android.arch.lifecycle:common-java8:$lifecycle_version'
    implementation 'com.android.support:multidex:1.0.3'
    implementation 'com.google.android.datatransport:transport-api:2.2.0'
    implementation 'com.google.android.datatransport:transport-backend-cct:2.2.0'
    implementation 'com.google.android.datatransport:transport-runtime:2.2.0'
    implementation 'joda-time:joda-time:2.9.9'
    annotationProcessor 'androidx.annotation:annotation:1.1.0'
    annotationProcessor 'com.github.bumptech.glide:compiler:4.9.0'
}

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 un fichier secrets.properties situé dans le répertoire racine de votre projet et d'exclure ce fichier du contrôle des versions. Pour en savoir plus sur les fichiers de propriétés Gradle, 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.kts ou build.gradle de premier niveau et ajoutez le code suivant au bloc plugins.

Kotlin

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

Groovy

plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
}

Ouvrez le fichier build.gradle.kts ou build.gradle au niveau du module et ajoutez le code suivant à l'élément plugins.

Kotlin

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

Groovy

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 le fichier secrets.properties dans votre répertoire de premier niveau et ajoutez le code suivant. Remplacez YOUR_API_KEY par votre clé API. Veillez à ajouter secrets.properties à votre fichier .gitignore (ou à l'exclure de votre système de contrôle des versions) afin de ne pas enregistrer votre clé API dans le contrôle des versions.
Remarque : Si le fichier secrets.properties n'existe pas, créez-le dans le même dossier que le fichier local.properties.
```
MAPS_API_KEY=YOUR_API_KEY
```
Créez le fichier local.defaults.properties dans votre répertoire de premier niveau (même dossier que le fichier secrets.properties), puis ajoutez le code suivant.

Remarque : Saisissez le code comme indiqué. Ne remplacez pas DEFAULT_API_KEY par votre clé API.
```
MAPS_API_KEY=DEFAULT_API_KEY
```
Ce fichier a pour but de fournir un emplacement de sauvegarde de la clé API, à utiliser si le fichier secrets.properties est introuvable pour éviter l'échec des créations. Cette situation peut se produire si vous clonez l'application à partir d'un système de contrôle des versions qui omet secrets.properties et que vous n'avez pas encore créé de fichier secrets.properties localement pour fournir votre clé API.
Vous pouvez ajouter la clé API à votre fichier AndroidManifest.xml ou la fournir de manière 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 accepte é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 de manière 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 instructions d'importation suivantes :
    import com.google.android.libraries.navigation.NavigationApi
  2. Ajoutez ce qui suit à votre méthode Application.onCreate() :
    NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)
  Java
  1. Ajoutez les instructions 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(), tenez compte des points suivants :
  - 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 renvoie IllegalStateException si elle est appelée plusieurs 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 de votre AndroidManifest.xml.
  - Utilisez le SDK Navigation version 7.6 ou ultérieure.

Dans Android Studio, ouvrez votre fichier build.gradle.kts ou build.gradle au niveau du module et modifiez la propriété secrets. Si la propriété secrets n'existe pas, ajoutez-la.

Modifiez les propriétés du plug-in pour définir propertiesFileName sur "secrets.properties", defaultPropertiesFileName sur "local.defaults.properties" et toutes les autres propriétés.

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

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"
}

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 et les licences Open Source requis dans le fichier ZIP du SDK Navigation pour Android :

NOTICE.txt
LICENSES.txt

Configurer votre projet – Version 4.99 et antérieure Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Configuration minimale requise pour utiliser le SDK Navigation

Configurer vos projets : projet de la console Cloud et projet Android

Ajouter le SDK Navigation à votre projet

Utiliser Maven pour le SDK Navigation v4.5 et versions ultérieures (recommandé)

Gradle

Maven

Utiliser Maven pour le SDK Navigation antérieur à la version 4.5 ou avec le SDK Driver

Gradle

Maven

Utiliser un bundle AAR téléchargé (non recommandé)

Configurer la compilation

Mettre à jour les propriétés locales

Mettre à jour le script de compilation Gradle

Ajouter la clé API à votre application

Kotlin

Groovy

Kotlin

Groovy

Kotlin

Java

Kotlin

Groovy

Inclure les attributions requises dans votre application

Configurer votre projet – Version 4.99 et antérieure