Projekt einrichten – Version 4.99 und niedriger

In dieser Anleitung sind die Anforderungen an die Build-Konfiguration für die Verwendung des Navigation SDK for 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 in Version 4.99 und früher.

  • Eine Google Cloud Console

    –Projekt mit aktiviertem Navigation SDK. Wenden Sie sich zur 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.

  • Quellenangaben und Lizenztext 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 API-Schlüsselanmeldedaten hinzufügen. Das Projekt muss für den Zugriff auf das Navigation SDK bereitgestellt werden. Alle Schlüssel im Cloud Console-Projekt haben denselben Zugriff auf das Navigation SDK. Mit einem Schlüssel können mehrere Entwicklungsprojekte verknüpft sein. Wenn Sie bereits ein Console-Projekt haben, können Sie Ihrem aktuellen Projekt einen Schlüssel hinzufügen.

Einrichten

  1. Melden Sie sich in Ihrem bevorzugten Webbrowser in der Cloud Console an und erstellen Sie Ihr Cloud Console Projekt.
  2. Erstellen Sie in Ihrer IDE, z. B. Android Studio, ein Android-App-Entwicklungsprojekt und notieren Sie sich den Paketnamen.
  3. Bitten Sie Ihren Google Maps Platform-Ansprechpartner, Zugriff auf das Navigation SDK für Ihr Cloud Console-Projekt zu gewähren.
  4. Erstellen Sie im Cloud Console-Dashboard in Ihrem Webbrowser Anmeldedaten, um einen API-Schlüssel mit Einschränkungen zu generieren.
  5. Klicken Sie auf der Seite API-Schlüssel im Bereich Anwendung einschränkungen auf „Android-Apps“.
  6. Klicken Sie auf Paketnamen und Fingerabdruck hinzufügen und geben Sie dann den Paket namen Ihres Entwicklungsprojekts und den SHA1-Fingerabdruck für diesen Schlüssel ein.
  7. Klicken Sie auf Speichern.

Navigation SDK in ein Projekt einbinden

Das Navigation SDK ist über Maven oder als ein AAR Bundle verfügbar. Nachdem Sie Ihr Entwicklungsprojekt erstellt haben, können Sie das SDK mit einer der folgenden Methoden einbinden.

Maven für Navigation SDK Version 4.5 und höher verwenden (empfohlen)

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

  1. 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 Plug-in com.google.cloud.artifactregistry.gradle-plugin 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 der Datei 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 weiterhin über das ursprüngliche Maven-Repository für die restlichen Versionen von Version 4 verfügbar. Dies ist dieselbe Bibliothek mit allen Updates wie die oben genannte Version und bietet während des Übergangs Kompatibilität mit dem Driver SDK und anderen Bibliotheken. Für die Verwendung dieser Abhängigkeit müssen Sie sich beim Kompilieren mit gcloud in Ihrem Cloud-Projekt anmelden.

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

  2. 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 der Datei 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.

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

  2. Öffnen Sie in Android Studio ein Projekt und fügen Sie das Paket Google Play-Dienste über den SDK-Manager hinzu.

  3. Kopieren Sie libs/google_navigation_navmap.aar aus dem Verzeichnis der ZIP-Datei in das Verzeichnis app/libs Ihres Projekts.

  4. 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 Anforderungen für das Navigation SDK. Sie sollten auch die Optimierungsoptionen festlegen.

    Erforderliche Einstellungen für das Navigation SDK

    1. Legen Sie minSdkVersion auf 23 oder höher fest.
    2. Legen Sie targetSdkVersion auf 30 oder höher fest.
    3. Fügen Sie eine dexOptions-Einstellung hinzu, die 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 Reduzierung der Build-Zeit

    • Aktivieren Sie die Code- und Ressourcenreduzierung mit R8/ProGuard, um nicht verwendeten Code und nicht verwendete Ressourcen aus Abhängigkeiten zu entfernen. Wenn der R8/ProGuard-Schritt zu lange dauert, sollten Sie Multidex für die Entwicklungsarbeit aktivieren.
    • Reduzieren Sie die Anzahl der in den Build aufgenommenen Sprachübersetzungen: Legen Sie resConfigs während der Entwicklung 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.

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 Version des Navigation SDK, die Sie verwenden, möglicherweise etwas neuer oder älter als diese 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. 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. 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 for Android und speichern Ihren API-Schlüssel:

  1. Öffnen Sie in Android Studio die Datei auf Stammebene build.gradle und fügen Sie den folgenden Code in das Element dependencies 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 App-Ebene und fügen Sie dem plugins Element den folgenden Code hinzu.

    Groovy

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

    Kotlin

    plugins {
    id("com.android.application")
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}
  3. Wenn Sie Android Studio verwenden, synchronisieren Sie Ihr Projekt mit Gradle.
  4. Öffnen Sie die Datei local.properties in Ihrem Verzeichnis auf Projektebene und fügen Sie den folgenden Code ein. Ersetzen Sie YOUR_API_KEY durch Ihren API-Schlüssel. 
    MAPS_API_KEY=YOUR_API_KEY
  5. Sie können den API-Schlüssel entweder der Datei AndroidManifest.xml hinzufügen oder programmatisch angeben.
    • Fügen Sie der Datei AndroidManifest.xml Ihren API-Schlüssel hinzu: 
      <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

      Hinweis: com.google.android.geo.API_KEY ist der empfohlene Metadatenname für den API-Schlüssel. Ein Schlüssel mit diesem Namen kann zur Authentifizierung bei mehreren Google Maps-basierten APIs auf der Android-Plattform verwendet werden, einschließlich des 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 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.

    • API-Schlüssel programmatisch angeben:

      Das Secrets Gradle-Plug-in stellt den Schlüssel in der Klasse BuildConfig zur Verfügung. Rufen Sie bei der Initialisierung Ihrer App (z. B. in der Methode Application.onCreate()) die Methode 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:Bei der Verwendung von setApiKey() ist Folgendes zu beachten:
      • Geben Sie einen API-Schlüssel an, der nicht null und nicht leer ist.
      • Rufen Sie setApiKey() nur einmal während der Lebensdauer Ihrer Anwendung auf. Die Methode löst eine IllegalStateException aus, wenn sie mehr als einmal aufgerufen wird.
      • Rufen Sie setApiKey() auf, bevor Sie andere Navigation SDK-Komponenten wie Navigator initialisieren.
      • Der mit dieser Methode angegebene Schlüssel überschreibt alle API-Schlüssel in Ihrer Datei AndroidManifest.xml.
      • Verwenden Sie das Navigation SDK in Version 7.6 oder höher.

Erforderliche Quellenangaben in die 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 einfügen.

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

  • NOTICE.txt
  • LICENSES.txt