Seien Sie im Dezember beim nächsten Google Maps Platform Developer Community Day in San Francisco dabei. Jetzt bewerben

Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Projekt einrichten – Version 4.99 und niedriger

In diesem Leitfaden werden die Anforderungen an die Build-Konfiguration für die Verwendung des Navigation SDK für Android aufgeführt. In der 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, Version 4.99 und niedriger.

Eine Google Cloud Console

-Projekt mit aktiviertem Navigation SDK. Wenden Sie sich für die Bereitstellung an Ihren Google Maps Platform-Ansprechpartner.
Ihre App muss auf API-Level 30 oder höher ausgerichtet sein.
Damit eine mit dem Navigation SDK erstellte App ausgeführt werden kann, müssen auf dem Android-Gerät die Google Play-Dienste installiert und aktiviert sein.
Hinweise und Lizenzierungstext müssen der App hinzugefügt werden.

Projekte einrichten: Cloud Console-Projekt und Android-Projekt

Bevor Sie eine App 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 für den Zugriff auf das Navigation SDK bereitgestellt sein. Alle Schlüssel im Cloud Console-Projekt erhalten denselben Zugriff auf das Navigation SDK. Ein Schlüssel kann mit mehreren Entwicklungsprojekten verknüpft sein. Wenn Sie bereits ein Console-Projekt haben, können Sie Ihrem aktuellen 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 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 Paketnamen und Fingerabdruck hinzufügen und geben Sie dann den Paketnamen Ihres Entwicklungsprojekts und den SHA-1-Fingerabdruck für diesen Schlüssel ein.
Klicken Sie auf Speichern.

Navigation SDK zu Ihrem Projekt hinzufügen

Das Navigation SDK ist über Maven oder als AAR-Bundle verfügbar. Nachdem du dein Entwicklungsprojekt erstellt hast, kannst du das SDK mit einer der folgenden Methoden einbinden.

Maven für Navigation SDK ab Version 4.5 verwenden (empfohlen)

Im Folgenden wird das Maven-Repository google() verwendet. Das ist die einfachste und empfohlene Methode, um das Navigation SDK in Ihr Projekt einzubinden.

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

Gradle

Fügen Sie der Datei 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 com.google.cloud.artifactregistry.gradle-plugin-Plug-in nicht mehr erforderlich ist.

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

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

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, die das Maps SDK verwenden, 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>

Maven für Navigation SDK vor Version 4.5 oder mit Driver SDK verwenden

Das Navigation SDK ist für die restlichen v4-Versionen weiterhin über das ursprüngliche Maven-Repository verfügbar. Diese Bibliothek ist mit der oben genannten Version identisch und enthält dieselben Updates. Sie bietet während der Umstellung Kompatibilität mit dem Driver SDK und anderen Bibliotheken. Wenn Sie diese Abhängigkeit verwenden, müssen Sie sich beim Kompilieren mit gcloud in Ihrem Cloud-Projekt anmelden.

Richten Sie Ihre Umgebung für den Zugriff auf das Maven-Repository von Google ein, wie im Abschnitt Voraussetzungen der Consumer SDK-Dokumentation beschrieben. Der Zugriff auf das Navigation SDK wird über eine Workspace-Gruppe gesteuert.

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

Gradle

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

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

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

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

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, die das Maps SDK verwenden, 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>

Heruntergeladenes AAR-Bundle verwenden (nicht empfohlen)

Das Navigation SDK ist auch als AAR-Bundle verfügbar. Nachdem Sie das Entwicklungsprojekt erstellt haben, können Sie das SDK einbinden. In dieser Anleitung wird davon ausgegangen, dass Sie Android Studio als IDE verwenden.

Laden Sie die aktuelle Version des Navigation SDK aus dem freigegebenen Google Drive herunter und extrahieren 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 Google Play-Dienste-Paket hinzu. Verwenden Sie dazu den SDK-Manager.
Kopieren Sie libs/google_navigation_navmap.aar aus dem Verzeichnis der ZIP-Datei in das Verzeichnis app/libs Ihres Projekts.

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

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

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

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

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 Attribute 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 gemäß den folgenden Richtlinien, um die Anforderungen für das Navigation SDK zu erfüllen. Sie können auch die Optimierungsoptionen festlegen.

Erforderliche Einstellungen für das Navigation SDK
1. Legen Sie für minSdkVersion mindestens 23 fest.
2. Legen Sie für targetSdkVersion mindestens 30 fest.
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 das repositories und das 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 Verkürzung der Build-Dauer
- Aktivieren Sie die Codekomprimierung und die Entfernung von Ressourcen mit R8/ProGuard, um nicht verwendeten Code und nicht verwendete Ressourcen aus Abhängigkeiten zu entfernen. Wenn der R8/ProGuard-Schritt zu lange dauert, können Sie Multidex für die Entwicklungsarbeit aktivieren.
- Reduzieren Sie die Anzahl der im Build enthaltenen Sprachü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 Sprachen, die vom Navigation SDK unterstützt werden.

Unten sehen Sie ein Beispiel für das Gradle-Build-Skript für die Anwendung. In den Beispiel-Apps finden Sie aktualisierte Abhängigkeiten, da die von Ihnen verwendete Version des Navigation SDK möglicherweise etwas vor oder hinter dieser Dokumentation liegt.

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

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 und diese Datei von der Versionsverwaltung auszuschließen. Weitere Informationen zu Gradle-Eigenschaftendateien finden Sie unter Gradle-Eigenschaftendateien.

Sie können das Secrets Gradle-Plug-in für Android verwenden, um diese Aufgabe zu vereinfachen.

So installieren Sie das Secrets Gradle-Plug-in für Android und speichern Ihren API-Schlüssel:

Öffnen Sie in Android Studio die Datei build.gradle.kts oder build.gradle auf oberster Ebene und fügen Sie den folgenden Code in den plugins-Block ein.

Kotlin

plugins {
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") version "2.0.1" apply false
}

Groovy

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

Öffnen Sie die Datei build.gradle.kts oder build.gradle auf Modulebene und fügen Sie dem plugins-Element den folgenden Code hinzu.

Kotlin

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

Groovy

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

Wenn Sie Android Studio verwenden, 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 YOUR_API_KEY durch Ihren API-Schlüssel. Fügen Sie secrets.properties der Datei .gitignore hinzu oder schließen Sie sie anderweitig aus dem Versionsverwaltungssystem aus, damit Ihr API-Schlüssel nicht in die Versionsverwaltung eingecheckt wird.
Hinweis: Sollte die Datei secrets.properties nicht vorhanden sein, erstellen Sie sie im selben Ordner wie die Datei local.properties.
```
MAPS_API_KEY=YOUR_API_KEY
```
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.
```
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 dem secrets.properties nicht vorhanden ist, und noch keine lokale Datei secrets.properties erstellt haben, um Ihren API-Schlüssel bereitzustellen.
Sie können den API-Schlüssel entweder der Datei AndroidManifest.xml hinzufügen oder ihn programmatisch bereitstellen.
- Fügen Sie Ihren API-Schlüssel in AndroidManifest.xml ein:
```
<meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />
        
```
  Hinweis: Für den API-Schlüssel wird com.google.android.geo.API_KEY als Metadatenname empfohlen. Ein Schlüssel mit diesem Namen kann zur Authentifizierung bei mehreren Google Maps-basierten APIs auf der Android-Plattform verwendet werden, einschließlich Navigation SDK for Android. Aus Gründen der Abwärtskompatibilität unterstützt die API auch den Namen com.google.android.maps.v2.API_KEY. Für diesen alten Namen wird nur die Authentifizierung bei Version 2 der Android Google Maps-API unterstützt. In der App können nicht beide Metadatennamen für den API-Schlüssel angegeben werden, sondern nur jeweils einer. Falls beide angegeben werden, gibt die API eine Ausnahme aus.
- Stellen Sie den API-Schlüssel programmatisch bereit:
  Das Secrets Gradle-Plug-in stellt den Schlüssel in der Klasse BuildConfig zur Verfügung. Rufen Sie die Methode bei der Initialisierung Ihrer App (z. B. in der Methode Application.onCreate()) so auf:
  Kotlin
  1. Fügen Sie die folgenden Importanweisungen hinzu:
    import com.google.android.libraries.navigation.NavigationApi
  2. Fügen Sie der Methode Application.onCreate() Folgendes hinzu:
    NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)
  Java
  1. Fügen Sie die folgenden Importanweisungen hinzu:
    import com.google.android.libraries.navigation.NavigationApi;
  2. Fügen Sie der Methode Application.onCreate() Folgendes hinzu:
    NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY);
  Hinweis: Beachten Sie bei Verwendung von setApiKey() Folgendes:
  - Geben Sie einen API-Schlüssel an, der weder null noch leer ist.
  - Rufen Sie setApiKey() nur einmal während der Lebensdauer Ihrer Anwendung auf. Die Methode löst einen IllegalStateException aus, wenn sie mehr als einmal aufgerufen wird.
  - Rufen Sie setApiKey() auf, bevor Sie andere Navigation SDK-Komponenten wie Navigator initialisieren.
  - Der Schlüssel, den Sie mit dieser Methode angeben, überschreibt alle API-Schlüssel in Ihrer AndroidManifest.xml.
  - Verwenden Sie das Navigation SDK ab Version 7.6.

Öffnen Sie in Android Studio die Datei build.gradle.kts oder build.gradle auf Modulebene und bearbeiten Sie das Attribut secrets. Wenn die Property secrets nicht vorhanden ist, fügen Sie sie hinzu.

Bearbeiten Sie die Attribute des Plug-ins, um propertiesFileName auf "secrets.properties", defaultPropertiesFileName auf "local.defaults.properties" und alle anderen Attribute festzulegen.

Kotlin

secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root 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"
}

Groovy

secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root 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"
}

Erforderliche Quellenangaben in Ihre App einfügen

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 Ihrer App aufnehmen.

Die erforderlichen Quellenangaben und Open-Source-Lizenzen finden Sie in der ZIP-Datei des Navigation SDK for Android:

NOTICE.txt
LICENSES.txt

Projekt einrichten – Version 4.99 und niedriger Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Mindestanforderungen für die Verwendung des Navigation SDK

Projekte einrichten: Cloud Console-Projekt und Android-Projekt

Navigation SDK zu Ihrem Projekt hinzufügen

Maven für Navigation SDK ab Version 4.5 verwenden (empfohlen)

Gradle

Maven

Maven für Navigation SDK vor Version 4.5 oder mit Driver SDK verwenden

Gradle

Maven

Heruntergeladenes AAR-Bundle verwenden (nicht empfohlen)

Build konfigurieren

Lokale Attribute aktualisieren

Gradle-Build-Skript aktualisieren

API-Schlüssel in die App einfügen

Kotlin

Groovy

Kotlin

Groovy

Kotlin

Java

Kotlin

Groovy

Erforderliche Quellenangaben in Ihre App einfügen

Projekt einrichten – Version 4.99 und niedriger