Configura il progetto

Questa guida elenca i requisiti di configurazione della build per l'utilizzo dell'SDK di navigazione per Android versione 5.0.0 e successive.

Le istruzioni presuppongono che tu abbia installato un IDE Android e dimestichezza con lo sviluppo Android.

Requisiti minimi per l'utilizzo dell'SDK di navigazione

Questi requisiti si applicano all'SDK di navigazione per Android 5.0.0 e versioni successive.

  • Un progetto della console Google Cloud con l'SDK di navigazione abilitato. Per il provisioning, rivolgiti al tuo rappresentante di Google Maps Platform.

  • La tua app deve specificare le versioni di Android come segue:

    • La versione target deve essere Android 13 (livello API 33) o versioni successive.
    • La versione minima deve essere Android 6 (livello API 23) o versioni successive.
  • Per eseguire un'app creata con l'SDK di navigazione, il dispositivo Android deve soddisfare i seguenti requisiti:

  • Le attribuzioni e il testo delle licenze devono essere aggiunti all'app.

Configura i progetti: progetto Cloud Console e progetto Android

Prima di poter creare o testare un'app, devi creare un progetto della console Cloud e aggiungere le credenziali della chiave API. Il progetto deve disporre del provisioning per accedere all'SDK di navigazione. A tutte le chiavi all'interno del progetto della console Cloud viene concesso lo stesso accesso a Navigation SDK. A una chiave può essere associato più di un progetto di sviluppo. Se hai già un progetto nella console, puoi aggiungere una chiave a quello attuale.

Per configurare

  1. Nel tuo browser web preferito, accedi alla console Cloud e crea il tuo progetto nella console Cloud.
  2. Nel tuo IDE, ad esempio Android Studio, crea un progetto di sviluppo di app Android e prendi nota del nome del pacchetto.
  3. Contatta il tuo rappresentante di Google Maps Platform per fornire l'accesso all'SDK di navigazione per il tuo progetto nella console Cloud.
  4. Nella dashboard della console Cloud nel browser web, crea le credenziali per generare una chiave API con restrizioni.
  5. Nella pagina Chiave API, fai clic su App Android nell'area Limitazioni applicazioni.
  6. Fai clic su Aggiungi il nome del pacchetto e l'impronta, quindi inserisci il nome del pacchetto del progetto di sviluppo e l'impronta SHA-1 per la chiave.
  7. Fai clic su Salva.

Aggiungi l'SDK di navigazione al progetto

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.

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

  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 tuo 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 stati modificati e che il plug-in com.google.cloud.artifactregistry.gradle-plugin non è più necessario.

    Inoltre, aggiungi quanto segue al tuo 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 sono presenti 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 l'utilizzo corretti 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 segui le linee guida che seguono per aggiornare le impostazioni in modo da soddisfare i requisiti dell'SDK di navigazione e valutare anche la possibilità di impostare le opzioni di ottimizzazione.

    Impostazioni obbligatorie per l'SDK Navigazione

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

    Impostazioni facoltative per ridurre i tempi di compilazione

    • Abilita la riduzione del codice e delle risorse utilizzando R8/ProGuard per rimuovere il codice e le risorse inutilizzati dalle dipendenze. Se l'esecuzione del passaggio R8/ProGuard richiede troppo tempo, ti consigliamo di abilitare multidex per le attività di sviluppo.
    • Riduci il numero di traduzioni 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 di risorse per tutte le lingue supportate 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 Java 8. Per ulteriori informazioni, consulta la pagina relativa al supporto per la rimozione di Java 8. Consulta lo snippet di script di build di seguito per informazioni sulle opzioni di compilazione e dipendenza.

Di seguito è riportato un esempio dello script di build Gradle per l'applicazione. Controlla le app di esempio per insiemi di dipendenze aggiornati, poiché la versione dell'SDK di navigazione che stai utilizzando potrebbe essere leggermente superiore o precedente 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 possa essere utilizzata in modo sicuro come riferimento dall'applicazione. Non controllare la chiave API nel sistema di controllo della versione, pertanto ti consigliamo di memorizzarla nel file secrets.properties, che si trova nella directory root del progetto. Per ulteriori informazioni sul file secrets.properties, consulta File delle 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 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 e aggiungi il codice seguente. Sostituisci YOUR_API_KEY con la tua chiave API. Archivia la chiave in questo file perché secrets.properties è escluso dal check-in in un sistema di controllo della versione.
    MAPS_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.

    MAPS_API_KEY=DEFAULT_API_KEY

    Lo scopo di questo file è fornire un percorso di backup per la chiave API nel caso in cui il file secrets.properties non venga trovato, in modo che le build non generino errori. 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 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 utilizzi l'SDK Navigation per Android nella tua app, devi includere il testo dell'attribuzione e le licenze open source nella sezione delle note legali dell'app.

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

  • NOTICE.txt
  • LICENSES.txt

Se sei un cliente Mobility o Fleet Engine Deliveries

Se sei un cliente Mobility o Fleet Engine Deliveries, scopri di più sulla fatturazione nella documentazione su Mobility. Per maggiori informazioni sulla registrazione delle transazioni, consulta Configurare la fatturazione, Registrare le transazioni fatturabili, Report e Registrare le transazioni fatturabili (Android).