In dieser Anleitung werden die Build-Konfigurationsanforderungen für die Verwendung des Navigation SDK for Android ab Version 5.0.0 aufgeführt.
In dieser Anleitung wird davon ausgegangen, dass Sie eine Android-IDE installiert haben und mit der Android-Entwicklung vertraut sind.
Mindestanforderungen für die Verwendung des Navigation SDK
Diese Anforderungen gelten für das Navigation SDK for Android ab Version 5.0.0.
Ein Google Cloud Console-Projekt mit aktiviertem Navigation SDK. Weitere Informationen zur Bereitstellung erhalten Sie von Ihrem Google Maps Platform-Ansprechpartner.
Für Ihre App müssen die folgenden Android-Versionen angegeben werden:
- Die Zielversion muss Android 13 (API-Level 33) oder höher sein.
- Die Mindestversion muss Android 6 (API-Level 23) oder höher sein.
Damit Sie eine App ausführen können, die mit dem Navigation SDK erstellt wurde, muss das Android-Gerät die folgenden Anforderungen erfüllen:
Google Play-Dienste installiert und aktiviert sein.
2 GB RAM oder mehr
OpenGL ES 2.0 wird unterstützt. Informationen zur 2D- und 3D-Grafikbeschleunigung finden Sie in der Open-Source-Dokumentation zur Android 6.0-Kompatibilität von Android.
Quellenangaben und Lizenztext müssen der App hinzugefügt werden.
Projekte einrichten: Cloud Console-Projekt und Android-Projekt
Bevor Sie eine Anwendung erstellen oder testen können, müssen Sie ein Cloud Console-Projekt erstellen und Anmeldedaten für den API-Schlüssel hinzufügen. Das Projekt muss eine Nutzerverwaltung haben, um auf das Navigation SDK zugreifen zu können. Allen Schlüsseln innerhalb des Cloud Console-Projekts wird derselbe Zugriff auf das Navigation SDK gewährt. Einem Schlüssel kann mehr als ein Entwicklungsprojekt zugeordnet sein. Wenn Sie bereits ein Konsolenprojekt haben, können Sie diesem Projekt einen Schlüssel hinzufügen.
Einrichtung
- Melden Sie sich in Ihrem bevorzugten Webbrowser in der Cloud Console an und erstellen Sie Ihr Cloud Console-Projekt.
- Erstellen Sie in Ihrer IDE, z. B. Android Studio, ein Android-App-Entwicklungsprojekt und notieren Sie sich den Paketnamen.
- Wenden Sie sich an Ihren Google Maps Platform-Ansprechpartner, um Zugriff auf das Navigation SDK für Ihr Cloud Console-Projekt zu gewähren.
- Erstellen Sie im Cloud Console-Dashboard im Webbrowser Anmeldedaten, um einen API-Schlüssel mit Einschränkungen zu generieren.
- Klicken Sie auf der Seite API-Schlüssel im Bereich Anwendungseinschränkungen auf „Android-Apps“.
- Klicken Sie auf Paketname und Fingerabdruck hinzufügen und geben Sie dann den Paketnamen Ihres Entwicklungsprojekts und den SHA-1-Fingerabdruck für diesen Schlüssel ein.
- Klicke auf Speichern.
Ihrem Projekt das Navigation SDK hinzufügen
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 einbinden.
Verwendung von Maven for Navigation SDK 4.5 und höher (empfohlen)
Im Folgenden wird das Maven-Repository google()
verwendet. Dies ist die einfachste und empfohlene Methode, um Ihrem Projekt das Navigation SDK hinzuzufügen.
Fügen Sie Ihrer Gradle- oder Maven-Konfiguration die folgende Abhängigkeit hinzu und ersetzen Sie den Platzhalter
VERSION_NUMBER
durch die gewünschte Version des Navigation SDK for Android.Gradle
Fügen Sie dem
build.gradle
auf Modulebene Folgendes hinzu:dependencies { ... implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER' }
Beachten Sie beim Upgrade des ursprünglichen Maven-Repositorys, 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 der obersten Ebene
build.gradle
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, die auf dem Maps SDK basiert, ausschließen.
<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 eine erfolgreiche Verwendung des Navigation SDK konfigurieren.
Lokale Unterkünfte aktualisieren
- Öffnen Sie im Gradle Scripts-Ordner die Datei
local.properties
und fügen Sieandroid.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 Navigation SDK
- Legen Sie für
minSdkVersion
mindestens 23 fest. - Legen Sie für
targetSdkVersion
mindestens 33 fest. - Fügen Sie eine
dexOptions
-Einstellung hinzu, mit der derjavaMaxHeapSize
erhöht wird. - Legen Sie den Speicherort für zusätzliche Bibliotheken fest.
- Fügen Sie
repositories
unddependencies
für das Navigation SDK hinzu. - Ersetzen Sie die Versionsnummern in den Abhängigkeiten durch die neuesten verfügbaren Versionen.
Optionale Einstellungen zur Verkürzung der Build-Dauer
- Aktivieren Sie die Code- und Ressourcenschrumpfung mit R8/ProGuard, um nicht verwendeten Code und nicht verwendete Ressourcen aus Abhängigkeiten zu entfernen. Wenn die Ausführung des Schritts R8/ProGuard zu lange dauert, sollten Sie Multidex für Entwicklungsarbeiten 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 BuildresConfigs
für die Sprachen fest, die Sie tatsächlich verwenden. Standardmäßig enthält Gradle Ressourcenstrings für alle Sprachen, die vom Navigation SDK unterstützt werden.
Entsugaring für Java8-Unterstützung hinzufügen
- Wenn Sie Ihre App mit dem Android-Gradle-Plug-in 4.0.0 oder höher erstellen, erweitert das Plug-in die Unterstützung für eine Reihe von Java 8-Sprach-APIs. Weitere Informationen finden Sie unter Entugaring-Unterstützung in Java 8. Im nachfolgenden Beispiel-Build-Skript-Snippet sehen Sie, wie Kompilierungs- und Abhängigkeitsoptionen erläutert werden.
- Legen Sie für
Unten sehen Sie ein Beispiel für das Gradle-Build-Skript für die Anwendung. Prüfen Sie die Beispielanwendungen auf aktualisierte Abhängigkeiten, da die von Ihnen verwendete Version des Navigation SDK etwas hinter dieser Dokumentation zurückliegt.
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.
So installieren Sie das Secrets Gradle-Plug-in für Android in Ihrem Google Maps-Projekt:
-
Öffnen Sie in Android Studio die Datei
build.gradle
oderbuild.gradle.kts
auf oberster Ebene und fügen Sie den folgenden Code in dasdependencies
-Element unterbuildscript
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") } }
-
Öffnen Sie die Datei
build.gradle
auf Modulebene und fügen Sie demplugins
-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") }
- In der Datei
build.gradle
auf Modulebene müssentargetSdk
undcompileSdk
auf 34 gesetzt sein. - Speichern Sie die Datei und synchronisieren Sie Ihr Projekt mit Gradle.
-
Öffnen Sie die Datei
secrets.properties
im Verzeichnis der obersten Ebene und fügen Sie den folgenden Code ein. Ersetzen Sie dabeiYOUR_API_KEY
durch Ihren eigenen API-Schlüssel. Speichern Sie den Schlüssel in dieser Datei, dasecrets.properties
nicht in ein Versionsverwaltungssystem eingecheckt werden kann.MAPS_API_KEY=YOUR_API_KEY
- Speichern Sie die Datei.
-
Erstellen Sie die Datei
local.defaults.properties
im Verzeichnis der obersten Ebene, im selben Ordner wie die Dateisecrets.properties
, und fügen Sie folgenden Code ein.MAPS_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 demsecrets.properties
nicht vorhanden ist, und noch keine lokale Dateisecrets.properties
erstellt haben, um Ihren API-Schlüssel bereitzustellen. - Speichern Sie die Datei.
-
Gehen Sie in der Datei
AndroidManifest.xml
zucom.google.android.geo.API_KEY
und aktualisieren Sie dasandroid: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 namecom.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. -
In Android Studio, open your module-level
build.gradle
orbuild.gradle.kts
file and edit thesecrets
property. If thesecrets
property does not exist, add it.Edit the properties of the plugin to set
propertiesFileName
tosecrets.properties
, setdefaultPropertiesFileName
tolocal.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.*" }
Nimm die erforderlichen Quellenangaben in deine App auf.
Wenn Sie das Navigation SDK for Android in Ihrer App verwenden, müssen Sie im Abschnitt mit den rechtlichen Hinweisen Ihrer App Quellenangaben und Open-Source-Lizenzen angeben.
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 Mobility- oder Fleet Engine Deliveries-Kunde sind
Wenn Sie 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 erfassen, Berichterstellung und Abrechenbare Transaktionen aufzeichnen (Android).
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2024-06-26 (UTC).
[] [] { "last_modified": "Zuletzt aktualisiert: 2024-06-26 (UTC).", "state": "" }