如需设置和配置 Google Cloud 控制台以使用适用于 Android 的 Consumer SDK,请按以下步骤操作。
如需详细了解各个步骤,请参阅以下部分。
设置您的开发项目
如果您没有移动项目的 Google Cloud 控制台开发项目和 API 密钥,则需要进行设置。如需了解详情,请参阅车队引擎指南中的创建项目部分。
为 Consumer SDK 选择开发项目时,请选择与您为车队引擎使用的 Google Cloud 控制台项目和 API 密钥相同的项目和密钥。
将 Consumer SDK 添加到您的应用
您可以从 Google Maven 制品库中获取 Consumer SDK。该代码库包含 SDK 的项目对象模型 (.pom) 文件和 Javadoc。如需将 Consumer SDK 添加到您的应用,请将 Consumer SDK 和 Maps SDK 依赖项添加到您的 Gradle 或 Maven 配置中。
在以下示例中,请将 VERSION_NUMBER
替换为所需版本的使用方 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 文档 Android 版 Secrets Gradle 插件。
如需安装此插件并存储您的 API 密钥,请执行以下操作:
打开根级
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") } }
打开应用级
build.gradle
文件,并将以下代码添加到plugins
元素中。Groovy
id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
Kotlin
id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
如果您使用 Android Studio,请将项目与 Gradle 同步。如需了解详情,请参阅 Android 文档中的将项目与 Gradle 同步。
在项目级目录中打开
local.properties
,然后添加以下代码。将YOUR_API_KEY
替换为您的 API 密钥。MAPS_API_KEY=YOUR_API_KEY
在
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。