Configurer un projet Android Studio

AVERTISSEMENT : Les versions 2.0.0 et ultérieures du SDK Places pour Android dépendent de AndroidX À compter de cette version, l'ancienne bibliothèque Support ne sera plus compatibles. Pour conserver la compatibilité, vous devez migrer vos projets vers utilisent AndroidX.

Pour configurer votre application afin d'utiliser le SDK Places pour Android, procédez comme suit : étapes. Ils 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 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 le dependencies de votre fichier build.gradle au niveau du module, ajoutez une dépendance au SDK Places pour Android:

   Remarque : Version du SDK Places pour Android La version 3.5.0 nécessite kotlin-bom 1.8.0 ou version ultérieure. Pour 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 {
       // If updating kotlin-bom version number above, also edit project-level build.gradle definition of $kotlin_version variable
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation 'com.google.android.libraries.places:places:3.3.0'
   }

   Kotlin

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

4. Dans le fichier build.gradle au niveau du module, définissez compileSdk. et minSdk aux valeurs suivantes:
   Remarque:Assurez-vous que compileSdk est défini sur définie sur 34 ou plus et minSdk est définie sur 21 ou plus.

   Groovy

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

   Kotlin

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

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.

Remarque : Consultez la documentation du plug-in Secrets Gradle pour Android sur GitHub pour connaître la configuration système requise et lire les instructions d'installation.

Pour installer le plug-in Secrets Gradle pour Android dans votre projet Google Maps :

1. Dans Android Studio, ouvrez votre fichier build.gradle.kts ou build.gradle de premier niveau et ajoutez le code suivant à l'élément dependencies sous buildscript.

   Kotlin

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

   Groovy

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

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

   Kotlin

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

   Groovy

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

3. Dans le fichier build.gradle.kts ou build.gradle au niveau du module, assurez-vous que targetSdk et compileSdk sont définis à 34 ans.
4. Enregistrez le fichier et synchronisez votre projet avec Gradle.
5. 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.

   PLACES_API_KEY=YOUR_API_KEY

6. Enregistrez le fichier.

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

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

8. Enregistrez le fichier.

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

   Modifiez les propriétés du plug-in pour définir propertiesFileName sur secrets.properties, définir defaultPropertiesFileName sur local.defaults.properties et définissez 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 same folder as the 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"
   
       // 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.*"
   }
           

   Groovy

   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the same folder as the 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"
   
       // 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.*"
   }
           

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

Initialisez le SDK Places pour Android dans une activité ou un fragment. Vous devez d'abord choisir la version du SDK à utiliser: SDK Places pour Android ou SDK Places pour Android (nouveau). Pour en savoir plus sur les versions de produit, consultez la section Choisir votre version du SDK.

L'exemple suivant montre comment initialiser le SDK pour les deux versions.

SDK Places pour Android (nouveau)

Transmettre la clé API lors de l'appel 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);
    

SDK Places pour Android

Transmettre la clé API lors de l'appel Places.initialize():

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.initialize(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.initialize(getApplicationContext(), apiKey);

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

IMPORTANT:N'ajoutez jamais de clés API directement dans le code d'application. Dans les environnements de production, nous vous recommandons d'utiliser mécanisme de sécurité 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 Android basé sur Android 5.0 ou version ultérieure et qui 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 applications exemples.