Configurare un progetto Android Studio

In questa pagina viene descritto come configurare un progetto Android Studio per l'utilizzo Maps SDK for Android senza utilizzare il modello di Google Maps che è 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 manualmente configura il progetto e poi aggiungi la mappa.

Passaggio 1: configura Android Studio

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

Passaggio 2: Configurare l'SDK

La raccolta di Maps SDK for Android è disponibile tramite Repository Maven di Google. A aggiungi l'SDK alla tua app:

  1. Nel file settings.gradle.kts di primo livello, includi il parametro Portale plug-in Gradle Repository Maven di Google, e il repository centrale Maven nel blocco pluginManagement. Il blocco pluginManagement deve apparire prima di qualsiasi altra istruzione nello script.
    pluginManagement {
        repositories {
            gradlePluginPortal()
            google()
            mavenCentral()
        }
    } 
  2. Nel file settings.gradle.kts di primo livello, includi il parametro Repository Maven di Google e 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 il Dipendenza di Google Play Services per Maps SDK for 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 modulo build.gradle.kts a livello di modulo o build.gradle file, aggiungi la classe BuildConfig, che puoi utilizzare per accedi ai valori dei metadati definiti più avanti 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 da potervi fare riferimento in modo sicuro la tua app. Non dovresti verificare la chiave API nel tuo sistema di controllo della versione, quindi ti consigliamo archiviandolo nel file secrets.properties, che si trova nella directory radice del progetto. Per ulteriori informazioni sul file secrets.properties, vedi File delle proprietà di Gradle.

Per semplificare questa attività, ti consigliamo di utilizzare 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 l'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 sono impostati a 34.
  4. Salva il file e sincronizzare il progetto con Gradle.
  5. Apri il file secrets.properties nella directory di primo livello, quindi aggiungi seguire il codice. Sostituisci YOUR_API_KEY con la tua chiave API. Memorizza la chiave in questo file perché secrets.properties è escluso dall'archiviazione in un controllo della versione di un sistema operativo completo.
    MAPS_API_KEY=YOUR_API_KEY
  6. Salva il file.
  7. Crea il file local.defaults.properties nella directory di primo livello, uguale cartella come file secrets.properties, quindi aggiungi il codice riportato di seguito.

    MAPS_API_KEY=DEFAULT_API_KEY

    Lo scopo di questo file è fornire un percorso di backup per la chiave API se Impossibile trovare il file secrets.properties per evitare errori di build. Ciò può verificarsi 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 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}" />

    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 eseguire l'autenticazione API basate su Google Maps sulla piattaforma Android, tra cui Maps SDK per Android. Per garantire la compatibilità con le versioni precedenti, l'API supporta il nome com.google.android.maps.v2.API_KEY. Questa eredità permette l'autenticazione solo all'API di Android Maps v2. Un'applicazione può specificare solo uno dei nomi dei metadati delle chiavi API. Se sono specificati entrambi, l'API genera un'eccezione.

  10. In Android Studio, apri l'build.gradle.kts a livello di modulo oppure build.gradle e modifica la proprietà secrets. Se La proprietà secrets non esiste. Aggiungila.

    Modifica le proprietà del plug-in impostando propertiesFileName su secrets.properties, imposta defaultPropertiesFileName su local.defaults.properties e imposta eventuali 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 tuo AndroidManifest.xml.

Numero di versione di Google Play Services

Aggiungi la seguente dichiarazione nell'elemento application. Incorporati 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 autorizzazione di accesso alla posizione nel tuo file AndroidManifest.xml. Le opzioni sono ACCESS_FINE_LOCATION, che fornisce la posizione esatta del dispositivo. ACCESS_COARSE_LOCATION, che è meno precisa. Per maggiori dettagli, consulta dati sulla posizione.

Per richiedere l'autorizzazione ACCESS_FINE_LOCATION, aggiungi questo codice alla Elemento manifest:

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

Autorizzazione archiviazione esterna

Se scegli come target la versione 8.3 o successiva 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 WRITE_EXTERNAL_STORAGE nell'elemento manifest.

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

Libreria legacy HTTP di Apache

Se utilizzi com.google.android.gms:play-services-maps:16.0.0 o versioni precedenti e se 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, 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 implementarla su un dispositivo Android o Android basato su Android 5.0 o versioni successive e che include le API di Google.

  • Per utilizzare un dispositivo Android, segui le istruzioni all'indirizzo Eseguire app su un dispositivo hardware.
  • Per utilizzare un emulatore Android, puoi creare un dispositivo virtuale e installarlo utilizzando Gestione dispositivi virtuali Android inclusi in Android Studio.

Passaggio 6: se vuoi, controlla l'assistenza di Play Service

Maps SDK for Android richiede che il dispositivo su cui implementi il tuo su cui è installato Google Play Services. Google offre un metodo per chiamare dall'app per controllare. Per ulteriori informazioni, consulta l'articolo Controllare se Google Play Services sia installato.

Passaggi successivi

Una volta configurato il progetto, puoi aggiungere una mappa.