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 in dettaglio 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 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 Gradle per Android nella 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, il repository Maven di Google e il repository Maven central nel blocco pluginManagement. Il blocco pluginManagement deve apparire prima di qualsiasi altro statement nello script.

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

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.FAIL_ON_PROJECT_REPOS)
       repositories {
           google()
           mavenCentral()
       }
   } 

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

   Kotlin

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

   Trendy

   dependencies {
   
       // Maps SDK for Android
       implementation "com.google.android.gms:play-services-maps:19.0.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 = 21
           // ...
       }
   }

   Trendy

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

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 in un secondo momento in questa procedura:

   Kotlin

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

   Trendy

   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 richiamata in modo sicuro dalla tua app. Non devi inserire la chiave API nel tuo sistema di controllo delle versioni, quindi ti consigliamo di archiviarla nel file secrets.properties, che si trova nella directory principale del progetto. Per ulteriori informazioni sul file secrets.properties, consulta File di proprietà 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 nel tuo progetto Google Maps:

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

   Kotlin

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

   Trendy

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

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.google.android.libraries.mapsplatform.secrets-gradle-plugin")
   }

   Trendy

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

3. Nel file build.gradle.kts o 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. Memorizza la chiave in questo file perché secrets.properties è esclusa dal controllo in un sistema di controllo delle versioni.

   MAPS_API_KEY=YOUR_API_KEY

6. Salva il file.

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

   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 falliscano. 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 localmente 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, creane uno come elemento secondario del tag <application>.

   <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 autenticarsi in più API basate su Google Maps sulla piattaforma Android, incluso 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 Android Maps v2. Un'applicazione può specificare solo uno dei nomi dei metadati della chiave API. Se vengono specificati entrambi, l'API genera un'eccezione.

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

    Modifica le proprietà del plug-in per impostare propertiesFileName su secrets.properties, defaultPropertiesFileName su local.defaults.properties e altre 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 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.*"
    }
            

    Trendy

    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.*"
    }
            

Passaggio 4: aggiorna il file manifest dell'app

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

Numero di versione di Google Play Services

Aggiungi la seguente dichiarazione all'interno dell'elemento application. 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 esatta del dispositivo, e ACCESS_COARSE_LOCATION, che è meno precisa. Per maggiori dettagli, consulta la guida relativa 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'autorizzazione WRITE_EXTERNAL_STORAGE nell'elemento manifest.

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

Libreria Apache HTTP Legacy

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 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 l'SDK Maps per Android, devi eseguirne il deployment su un dispositivo Android o su un emulatore Android basato su Android 5.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 AVD, disponibile in Android Studio.

(Facoltativo) Passaggio 6: controlla se è disponibile l'assistenza di Play Services

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

Passaggi successivi

Una volta configurato il progetto, puoi aggiungere una mappa.