Configurer un projet Android Studio

AVIS : La version 2.0.0 et les versions ultérieures du SDK Places pour Android dépendent d'AndroidX. À partir de cette version, l'ancienne bibliothèque d'assistance ne sera plus compatible. Pour conserver la compatibilité, vous devez migrer vos projets vers AndroidX.

Pour configurer votre application afin qu'elle utilise 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

Ce document décrit un environnement de développement utilisant Android Studio Hedgehog et la version 8.2 du plug-in Android Gradle.

Remarque : Si votre environnement de développement utilise une autre version d'Android Studio ou de Gradle, vous devrez peut-être modifier les étapes en fonction de ces versions. Pour plus d'informations sur les versions d'Android Studio et de Gradle, consultez Compatibilité entre le plug-in Android Gradle et 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.kts de premier niveau, incluez le portail de plug-ins Gradle, le dépôt Maven de Google 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.kts 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.kts au niveau du module, ajoutez une dépendance au SDK Places pour Android :

   Remarque  : Places SDK pour Android version 3.5.0 nécessite kotlin-bom 1.8.0 ou version ultérieure. Pour en savoir plus sur la dépendance kotlin-bom, consultez Utilisation de la dernière version de kotlin-stdlib dans les dépendances transitives.

   Groovy

   dependencies {
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation("com.google.android.libraries.places:places:3.5.0")
   }

   Kotlin

             dependencies {
   
       // Places and Maps SDKs
       implementation("com.google.android.libraries.places:places:5.0.0")
   }

4. Dans le fichier build.gradle.kts au niveau du module, définissez compileSdk et minSdk sur les valeurs suivantes :
   Remarque : Vérifiez que compileSdk est défini sur 34 ou plus, et minSdk sur 23 ou plus.

   Groovy

   android {
       compileSdk 34
   
       defaultConfig {
           minSdk 23
           // ...
       }
   }

   Kotlin

   android {
       compileSdk = 34
   
       defaultConfig {
           minSdk = 23
           // ...
       }
   }

5. Dans la section buildFeatures de votre fichier build.gradle au niveau du module, ajoutez la classe BuildConfig, qui vous permettra d'accéder aux valeurs de métadonnées définies ultérieurement dans cette procédure :

   Groovy

   android {
     // ...
     buildFeatures {
       buildConfig true
       // ...
     }
   }

   Kotlin

   android {
     // ...
     buildFeatures {
       buildConfig = true
       // ...
     }
   }

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

1. 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")
       }
   }

2. Ouvrez le 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")
   }

3. Si vous utilisez Android Studio, 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.

   PLACES_API_KEY=YOUR_API_KEY

Étape 4 : Initialiser le client de l'API Places

Pour initialiser le SDK Places pour Android dans une activité ou un fragment, transmettez la clé API lorsque vous appelez Places.initializeWithNewPlacesApiEnabled() :

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

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

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

Java

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

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

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

IMPORTANT : N'ajoutez jamais de clés API directement au code de l'application. Dans les environnements de production, nous vous recommandons d'utiliser un mécanisme sécurisé pour gérer les clés API.

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 sur un émulateur Android qui exécute Android 5.0 (ou une 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.
  Remarque : Si vous choisissez d'utiliser un émulateur Android, assurez-vous de sélectionner un appareil signalé par l'icône Play dans la colonne Play Store. L'icône indique que ces profils sont entièrement compatibles avec CTS et qu'ils peuvent utiliser des images système incluant l'application Play Store :

  

Étapes suivantes

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