หากต้องการตั้งค่าและกำหนดค่าคอนโซล Google Cloud เพื่อใช้ Consumer SDK สำหรับ Android ให้ทำตามขั้นตอนต่อไปนี้
- ตั้งค่าโปรเจ็กต์การพัฒนา
- เพิ่ม Consumer SDK ลงในแอป
- เพิ่มคีย์ API ลงในแอป
- ใส่การระบุแหล่งที่มาที่จำเป็นในแอป
ดูรายละเอียดเพิ่มเติมเกี่ยวกับแต่ละขั้นตอนได้ในส่วนต่อไปนี้
ตั้งค่าโปรเจ็กต์การพัฒนา
หากคุณไม่มีโปรเจ็กต์การพัฒนาคอนโซล Google Cloud และคีย์ API สำหรับโปรเจ็กต์การเดินทาง คุณต้องตั้งค่าโปรเจ็กต์และคีย์ API ดูรายละเอียดได้ที่ หัวข้อสร้างโปรเจ็กต์ในคู่มือ Fleet Engine
เมื่อเลือกโปรเจ็กต์การพัฒนาสำหรับ Consumer SDK ให้เลือกโปรเจ็กต์คอนโซล Google Cloud และคีย์ API เดียวกันกับที่ใช้สำหรับ Fleet Engine
เพิ่ม Consumer SDK ลงในแอป
Consumer SDK พร้อมใช้งานจากที่เก็บ Maven ของ Google ที่เก็บประกอบด้วยไฟล์ Project Object Model (.pom) และ Javadoc ของ SDK หากต้องการเพิ่ม Consumer SDK ลงในแอป ให้เพิ่มทรัพยากร Dependency ของ 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 ได้อย่างปลอดภัยยิ่งขึ้น ดูข้อมูลเพิ่มเติมเกี่ยวกับแนวทางปฏิบัติแนะนำด้านความปลอดภัยของคีย์ API ได้ที่ บทความแนวทางปฏิบัติแนะนำด้านความปลอดภัยของ API ใน Google Maps Platform แนวทางปฏิบัติแนะนำด้านความปลอดภัยของ API
คุณสามารถใช้ปลั๊กอิน Secrets Gradle สำหรับ Android ในเอกสารประกอบของ GitHub เพื่อลดความซับซ้อนของงานนี้
วิธีติดตั้งปลั๊กอินและจัดเก็บคีย์ API
เปิดไฟล์
build.gradleระดับราก แล้วเพิ่มโค้ดต่อไปนี้ลงในองค์ประกอบdependenciesภายใต้buildscriptGroovy
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ระดับแอป แล้วเพิ่มโค้ดต่อไปนี้ลงในองค์ประกอบpluginsGroovy
id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'Kotlin
id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")หากใช้ Android Studio ให้ซิงค์โปรเจ็กต์กับ Gradle ดูรายละเอียดได้ที่หัวข้อ ซิงค์โปรเจ็กต์กับ Gradle ในเอกสารประกอบของ Android
เปิด
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 ที่สมบูรณ์สำหรับแอปตัวอย่าง
<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 ในแอป คุณต้องใส่ข้อความแสดงแหล่งที่มาและใบอนุญาตโอเพนซอร์สเป็นส่วนหนึ่งของส่วนประกาศทางกฎหมายของแอป วิธีที่ดีที่สุดคือใส่การระบุแหล่งที่มาเป็นรายการในเมนูอิสระหรือเป็นส่วนหนึ่งของรายการในเมนูเกี่ยวกับ
คุณดูข้อมูลใบอนุญาตได้ในไฟล์ "third_party_licenses.txt" ในไฟล์ AAR ที่ไม่ได้เก็บถาวร
ดูวิธีใส่ประกาศโอเพนซอร์สได้ที่ https://developers.google.com/android/guides/opensource