配置 Google Cloud 控制台项目

如需设置和配置 Google Cloud 控制台项目以使用 Driver SDK for Android，请按以下步骤操作。

  1. 设置移动应用项目。
  2. 将 Driver SDK 添加到您的应用。
  3. 将 API 密钥添加到您的应用。
  4. 在应用中添加必要的提供方说明。

如需详细了解每个步骤，请参阅以下部分。

设置移动应用项目

本部分介绍了如何为 Driver SDK 配置移动应用项目。

如需配置移动应用项目，请按以下步骤操作：

  1. 如果您没有移动项目的 Google Cloud 控制台开发项目和 API 密钥，则需要设置一个。如需了解详情，请参阅创建车队引擎项目。
  2. 在 Google Cloud 控制台中，选择您为车队引擎使用的 Google Cloud 控制台项目和 API 密钥。
  3. 选择 API 和服务，然后搜索并启用 Maps SDK for Android。

将 Driver SDK 添加到您的应用

驱动程序 SDK 可从 Google Maven 制品库中获得。该代码库包含 SDK 的项目对象模型 (.pom) 文件和 Javadoc。

如需将 Driver SDK 添加到您的应用，请将 Driver SDK 和 Navigation SDK 依赖项添加到您的 Gradle 或 Maven 配置中。

在以下示例中，将 VERSION_NUMBER 替换为所选的驱动程序 SDK 版本。

Gradle

将以下内容添加到 build.gradle 中：

dependencies {
...
implementation 'com.google.android.libraries.mapsplatform.transportation:transportation-driver:VERSION_NUMBER'
implementation 'com.google.android.libraries.navigation:navigation:5.0.0'
}

Maven

将以下内容添加到 pom.xml 中：

<dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.mapsplatform.transportation.driver</groupId>
    <artifactId>transportation-driver</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
  <dependency>
    <groupId>com.google.android.libraries.navigation</groupId>
    <artifactId>navigation</artifactId>
    <version>5.0.0</version>
  </dependency>
</dependencies>

向您的应用添加 API 密钥

将 Driver SDK 添加到应用后，请添加 API 密钥。您必须使用在设置开发项目时获得的项目 API 密钥。如需了解详情，请参阅设置移动应用项目。

本部分介绍了如何存储 API 密钥，以便您的应用可以更加安全地引用该密钥。如需详细了解 API 密钥安全性最佳实践，请参阅 Google Maps Platform 文章中的API 安全性最佳实践。

为了简化此任务，您可以使用 GitHub 文档 Android 版 Secrets Gradle 插件。

如需安装此插件并存储您的 API 密钥，请按以下步骤操作：

  1. 打开根级 build.gradle 文件，并将以下代码添加到 buildscript 下的 dependencies 元素中。

    Groovy

    buildscript {
      dependencies {
          // ...
          classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.0"
      }
}

    Kotlin

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

  2. 打开应用级 build.gradle 文件，并将以下代码添加到 plugins 元素中。

    Groovy

    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'

    Kotlin

    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")

  3. 如果您使用 Android Studio，请将项目与 Gradle 同步。如需了解详情，请参阅将项目与 Gradle 同步。

  4. 在项目级目录中打开 local.properties，然后添加以下代码。将 YOUR_API_KEY 替换为您的 API 密钥。

    MAPS_API_KEY=YOUR_API_KEY

  5. 在 AndroidManifest.xml 文件中，找到 com.google.android.geo.API_KEY 并按如下所示更新 android:value 属性：

       <meta-data
           android:name="com.google.android.geo.API_KEY"
           android:value="${MAPS_API_KEY}" />

以下示例展示了示例应用的完整清单：

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
        package="com.example.driverapidemo" >
        <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
        <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
        <application
            android:allowBackup="true"
            android:icon="@mipmap/ic_launcher"
            android:label="@string/app_name"
            android:supportsRtl="true"
            android:theme="@style/_AppTheme" >

            <meta-data
                android:name="com.google.android.geo.API_KEY"
                android:value="${MAPS_API_KEY}" />

            <activity android:name=".MainActivity" >
                <intent-filter>
                    <action android:name="android.intent.action.MAIN" />
                    <category android:name="android.intent.category.LAUNCHER" />
                </intent-filter>
            </activity>
        </application>
    </manifest>

在应用中添加必要的提供方说明

如果您在应用中使用 Driver SDK，则必须在应用的法律声明部分包含提供方说明文本和开源许可。最好将提供方信息作为独立菜单项或关于菜单项的一部分提供。

您可以在未归档的 AAR 文件中的“third_party_licenses.txt”文件中找到许可信息。

如需了解如何添加开源声明，请参阅添加开源声明。

后续步骤

声明依赖项