Configuration

Cette page décrit ce que vous devez faire pour vous préparer à créer des applications avec le SDK Maps 3D pour Android. Le processus de configuration consiste à configurer un projet et une API Google Cloud pour les utiliser avec le SDK, puis à configurer un projet Android Studio. Suivez ces étapes avant d'ajouter votre première carte 3D à votre application.

Configurer un projet Google Cloud et une clé API

Avant de commencer à créer des applications 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 suivant les étapes ci-dessous :

gcloud projects create "PROJECT"

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"

gcloud services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Pour activer le SDK, consultez la page SDK Maps 3D pour Android dans la console Google Cloud. Pour en savoir plus sur la façon de procéder, consultez Premiers pas avec Google Maps Platform.

Configurer un projet Android Studio

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

Partie 1 : Configurer votre projet et la configuration Gradle

1. Créez un projet Android Studio à l'aide du modèle Empty Views Activity (Activité Vues vide).

2. Si vous utilisez Git pour le contrôle des sources, modifiez le fichier .gitignore du projet pour empêcher la validation 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 des versions, ajoutez les versions du SDK et du plug-in Secrets Gradle :

   maps3dSdk = "0.0.1" # Update this value to match the SDK version to include
   secretsGradlePlugin = "2.0.1"
   

   -   In the library section, add the SDK library:
   

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

   -   In the plugin section, add the Secrets Gradle plugin:
   

   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
   }
   

   -   In the `dependencies` block, add the SDK:
   

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

   -   At the end of the file, outside of the `android` and `dependencies`
       blocks, add the secrets configuration:
   

   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 : Ajoutez 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
   ``` Note: Make sure you
       replace `YOUR_API_KEY_HERE` with the API key that you configured for use
   with the Maps 3D SDK for Android.
   

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

   MAPS3D_API_KEY=DEFAULT_API_KEY_OR_PLACEHOLDER
   

Partie 3 : Mettez à 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>
   

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

Étapes suivantes

Maintenant que vous avez configuré un projet Google Cloud, une clé API et un projet Android Studio pour une utilisation avec le SDK Maps 3D pour Android, vous pouvez ajouter une carte 3D à votre application.