Để thiết lập và định cấu hình Google Cloud Console nhằm sử dụng SDK Người tiêu dùng cho Android, hãy làm theo các bước sau.
- Thiết lập dự án phát triển.
- Thêm Consumer SDK vào ứng dụng của bạn.
- Thêm khoá API vào ứng dụng.
- Thêm thông tin ghi nhận tác giả bắt buộc vào ứng dụng.
Để biết thêm thông tin chi tiết về từng bước, hãy xem các phần sau.
Thiết lập dự án phát triển
Nếu chưa có dự án phát triển Google Cloud Console và khoá API cho dự án di động, bạn cần thiết lập một dự án. Để biết thông tin chi tiết, hãy xem phần Tạo dự án trong hướng dẫn về Fleet Engine.
Khi chọn dự án phát triển cho SDK Người tiêu dùng, hãy chọn cùng một dự án Google Cloud Console và khoá API mà bạn đang dùng cho Fleet Engine.
Thêm SDK Người tiêu dùng vào ứng dụng của bạn
Consumer SDK có trong kho lưu trữ Maven của Google. Kho lưu trữ này bao gồm các tệp Mô hình đối tượng dự án (.pom) và Javadoc của SDK. Để thêm SDK Người tiêu dùng vào ứng dụng, hãy thêm các phần phụ thuộc SDK Người tiêu dùng và SDK Maps vào cấu hình Gradle hoặc Maven.
Trong các ví dụ sau, hãy thay thế VERSION_NUMBER bằng phiên bản bắt buộc của SDK Người tiêu dùng:
Gradle
Thêm đoạn mã sau vào 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
Thêm đoạn mã sau vào 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>
Thêm khoá API vào ứng dụng
Sau khi thêm SDK Người tiêu dùng vào ứng dụng, hãy thêm khoá API. Bạn phải sử dụng khoá API dự án mà bạn nhận được khi thiết lập dự án phát triển. Để biết thêm thông tin, hãy xem phần Thiết lập dự án phát triển ở Bước 3 của hướng dẫn này.
Phần này mô tả cách lưu trữ khoá API để ứng dụng của bạn có thể tham chiếu khoá đó một cách an toàn hơn. Để biết thêm thông tin về các phương pháp hay nhất để bảo mật khoá API, hãy xem bài viết của Google Maps Platform về các phương pháp hay nhất để bảo mật API.
Để đơn giản hoá nhiệm vụ này, bạn có thể sử dụng tài liệu GitHub Secrets Gradle Plugin for Android (Trình bổ trợ Secrets Gradle cho Android).
Cách cài đặt trình bổ trợ và lưu trữ khoá API:
Mở tệp
build.gradleở cấp gốc và thêm mã sau vào phần tửdependenciestrongbuildscript.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") } }Mở tệp
build.gradleở cấp ứng dụng rồi thêm mã sau vào phần tửplugins.Groovy
id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'Kotlin
id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")Nếu bạn sử dụng Android Studio, hãy đồng bộ hoá dự án với Gradle. Để biết thông tin chi tiết, hãy xem phần Đồng bộ hoá dự án với Gradle trong tài liệu về Android.
Mở
local.propertiestrong thư mục cấp dự án, sau đó thêm đoạn mã sau. Thay thếYOUR_API_KEYbằng khoá API của bạn.MAPS_API_KEY=YOUR_API_KEY
Trong tệp
AndroidManifest.xml, hãy chuyển đếncom.google.android.geo.API_KEYvà cập nhật thuộc tínhandroid:valuenhư sau:
<meta-data
android:name="com.google.android.geo.API_KEY"
android:value="${MAPS_API_KEY}" />
Ví dụ sau đây cho thấy một tệp kê khai hoàn chỉnh cho một ứng dụng mẫu:
<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>
Thêm thông tin ghi nhận tác giả bắt buộc vào ứng dụng
Nếu sử dụng SDK Người tiêu dùng trong ứng dụng, bạn phải đưa văn bản ghi công và giấy phép nguồn mở vào phần thông báo pháp lý của ứng dụng. Tốt nhất là bạn nên đưa thông tin ghi nhận tác giả vào một mục trình đơn độc lập hoặc dưới dạng một phần của mục trình đơn Giới thiệu.
Bạn có thể tìm thấy thông tin giấy phép trong tệp "third_party_licenses.txt" trong tệp AAR chưa lưu trữ.
Tham khảo https://developers.google.com/android/guides/opensource để biết cách thêm thông báo về nguồn mở.