Configurazione del progetto: versione 4.99 e precedenti

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

Requisiti minimi per l'utilizzo di Navigation SDK

Questi requisiti si applicano a Navigation SDK for Android versione 4.99 e precedenti.

  • Une console Google Cloud

    nella console Google Cloud con Navigation SDK abilitato. Per il provisioning, contatta il tuo rappresentante di Google Maps Platform.

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

  • Per eseguire un'app creata con Navigation SDK, sul dispositivo Android devono essere Google Play Services installati e attivati.

  • All'app devono essere aggiunti i testi di attribuzione e licenza.

Configurare 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 avere il provisioning per accedere a Navigation SDK. A tutte le chiavi all'interno del progetto della console Cloud viene concesso lo stesso accesso a Navigation SDK. A una chiave possono essere associati più progetti di sviluppo. Se hai già un progetto della console, puoi aggiungere una chiave al progetto corrente.

Per configurare

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

Aggiungere Navigation SDK al progetto

Navigation SDK è disponibile tramite Maven o come bundle AAR. Dopo aver creato il progetto di sviluppo, puoi integrarlo utilizzando uno dei seguenti approcci.

Utilizzare Maven per Navigation SDK v4.5 e versioni successive (scelta consigliata)

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

  1. Aggiungi la seguente dipendenza alla configurazione di Gradle o Maven, sostituendo il segnaposto VERSION_NUMBER con la versione di Navigation SDK for Android.

    Gradle

    Aggiungi quanto segue a 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 di gruppo e artefatto sono cambiati e il plug-in com.google.cloud.artifactregistry.gradle-plugin non è più necessario.

    Aggiungi quanto segue a build.gradle a livello principale:

    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>
    

Utilizzare Maven per Navigation SDK precedente alla v4.5 o con Driver SDK

Navigation SDK 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 fornisce la 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 in the Prerequisiti sezione della documentazione di Consumer SDK. L'accesso a Navigation SDK è 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 di Navigation SDK.

    Gradle

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

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

    Aggiungi quanto segue a build.gradle a livello principale:

    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>
    

Utilizzare un bundle AAR scaricato (scelta non consigliata)

Navigation SDK è disponibile anche come un 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 di Navigation SDK 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 a build.gradle a livello di modulo:

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

    Aggiungi quanto segue a build.gradle a livello principale:

    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 build e un utilizzo di Navigation SDK riusciti.

Aggiornare le proprietà locali

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

Aggiornare 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 obbligatorie per Navigation SDK

    1. Imposta minSdkVersion su 23 o versioni successive.
    2. Imposta targetSdkVersion su 30 o versioni successive.
    3. Aggiungi un'impostazione dexOptions che aumenti javaMaxHeapSize.
    4. Imposta la posizione per le librerie aggiuntive.
    5. Aggiungi repositories e dependencies per Navigation SDK.
    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 il codice e le risorse inutilizzati dalle dipendenze. Se l'esecuzione del passaggio R8/ProGuard richiede troppo tempo, valuta la possibilità di attivare multidex per il lavoro di sviluppo.
    • Riduci il numero di traduzioni linguistiche 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. Controlla le app di esempio per i set di dipendenze aggiornati, poiché la versione di Navigation SDK che stai utilizzando 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 della versione, 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 e archiviare la chiave API:

  1. In Android Studio, apri il file build.gradle a livello principale e aggiungi il seguente codice all'elemento dependencies in buildscript.

    Groovy

    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 app e aggiungi il seguente codice all' plugins elemento.

    Groovy

    plugins {
        id 'com.android.application'
        // ...
        id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
    }

    Kotlin

    plugins {
        id("com.android.application")
        // ...
        id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
    }
  3. Se utilizzi Android Studio, sincronizza il progetto con Gradle.
  4. Apri local.properties nella directory a livello di progetto, quindi aggiungi il seguente codice. Sostituisci YOUR_API_KEY con la tua chiave API.
    MAPS_API_KEY=YOUR_API_KEY
  5. Puoi aggiungere la chiave API al file AndroidManifest.xml o fornirla a livello di programmazione.
    • Aggiungi la chiave API a AndroidManifest.xml:
      <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 multiple API basate su Google Maps sulla piattaforma Android, incluso il Navigation SDK for 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 di Google Maps per Android v2. Un'applicazione può specificare solo uno dei nomi dei metadati della chiave API. Se vengono specificati entrambi, l'API genera un'eccezione.

    • Fornisci la chiave API a livello di programmazione:

      Il plug-in Secrets Gradle rende la chiave disponibile nella classe BuildConfig. Nell'inizializzazione dell'app (ad esempio, nel metodo Application.onCreate()), chiama il metodo nel seguente modo:

      Kotlin

      1. Aggiungi le seguenti istruzioni di importazione:
        import com.google.android.libraries.navigation.NavigationApi
      2. Aggiungi quanto segue al metodo Application.onCreate():
        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)

      Java

      1. Aggiungi le seguenti istruzioni di importazione:
        import com.google.android.libraries.navigation.NavigationApi;
      2. Aggiungi quanto segue al metodo Application.onCreate():
        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY);
      Nota:quando utilizzi setApiKey(), tieni presente quanto segue:
      • Fornisci una chiave API non nulla e non vuota.
      • Chiama setApiKey() una sola volta durante il ciclo di vita dell'applicazione. Il metodo genera un'eccezione IllegalStateException se viene chiamato più di una volta.
      • Chiama setApiKey() prima di inizializzare altri componenti di Navigation SDK, come Navigator.
      • La chiave fornita con questo metodo sostituisce qualsiasi chiave API in AndroidManifest.xml.
      • Utilizza Navigation SDK versione 7.6 o successive.

Includere le attribuzioni richieste nell'app

Se utilizzi Navigation SDK for 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 dell'attribuzione e le licenze open source richieste nel file ZIP di Navigation SDK for Android:

  • NOTICE.txt
  • LICENSES.txt