Configurazione del progetto: versione 4.99 e precedenti

Questa guida elenca i requisiti di configurazione della build per l'utilizzo di Navigation SDK per Android. Le istruzioni presuppongono che tu abbia installato un IDE Android e che tu abbia familiarità con lo sviluppo per Android.

Requisiti minimi per l'utilizzo di Navigation SDK

Questi requisiti si applicano all'SDK Navigation per Android versione 4.99 e precedenti.

  • Una console Google Cloud

    progetto con l'SDK Navigation abilitato. Per il provisioning, rivolgiti al tuo rappresentante di Google Maps Platform.

  • La tua app deve avere come target il livello API 30 o versioni successive.

  • Per eseguire un'app creata con l'SDK Navigation, il dispositivo Android deve avere Google Play Services installato e abilitato.

  • Il testo di attribuzione e licenza deve essere aggiunto all'app.

Configura i progetti: il progetto della console Cloud e il progetto Android

Prima di poter creare o testare un'app, devi creare un progetto della console Google Cloud e aggiungere le credenziali della chiave API. Il progetto deve avere il provisioning per accedere all'SDK Navigation. 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

  1. Nel tuo browser web preferito, accedi alla console Cloud e crea il tuo progetto console Cloud.
  2. Nel tuo IDE, ad esempio Android Studio, crea un progetto di sviluppo di app per Android e annota il nome del pacchetto.
  3. Contatta il tuo rappresentante di Google Maps Platform per fornire l'accesso all'SDK Navigation per il tuo progetto della console Cloud.
  4. Mentre ti trovi nella dashboard della console Cloud nel browser web, crea le credenziali per generare una chiave API con limitazioni.
  5. Nella pagina della chiave API, fai clic su App Android nell'area Limitazioni dell'applicazione.
  6. Fai clic su Aggiungi il nome del pacchetto e l'impronta, quindi inserisci il nome del pacchetto del tuo progetto di sviluppo e l'impronta SHA-1 per quella chiave.
  7. 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.

Utilizzare Maven per l'SDK Navigation v4.5 e versioni successive (consigliato)

Il seguente esempio utilizza il repository Maven google(), che è il modo più semplice e consigliato per aggiungere l'SDK Navigation al tuo progetto

  1. Aggiungi la seguente dipendenza alla configurazione di Gradle o Maven, sostituendo il segnaposto VERSION_NUMBER con la versione dell'SDK Navigation 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 del gruppo e dell'artefatto sono cambiati e che il plug-in com.google.cloud.artifactregistry.gradle-plugin non è più necessario.

    Aggiungi quanto segue al build.gradle di primo livello:

    allprojects {
    ...
    // Required: you must exclude the Google Play service Maps SDK from
    // your transitive dependencies to make nsure 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 quanto segue 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>
    

Utilizza Maven per l'SDK Navigation precedente alla versione 4.5 o con Driver SDK

L'SDK Navigation continua a essere disponibile utilizzando il repository Maven originale per il resto delle versioni v4. Si tratta della stessa libreria con tutti gli stessi aggiornamenti della versione precedente e offre compatibilità con Driver SDK e altre librerie durante la transizione. L'utilizzo di questa dipendenza richiede l'accesso al progetto cloud utilizzando gcloud durante la compilazione.

  1. Configura l'ambiente per accedere al repository Maven di Google come descritto nella sezione Prerequisiti della documentazione dell'SDK Consumer. L'accesso all'SDK di navigazione è controllato tramite un gruppo di workspace.
  2. Aggiungi la seguente dipendenza alla configurazione di Gradle o Maven, sostituendo il segnaposto VERSION_NUMBER con la versione dell'SDK Navigation.

    Gradle

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

    dependencies {
    ...
    implementation 'com.google.android.maps:navsdk:VERSION_NUMBER'
    }
    

    Aggiungi quanto segue al build.gradle di primo livello:

    allprojects {
    ...
    // Required: you must exclude the Google Play service Maps SDK from
    // your transitive dependencies to make sure 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 quanto segue 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 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>
    

Utilizza un bundle AAR scaricato (scelta non consigliata)

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 per l'IDE.

  1. Scarica l'ultima versione dell'SDK Navigation da Google Drive condiviso ed estraila. Se non hai accesso, contatta il tuo rappresentante.

  2. In Android Studio, apri un progetto e aggiungi il pacchetto Google Play Services utilizzando SDK Manager.

  3. Dalla directory del file zip, copia libs/google_navigation_navmap.aar nella directory app/libs del progetto.

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

    implementation(name: 'google_navigation_navmap', ext: 'aar')
    

    Aggiungi quanto segue al build.gradle di primo livello:

    allprojects {
       ...
       // Required: you must exclude the Google Play service Maps SDK from
       // your transitive dependencies to make sure 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'
           }
       }
    }
    

Configurare la build

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

Aggiornare le 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 che soddisfino i requisiti di Navigation SDK e valuta la possibilità di impostare anche le opzioni di ottimizzazione.

    Impostazioni richieste per l'SDK Navigation

    1. Imposta minSdkVersion su 23 o un valore superiore.
    2. Imposta targetSdkVersion su 30 o un valore superiore.
    3. Aggiungi un'impostazione dexOptions che aumenti il javaMaxHeapSize.
    4. Imposta la posizione per le librerie aggiuntive.
    5. Aggiungi repositories e dependencies per l'SDK Navigation.
    6. 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 il passaggio R8/ProGuard richiede troppo tempo per l'esecuzione, valuta la possibilità di attivare multidex per il lavoro 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 le stringhe di risorse per tutte le lingue supportate da Navigation SDK.

Di seguito è riportato un esempio dello script di build Gradle per l'applicazione. Consulta le app di esempio per set di dipendenze aggiornati, poiché la versione di Navigation SDK che utilizzi potrebbe essere leggermente precedente o successiva 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. Make sure 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'
}

Aggiungere la chiave API all'app

Questa sezione descrive come archiviare la chiave API in modo che possa essere referenziata in modo sicuro dalla tua app. Non devi archiviare la chiave API nel sistema di controllo delle versioni, pertanto ti consigliamo di archiviarla nel file secrets.properties, che si trova nella directory principale del 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:

  1. In Android Studio, apri il file build.gradle.kts o build.gradle di primo livello e aggiungi il seguente codice all'elemento dependencies sotto buildscript.

    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"
        }
    }
  2. Apri il file build.gradle.kts o build.gradle a livello di modulo e aggiungi il seguente codice all'elemento plugins.

    Kotlin

    plugins {
        // ...
        id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
    }

    Trendy

    plugins {
        // ...
        id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
    }
  3. Nel file build.gradle.kts o build.gradle a livello di modulo, assicurati che targetSdk e compileSdk siano impostati su 34.
  4. 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. Memorizza la chiave in questo file perché secrets.properties è escluso dal controllo in un sistema di controllo delle versioni.
    MAPS_API_KEY=YOUR_API_KEY
  6. Crea il file local.defaults.properties nella directory di primo livello, la stessa cartella del file secrets.properties, quindi aggiungi il seguente codice.

    MAPS_API_KEY=DEFAULT_API_KEY

    Lo scopo di questo file è fornire una posizione di backup per la chiave API se il file secrets.properties non viene trovato, in modo che le build non non vadano a buon fine. Ciò può accadere se cloni l'app da un sistema di controllo delle versioni che omette secrets.properties e non hai ancora creato un file secrets.properties localmente per fornire la chiave API.

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

    Nota:com.google.android.geo.API_KEY è il nome dei metadati consigliato per la chiave API. Una chiave con questo nome può essere utilizzata per l'autenticazione a più API basate su Google Maps sulla piattaforma Android, incluso l'SDK Navigation per Android. Per la compatibilità con le versioni precedenti, l'API supporta anche il nome com.google.android.maps.v2.API_KEY. Questo nome legacy consente l'autenticazione solo all'API Android Maps v2. Un'applicazione può specificare solo uno dei nomi dei metadati della chiave API. Se vengono specificati entrambi, l'API genera un'eccezione.

  8. In Android Studio, apri il file build.gradle.kts o build.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 su secrets.properties, imposta defaultPropertiesFileName su local.defaults.properties e imposta qualsiasi altra 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"
    }
            

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

Includere le attribuzioni richieste nella tua app

Se utilizzi l'SDK Navigation per Android nella tua app, devi includere il testo di attribuzione e le licenze open source nella sezione delle note legali della tua 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