Projekt einrichten – Version 4.99 und niedriger

In diesem Leitfaden werden die Anforderungen an die Buildkonfiguration 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 4.99 und niedriger.

  • Ein Google Cloud Console-Projekt mit aktiviertem Navigation SDK. Wenden Sie sich an Ihren Google Maps Platform-Kundenbetreuer, um eine Bereitstellung zu beantragen.

  • 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 Bereitstellungen haben, um auf das Navigation SDK zugreifen zu können. Allen Schlüsseln im Cloud Console-Projekt wird derselbe Zugriff auf das Navigation SDK gewährt. Mit einem Schlüssel kann mehr als ein Entwicklungsprojekt verknüpft sein. Wenn Sie bereits ein Konsolenprojekt haben, können Sie Ihrem aktuellen Projekt einen Schlüssel hinzufügen.

Einrichtung

  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. Wenden Sie sich an Ihren Google Maps Platform-Ansprechpartner, um Zugriff auf das Navigation SDK für Ihr Cloud Console-Projekt zu erhalten.
  4. Erstellen Sie in Ihrem Webbrowser im Cloud Console-Dashboard Anmeldedaten, um einen API-Schlüssel mit Einschränkungen zu generieren.
  5. Klicken Sie auf der Seite API-Schlüssel im Bereich Anwendungseinschränkungen auf „Android-Apps“.
  6. Klicken Sie auf Paketnamen und Fingerabdruck hinzufügen und geben Sie den Paketnamen Ihres Entwicklungsprojekts und den SHA-1-Fingerabdruck für diesen Schlüssel ein.
  7. Klicken Sie auf Speichern.

Dem Projekt das Navigation SDK hinzufügen

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

Im Folgenden wird das Maven-Repository google() verwendet. Dies ist die einfachste und empfohlene Methode, um Ihrem Projekt das Navigation SDK 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 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, 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 das Navigation SDK vor Version 4.5 oder mit dem 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 denselben Aktualisierungen wie die Version oben. Sie bietet während der Umstellung Kompatibilität mit dem Driver SDK und anderen Bibliotheken. Wenn Sie diese Abhängigkeit verwenden möchten, müssen Sie sich beim Kompilieren über gcloud in Ihrem Cloud-Projekt anmelden.

  1. 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 Arbeitsgruppen-ID gesteuert.

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

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 für Ihre IDE verwenden.

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

  2. Öffnen Sie in Android Studio ein Projekt und fügen Sie das Paket der 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 dem 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 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. Sie können auch die Optimierungsoptionen festlegen.

    Erforderliche Einstellungen für das Navigation SDK

    1. Setze minSdkVersion auf 23 oder höher.
    2. Legen Sie targetSdkVersion auf 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 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 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.
    • Anzahl der im Build enthaltenen Sprachübersetzungen reduzieren: 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.

Im Folgenden finden Sie ein Beispiel für das Gradle-Build-Skript für die Anwendung. Überprüfen Sie die Beispiel-Apps auf aktualisierte Gruppen von Abhängigkeiten, da die von Ihnen verwendete Navigation SDK-Version 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:

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

    Kotlin

    buildscript {
    dependencies {
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}

    Groovy

    buildscript {
    dependencies {
        classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
    }
}
  2. Ö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.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}

    Groovy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. In der Datei build.gradle.kts oder 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. 
    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.

    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}" />

    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 ist nur die Authentifizierung bei Version 2 der Android Maps API möglich. In der Anwendung kann nur einer der Metadatennamen für den API-Schlüssel festgelegt werden. Falls beide angegeben werden, gibt die API eine Ausnahme aus.

  10. Ö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 Eigenschaften des Plug-ins, um propertiesFileName auf secrets.properties, defaultPropertiesFileName auf local.defaults.properties und alle anderen Eigenschaften 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 same folder as the 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"

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

    Groovy

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

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

Erforderliche Quellenangaben in Ihrer App angeben

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 Attributionstext und die Open-Source-Lizenzen finden Sie in der ZIP-Datei mit dem Navigation SDK for Android:

  • NOTICE.txt
  • LICENSES.txt