Configurare un progetto Android Studio

Questa pagina descrive come configurare un progetto Android Studio per utilizzare Maps SDK for Android senza utilizzare il modello di Google Maps descritto nella guida rapida.

Il modello di Google Maps configura e aggiunge automaticamente una mappa di base a un nuovo progetto Android Studio. Tuttavia, puoi anche aggiungere una mappa a un progetto Android che utilizza un modello di Android Studio diverso. Per farlo, devi configurare manualmente il progetto e poi aggiungere la mappa.

Passaggio 1: configura Android Studio

Questo documento descrive un ambiente di sviluppo che utilizza Android Studio Hedgehog e il plug-in Android per Gradle versione 8.2.

Passaggio 2: configura l'SDK

La libreria Maps SDK for Android è disponibile tramite il repository Maven di Google. Per aggiungere l'SDK alla tua app:

1. Nel file settings.gradle.kts di primo livello, includi il portale dei plug-in Gradle, repository Maven di Google, e repository centrale Maven nel blocco pluginManagement. Il blocco pluginManagement deve essere visualizzato prima di qualsiasi altra istruzione nello script.

   pluginManagement {
       repositories {
           google()
           mavenCentral()
           gradlePluginPortal()
       }
   } 

2. Nel file settings.gradle.kts di primo livello, includi il repository Maven di Google e il repository centrale Maven nel blocco dependencyResolutionManagement:

   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
       repositories {
           google()
           mavenCentral()
       }
   } 

3. Nel file build.gradle.kts o build.gradle a livello di modulo, aggiungi la dipendenza di Google Play Services per Maps SDK for Android.

   Kotlin

   dependencies {
   
       // Maps SDK for Android
       implementation(libs.play.services.maps)
   }

   Groovy

   dependencies {
   
       // Maps SDK for Android
       implementation "com.google.android.gms:play-services-maps:20.1.0"
   }

4. Nel file build.gradle.kts o build.gradle a livello di modulo, imposta compileSdk e minSdk sui seguenti valori:

   Kotlin

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

   Groovy

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

5. Nella sezione buildFeatures del file build.gradle.kts o build.gradle a livello di modulo, aggiungi la classe BuildConfig, che puoi utilizzare per accedere ai valori dei metadati definiti più avanti in questa procedura:

   Kotlin

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

   Groovy

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

6. Nel file libs.versions.toml, aggiungi quanto segue:

   [versions]
   play-services-maps = "20.1.0"
   
   [libraries]
   play-services-maps = { module = "com.google.android.gms:play-services-maps", version.ref = "play-services-maps" }
       

Passaggio 3: aggiungi la chiave API al progetto

Questa sezione descrive come archiviare la chiave API in modo che possa essere referenziata in modo sicuro dalla tua app. Non devi inserire la chiave API nel sistema di controllo delle versioni, quindi ti consigliamo di archiviarla in un file secrets.properties nella directory principale del progetto ed escludere questo file dal controllo delle versioni. Per ulteriori informazioni sui file delle proprietà di Gradle, consulta File delle proprietà di Gradle.

Per semplificare questa attività, ti consigliamo di utilizzare il plug-in Secrets Gradle per Android.

Per installare il plug-in Secrets Gradle per Android e archiviare la chiave API:

1. In Android Studio, apri il file build.gradle.kts o build.gradle di primo livello e aggiungi il seguente codice al blocco plugins.

   Kotlin

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

   Groovy

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

2. Apri il file build.gradle.kts o build.gradle a livello di modulo e aggiungi il seguente codice all'elemento plugins.

   Kotlin

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

   Groovy

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

3. Se utilizzi Android Studio, sincronizza il progetto con Gradle.
4. Apri il file secrets.properties nella directory di primo livello, e aggiungi il seguente codice. Sostituisci YOUR_API_KEY con la tua chiave API. Assicurati di aggiungere secrets.properties al tuo .gitignore file (o di escluderlo in altro modo dal sistema di controllo delle versioni) in modo da non inserire la chiave API nel controllo delle versioni.

   MAPS_API_KEY=YOUR_API_KEY

5. Crea il file local.defaults.properties nella directory di primo livello, nella stessa cartella del file secrets.properties e aggiungi il seguente codice.

   MAPS_API_KEY=DEFAULT_API_KEY

   Lo scopo di questo file è fornire una posizione di backup per la chiave API se il file secrets.properties non viene trovato, in modo che le build non vadano in errore. Questo può accadere se cloni l'app da un sistema di controllo delle versioni che omette secrets.properties e non hai ancora creato un file secrets.properties in locale per fornire la chiave API.

6. Nel file AndroidManifest.xml, vai a com.google.android.geo.API_KEY e aggiorna l'attributo android:value come segue:

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

   Nota: com.google.android.geo.API_KEY è il nome dei metadati consigliato per la chiave API. Una chiave con questo nome può essere utilizzata per l'autenticazione a multiple Google Maps-based APIs sulla piattaforma Android, incluso the Maps SDK for Android. Per la compatibilità con le versioni precedenti, l'API supporta anche il nome com.google.android.maps.v2.API_KEY. Questo nome legacy consente l'autenticazione solo all'API di Google Maps Android v2. Un'applicazione può specificare solo uno dei nomi dei metadati della chiave API. Se vengono specificati entrambi, l'API genera un'eccezione.

7. In Android Studio, apri il file a livello di modulo build.gradle.kts o build.gradle e modifica la proprietà secrets. Se la proprietà secrets non esiste, aggiungila.

   Modifica le proprietà del plug-in per impostare propertiesFileName su "secrets.properties", impostare defaultPropertiesFileName su "local.defaults.properties" e qualsiasi altra proprietà.

   Kotlin

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

   Groovy

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

Passaggio 4: aggiorna il manifest dell'app

Questa sezione descrive le impostazioni da aggiungere al tuo AndroidManifest.xml file.

Numero di versione di Google Play Services

Aggiungi la seguente dichiarazione all'interno dell'elemento application. In questo modo viene incorporata la versione di Google Play Services con cui è stata compilata l'app.

<meta-data
    android:name="com.google.android.gms.version"
    android:value="@integer/google_play_services_version"/>

Autorizzazione di accesso alla posizione

Se la tua app deve accedere alla posizione dell'utente, devi richiedere l'autorizzazione di accesso alla posizione nel file AndroidManifest.xml. Le opzioni sono ACCESS_FINE_LOCATION, che fornisce la posizione precisa del dispositivo, e ACCESS_COARSE_LOCATION, che è meno precisa. Per i dettagli, consulta la guida ai dati sulla posizione.

Per richiedere l'autorizzazione ACCESS_FINE_LOCATION, aggiungi questo codice all'elemento manifest:

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>

Autorizzazione di accesso all'unità di archiviazione esterna

Se scegli come target la versione 8.3 o successive dell'SDK Google Play Services, non hai bisogno dell'autorizzazione WRITE_EXTERNAL_STORAGE. Se scegli come target versioni precedenti dell'SDK Google Play Services, devi richiedere l' WRITE_EXTERNAL_STORAGE nell'elemento manifest.

<uses-permission
        android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

Libreria legacy Apache HTTP

Se utilizzi com.google.android.gms:play-services-maps:16.0.0 o versioni precedenti e la tua app ha come livello API target 28 (Android 9.0) o versioni successive, devi includere la seguente dichiarazione all'interno dell'elemento <application> di AndroidManifest.xml. In caso contrario, salta questa dichiarazione.

<uses-library
    android:name="org.apache.http.legacy"
    android:required="false"/>

Passaggio 5: configura un dispositivo Android

Per eseguire un'app che utilizza Maps SDK for Android, devi eseguirne il deployment su un dispositivo Android o un emulatore Android basato su Android 6.0 o versioni successive e che includa le API Google.

• Per utilizzare un dispositivo Android, segui le istruzioni riportate in Eseguire app su un dispositivo hardware.
• Per utilizzare un emulatore Android, puoi creare un dispositivo virtuale e installare l'emulatore utilizzando Gestione dispositivi disponibile in Android Studio.

Passaggio 6: (facoltativo) controlla il supporto di Play Services

Maps SDK for Android richiede che sul dispositivo su cui esegui il deployment dell'app sia installato Google Play Services. Google fornisce un metodo che puoi chiamare dalla tua app per eseguire il controllo. Per ulteriori informazioni, consulta Controllare se Google Play Services è installato.

Passaggi successivi

Una volta configurato il progetto, puoi aggiungere una mappa.