Android Studio-Projekt einrichten

Das Navigation SDK ist über Maven verfügbar. Nachdem Sie Ihr Entwicklungsprojekt erstellt haben, können Sie das SDK mit einem der folgenden Ansätze in dieses Projekt integrieren.

Wichtig :Verwenden Sie in Ihrem Projekt Maven-Abhängigkeiten, um das Navigation SDK for Android zu verknüpfen.

Maven für das Navigation SDK verwenden (empfohlen)

Im Folgenden wird das Maven-Repository google() verwendet. Dies ist die einfachste und empfohlene Methode, um Ihrem Projekt das Navigation SDK hinzuzufügen.

Hinweis: Diese Methode ist nicht mit einigen Bibliotheken kompatibel, die über die vorherige Artefakt-ID vom Navigation SDK abhängig sind. Dazu gehören auch Releases des Driver SDK Version 4.4 oder niedriger.

1. Fügen Sie Ihrer Gradle- oder Maven-Konfiguration die folgende Abhängigkeit hinzu und ersetzen Sie dabei den Platzhalter VERSION_NUMBER durch die gewünschte Version des Navigation SDK for Android.

   Gradle

   Fügen Sie build.gradle auf Modulebene Folgendes hinzu:

   dependencies {
   ...
   implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
   }
   

   Wenn Sie ein Upgrade vom ursprünglichen Maven-Repository durchführen, beachten Sie, dass sich die Gruppen- und Artefaktnamen geändert haben und das Plug-in com.google.cloud.artifactregistry.gradle-plugin nicht mehr erforderlich ist.

   Fügen Sie Ihrem build.gradle auf oberster Ebene Folgendes hinzu:

   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

   Fügen Sie zum pom.xml Folgendes hinzu:

   <dependencies>
     ...
     <dependency>
       <groupId>com.google.android.libraries.navigation</groupId>
       <artifactId>navigation</artifactId>
       <version>VERSION_NUMBER</version>
     </dependency>
   </dependencies>
   

   Wenn Sie Abhängigkeiten haben, für die das Maps SDK verwendet wird, müssen Sie die Abhängigkeit in jeder deklarierten Abhängigkeit ausschließen, die auf dem Maps SDK basiert.

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

Build konfigurieren

Nachdem Sie das Projekt erstellt haben, können Sie die Einstellungen für einen erfolgreichen Build und die Verwendung des Navigation SDK konfigurieren.

Lokale Unterkünfte aktualisieren

• Öffnen Sie im Ordner „Gradle Scripts“ die Datei local.properties und fügen Sie android.useDeprecatedNdk=true hinzu.

Gradle-Build-Skript aktualisieren

• Öffnen Sie die Datei build.gradle (Module:app) und aktualisieren Sie die Einstellungen anhand der folgenden Richtlinien, damit sie den Anforderungen für das Navigation SDK entsprechen. Legen Sie gegebenenfalls auch die Optimierungsoptionen fest.

  Erforderliche Einstellungen für das Navigation SDK

  1. Setzen Sie minSdkVersion auf 23 oder höher.
  2. Setzen Sie targetSdkVersion auf 33 oder höher.
  3. Fügen Sie eine dexOptions-Einstellung hinzu, die den javaMaxHeapSize erhöht.
  4. Legen Sie den Speicherort für zusätzliche Bibliotheken fest.
  5. Fügen Sie repositories und dependencies für das Navigation SDK hinzu.
  6. Ersetzen Sie die Versionsnummern in den Abhängigkeiten durch die neuesten verfügbaren Versionen.

  Optionale Einstellungen zur Verringerung der Build-Dauer

  • Aktivieren Sie das Code- und das Ressourcenverkleinern mithilfe von R8/ProGuard, um nicht verwendeten Code und Ressourcen aus Abhängigkeiten zu entfernen. Wenn die Ausführung des R8/ProGuard-Schritts zu viel Zeit in Anspruch nimmt, sollten Sie Multidex für Entwicklungsarbeit aktivieren.
  • Reduzieren Sie die Anzahl der im Build enthaltenen Übersetzungen: Legen Sie während der Entwicklung resConfigs für eine Sprache fest. Legen Sie für den endgültigen Build resConfigs für die Sprachen fest, die Sie tatsächlich verwenden. Standardmäßig enthält Gradle Ressourcenstrings für alle vom Navigation SDK unterstützten Sprachen.

  Desugaring für Java 8-Unterstützung hinzufügen

  • Wenn Sie Ihre App mit dem Android-Gradle-Plug-in ab Version 4.0.0 erstellen, unterstützt das Plug-in die Verwendung einer Reihe von Java 8-Sprach-APIs. Weitere Informationen finden Sie unter Unterstützung für die Java 8-Desugarierung. Das folgende Beispiel-Snippet des Build-Skripts zeigt, wie Kompilierungs- und Abhängigkeitsoptionen funktionieren.

Im Folgenden finden Sie ein Beispiel für das Gradle-Build-Skript für die Anwendung. Prüfen Sie die Beispiel-Apps auf aktualisierte Gruppen von Abhängigkeiten, da die von Ihnen verwendete Navigation SDK-Version möglicherweise etwas vor oder hinter dieser Dokumentation ist.

apply plugin: 'com.android.application'

ext {
    navSdk = "__NAVSDK_VERSION__"
}

android {
    compileSdk 33
    buildToolsVersion='28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 33
        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 {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled true
        // Sets Java compatibility to Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

repositories {
    // Navigation SDK for Android and other libraries are hosted on Google's Maven repository.
    google()
}

dependencies {
    // Include the Google Navigation SDK.
    // Note: remember to exclude Google Play service Maps SDK from your transitive
    // dependencies to avoid duplicate copies of the Google Maps SDK.
    api "com.google.android.libraries.navigation:navigation:${navSdk}"

    // Declare other dependencies for your app here.

    annotationProcessor "androidx.annotation:annotation:1.7.0"
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.9'
}

API-Schlüssel in die App einfügen

In diesem Abschnitt wird beschrieben, wie Sie Ihren API-Schlüssel speichern, damit er von Ihrer App sicher referenziert werden kann. Er sollte nicht in Ihrem Versionsverwaltungssystem eingecheckt werden. Stattdessen empfehlen wir, ihn im Stammverzeichnis Ihres Projekts in der Datei secrets.properties zu speichern. Weitere Informationen zur Datei secrets.properties finden Sie unter Gradle properties files.

Sie können das Secrets Gradle-Plug-in for Android verwenden, um diese Aufgabe zu optimieren.

Hinweis: Aktuelle Systemanforderungen und Installationsanleitungen finden Sie in der Dokumentation zum Secrets Gradle-Plug-in für Android auf GitHub.

So installieren Sie das Secrets Gradle-Plug-in für Android in Ihrem Google Maps-Projekt:

1. Öffnen Sie in Android Studio die Datei build.gradle oder build.gradle.kts auf oberster Ebene und fügen Sie den folgenden Code in das dependencies-Element unter buildscript ein.

   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. Öffnen Sie die Datei build.gradle auf Modulebene und fügen Sie dem plugins-Element den folgenden Code hinzu.

   Groovy

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

   Kotlin

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

3. In der Datei build.gradle auf Modulebene müssen targetSdk und compileSdk auf 34 gesetzt sein.
4. Speichern Sie die Datei und synchronisieren Sie Ihr Projekt mit Gradle.
5. Öffnen Sie die Datei secrets.properties im Verzeichnis der obersten Ebene und fügen Sie den folgenden Code ein. Ersetzen Sie dabei YOUR_API_KEY durch Ihren eigenen API-Schlüssel. Speichern Sie den Schlüssel in dieser Datei, da secrets.properties nicht in ein Versionsverwaltungssystem eingecheckt werden kann.
   Hinweis: Sollte die Datei secrets.properties nicht vorhanden sein, erstellen Sie sie im selben Ordner wie die Datei local.properties.

   NAV_API_KEY=YOUR_API_KEY

6. Speichern Sie die Datei.

7. Erstellen Sie die Datei local.defaults.properties im Verzeichnis der obersten Ebene, im selben Ordner wie die Datei secrets.properties, und fügen Sie folgenden Code ein.

   Hinweis: Geben Sie den Code genau wie hier gezeigt ein. Ersetzen Sie DEFAULT_API_KEY nicht durch Ihren API-Schlüssel.

   NAV_API_KEY=DEFAULT_API_KEY

   Diese Datei ist ein Ersatzspeicherort für den API-Schlüssel, damit Builds nicht fehlschlagen, falls die Datei secrets.properties nicht gefunden wird. Das kann passieren, wenn Sie die App aus einem Versionsverwaltungssystem klonen, in dem secrets.properties nicht vorhanden ist, und noch keine lokale Datei secrets.properties erstellt haben, um Ihren API-Schlüssel bereitzustellen.

8. Speichern Sie die Datei.
9. Gehen Sie in der Datei AndroidManifest.xml zu com.google.android.geo.API_KEY und aktualisieren Sie das android:value attribute. Falls das <meta-data>-Tag nicht vorhanden ist, erstellen Sie es als untergeordnetes Element des <application>-Tags.

   <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 or build.gradle.kts 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.

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

Fügen Sie Ihrer App die erforderlichen Quellenangaben hinzu.

Wenn Sie das Navigation SDK for Android in Ihrer App verwenden, müssen Sie Quellenangaben und Open-Source-Lizenzen in den Abschnitt mit den rechtlichen Hinweisen für Ihre App aufnehmen.

Wichtig: Wenn du die Quellenangaben hinzufügen möchtest, musst du sie als eigenständigen Menüpunkt oder als Element in einem „Info“-Menü hinzufügen.

Den erforderlichen Quellenangabentext und die Open-Source-Lizenzen finden Sie in der ZIP-Datei mit dem Navigation SDK for Android:

• NOTICE.txt
• LICENSES.txt

Wenn Sie ein Mobility- oder Fleet Engine Deliveries-Kunde sind

Wenn Sie ein Mobility- oder Fleet Engine Deliveries-Kunde sind, finden Sie in der Mobility-Dokumentation Informationen zur Abrechnung. Weitere Informationen zum Erfassen von Transaktionen finden Sie unter Abrechnung einrichten, Abrechenbare Transaktionen aufzeichnen, Berichterstellung und Abrechenbare Transaktionen aufzeichnen (Android).