Questa guida elenca i requisiti di configurazione della build per utilizzare l'SDK di navigazione per Android. Le istruzioni presuppongono che tu abbia installato un IDE per Android e abbia familiarità con lo sviluppo di 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 Google Cloud Console con l'SDK Navigation abilitato. Per il provisioning, rivolgiti al tuo rappresentante di Google Maps Platform.
L'app deve avere come target il livello API 30 o versioni successive.
Per eseguire un'app creata con l'SDK Navigation, sul dispositivo Android deve essere installato e abilitato Google Play Services.
Devi aggiungere all'app attribuzioni e testo delle licenze.
Configura i progetti: progetto della console Cloud 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 all'SDK Navigation. 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 a Cloud Console e crea il tuo progetto Cloud Console.
- Nel tuo IDE, ad esempio Android Studio, crea un progetto di sviluppo di app per 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 di Cloud Console nel browser web, crea le credenziali per generare una chiave API con limitazioni.
- Nella pagina della chiave API, fai clic su App per 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.
Aggiungere l'SDK Navigation al progetto
L'SDK Navigation è disponibile tramite Maven o come bundle AAR. Dopo aver creato il progetto di sviluppo, puoi integrare l'SDK utilizzando uno dei seguenti approcci.
Utilizzo di Maven per l'SDK di navigazione v4.5 e successive (consigliato)
Di seguito viene utilizzato il repository Maven google()
, che è il modo più semplice e consigliato per aggiungere l'SDK Navigation al progetto
Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto
VERSION_NUMBER
con la versione desiderata dell'SDK Navigation 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 l'SDK Maps, devi escludere la dipendenza in ogni dipendenza dichiarata che si basa sull'SDK Maps.
<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 Maven per l'SDK di navigazione precedente alla v4.5 o 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 gli stessi aggiornamenti della versione precedente e offre compatibilità con l'SDK Driver e altre librerie durante la transizione. Per utilizzare questa dipendenza è necessario accedere al progetto cloud tramite gcloud
durante la compilazione.
- Configura l'ambiente per accedere al repository Maven di Google come descritto nella sezione Prerequisiti della documentazione dell'SDK Consumer. L'accesso all'SDK Navigation è controllato tramite un gruppo di spazi di lavoro.
Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto
VERSION_NUMBER
con la versione dell'SDK Navigation che preferisci.Gradle
Aggiungi quanto segue a
build.gradle
a livello di modulo:dependencies { ... implementation 'com.google.android.maps:navsdk:VERSION_NUMBER' }
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.maps</groupId> <artifactId>navsdk</artifactId> <version>VERSION_NUMBER</version> </dependency> </dependencies>
Se hai dipendenze che utilizzano l'SDK Maps, devi escludere la dipendenza in ogni dipendenza dichiarata che si basa sull'SDK Maps.
<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 Navigation è disponibile anche come bundle AAR. Dopo aver creato il progetto di sviluppo, puoi integrare l'SDK. Queste istruzioni presuppongono l'utilizzo di Android Studio come IDE.
Scarica la versione più recente dell'SDK Navigation da Google Drive condiviso e decomprimila. Se non hai accesso, 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 tuo progetto.Aggiungi quanto segue a
build.gradle
a livello di modulo:implementation(name: 'google_navigation_navmap', ext: 'aar')
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' } } }
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 aggiungiandroid.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 per l'SDK Navigation e valuta la possibilità di impostare anche le opzioni di ottimizzazione.Impostazioni richieste per l'SDK Navigation
- Imposta
minSdkVersion
su 23 o più. - Imposta
targetSdkVersion
su un valore pari o superiore a 30. - Aggiungi un'impostazione
dexOptions
che aumenti il valorejavaMaxHeapSize
. - Imposta la posizione per le librerie aggiuntive.
- Aggiungi
repositories
edependencies
per l'SDK Navigation. - Sostituisci i numeri di versione nelle dipendenze con le versioni più recenti disponibili.
Impostazioni facoltative per ridurre il tempo di compilazione
- Attiva la riduzione 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 lingua incluse nella compilazione: 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 delle 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 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'
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 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.
Per installare il plug-in Secrets Gradle per Android nel tuo progetto Google Maps:
-
In Android Studio, apri il file
build.gradle.kts
obuild.gradle
di primo livello e aggiungi il seguente codice all'elementodependencies
inbuildscript
.Kotlin
buildscript { dependencies { classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1") } }
Trendy
buildscript { dependencies { classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1" } }
-
Apri il file
build.gradle.kts
obuild.gradle
a livello di modulo e aggiungi il seguente codice all'elementoplugins
.Kotlin
plugins { // ... id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
Trendy
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
- Nel file
build.gradle.kts
obuild.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. Memorizza la chiave in questo file perchésecrets.properties
è esclusa dal controllo in un sistema di controllo delle versioni.NAV_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.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 omettesecrets.properties
e non hai ancora creato un filesecrets.properties
localmente 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 tag secondario del tag<application>
.<meta-data android:name="com.google.android.geo.API_KEY" android:value="${MAPS_API_KEY}" />
Nota:
com.google.android.geo.API_KEY
è il nome consigliato per i metadati per la chiave API. Una chiave con questo nome può essere utilizzata per autenticarsi a più API basate su Google Maps sulla piattaforma Android, incluso l'SDK di navigazione per Android. Per la compatibilità con le versioni precedenti, l'API supporta anche il nomecom.google.android.maps.v2.API_KEY
. Questo nome precedente consente l'autenticazione solo nell'API di Android Maps v2. Un'applicazione può specificare solo uno dei nomi dei metadati della chiave API. Se sono specificati entrambi, l'API genera un'eccezione. -
In Android Studio, apri il file
build.gradle.kts
obuild.gradle
a livello di modulo e modifica la proprietàsecrets
. Se la proprietàsecrets
non esiste, aggiungila.Modifica le proprietà del plug-in per impostare
propertiesFileName
susecrets.properties
,defaultPropertiesFileName
sulocal.defaults.properties
e altre 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 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.*" }
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.*" }
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.
Puoi trovare il testo di attribuzione richiesto e le licenze open source nel file zip dell'SDK Navigation per Android:
NOTICE.txt
LICENSES.txt