Configurer un projet Android Studio

Pour configurer votre application afin d'utiliser le SDK Places pour Android, procédez comme suit : Elles sont obligatoires pour toutes les applications utilisant le SDK Places pour Android.

Étape 1 : Configurez Android Studio

  1. Vous devez disposer d'Android Studio Arctic Fox ou version ultérieure. Si vous ne l'avez pas encore fait, téléchargez-le et installez-le.
  2. Veillez à utiliser le plug-in Android Gradle version 7.0 ou ultérieure dans Android Studio.

Étape 2 : Configurez le SDK

La bibliothèque du SDK Places pour Android est disponible via le dépôt Maven de Google. Pour ajouter le SDK à votre application, procédez comme suit :

  1. Dans le fichier settings.gradle de premier niveau, incluez le portail de plug-ins Gradle, le dépôt Google Maven et le dépôt central Maven sous le bloc pluginManagement. Dans le script, le bloc pluginManagement doit apparaître avant toute autre instruction.
    pluginManagement {
        repositories {
            gradlePluginPortal()
            google()
            mavenCentral()
        }
    } 
  2. Dans le fichier settings.gradle de premier niveau, incluez le dépôt Maven de Google et le dépôt central Maven sous le bloc dependencyResolutionManagement :
    dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
            google()
            mavenCentral()
        }
    } 
  3. Dans la section dependencies de votre fichier build.gradle au niveau du module, ajoutez une dépendance au SDK Places pour Android:

    dependencies {
        implementation 'com.google.android.libraries.places:places:3.1.0'
    }
    
  4. Dans le fichier build.gradle au niveau du module, définissez compileSdk et minSdk sur les valeurs suivantes :
    android {
        compileSdk 31
    
        defaultConfig {
            minSdk 21
            // ...
        }

Étape 3 : Ajoutez votre clé API au projet

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 local.properties, qui se trouve dans le répertoire racine de votre projet. Pour en savoir plus sur le fichier local.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 et stocker votre clé API :

  1. Dans Android Studio, ouvrez votre fichier build.gradle au niveau du projet et ajoutez le code suivant à l'élément dependencies sous buildscript.
    plugins {
        // ...
        id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
    }
  2. Ensuite, ouvrez le fichier build.gradle au niveau du module et ajoutez le code suivant à l'élément plugins.
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
        
  3. Enregistrez le fichier et synchronisez votre projet avec Gradle.
  4. 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
        
  5. Enregistrez le fichier.
  6. Dans votre fichier AndroidManifest.xml, accédez à com.google.android.geo.API_KEY et mettez à jour android:value attribute comme suit :
    <meta-data
        android:name="com.google.android.geo.API_KEY"
        android:value="${MAPS_API_KEY}" />
        

Remarque : Comme indiqué ci-dessus, 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 s'authentifier auprès de plusieurs API basées sur Google Maps sur la plate-forme Android, y compris le SDK Places 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 renvoie une exception.

Étape 4 : Initialiser le client API Places

Initialisez le SDK Places pour Android dans une activité ou un fragment, comme indiqué dans l'exemple suivant (notez que vous transmettez la clé API lors de l'appel de Places.initialize()):

Java


    // Initialize the SDK
    Places.initialize(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);

      

Kotlin


    // Initialize the SDK
    Places.initialize(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)

      

Vous êtes maintenant prêt à utiliser le SDK Places pour Android.

Étape 5 : Configurez un appareil Android

Pour exécuter une application qui utilise le SDK Places pour Android, vous devez la déployer sur un appareil Android ou un émulateur Android qui fonctionne sous Android 4.0 (ou version ultérieure) et inclut les API Google.

  • Pour utiliser un appareil Android, suivez les instructions dans Exécuter des applications sur un appareil matériel.
  • Pour utiliser un émulateur Android, vous pouvez créer un appareil virtuel et installer l'émulateur à l'aide d'AVD Manager (le gestionnaire d'appareils virtuels Android) fourni avec Android Studio.

Étapes suivantes

Une fois votre projet configuré, vous pouvez explorer les exemples d'applications.