Configurazione del progetto: versione 4.99 e precedenti

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

Requisiti minimi per l'utilizzo dell'SDK di navigazione

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

  • Un progetto della console Google Cloud con l'SDK di navigazione abilitato. Per il provisioning, chiedi 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, è necessario sul dispositivo deve essere installato Google Play Services installato e abilitato.

  • Attribuzioni e testo delle licenze devono essere aggiunti all'app.

Configura i tuoi progetti: progetto Cloud Console e progetto Android

Prima di poter creare o testare un'app, devi creare un progetto nella console Cloud e aggiungi le credenziali della chiave API. Il progetto deve disporre del provisioning per accedere SDK di navigazione. Tutte le chiavi all'interno del progetto della console Cloud viene concesso lo stesso accesso all'SDK di navigazione. Una chiave può essere associato a 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 all' console Cloud e creare Console Cloud progetto.
  2. Nel tuo IDE, ad esempio Android Studio, crea uno sviluppo di app Android e prendi nota del nome del pacchetto.
  3. Contatta il tuo rappresentante di Google Maps Platform per fornire l'accesso ai SDK di navigazione per la console Cloud progetto.
  4. Nella dashboard della console Cloud nel browser web, creare credenziali per generare una chiave API con restrizioni.
  5. Nella pagina della chiave API, fai clic su App Android in Limitazioni applicazioni geografica specifica.
  6. Fai clic su Aggiungi il nome del pacchetto e l'impronta, quindi inserisci il pacchetto. del progetto di sviluppo e l'impronta SHA-1 della chiave.
  7. 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.

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

  1. Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto VERSION_NUMBER con desiderata dell'SDK di navigazione 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 il gruppo e i nomi degli artefatti sono cambiati Il plug-in com.google.cloud.artifactregistry.gradle-plugin non è più necessaria.

    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 Maps SDK, devi escludere 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 Maven per l'SDK di navigazione precedente alla v4.5 o con l'SDK driver

L'SDK di navigazione continua a essere disponibile tramite la il repository Maven originale nelle altre versioni v4. Questo è il la stessa libreria con gli stessi aggiornamenti della versione precedente e fornisce compatibilità con Driver SDK e altre librerie durante la transizione. Utilizzo questa dipendenza richiede l'accesso al tuo progetto cloud tramite gcloud quando in fase di compilazione.

  1. Configura il tuo ambiente per accedere al Repository Maven di Google come descritto in Prerequisiti della documentazione relativa all'SDK consumer. L'accesso ai L'SDK di navigazione è controllato tramite un gruppo di aree di lavoro.
  2. Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto Segnaposto VERSION_NUMBER per la versione desiderata dell'SDK di navigazione.

    Gradle

    Aggiungi quanto segue al campo 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 Maps SDK, devi escludere 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>
    

L'SDK di navigazione è disponibile anche come pacchetto AAR. Dopo aver creato il progetto di sviluppo, puoi integrare l'SDK. Queste istruzioni presupporre l'utilizzo di Android Studio per il tuo IDE.

  1. Scarica l'ultima versione dell'SDK di navigazione dal Google Drive condiviso e decomprimilo. Se non disponi dell'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 in della directory app/libs del progetto.

  4. Aggiungi quanto segue al campo 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 di un la creazione e l'utilizzo dell'SDK di navigazione correttamente.

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 seguenti per aggiorna le impostazioni per soddisfare i requisiti dell'SDK di navigazione e valuta l'opportunità di impostare anche le opzioni di ottimizzazione.

    Impostazioni obbligatorie per l'SDK di navigazione

    1. Imposta minSdkVersion su 23 o più.
    2. Imposta targetSdkVersion su un valore pari o superiore a 30.
    3. Aggiungi un'impostazione di dexOptions che aumenti il valore di javaMaxHeapSize.
    4. Imposta la posizione 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 il tempo di compilazione

    • Attiva 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 abilitare multidex per attività di sviluppo.
    • Riduci il numero di traduzioni in lingue incluse nella build: imposta resConfigs per una lingua durante lo sviluppo. Per la build finale, imposta resConfigs per le lingue che usi attualmente. Per impostazione predefinita, Gradle include stringhe delle risorse per tutti i linguaggi supportati dall'SDK di navigazione.

Di seguito è riportato un esempio dello script di build Gradle per l'applicazione. Controlla il app di esempio per insiemi aggiornati di dipendenze, come versione di L'SDK di navigazione che stai utilizzando potrebbe essere leggermente in avanti o dietro 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 da potervi fare riferimento in modo sicuro la tua app. Non dovresti verificare la chiave API nel tuo sistema di controllo della versione, quindi ti consigliamo archiviandolo nel file secrets.properties, che si trova nella directory radice del progetto. Per ulteriori informazioni sul file secrets.properties, vedi File delle proprietà di Gradle.

Per semplificare questa attività, ti consigliamo di utilizzare 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 l'build.gradle.kts o build.gradle di primo livello e aggiungi il seguente codice all'elemento dependencies in 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 sono impostati a 34.
  4. Salva il file e sincronizzare il progetto con Gradle.
  5. Apri il file secrets.properties nella directory di primo livello, quindi aggiungi seguire il codice. Sostituisci YOUR_API_KEY con la tua chiave API. Memorizza la chiave in questo file perché secrets.properties è escluso dall'archiviazione in un controllo della versione di un sistema operativo completo.
    NAV_API_KEY=YOUR_API_KEY
  6. Salva il file.
  7. Crea il file local.defaults.properties nella directory di primo livello, uguale cartella come file secrets.properties, quindi aggiungi il codice riportato di seguito.

    NAV_API_KEY=DEFAULT_API_KEY

    Lo scopo di questo file è fornire un percorso di backup per la chiave API se Impossibile trovare il file secrets.properties per evitare errori di build. Ciò può verificarsi 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 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.kts or build.gradle 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.

    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 testo di attribuzione e licenze open source nell'ambito delle note legali dell'app .

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

  • NOTICE.txt
  • LICENSES.txt