In dieser Anleitung sind die Build-Konfigurationsanforderungen für die Verwendung des Navigation SDK for Android 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 4.99 und niedriger.
Ein Google Cloud Console-Projekt mit aktiviertem Navigation SDK Wenden Sie sich bezüglich der Bereitstellung an Ihren Google Maps Platform-Ansprechpartner.
Ihre App muss auf API-Level 30 oder höher ausgerichtet sein.
Damit Sie eine mit dem Navigation SDK erstellte App ausführen können, müssen auf dem Android-Gerät Google Play-Dienste installiert und aktiviert sein.
Quellenangaben und Lizenztexte 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 API-Schlüssel hinzufügen. Das Projekt muss die Bereitstellung für den Zugriff auf das Navigation SDK haben. Alle Schlüssel im Cloud Console-Projekt erhalten denselben Zugriff auf das Navigation SDK. Mit einem Schlüssel können mehrere Entwicklungsprojekte verknüpft sein. Wenn Sie bereits ein Konsolenprojekt haben, können Sie Ihrem aktuellen Projekt einen Schlüssel hinzufügen.
Einrichtung
- Melden Sie sich in einem 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 erhalten.
- Erstellen Sie im Cloud Console-Dashboard in Ihrem 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.
Dem Projekt das Navigation SDK hinzufügen
Das Navigation SDK ist über Maven oder als AAE-Bundle verfügbar. Nachdem Sie Ihr Entwicklungsprojekt erstellt haben, können Sie das SDK mit einem der folgenden Ansätze in dieses Projekt integrieren.
Maven for Navigation SDK Version 4.5 und höher 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.
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>
Verwendung von Maven für das Navigation SDK vor Version 4.5 oder mit dem Treiber SDK
Das Navigation SDK ist bis zu den restlichen Versionen der Version 4 weiterhin über das ursprüngliche Maven-Repository verfügbar. Dies ist dieselbe Bibliothek mit denselben Updates wie die obige Version und sorgt während der Umstellung für Kompatibilität mit dem Treiber-SDK und anderen Bibliotheken. Wenn Sie diese Abhängigkeit verwenden, müssen Sie sich beim Kompilieren über gcloud
bei Ihrem Cloud-Projekt anmelden.
- Richten Sie Ihre Umgebung so ein, dass sie auf das Maven-Repository von Google zugreifen kann, wie im Abschnitt Voraussetzungen der Consumer SDK-Dokumentation beschrieben. Der Zugriff auf das Navigation SDK wird über eine Arbeitsbereichsgruppe gesteuert.
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.Gradle
Fügen Sie
build.gradle
auf Modulebene Folgendes hinzu:dependencies { ... implementation 'com.google.android.maps:navsdk:VERSION_NUMBER' }
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.maps</groupId> <artifactId>navsdk</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>
Heruntergeladene AAE-Bundles verwenden (nicht empfohlen)
Das Navigation SDK ist auch als AAE-Paket verfügbar. Nachdem Sie das Entwicklungsprojekt erstellt haben, können Sie das SDK integrieren. In dieser Anleitung wird davon ausgegangen, dass Sie Android Studio für Ihre IDE verwenden.
Laden Sie die neueste Version des Navigation SDK aus dem freigegebenen Google Drive herunter und entpacken Sie sie. Wenn Sie keinen Zugriff haben, wenden Sie sich an Ihren Ansprechpartner.
Öffnen Sie in Android Studio ein Projekt und fügen Sie das Paket der Google Play-Dienste über den SDK-Manager hinzu.
Kopieren Sie
libs/google_navigation_navmap.aar
aus dem ZIP-Dateiverzeichnis in dasapp/libs
-Verzeichnis Ihres Projekts.Fügen Sie
build.gradle
auf Modulebene Folgendes hinzu:implementation(name: 'google_navigation_navmap', ext: 'aar')
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' } } }
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 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. Sie können auch die Optimierungsoptionen festlegen.Erforderliche Einstellungen für das Navigation SDK
- Setze
minSdkVersion
auf 23 oder höher. - Legen Sie für
targetSdkVersion
mindestens 30 fest. - Fügen Sie eine
dexOptions
-Einstellung hinzu, die denjavaMaxHeapSize
erhöht. - 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 Verringerung der Build-Dauer
- Aktivieren Sie die Code- und Ressourcenverkleinerung 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 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 vom Navigation SDK unterstützten Sprachen.
- Setze
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'
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'
}
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.NAV_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.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 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.*" }
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.
Den erforderlichen Quellenangabentext und die Open-Source-Lizenzen finden Sie in der ZIP-Datei mit dem Navigation SDK for Android:
NOTICE.txt
LICENSES.txt
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-07-13 (UTC).
[{ "type": "thumb-down", "id": "missingTheInformationINeed", "label":"Benötigte Informationen nicht gefunden" },{ "type": "thumb-down", "id": "tooComplicatedTooManySteps", "label":"Zu umständlich/zu viele Schritte" },{ "type": "thumb-down", "id": "outOfDate", "label":"Nicht mehr aktuell" },{ "type": "thumb-down", "id": "translationIssue", "label":"Problem mit der Übersetzung" },{ "type": "thumb-down", "id": "samplesCodeIssue", "label":"Problem mit Beispielen/Code" },{ "type": "thumb-down", "id": "otherDown", "label":"Sonstiges" }] [{ "type": "thumb-up", "id": "easyToUnderstand", "label":"Leicht verständlich" },{ "type": "thumb-up", "id": "solvedMyProblem", "label":"Mein Problem wurde gelöst" },{ "type": "thumb-up", "id": "otherUp", "label":"Sonstiges" }]