Le SDK Navigation n'est actuellement disponible que pour certains clients. Pour en savoir plus, contactez le service commercial.

De nouveaux styles de carte seront bientôt disponibles dans Google Maps Platform. Cette mise à jour du style de carte comprend une nouvelle palette de couleurs par défaut, ainsi que des améliorations apportées à l'expérience utilisateur et à la facilité d'utilisation des cartes. Tous les styles de carte seront automatiquement mis à jour en mars 2025. Pour en savoir plus sur la disponibilité et découvrir comment l'activer plus tôt, consultez Nouveau style de carte pour Google Maps Platform.

Cette page a été traduite par l'API Cloud Translation.

Configurer votre projet

Ce guide liste les exigences de configuration de compilation pour l'utilisation du SDK Navigation pour Android 5.0.0 et versions ultérieures.

Ces 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 5.0.0 et versions ultérieures.

Un projet de console Google Cloud avec le SDK Navigation activé Pour le provisionnement, contactez votre représentant Google Maps Platform.
Votre application doit spécifier les versions d'Android suivantes:
- La version cible doit être Android 13 (niveau d'API 33) ou une version ultérieure.
- La version minimale doit être Android 6 (niveau d'API 23) ou une version ultérieure.
Pour exécuter une application créée avec le SDK Navigation, l'appareil Android doit disposer de la configuration suivante:
- Services Google Play installés et activés
- 2 Go de RAM ou plus.
- Compatibilité avec OpenGL ES 2.0 Consultez la documentation sur la compatibilité Android 6.0 Open Source pour en savoir plus sur l'accélération graphique 2D et 3D.
Le texte d'attribution et de licence doit être ajouté à l'application.

Configurer vos projets: projet Cloud Console et projet Android

Avant de pouvoir créer ou tester une application, vous devez créer un projet Cloud Console et ajouter des identifiants de clé API. Le provisionnement du projet doit être activé pour que vous puissiez accéder au SDK Navigation. Toutes les clés du projet de la console Cloud disposent 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 à Cloud Console et créez votre projet Cloud Console.
Dans votre IDE, tel qu'Android Studio, créez un projet de développement d'applications Android et notez le nom du package.
Contactez votre représentant Google Maps Platform afin de lui accorder l'accès au SDK Navigation pour votre projet dans la console Cloud.
Depuis le tableau de bord Cloud Console 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 et l'empreinte du package, 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. 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 version 4.5 ou ultérieure (recommandé)

L'exemple suivant utilise le dépôt Maven google(), qui est le moyen le plus simple et le plus 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 souhaitée du SDK Navigation pour Android.

Gradle

Ajoutez le code suivant à votre 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 des groupes et des artefacts ont changé et que le plug-in com.google.cloud.artifactregistry.gradle-plugin n'est plus nécessaire.

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

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

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>

Si vous avez des dépendances qui utilisent le SDK Maps, vous devez l'exclure 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>

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 établissements locaux

Dans le dossier Gradle Scripts (Scripts Gradle), 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 instructions ci-dessous pour mettre à jour les paramètres afin de répondre aux exigences du SDK Navigation et envisager de définir également les options d'optimisation.

Paramètres requis pour le SDK Navigation
1. Définissez minSdkVersion sur 23 ou plus.
2. Définissez targetSdkVersion sur 33 ou plus.
3. Ajoutez un paramètre dexOptions qui augmente la 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 la durée de compilation
- Activez la minification de 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'étape R8/ProGuard prend trop de temps, envisagez d'activer multidex pour les tâches de développement.
- Réduisez le nombre de traductions incluses dans la compilation en définissant 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.
Ajouter le désucrage pour la compatibilité avec Java8
- Si vous compilez votre application à l'aide du plug-in Android Gradle 4.0.0 ou version ultérieure, celui-ci vous permet d'utiliser un certain nombre d'API en langage Java 8. Pour en savoir plus, consultez la section Compatibilité avec le désucrage Java 8. Consultez l'exemple d'extrait de script de compilation ci-dessous pour découvrir les options de compilation et de dépendance.

Vous trouverez ci-dessous un exemple de script de compilation Gradle pour l'application. Consultez les applications exemples pour obtenir les ensembles de dépendances mis à jour, car la version du SDK Navigation que vous utilisez peut être légèrement avancée ou inférieure à 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 33
        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:1.1.9'
}

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 dans votre projet Google Maps :

Dans Android Studio, ouvrez votre fichier build.gradle ou build.gradle.kts de premier niveau 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 le fichier build.gradle au niveau du module et ajoutez le code suivant à l'élément plugins.

Groovy

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

Kotlin

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

Dans le fichier build.gradle au niveau du module, assurez-vous que targetSdk et compileSdk sont définis sur 34.
Enregistrez le fichier et 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. Stockez votre clé dans ce fichier, car secrets.properties n'est pas vérifié dans un système de 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
```
Enregistrez le fichier.
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.
Enregistrez le fichier.
Dans votre fichier AndroidManifest.xml, accédez à com.google.android.geo.API_KEY, puis modifiez le android:value attribute. Si le tag <meta-data> n'existe pas, créez-le comme enfant du tag <application>.
```
<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.

In Android Studio, open your module-level build.gradle or build.gradle.kts file and edit the secrets property. If the secrets property does not 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.

Groovy

secrets {
    // Optionally specify a different file name containing your secrets.
    // The plugin defaults to "local.properties"
    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.*"
}

Kotlin

secrets {
    // Optionally specify a different file name containing your secrets.
    // The plugin defaults to "local.properties"
    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.*"
}

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

Si vous êtes un client Mobility ou Fleet Engine Deliveries

Si vous êtes un client Mobility ou Fleet Engine Deliveries, consultez la documentation sur la mobilité pour en savoir plus sur la facturation. 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).