Configuration

Cette page décrit la procédure à suivre pour commencer à créer des applications avec le SDK Maps 3D pour Android. Le processus de configuration implique de configurer un projet Google Cloud et une API à utiliser avec le SDK, puis de configurer un projet Android Studio. Suivez ces étapes avant d'ajouter votre première carte 3D à votre application.

Prérequis

Pour utiliser le SDK Maps 3D pour Android, votre projet et vos appareils cibles doivent répondre aux exigences suivantes :

• Niveau d'API minimal : niveau d'API Android 24 (Android 7.0) ou version ultérieure. Votre application doit cibler un minSdk de 24 ou version ultérieure.
• Services Google Play : le SDK Maps 3D pour Android dépend des services Google Play. Les services Google Play doivent être installés sur les appareils cibles (et les émulateurs avec les API Google).

Configurer un projet Google Cloud et une clé API

Avant de pouvoir commencer à créer des cartes avec le SDK Maps 3D pour Android, vous devez configurer un projet Google Cloud et une clé API à utiliser avec le SDK Maps 3D pour Android en procédant comme suit :

Étape 1 : Configurez votre projet

gcloud projects create "PROJECT"

Étape 2 : Activez les API ou les SDK

Pour utiliser Google Maps Platform, vous devez activer les API ou les SDK que vous prévoyez d'utiliser avec votre projet.

Notez que, pour certaines intégrations, vous devez activer plusieurs API/SDK. Si vous ne savez pas quelles API ou quels SDK activer, essayez d'utiliser l'explorateur de fonctionnalités, ou consultez la documentation de l'API ou du SDK que vous souhaitez utiliser.

Pour activer des API ou SDK :

gcloud services enable \
    --project "PROJECT" \
    "addressvalidation.googleapis.com" \
    "areainsights.googleapis.com" \
    "tile.googleapis.com" \
    "aerialview.googleapis.com" \
    "elevation-backend.googleapis.com" \
    "routes.googleapis.com" \
    "geocoding-backend.googleapis.com" \
    "geolocation.googleapis.com" \
    "maps-android-backend.googleapis.com" \
    "maps-backend.googleapis.com" \
    "maps-embed-backend.googleapis.com" \
    "maps-ios-backend.googleapis.com" \
    "mapsplatformdatasets.googleapis.com" \
    "places-backend.googleapis.com" \
    "roads.googleapis.com" \
    "routeoptimization.googleapis.com" \
    "static-maps-backend.googleapis.com" \
    "street-view-image-backend.googleapis.com" \
    "timezone-backend.googleapis.com"

gcloud services enable \
    --project "PROJECT" \
    "airquality.googleapis.com" \
    "solar.googleapis.com" \
    "pollen.googleapis.com" \
    "weather.googleapis.com"

Étape 3 : Obtenez une clé API

Cette étape concerne uniquement le processus de création de la clé API. Si vous utilisez votre clé API en production, nous vous recommandons vivement de la restreindre. Vous trouverez plus d'informations sur la page Utiliser des clés API spécifique au produit.

Une clé API est un identifiant unique qui permet d'authentifier les requêtes associées à votre projet à des fins d'utilisation et de facturation. Vous devez associer au moins une clé API à votre projet. Pour créer une clé ou ajouter une API ou un SDK à une clé existante, suivez ces instructions.

Pour activer le SDK, consultez la page SDK Maps 3D pour Android dans la console Google Cloud. Pour en savoir plus sur la procédure à suivre, consultez Premiers pas avec Google Maps Platform.

Configurer un projet Android Studio

Cette section explique comment créer et configurer un projet Android Studio à utiliser avec le SDK Maps 3D pour Android.

Partie 1 : Configurer votre projet et Gradle

1. Créez un projet Android Studio à l'aide du modèle Empty Views Activity (Activité Vues vide). Dans la configuration du projet, définissez le SDK minimal sur l'API 24 ou une version ultérieure.

2. Si vous utilisez Git pour le contrôle des sources, modifiez le fichier .gitignore du projet pour empêcher l'enregistrement de votre fichier de secrets dans le contrôle des versions :

   • Dans le répertoire racine de votre projet, ouvrez le fichier .gitignore.
   • Ajoutez la ligne suivante :

   secrets.properties
   

3. Mettez à jour le fichier build.gradle.kts au niveau du projet :

   • Dans le répertoire racine de votre projet, ouvrez le fichier build.gradle.kts.
   • Dans le bloc plugins, ajoutez le plug-in Secrets Gradle :

   plugins {
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.kotlin.android) apply false
     alias(libs.plugins.secrets.gradle.plugin) apply false // Add this line
   }
   

4. Mettez à jour le fichier gradle/libs.versions.toml :

   • Ouvrez le fichier gradle/libs.versions.toml, qui se trouve généralement dans le répertoire gradle du répertoire racine du projet.
   • Dans la section [versions], ajoutez les versions du SDK et du plug-in Gradle Secrets :

   # See https://developers.google.com/android/guides/setup?device=phone-tablet for available releases
   maps3dSdk = "16.0.1"
   # See https://github.com/google/secrets-gradle-plugin/releases for available releases
   secretsGradlePlugin = "2.0.1"
   

   • Dans la section [library], ajoutez la bibliothèque du SDK :

   play-services-maps3d = { module = "com.google.android.gms:play-services-maps3d", version.ref = "maps3dSdk" }
   

   • Dans la section [plugins], ajoutez le plug-in Secrets Gradle :

   secrets-gradle-plugin = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secretsGradlePlugin" }
   

5. Mettez à jour le fichier app/build.gradle.kts au niveau du module :

   • Ouvrez le fichier build.gradle.kts au niveau du module, qui se trouve généralement dans le répertoire app.
   • En haut du fichier, ajoutez le plug-in Secrets Gradle au bloc plugins :

   plugins {
       alias(libs.plugins.android.application)
       alias(libs.plugins.kotlin.android)
       alias(libs.plugins.secrets.gradle.plugin) // Add this line
   }
   

   • Dans le bloc dependencies, ajoutez la dépendance des services Google Play pour le SDK Maps 3D pour Android :

   dependencies {
       // ... other dependencies
       implementation(libs.play.services.maps3d) // Add this line
   }
   

   • À la fin du fichier, en dehors des blocs android et dependencies, ajoutez la configuration des secrets :

   secrets {
       // Optionally specify a different filename 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"
   }
   

Partie 2 : Ajouter votre clé API à votre projet

1. Créez un fichier secrets.properties :

   • Dans le répertoire racine du module d'application (généralement le répertoire app), créez un fichier nommé secrets.properties.
   • Ajoutez votre clé API au fichier :

   MAPS3D_API_KEY=YOUR_API_KEY_HERE
   

2. Créez un fichier local.defaults.properties : - Dans le répertoire racine du module d'application, créez un fichier nommé local.defaults.properties. - Ajoutez une clé API par défaut ou d'espace réservé au fichier. Ce fichier peut être archivé dans le contrôle des versions :

   MAPS3D_API_KEY=DEFAULT_API_KEY_OR_PLACEHOLDER
   

Partie 3 : Mettre à jour votre fichier AndroidManifest.xml

1. Ouvrez le fichier app/src/main/AndroidManifest.xml.

2. Dans la balise <application>, avant la balise <activity>, ajoutez l'élément <meta-data> suivant pour déclarer votre clé API :

   <application
       ...>
   
       <meta-data
           android:name="com.google.android.geo.maps3d.API_KEY"
           android:value="${MAPS3D_API_KEY}" />
   
       <activity
           ...>
       </activity>
   </application>
   

   Pendant le processus de compilation, le plug-in Secrets Gradle remplace l'espace réservé ${MAPS3D_API_KEY} par la clé de votre fichier secrets.properties.

Initialisation de la vue par programmation (facultatif)

Si vous préférez initialiser votre vue cartographique de manière programmatique plutôt que dans des mises en page XML, utilisez Map3DInitConfig.

import com.google.android.gms.maps3d.Map3DInitConfig
import com.google.android.gms.maps3d.Map3DView
import com.google.android.gms.maps3d.model.Map3DMode

// Set configuration options using the factory method
val config = Map3DInitConfig.create(
    mapMode = Map3DMode.HYBRID,
    centerLat = 38.544012,
    centerLng = -107.670428
)

val map3DView = Map3DView(context, config)

Étapes suivantes

Maintenant que vous disposez d'un projet Google Cloud, d'une clé API et d'un projet Android Studio configurés pour être utilisés avec le SDK Maps 3D pour Android, vous pouvez ajouter une carte 3D à votre application.