Configurare un progetto Android Studio

AVVISO: la versione 2.0.0 e successive di Places SDK per Android dipende da AndroidX. A partire da questa versione, la vecchia libreria di supporto non sarà più supportata. Per mantenere la compatibilità, devi eseguire la migrazione dei progetti per utilizzare AndroidX.

Per configurare l'app in modo che utilizzi Places SDK per Android, segui questi passaggi. Sono obbligatori per tutte le app che utilizzano Places SDK per Android.

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.

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 Compatibilità del plug-in Android per Gradle e di Android Studio.

Passaggio 2: Configura l'SDK

La libreria Places SDK per 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 del 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. Nella sezione dependencies del file build.gradle.kts a livello di modulo, aggiungi una dipendenza a Places SDK per Android:

   Nota: Places SDK per Android versione 3.5.0 richiede kotlin-bom 1.8.0 o versioni successive. Per ulteriori informazioni sulla dipendenza kotlin-bom, consulta Utilizzo della versione più recente di kotlin-stdlib nelle dipendenze transitive.

   Groovy

   dependencies {
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation("com.google.android.libraries.places:places:3.5.0")
   }

   Kotlin

             dependencies {
   
       // Places and Maps SDKs
       implementation("com.google.android.libraries.places:places:6.0.2")
   }

4. Nel file build.gradle.kts a livello di modulo, imposta compileSdk e minSdk sui seguenti valori:
   Nota: assicurati che compileSdk sia impostato su 34 o versioni successive e minSdk sia impostato su 23 o versioni successive.

   Groovy

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

   Kotlin

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

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

   Groovy

   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 referenziata in modo sicuro dalla tua app. Non devi archiviare la chiave API nel sistema di controllo della versione, pertanto ti consigliamo di archiviarla in un file secrets.properties nella directory principale del progetto e di escludere questo file dal controllo della versione. 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 della versione) in modo da non archiviare la chiave API nel controllo della versione.
   Nota: se il file secrets.properties non esiste, crealo nella stessa cartella del file local.properties.

   PLACES_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.

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

   PLACES_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 della versione che omette secrets.properties e non hai ancora creato un file secrets.properties in locale per fornire la chiave API.

6. 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: Inizializza il client dell'API Places

Per inizializzare Places SDK per Android all'interno di un'attività o di un fragment, passa la chiave API quando chiami Places.initializeWithNewPlacesApiEnabled():

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

    // Initialize the SDK
    Places.initializeWithNewPlacesApiEnabled(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)
    

Java

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

    // Initialize the SDK
    Places.initializeWithNewPlacesApiEnabled(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);
    

IMPORTANTE: non aggiungere mai le chiavi API direttamente al codice dell'applicazione. Negli ambienti di produzione, ti consigliamo di utilizzare un meccanismo sicuro per gestire le chiavi API.

Ora puoi iniziare a utilizzare Places SDK per Android.

Passaggio 5: configura un dispositivo Android

Per eseguire un'app che utilizza Places SDK per 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.
  Nota: se scegli di utilizzare un emulatore Android, assicurati di scegliere un profilo del dispositivo con l'icona di Play,, visualizzata nella colonna Play Store. Questa icona indica che questi profili sono completamente CTS e possono utilizzare immagini di sistema che includono l'app Play Store.

Passaggi successivi

Dopo aver configurato il progetto, puoi esplorare le app di esempio.