Configurare un progetto Android Studio

In questa pagina viene descritto come configurare un progetto Android Studio per l'utilizzo dell'SDK Maps per Android senza utilizzare il modello di Google Maps descritto nella Guida rapida.

Il modello di Google Maps configura automaticamente e aggiunge una mappa di base a un nuovo progetto Android Studio. Tuttavia, puoi anche aggiungere una mappa a un progetto Android che utilizza un modello 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 Gradle versione 8.2.

Nota: se il tuo ambiente di sviluppo utilizza una versione diversa di Android Studio o Gradle, potresti dover modificare i passaggi in base a queste versioni. Per ulteriori informazioni sulle versioni di Android Studio e Gradle, consulta la pagina relativa alla compatibilità del plug-in Android per Gradle e di Android Studio.

Passaggio 2: Configura l'SDK

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

1. Nel file settings.gradle di primo livello, includi il portale plug-in Gradle, il repository Maven di Google e il repository centrale Maven sotto il blocco pluginManagement. Il blocco pluginManagement deve precedere qualsiasi altra istruzione nello script.

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

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

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

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

   Trendy

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

   Kotlin

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

4. Nel file build.gradle a livello di modulo, imposta compileSdk e minSdk sui seguenti valori:
   Nota: assicurati che compileSdk sia impostato su 34 o un numero superiore e che minSdk sia impostato su 19 o un numero superiore.

   Trendy

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

   Kotlin

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

5. Nella sezione buildFeatures del file 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:

   Trendy

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

   Kotlin

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

Passaggio 3: aggiungi la chiave API al progetto

Questa sezione descrive come archiviare la chiave API in modo che possa essere utilizzata in modo sicuro come riferimento dall'applicazione. Non controllare la chiave API nel sistema di controllo della versione, pertanto ti consigliamo di memorizzarla nel file secrets.properties, che si trova nella directory root del progetto. Per ulteriori informazioni sul file secrets.properties, consulta File delle proprietà Gradle.

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

Nota: consulta la documentazione relativa al plug-in Secrets Gradle per Android su GitHub per conoscere i requisiti di sistema più recenti e le istruzioni di installazione.

Per installare il plug-in Secrets Gradle per Android nel tuo progetto Google Maps:

1. In Android Studio, apri il file build.gradle o build.gradle.kts di primo livello e aggiungi il seguente codice all'elemento dependencies in buildscript.

   Trendy

   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. Apri il file build.gradle a livello di modulo e aggiungi il seguente codice all'elemento plugins.

   Trendy

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

   Kotlin

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

3. Nel file build.gradle a livello di modulo, assicurati che targetSdk e compileSdk siano impostati su 34.
4. Salva il file e sincronizza il progetto con Gradle.
5. Apri il file secrets.properties nella directory di primo livello e aggiungi il codice seguente. Sostituisci YOUR_API_KEY con la tua chiave API. Archivia la chiave in questo file perché secrets.properties è escluso dal check-in in un sistema di controllo della versione.
   Nota: se il file secrets.properties non esiste, crealo nella stessa cartella del file local.properties.

   MAPS_API_KEY=YOUR_API_KEY

6. Salva il file.

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

   Nota: inserisci il codice come mostrato. Non sostituire DEFAULT_API_KEY con la tua chiave API.

   MAPS_API_KEY=DEFAULT_API_KEY

   Lo scopo di questo file è fornire un percorso di backup per la chiave API nel caso in cui il file secrets.properties non venga trovato, in modo che le build non generino errori. Questo può accadere se cloni l'app da un sistema di controllo della versione che omette secrets.properties e non hai ancora creato un file secrets.properties in locale per fornire la tua chiave API.

8. Salva il file.
9. Nel file AndroidManifest.xml, vai a com.google.android.geo.API_KEY e aggiorna android:value attribute. Se il tag <meta-data> non esiste, crealo come elemento secondario del tag <application>.

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

   Note: com.google.android.geo.API_KEY is the recommended metadata name for the API key. A key with this name can be used to authenticate to multiple Google Maps-based APIs on the Android platform, including the Maps SDK for Android. For backwards compatibility, the API also supports the name com.google.android.maps.v2.API_KEY. This legacy name allows authentication to the Android Maps API v2 only. An application can specify only one of the API key metadata names. If both are specified, the API throws an exception.

10. In Android Studio, open your module-level build.gradle or build.gradle.kts file and edit the secrets property. If the secrets property does not exist, add it.

    Edit the properties of the plugin to set propertiesFileName to secrets.properties, set defaultPropertiesFileName to local.defaults.properties, and set any other properties.

    Groovy

    secrets {
        // Optionally specify a different file name 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"
    
        // 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.*"
    }
            

    Kotlin

    secrets {
        // Optionally specify a different file name 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"
    
        // 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.*"
    }
            

Passaggio 4: aggiorna il file manifest dell'app

In questa sezione vengono descritte le impostazioni da aggiungere al file AndroidManifest.xml.

Numero di versione di Google Play Services

Aggiungi la seguente dichiarazione all'interno dell'elemento application. che incorpora 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 esatta del dispositivo, e ACCESS_COARSE_LOCATION, che è meno precisa. Per maggiori dettagli, consulta la guida ai dati sulla località.

Nota: la quickstart ha ACCESS_FINE_LOCATION abilitato.

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

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

Autorizzazione per archiviazione esterna

Se hai scelto come target la versione 8.3 o successive dell'SDK Google Play Services, non è necessaria l'autorizzazione WRITE_EXTERNAL_STORAGE. Se hai scelto come target le versioni precedenti dell'SDK Google Play Services, devi richiedere l'autorizzazione 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 target il livello API 28 (Android 9.0) o versioni successive, devi includere la seguente dichiarazione nell'elemento <application> di AndroidManifest.xml. In caso contrario, ignora 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 su un emulatore Android basato su Android 4.0 o versioni successive che includa le API di Google.

• Per usare un dispositivo Android, segui le istruzioni in Eseguire app su un dispositivo hardware.
• Per utilizzare un emulatore Android, puoi creare un dispositivo virtuale e installarlo utilizzando lo strumento Gestione dispositivi virtuali Android (AVD) fornito in Android Studio.
  Nota: se scegli di utilizzare un emulatore Android, assicurati di scegliere un dispositivo con l'icona di riproduzione, , visualizzata nella colonna Play Store. Questa icona indica che questi profili sono completamente conformi alla CTS e possono utilizzare immagini di sistema che includono l'app Play Store:

  

Passaggio 6: se vuoi, verifica la presenza dell'assistenza di Play Service

Maps SDK for Android richiede che sul dispositivo su cui esegui il deployment della tua app sia installato Google Play Services. Google mette a disposizione un metodo che puoi chiamare dalla tua app. Per maggiori informazioni, consulta la pagina Controllare se Google Play Services è installato.

Passaggi successivi

Una volta configurato il progetto, puoi aggiungere una mappa.