如要設定 Google Cloud 控制台以使用 Android 適用的 Consumer SDK,請按照下列步驟操作。
如要進一步瞭解每個步驟,請參閱以下各節。
設定開發專案
如果您沒有 Google Cloud 控制台開發專案和行動專案的 API 金鑰,請設定這兩項項目。詳情請參閱 Fleet Engine 指南中的「建立專案」一節。
選取 Consumer SDK 的開發專案時,請選取與 Fleet Engine 相同的 Google Cloud 控制台專案和 API 金鑰。
在應用程式中加入 Consumer SDK
您可以從 Google Maven 存放區取得 Consumer SDK。存放區包含 SDK 的 Project Object Model (.pom) 檔案和 Javadoc。如要將 Consumer SDK 新增至應用程式,請在 Gradle 或 Maven 設定中新增 Consumer SDK 和 Maps SDK 依附元件。
在以下範例中,請將 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 地圖平台的「API 安全性最佳做法」一文。
您可以使用 GitHub 說明文件 Secrets Gradle Plugin for Android 來簡化這項工作。
如要安裝這個外掛程式並儲存 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。