本頁說明如何完成設定,開始使用 Maps 3D SDK for Android 建構。設定程序包括設定 Google Cloud 專案和 API,以便與 SDK 搭配使用,然後設定 Android Studio 專案。請先完成下列步驟,再將第一個 3D 地圖新增至應用程式。
必要條件
如要使用 Maps 3D SDK for Android,您的專案和目標裝置必須符合下列需求:
- 最低 API 級別:Android API 級別 24 (Android 7.0) 以上版本。應用程式必須指定
24以上版本的minSdk。 - Google Play 服務:Android 適用的 Maps 3D SDK 依附於 Google Play 服務。目標裝置 (以及搭載 Google API 的模擬器) 必須安裝 Google Play 服務。
設定 Google Cloud 雲端專案和 API 金鑰
如要開始使用 Android 適用的 Maps 3D SDK 進行建構,請完成下列步驟,設定 Google Cloud 雲端專案和 API 金鑰,以便搭配 Android 適用的 Maps 3D SDK 使用:
步驟 1
控制台
-
在 Google Cloud 控制台的專案選取器頁面中,按一下「建立專案」,開始建立新的 Cloud 專案。
-
確認 Cloud 專案已啟用計費功能。 確認專案已啟用計費功能。
Google Cloud 提供免付費試用期。試用期將於 90 天後或帳戶費用累積達 $300 美元時 (以先發生者為準) 結束。您隨時可以取消試用。詳情請參閱「帳單帳戶抵免額」和「帳單」。
Cloud SDK
gcloud projects create "PROJECT"
進一步瞭解 Google Cloud SDK、Cloud SDK 安裝和下列指令:
步驟 2
如要使用 Google 地圖平台,請啟用打算在專案中使用的 API 或 SDK。
請注意,有些整合需要您啟用多個 API/SDK。如果不確定要啟用哪些 API 或 SDK,請嘗試使用功能探索工具,或查詢要使用的 API/SDK 說明文件。
如要啟用一或多個 API 或 SDK,請按照下列步驟進行:
控制台
-
請前往 Cloud 控制台的「Maps API 程式庫」頁面,查看您可以啟用的 Google Maps Platform API 和 SDK:
- 按一下您要啟用的 API 或 SDK。
- 如果按鈕顯示「啟用」,請按一下按鈕啟用該 API 或 SDK。
- 如果按鈕顯示「管理」,表示 API 或 SDK 已啟用,您不需要再採取任何動作。
- 按一下上述其中一個按鈕,畫面隨即會顯示該 API 或 SDK 的資訊主頁 (按一下「停用」按鈕,即可將該 API 或 SDK 從這個專案中移除)。
Cloud SDK
下列指令會啟用所有 Maps、Routes 和 Places API:
gcloud services enable \ --project "PROJECT" \ "addressvalidation.googleapis.com" \ "areainsights.googleapis.com" \ "tile.googleapis.com" \ "aerialview.googleapis.com" \ "elevation-backend.googleapis.com" \ "routes.googleapis.com" \ "geocoding-backend.googleapis.com" \ "geolocation.googleapis.com" \ "maps-android-backend.googleapis.com" \ "maps-backend.googleapis.com" \ "maps-embed-backend.googleapis.com" \ "maps-ios-backend.googleapis.com" \ "mapsplatformdatasets.googleapis.com" \ "places-backend.googleapis.com" \ "roads.googleapis.com" \ "routeoptimization.googleapis.com" \ "static-maps-backend.googleapis.com" \ "street-view-image-backend.googleapis.com" \ "timezone-backend.googleapis.com"
進一步瞭解 Google Cloud SDK、Cloud SDK 安裝和下列指令:
使用下列指令啟用 Environment API:
gcloud services enable \ --project "PROJECT" \ "airquality.googleapis.com" \ "solar.googleapis.com" \ "pollen.googleapis.com" \ "weather.googleapis.com"
步驟 3
此步驟僅適用 API 金鑰建立程序。若您在正式環境中使用 API 金鑰,強烈建議您為 API 金鑰設定限制。詳情請參閱特定產品的「使用 API 金鑰」頁面。
API 金鑰是一組專屬 ID,用於驗證與您專案有關的使用權限及帳單處理要求。您的專案至少要有一個相關聯的 API 金鑰。
建立 API 金鑰的方法如下:
控制台
-
前往「Google Maps Platform」(Google 地圖平台) >「Credentials」(憑證) 頁面。
-
在「Credentials」(憑證) 頁面上,點選「Create credentials」(建立憑證) >「API key」(API 金鑰)。
「API key created」(建立的 API 金鑰) 對話方塊會顯示您新建立的 API 金鑰。 -
按一下「Close」(關閉)。
新建立的 API 金鑰會出現在「Credentials」(憑證) 頁面的「API keys」(API 金鑰) 下方。
(別忘了先為 API 金鑰設定限制,然後才在正式環境中使用)
Cloud SDK
gcloud services api-keys create \ --project "PROJECT" \ --display-name "DISPLAY_NAME"
進一步瞭解 Google Cloud SDK、Cloud SDK 安裝和下列指令:
如要啟用 SDK,請前往 Google Cloud 控制台的 Maps 3D SDK for Android 頁面。如要進一步瞭解如何完成這些步驟,請參閱「開始使用 Google 地圖平台」一文。
設定 Android Studio 專案
本節說明如何建立及設定 Android Studio 專案,以便搭配使用 Maps 3D SDK for Android。
第 1 部分:設定專案和 Gradle
使用「Empty Views Activity」範本建立新的 Android Studio 專案。在專案設定中,將「Minimum SDK」設為「API 24」以上。
如果您使用 Git 進行原始碼管控,請修改專案
.gitignore檔案,避免將 Secret 檔案提交至版本管控:- 在專案的根目錄中,開啟
.gitignore檔案。 - 新增下列程式碼:
secrets.properties- 在專案的根目錄中,開啟
更新專案層級
build.gradle.kts檔案:- 在專案的根目錄中,開啟
build.gradle.kts檔案。 - 在
plugins區塊中,新增 Secrets Gradle 外掛程式:
plugins { alias(libs.plugins.android.application) apply false alias(libs.plugins.kotlin.android) apply false alias(libs.plugins.secrets.gradle.plugin) apply false // Add this line }- 在專案的根目錄中,開啟
更新
gradle/libs.versions.toml檔案:- 開啟
gradle/libs.versions.toml檔案,通常位於專案根目錄的gradle目錄中。 - 在
[versions]區段中,新增 SDK 和 Secrets Gradle 外掛程式的版本:
# See https://developers.google.com/android/guides/setup?device=phone-tablet for available releases maps3dSdk = "16.0.0" # See https://github.com/google/secrets-gradle-plugin/releases for available releases secretsGradlePlugin = "2.0.1"- 在
[library]區段中,新增 SDK 程式庫:
play-services-maps3d = { module = "com.google.android.gms:play-services-maps3d", version.ref = "maps3dSdk" }- 在
[plugins]區段中,新增 Secrets Gradle 外掛程式:
secrets-gradle-plugin = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secretsGradlePlugin" }- 開啟
更新模組層級
app/build.gradle.kts檔案:- 開啟模組層級的
build.gradle.kts檔案,通常位於app目錄中。 - 在檔案頂端,將 Secrets Gradle 外掛程式新增至
plugins區塊:
plugins { alias(libs.plugins.android.application) alias(libs.plugins.kotlin.android) alias(libs.plugins.secrets.gradle.plugin) // Add this line }- 在
dependencies區塊中,加入 Maps 3D SDK for Android 的 Google Play 服務依附元件:
dependencies { // ... other dependencies implementation(libs.play.services.maps3d) // Add this line }- 在檔案結尾處,
android和dependencies區塊外,新增 Secret 設定:
secrets { // Optionally specify a different filename containing your secrets. // The plugin defaults to "local.properties" propertiesFileName = "secrets.properties" // A properties file containing default secret values. This file can be // checked in version control. defaultPropertiesFileName = "local.defaults.properties" }- 開啟模組層級的
第 2 部分:將 API 金鑰加進專案
建立
secrets.properties檔案:- 在應用程式模組根目錄 (通常是
app目錄) 中,建立名為secrets.properties的新檔案。 - 在檔案中加入 API 金鑰:
MAPS3D_API_KEY=YOUR_API_KEY_HERE- 在應用程式模組根目錄 (通常是
建立
local.defaults.properties檔案: - 在應用程式模組根目錄中,建立名為local.defaults.properties的新檔案。 - 在檔案中新增預設或預留位置的 API 金鑰。這個檔案可以登錄在版本管控系統中:MAPS3D_API_KEY=DEFAULT_API_KEY_OR_PLACEHOLDER
第 3 部分:更新 AndroidManifest.xml 檔案
開啟
app/src/main/AndroidManifest.xml檔案。在
<application>標記內,<activity>標記之前,加入下列<meta-data>元素來宣告 API 金鑰:<application ...> <meta-data android:name="com.google.android.geo.maps3d.API_KEY" android:value="${MAPS3D_API_KEY}" /> <activity ...> </activity> </application>在建構程序中,Secrets Gradle 外掛程式會將
${MAPS3D_API_KEY}預留位置替換為secrets.properties檔案中的金鑰。
程式輔助檢視初始化 (選用)
如果您偏好以程式輔助方式初始化地圖檢視區塊,而非使用 XML 版面配置,請使用 Map3DInitConfig。
import com.google.android.gms.maps3d.Map3DInitConfig
import com.google.android.gms.maps3d.Map3DView
import com.google.android.gms.maps3d.model.Map3DMode
// Set configuration options using the factory method
val config = Map3DInitConfig.create(
mapMode = Map3DMode.HYBRID,
centerLat = 38.544012,
centerLng = -107.670428
)
val map3DView = Map3DView(context, config)
後續步驟
您已設定 Google Cloud 雲端專案、API 金鑰和 Android Studio 專案,可搭配 Maps 3D SDK for Android 使用,接下來請將 3D 地圖新增至應用程式。