配置 Google Cloud 控制台项目

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

  1. 设置您的开发项目。
  2. 将 Consumer SDK 添加到您的应用。
  3. 向您的应用添加 API 密钥。
  4. 在应用中添加所需的提供方说明。

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

设置您的开发项目

如果您没有 Google Cloud 控制台开发项目和移动出行项目的 API 密钥，则需要进行设置。如需了解详情，请参阅 Fleet Engine 指南中的 创建项目。

在为 Consumer SDK 选择开发项目时，请选择您用于 Fleet Engine 的同一 Google Cloud 控制台项目和 API 密钥。

将 Consumer SDK 添加到您的应用

Consumer SDK 可从 Google Maven 制品库获取。该制品库包含 SDK 的项目对象模型 (.pom) 文件和 Javadocs。如需将 Consumer SDK 添加到您的应用，请将 Consumer SDK 和 Maps SDK 依赖项添加到您的 Gradle 或 Maven 配置中。

在以下示例中，将 VERSION_NUMBER 替换为所需的 Consumer SDK 版本：

Gradle

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

dependencies {
  ...
  implementation 'com.google.android.libraries.mapsplatform.transportation:transportation-consumer:VERSION_NUMBER'
  implementation "com.google.android.gms:play-services-maps:18.1.0"
}

Maven

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

<dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.mapsplatform.transportation</groupId>
    <artifactId>transportation-consumer</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
  <dependency>
    <groupId>com.google.android.gms</groupId>
    <artifactId>play-services-maps</artifactId>
    <version>18.1.0</version>
  </dependency>
</dependencies>

向您的应用添加 API 密钥

将 Consumer SDK 添加到您的应用后，请添加 API 密钥。您必须使用在设置开发项目时获取的项目 API 密钥。如需了解详情，请参阅本指南第 3 步中的设置您的开发项目。

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

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

如需安装此插件并存储您的 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 同步。如需了解详情，请参阅 Android 文档中的 将项目与 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.consumerapidemo">
        <uses-permission android:name="android.permission.ACCESS_FINE_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>

在应用中添加所需的提供方说明

如果您在应用中使用 Consumer SDK，则必须在应用的法律声明部分添加提供方文字和开源许可。最好将提供方说明作为独立菜单项添加，或将其添加到关于 菜单项中。

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

如需了解如何添加开源声明，请参阅 https://developers.google.com/android/guides/opensource。

后续步骤

获取身份验证令牌