Configurare un progetto Android Studio

L'SDK di navigazione è disponibile tramite Maven. Dopo aver creato il progetto di sviluppo, puoi integrare l'SDK al suo interno utilizzando uno dei seguenti approcci.

Importante: devi utilizzare le dipendenze Maven nel progetto per collegare l'SDK di navigazione per Android.

Utilizzo di Maven per l'SDK di navigazione (consigliato)

Di seguito viene utilizzato il Repository Maven di google(), che rappresenta il modo più semplice e consigliato per aggiungere l'SDK di navigazione al progetto.

Nota: questo metodo non è compatibile con alcune librerie che dipendono da SDK di navigazione tramite l'ID artefatto precedente. Sono incluse le release dell'SDK Driver 4.4 o precedenti.

1. Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto VERSION_NUMBER con la versione desiderata dell'SDK di navigazione per Android.

   Gradle

   Aggiungi quanto segue al campo build.gradle a livello di modulo:

   dependencies {
   ...
   implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
   }
   

   Se esegui l'upgrade dal repository Maven originale, tieni presente che i nomi dei gruppi e degli artefatti sono cambiati e il plug-in com.google.cloud.artifactregistry.gradle-plugin non è più necessario.

   Inoltre, aggiungi quanto segue al build.gradle di primo livello:

   allprojects {
   ...
   // Required: you must exclude the Google Play service Maps SDK from
   // your transitive dependencies. This is to ensure there won't be
   // multiple copies of Google Maps SDK in your binary, as the Navigation
   // SDK already bundles the Google Maps SDK.
   configurations {
           implementation {
               exclude group: 'com.google.android.gms', module: 'play-services-maps'
           }
   }
   }
   

   Maven

   Aggiungi il seguente codice a pom.xml:

   <dependencies>
     ...
     <dependency>
       <groupId>com.google.android.libraries.navigation</groupId>
       <artifactId>navigation</artifactId>
       <version>VERSION_NUMBER</version>
     </dependency>
   </dependencies>
   

   Se hai dipendenze che utilizzano Maps SDK, devi escludere la dipendenza in ogni dipendenza dichiarata che si basa su Maps SDK.

   <dependencies>
     <dependency>
     <groupId>project.that.brings.in.maps</groupId>
     <artifactId>MapsConsumer</artifactId>
     <version>1.0</version>
       <exclusions>
         <!-- Navigation SDK already bundles Maps SDK. You must exclude it to prevent duplication-->
         <exclusion>  <!-- declare the exclusion here -->
           <groupId>com.google.android.gms</groupId>
           <artifactId>play-services-maps</artifactId>
         </exclusion>
       </exclusions>
     </dependency>
   </dependencies>
   

Configura la build

Dopo aver creato il progetto, puoi configurare le impostazioni per una build e un utilizzo riusciti dell'SDK di navigazione.

Aggiorna proprietà locali

• Nella cartella Gradle Scripts, apri il file local.properties e aggiungi android.useDeprecatedNdk=true.

Aggiorna lo script di build Gradle

• Apri il file build.gradle (Module:app) e utilizza le seguenti linee guida per aggiornare le impostazioni in modo da soddisfare i requisiti dell'SDK di navigazione e valuta la possibilità di impostare anche le opzioni di ottimizzazione.

  Impostazioni obbligatorie per l'SDK di navigazione

  1. Imposta minSdkVersion su 23 o superiore.
  2. Imposta targetSdkVersion su 33 o superiore.
  3. Aggiungi un'impostazione di dexOptions che aumenti il valore di javaMaxHeapSize.
  4. Imposta la posizione per le librerie aggiuntive.
  5. Aggiungi repositories e dependencies per l'SDK di navigazione.
  6. Sostituisci i numeri di versione nelle dipendenze con le ultime versioni disponibili.

  Impostazioni facoltative per ridurre il tempo di compilazione

  • Abilita la contrazione del codice e delle risorse utilizzando R8/ProGuard per rimuovere le risorse e il codice inutilizzati dalle dipendenze. Se l'esecuzione del passaggio R8/ProGuard richiede troppo tempo, valuta la possibilità di abilitare multidex per le attività di sviluppo.
  • Riduci il numero di traduzioni in diverse lingue incluse nella build: imposta resConfigs per una lingua durante lo sviluppo. Per la build finale, imposta resConfigs per le lingue che utilizzi effettivamente. Per impostazione predefinita, Gradle include stringhe delle risorse per tutti i linguaggi supportati dall'SDK di navigazione.

  Aggiungere il desugaring per il supporto Java8

  • Se stai creando la tua app utilizzando il plug-in Android per Gradle 4.0.0 o versioni successive, il plug-in estende il supporto per l'utilizzo di una serie di API del linguaggio Java 8. Per ulteriori informazioni, consulta Supporto per il desugaring di Java 8. Per informazioni sulle opzioni di compilazione e dipendenza, vedi lo snippet dello script di build di esempio riportato di seguito.

Di seguito è riportato un esempio dello script di build Gradle per l'applicazione. Controlla se nelle app di esempio sono presenti insiemi di dipendenze aggiornati, poiché la versione dell'SDK di navigazione in uso potrebbe essere leggermente in avanti o indietro rispetto a questa documentazione.

apply plugin: 'com.android.application'

ext {
    navSdk = "__NAVSDK_VERSION__"
}

android {
    compileSdk 33
    buildToolsVersion='28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 33
        versionCode 1
        versionName "1.0"
        // Set this to the languages you actually use, otherwise you'll include resource strings
        // for all languages supported by the Navigation SDK.
        resConfigs "en"
        multiDexEnabled true
    }

    dexOptions {
        // This increases the amount of memory available to the dexer. This is required to build
        // apps using the Navigation SDK.
        javaMaxHeapSize "4g"
    }
    buildTypes {
        // Run ProGuard. Note that the Navigation SDK includes its own ProGuard configuration.
        // The configuration is included transitively by depending on the Navigation SDK.
        // If the ProGuard step takes too long, consider enabling multidex for development work
        // instead.
        all {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled true
        // Sets Java compatibility to Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

repositories {
    // Navigation SDK for Android and other libraries are hosted on Google's Maven repository.
    google()
}

dependencies {
    // Include the Google Navigation SDK.
    // Note: remember to exclude Google Play service Maps SDK from your transitive
    // dependencies to avoid duplicate copies of the Google Maps SDK.
    api "com.google.android.libraries.navigation:navigation:${navSdk}"

    // Declare other dependencies for your app here.

    annotationProcessor "androidx.annotation:annotation:1.7.0"
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.9'
}

Aggiungi la chiave API all'app

Questa sezione descrive come archiviare la chiave API in modo che l'app possa farvi riferimento in modo sicuro. Non dovresti verificare la chiave API nel tuo sistema di controllo della versione, quindi ti consigliamo di memorizzarla nel file secrets.properties, che si trova nella directory radice del tuo progetto. Per ulteriori informazioni sul file secrets.properties, consulta File delle proprietà di Gradle.

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

Nota : consulta la documentazione del plug-in Secrets Gradle per Android su GitHub per 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, quindi aggiungi il codice seguente. Sostituisci YOUR_API_KEY con la tua chiave API. Archivia la chiave in questo file perché secrets.properties è escluso dall'archiviazione in un sistema di controllo della versione.
   Nota: se il file secrets.properties non esiste, crealo nella stessa cartella del file local.properties.

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

   NAV_API_KEY=DEFAULT_API_KEY

   Lo scopo di questo file è fornire un percorso di backup per la chiave API se non viene trovato il file secrets.properties, in modo da evitare errori di build. Questo può accadere se cloni l'app da un sistema di controllo della versione che omette secrets.properties e non hai ancora creato in locale un file secrets.properties 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 Navigation 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.*"
    }
            

Includi le attribuzioni richieste nella tua app

Se nella tua app utilizzi l'SDK di navigazione per Android, devi includere il testo di attribuzione e le licenze open source nella sezione delle note legali dell'app.

Punto chiave: per includere le attribuzioni, aggiungile come voce di menu indipendente o come voce in un menu Informazioni.

Puoi trovare il testo di attribuzione richiesto e le licenze open source nel file ZIP dell'SDK di navigazione per Android:

• NOTICE.txt
• LICENSES.txt

Se sei un cliente di soluzioni di mobilità o di Fleet Engine Deliveries

Se sei un cliente di soluzioni per la mobilità o le consegne di Fleet Engine, scopri di più sulla fatturazione nella documentazione relativa alla mobilità. Per maggiori informazioni sulla registrazione delle transazioni, consulta gli articoli Configurare la fatturazione, Registrare le transazioni fatturabili, Reporting e Registrare le transazioni fatturabili (Android).