Questa guida elenca i requisiti di configurazione della build per l'utilizzo dell'SDK di navigazione per Android. 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 4.99 e versioni precedenti.
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 avere il livello API target 30 o versioni successive.
Per eseguire un'app creata con l'SDK di navigazione, sul dispositivo Android deve essere installato e attivato Google Play Services.
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 a Navigatore SDK. 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 della console, puoi aggiungere una chiave al progetto attuale.
Per configurare
- Nel tuo browser web preferito, accedi alla console Cloud e crea il tuo progetto nella console Cloud.
- Nel tuo IDE, ad esempio Android Studio, crea un progetto di sviluppo di app Android e prendi nota del nome del pacchetto.
- Contatta il tuo rappresentante di Google Maps Platform per fornire l'accesso all'SDK di navigazione per il tuo progetto nella console Cloud.
- Nella dashboard della console Cloud nel browser web, crea le credenziali per generare una chiave API con restrizioni.
- Nella pagina Chiave API, fai clic su App Android nell'area Limitazioni applicazioni.
- 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.
- Fai clic su Salva.
Aggiungi l'SDK di navigazione al progetto
L'SDK di navigazione è disponibile tramite Maven o come pacchetto AAR. Dopo aver creato il progetto di sviluppo, puoi integrare l'SDK al suo interno utilizzando uno dei seguenti approcci.
Utilizzare Maven per l'SDK Navigazione v4.5 e versioni successive (consigliato)
Di seguito viene utilizzato il Repository Maven di google()
, che è il modo più semplice e consigliato per aggiungere l'SDK di navigazione al tuo progetto
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>
Utilizzare l'SDK Maven per Navigazione precedente alla v4.5 oppure con l'SDK Driver
L'SDK di navigazione continua a essere disponibile tramite il Repository Maven originale fino alle altre versioni v4. Si tratta della stessa libreria con tutti gli stessi aggiornamenti della versione precedente e fornisce compatibilità con l'SDK Driver e altre librerie durante la transizione. L'utilizzo di questa dipendenza richiede l'accesso al progetto cloud tramite gcloud
durante la compilazione.
- Configura il tuo ambiente per accedere al Repository Maven di Google come descritto nella sezione Prerequisiti della documentazione relativa all'SDK per i consumatori. L'accesso all'SDK di navigazione è controllato tramite un gruppo di aree di lavoro.
Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto
VERSION_NUMBER
con la versione desiderata dell'SDK di navigazione.Gradle
Aggiungi quanto segue al tuo
build.gradle
a livello di modulo:dependencies { ... implementation 'com.google.android.maps:navsdk:VERSION_NUMBER' }
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.maps</groupId> <artifactId>navsdk</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>
Utilizzo di un bundle AAR scaricato (non consigliato)
L'SDK di navigazione è disponibile anche come pacchetto AAR. Dopo aver creato il progetto di sviluppo, puoi integrare l'SDK. In queste istruzioni si presume l'utilizzo di Android Studio per il tuo IDE.
Scarica la versione più recente dell'SDK di navigazione dal Drive Google condiviso e decomprimila. Se non riesci ad accedere, contatta il tuo rappresentante.
In Android Studio, apri un progetto e aggiungi il pacchetto Google Play Services utilizzando SDK Manager.
Dalla directory del file ZIP, copia
libs/google_navigation_navmap.aar
nella directoryapp/libs
del progetto.Aggiungi quanto segue al tuo
build.gradle
a livello di modulo:implementation(name: 'google_navigation_navmap', ext: 'aar')
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' } } }
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 aggiungiandroid.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
- Imposta
minSdkVersion
su 23 o un valore superiore. - Imposta
targetSdkVersion
su 30 o un valore superiore. - Aggiungi un'impostazione
dexOptions
che aumenta il valore dijavaMaxHeapSize
. - Imposta la località per le librerie aggiuntive.
- Aggiungi
repositories
edependencies
per l'SDK di navigazione. - 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, impostaresConfigs
per le lingue che utilizzi effettivamente. Per impostazione predefinita, Gradle include stringhe di risorse per tutte le lingue supportate dall'SDK di navigazione.
- Imposta
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'
apply plugin: 'com.google.cloud.artifactregistry.gradle-plugin'
ext {
androidxVersion = "1.0.0"
lifecycle_version = "1.1.1"
}
android {
compileSdkVersion 30
buildToolsVersion '28.0.3'
defaultConfig {
applicationId "<your id>"
// Navigation SDK supports SDK 23 and later.
minSdkVersion 23
targetSdkVersion 30
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 {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
// This tells Gradle where to look to find additional libraries - in this case, the
// google_navigation_navmap.aar file.
repositories {
flatDir {
dirs 'libs'
}
google()
// Required for accessing the Navigation SDK on Google's Maven repository.
maven {
url "artifactregistry://us-west2-maven.pkg.dev/gmp-artifacts/transportation"
}
}
dependencies {
// Include the Google Navigation SDK
implementation 'com.google.android.maps:navsdk:4.4.0'
// The included AAR file under libs can be used instead of the Maven repository.
// Uncomment the line below and comment out the previous dependency to use
// the AAR file instead. Ensure that you add the AAR file to the libs directory.
// implementation(name: 'google_navigation_navmap', ext: 'aar')
// These dependencies are required for the Navigation SDK to function
// properly at runtime.
implementation 'org.chromium.net:cronet-fallback:69.3497.100'
// Optional for Cronet users:
// implementation 'org.chromium.net:cronet-api:69.3497.100'
implementation 'androidx.appcompat:appcompat:${androidxVersion}'
implementation 'androidx.cardview:cardview:${androidxVersion}'
implementation 'com.google.android.material:material:${androidxVersion}'
implementation 'androidx.mediarouter:mediarouter:${androidxVersion}'
implementation 'androidx.preference:preference:${androidxVersion}'
implementation 'androidx.recyclerview:recyclerview:${androidxVersion}'
implementation 'androidx.legacy:legacy-support-v4:${androidxVersion}'
implementation 'com.github.bumptech.glide:glide:4.9.0'
implementation 'com.github.bumptech.glide:okhttp-integration:4.9.0'
implementation 'android.arch.lifecycle:common-java8:$lifecycle_version'
implementation 'com.android.support:multidex:1.0.3'
implementation 'com.google.android.datatransport:transport-api:2.2.0'
implementation 'com.google.android.datatransport:transport-backend-cct:2.2.0'
implementation 'com.google.android.datatransport:transport-runtime:2.2.0'
implementation 'joda-time:joda-time:2.9.9'
annotationProcessor 'androidx.annotation:annotation:1.1.0'
annotationProcessor 'com.github.bumptech.glide:compiler:4.9.0'
}
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:
-
In Android Studio, apri il file
build.gradle
obuild.gradle.kts
di primo livello e aggiungi il seguente codice all'elementodependencies
inbuildscript
.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") } }
-
Apri il file
build.gradle
a livello di modulo e aggiungi il seguente codice all'elementoplugins
.Trendy
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
Kotlin
plugins { id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
- Nel file
build.gradle
a livello di modulo, assicurati chetargetSdk
ecompileSdk
siano impostati su 34. - Salva il file e sincronizza il progetto con Gradle.
-
Apri il file
secrets.properties
nella directory di primo livello e aggiungi il codice seguente. SostituisciYOUR_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
- Salva il file.
-
Crea il file
local.defaults.properties
nella directory di primo livello, la stessa cartella del filesecrets.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 omettesecrets.properties
e non hai ancora creato un filesecrets.properties
in locale per fornire la tua chiave API. - Salva il file.
-
Nel file
AndroidManifest.xml
, vai acom.google.android.geo.API_KEY
e aggiornaandroid: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 namecom.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. -
In Android Studio, open your module-level
build.gradle
orbuild.gradle.kts
file and edit thesecrets
property. If thesecrets
property does not exist, add it.Edit the properties of the plugin to set
propertiesFileName
tosecrets.properties
, setdefaultPropertiesFileName
tolocal.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
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2024-03-15 UTC.
[] []