Configurare un progetto Android Studio

AVVISO: Le versioni 2.0.0 e successive di Places SDK per Android dipendono da AndroidX. A partire da questa versione, la libreria di assistenza precedente non sarà più supportati. Per mantenere la compatibilità, devi eseguire la migrazione dei progetti a usano AndroidX.

Per configurare l'app in modo che utilizzi Places SDK per Android, procedi nel seguente modo 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 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 maggiori informazioni informazioni sulle versioni di Android Studio e Gradle, consulta plug-in Android per Gradle e compatibilità con Android Studio.

Passaggio 2: Configurare l'SDK

La libreria Places SDK per Android è disponibile tramite Repository Maven di Google. A aggiungi l'SDK alla tua app:

1. Nel file settings.gradle 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 devono apparire prima di qualsiasi altra istruzione nello script.

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

2. Nel file settings.gradle 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. In dependencies del file build.gradle a livello di modulo, aggiungi una dipendenza all'SDK Places per Android:

   Nota: versione dell'SDK Places per Android 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.

   Trendy

   dependencies {
       // If updating kotlin-bom version number above, also edit project-level build.gradle definition of $kotlin_version variable
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation 'com.google.android.libraries.places:places:3.3.0'
   }

   Kotlin

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

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

   Trendy

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

   Kotlin

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

5. Nella sezione buildFeatures del file build.gradle a livello di modulo, aggiungi la classe BuildConfig, che utilizzerai per accedere ai valori dei metadati definiti in un secondo momento 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 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.

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

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

1. In Android Studio, apri l'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 alla 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 I valori di compileSdk sono impostati su 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.
   Nota: se il file secrets.properties non esiste, crealo nella stessa cartella del file local.properties.

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

   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 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. In Android Studio, apri l'build.gradle a livello di modulo oppure build.gradle.kts 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à.

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

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

Passaggio 4: Inizializzare il client API Places

Inizializza Places SDK per Android all'interno di un'attività o di un frammento. Devi prima decidi quale versione dell'SDK utilizzare: Places SDK for Android oppure SDK Places per Android (novità). Per ulteriori informazioni sulle versioni dei prodotti, consulta Scegliere la versione dell'SDK.

L'esempio seguente mostra come inizializzare l'SDK per entrambe le versioni.

SDK Places per Android (novità)

Passare la chiave API durante la chiamata 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);
    

Places SDK for Android

Passare la chiave API durante la chiamata Places.initialize():

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.initialize(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.initialize(getApplicationContext(), apiKey);

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

.

.

IMPORTANTE: non aggiungere mai chiavi API direttamente il codice dell'applicazione. In ambienti di produzione, consigliamo di utilizzare una meccanismo di sicurezza 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 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.
  Nota: se scegli di utilizzare un emulatore Android, assicurati che scegli un dispositivo con l'icona Play, , visualizzata nella colonna Play Store. Questa icona indica che questi profili sono completamente CTS. conformi e potrebbero utilizzare immagini di sistema che includono l'app Play Store:

  

Passaggi successivi

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