ตั้งค่าโปรเจ็กต์ Android Studio

หากต้องการกําหนดค่าแอปให้ใช้ Places SDK สําหรับ Android ให้ทําตามขั้นตอนต่อไปนี้ โดยจําเป็นสําหรับทุกแอปที่ใช้ Places SDK สําหรับ Android

ขั้นตอนที่ 1: ตั้งค่า Android Studio

  1. ต้องใช้ Android Studio Arctic Fox ขึ้นไป หากยังไม่ได้ติดตั้ง ให้ดาวน์โหลดและติดตั้ง
  2. ตรวจสอบว่าคุณใช้ปลั๊กอิน Android Gradle เวอร์ชัน 7.0 ขึ้นไปใน Android Studio

ขั้นตอนที่ 2 ตั้งค่า SDK

ไลบรารี Places SDK สําหรับ Android พร้อมใช้งานผ่านที่เก็บ Maven ของ Google หากต้องการเพิ่ม SDK ลงในแอป ให้ทําดังนี้

  1. ในไฟล์ settings.gradle ระดับบนสุด ให้ใส่พอร์ทัลปลั๊กอิน Gradle, ที่เก็บ Google Maven และที่เก็บส่วนกลางของ Maven ในส่วนบล็อก pluginManagement บล็อก pluginManagement ต้องปรากฏก่อนใบแจ้งยอดอื่นๆ ในสคริปต์ 
    pluginManagement {
    repositories {
        gradlePluginPortal()
        google()
        mavenCentral()
    }
}
  2. ในไฟล์ settings.gradle ระดับบนสุด ให้ใส่ที่เก็บ Maven ของ Google และที่เก็บส่วนกลางของ Maven ในส่วนบล็อก dependencyResolutionManagement ดังนี้ 
    dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
    }
}

  3. ในส่วน dependencies ของไฟล์ build.gradle ระดับโมดูล ให้เพิ่มทรัพยากร Dependency ไปยัง Places SDK สําหรับ Android ดังนี้

    dependencies {
    implementation 'com.google.android.libraries.places:places:3.1.0'
}
  4. ในไฟล์ build.gradle ระดับโมดูล ให้ตั้งค่า compileSdk และ minSdk เป็นค่าต่อไปนี้ 
    android {
    compileSdk 31

    defaultConfig {
        minSdk 21
        // ...
    }

ขั้นตอนที่ 3: เพิ่มคีย์ API ลงในโปรเจ็กต์

ส่วนนี้จะอธิบายวิธีจัดเก็บคีย์ API เพื่อให้แอปอ้างอิงได้อย่างปลอดภัย คุณไม่ควรตรวจสอบคีย์ API ในระบบควบคุมเวอร์ชัน เราจึงขอแนะนําให้จัดเก็บคีย์ในไฟล์ local.properties ซึ่งอยู่ในไดเรกทอรีรากของโปรเจ็กต์ ดูข้อมูลเพิ่มเติมเกี่ยวกับไฟล์ local.properties ได้ที่ไฟล์พร็อพเพอร์ตี้ Gradle

หากต้องการปรับปรุงงานนี้ เราขอแนะนําให้ใช้ปลั๊กอินข้อมูลลับ Gradle สําหรับ Android วิธีติดตั้งปลั๊กอินและจัดเก็บคีย์ API

  1. ใน Android Studio ให้เปิดไฟล์ build.gradle ระดับโปรเจ็กต์ แล้วเพิ่มโค้ดต่อไปนี้ลงในองค์ประกอบ dependencies ในส่วน buildscript 
    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
}
  2. จากนั้นเปิดไฟล์ build.gradle ระดับโมดูล แล้วเพิ่มโค้ดต่อไปนี้ลงในองค์ประกอบ plugins 
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
  3. บันทึกไฟล์และซิงค์โปรเจ็กต์กับ Gradle
  4. เปิด local.properties ในไดเรกทอรีระดับโปรเจ็กต์ แล้วเพิ่มโค้ดต่อไปนี้ แทนที่ YOUR_API_KEY ด้วยคีย์ API ของคุณ 
    MAPS_API_KEY=YOUR_API_KEY
  5. บันทึกไฟล์
  6. ในไฟล์ AndroidManifest.xml ให้ไปที่ com.google.android.geo.API_KEY และอัปเดต android:value attribute ดังนี้ 
    <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

หมายเหตุ: ดังที่แสดงด้านบน com.google.android.geo.API_KEY เป็นชื่อข้อมูลเมตาที่แนะนําสําหรับคีย์ API คีย์ที่ใช้ชื่อนี้จะใช้เพื่อตรวจสอบสิทธิ์ API ต่างๆ ของ Google Maps บนแพลตฟอร์ม Android ได้ ซึ่งรวมถึง Places SDK สําหรับ Android เพื่อให้เข้ากันได้กับแผนเดิม API รองรับชื่อ com.google.android.maps.v2.API_KEY ด้วย ชื่อเดิมนี้อนุญาตให้มีการตรวจสอบสิทธิ์กับ Android Maps API v2 เท่านั้น แอปพลิเคชันระบุชื่อข้อมูลเมตาคีย์ API ได้เพียงชื่อเดียวเท่านั้น หากมีการระบุทั้ง 2 แบบ API จะยกเว้นข้อยกเว้น

ขั้นตอนที่ 4 เริ่มต้นไคลเอ็นต์ Places API

เริ่มต้น Places SDK สําหรับ Android ภายในกิจกรรมหรือส่วนย่อยดังที่แสดงในตัวอย่างต่อไปนี้ (โปรดทราบว่าคุณส่งคีย์ API เมื่อเรียกใช้ Places.initialize())

Java


    // Initialize the SDK
    Places.initialize(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);

Kotlin


    // Initialize the SDK
    Places.initialize(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)

ตอนนี้คุณพร้อมที่จะเริ่มใช้ Places SDK สําหรับ Android แล้ว

ขั้นตอนที่ 5: ตั้งค่าอุปกรณ์ Android

หากต้องการเรียกใช้แอปที่ใช้ Places SDK สําหรับ Android คุณต้องทําให้แอปใช้งานได้ในอุปกรณ์ Android หรือโปรแกรมจําลองของ Android ที่ใช้ Android 4.0 ขึ้นไปและมี Google API

  • หากต้องการใช้อุปกรณ์ Android ให้ทําตามวิธีการที่เรียกใช้แอปในอุปกรณ์ฮาร์ดแวร์
  • หากต้องการใช้โปรแกรมจําลอง Android คุณสร้างอุปกรณ์เสมือนจริงและติดตั้งโปรแกรมจําลองได้โดยใช้โปรแกรมจัดการอุปกรณ์เสมือน Android (AVD) ที่มาพร้อมกับ Android Studio

ขั้นตอนถัดไป

หลังจากกําหนดค่าโปรเจ็กต์แล้ว คุณจะสํารวจตัวอย่างแอปได้