Menyiapkan project Android Studio

PEMBERITAHUAN: Places SDK for Android versi 2.0.0 dan yang lebih baru bergantung pada AndroidX. Mulai versi ini, library dukungan lama tidak akan lagi didukung. Untuk mempertahankan kompatibilitas, Anda harus memigrasikan project untuk menggunakan AndroidX.

Untuk mengonfigurasi aplikasi agar menggunakan Places SDK for Android, ikuti langkah-langkah berikut. API ini diperlukan untuk semua aplikasi yang menggunakan Places SDK for Android.

Langkah 1: Siapkan Android Studio

Dokumen ini menjelaskan lingkungan pengembangan yang menggunakan Android Studio Hedgehog dan plugin Android Gradle versi 8.2.

Catatan: Jika lingkungan pengembangan Anda menggunakan Android Studio atau Gradle dengan versi yang berbeda, Anda mungkin harus mengubah langkah-langkahnya berdasarkan versi tersebut. Untuk informasi selengkapnya mengenai versi Android Studio dan Gradle, lihat kompatibilitas plugin Android Gradle dan Android Studio.

Langkah 2: Siapkan SDK

Library Places SDK for Android tersedia melalui repositori Maven Google. Untuk menambahkan SDK ke aplikasi Anda, lakukan hal berikut:

1. Di file settings.gradle.kts tingkat atas, sertakan portal plugin Gradle, repositori Maven Google, dan repositori pusat Maven di bagian blok pluginManagement. Blok pluginManagement harus muncul sebelum pernyataan lain dalam skrip.

   pluginManagement {
       repositories {
           gradlePluginPortal()
           google()
           mavenCentral()
       }
   } 

2. Di file settings.gradle.kts tingkat atas, sertakan repositori Maven Google dan Maven Central Repository di bagian blok dependencyResolutionManagement:

   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           google()
           mavenCentral()
       }
   } 

3. Di bagian dependencies dari file build.gradle.kts tingkat modul, tambahkan dependensi ke Places SDK for Android:

   Catatan: Places SDK for Android versi 3.5.0 memerlukan kotlin-bom 1.8.0 atau yang lebih baru. Untuk informasi selengkapnya tentang dependensi kotlin-bom, lihat Penggunaan versi kotlin-stdlib terbaru dalam dependensi transitif.

   Groovy

   dependencies {
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation("com.google.android.libraries.places:places:3.5.0")
   }

   Kotlin

             dependencies {
   
       // Places and Maps SDKs
       implementation("com.google.android.libraries.places:places:4.1.0")
   }

4. Dalam file build.gradle.kts tingkat modul, tetapkan compileSdk dan minSdk ke nilai berikut:
   Catatan: Pastikan compileSdk ditetapkan ke 34 atau yang lebih tinggi dan minSdk ditetapkan ke 23 atau lebih tinggi.

   Groovy

   android {
       compileSdk 34
   
       defaultConfig {
           minSdk 23
           // ...
       }
   }

   Kotlin

   android {
       compileSdk = 34
   
       defaultConfig {
           minSdk = 23
           // ...
       }
   }

5. Di bagian buildFeatures dari file build.gradle level modul, tambahkan class BuildConfig, yang Anda gunakan untuk mengakses nilai metadata yang akan dijelaskan di bawah dalam prosedur ini:

   Groovy

   android {
     // ...
     buildFeatures {
       buildConfig true
       // ...
     }
   }

   Kotlin

   android {
     // ...
     buildFeatures {
       buildConfig = true
       // ...
     }
   }

Langkah 3: Tambahkan kunci API Anda ke project

Bagian ini menjelaskan cara menyimpan kunci API sehingga dapat dirujuk dengan aman oleh aplikasi Anda. Anda tidak boleh memasukkan kunci API ke dalam sistem kontrol versi Anda, jadi sebaiknya simpan kunci tersebut dalam file secrets.properties, yang terletak di direktori utama project Anda. Untuk informasi selengkapnya tentang file secrets.properties, lihat file properti Gradle.

Untuk menyederhanakan tugas ini, sebaiknya gunakan Plugin Secrets Gradle untuk Android.

Catatan: Lihat dokumentasi Plugin Secrets Gradle untuk Android di GitHub guna mengetahui petunjuk penginstalan dan persyaratan sistem terbaru.

Untuk menginstal Plugin Secrets Gradle untuk Android di project Google Maps:

1. Di Android Studio, buka file build.gradle.kts atau build.gradle tingkat teratas dan tambahkan kode berikut ke elemen dependencies di bagian buildscript.

   Kotlin

   buildscript {
       dependencies {
           classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
       }
   }

   Groovy

   buildscript {
       dependencies {
           classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
       }
   }

2. Buka file build.gradle.kts atau build.gradle tingkat modul dan tambahkan kode berikut ke elemen plugins.

   Kotlin

   plugins {
       // ...
       id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
   }

   Groovy

   plugins {
       // ...
       id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
   }

3. Dalam file build.gradle.kts atau build.gradle tingkat modul, pastikan targetSdk dan compileSdk ditetapkan ke 34.
4. Sinkronkan project Anda dengan Gradle.
5. Buka file secrets.properties di direktori tingkat teratas, lalu tambahkan kode berikut. Ganti YOUR_API_KEY dengan kunci API Anda. Simpan kunci Anda dalam file ini karena secrets.properties tidak di-check in ke dalam sistem kontrol versi.
   Catatan: Jika file secrets.properties tidak ada, buat file tersebut di folder yang sama dengan file local.properties.

   PLACES_API_KEY=YOUR_API_KEY

6. Buat file local.defaults.properties di direktori tingkat teratas, folder yang sama dengan file secrets.properties, lalu tambahkan kode berikut.

   Catatan: Masukkan kode sebagaimana yang ditampilkan. Jangan ganti DEFAULT_API_KEY dengan Kunci API Anda.

   PLACES_API_KEY=DEFAULT_API_KEY

   File ini ditujukan untuk menyediakan lokasi cadangan Kunci API jika file secrets.properties tidak dapat ditemukan agar build tidak gagal. Build dapat gagal jika Anda meng-clone aplikasi dari sistem kontrol versi yang menghapus secrets.properties dan Anda belum membuat file secrets.properties secara lokal untuk memberikan Kunci API Anda.

7. Di Android Studio, buka file build.gradle.kts atau build.gradle tingkat modul dan edit properti secrets. Jika properti secrets tidak ada, tambahkan.

   Edit properti plugin untuk menetapkan propertiesFileName ke secrets.properties, menetapkan defaultPropertiesFileName ke local.defaults.properties, dan menetapkan properti lainnya.

   Kotlin

   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
       // 2. Add this line, where YOUR_API_KEY is your API key:
       //        MAPS_API_KEY=YOUR_API_KEY
       propertiesFileName = "secrets.properties"
   
       // A properties file containing default secret values. This file can be
       // checked in version control.
       defaultPropertiesFileName = "local.defaults.properties"
   }
           

   Groovy

   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
       // 2. Add this line, where YOUR_API_KEY is your API key:
       //        MAPS_API_KEY=YOUR_API_KEY
       propertiesFileName = "secrets.properties"
   
       // A properties file containing default secret values. This file can be
       // checked in version control.
       defaultPropertiesFileName = "local.defaults.properties"
   }
           

Langkah 4. Melakukan inisialisasi klien Places API

Lakukan inisialisasi Places SDK for Android dalam aktivitas atau fragmen. Pertama-tama, Anda harus memutuskan versi SDK yang akan digunakan: Places SDK for Android atau Places SDK for Android (Baru). Untuk informasi selengkapnya tentang versi produk, lihat Memilih versi SDK.

Contoh berikut menunjukkan cara melakukan inisialisasi SDK untuk kedua versi.

Places SDK for Android (Baru)

Teruskan kunci API saat memanggil Places.initializeWithNewPlacesApiEnabled():

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

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

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

Java

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

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

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

Places SDK for Android

Teruskan kunci API saat memanggil Places.initialize():

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

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

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

Java

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

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

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

PENTING: Jangan pernah menambahkan kunci API secara langsung ke kode aplikasi. Dalam lingkungan produksi, sebaiknya gunakan mekanisme aman untuk mengelola kunci API.

Sekarang Anda siap untuk mulai menggunakan Places SDK for Android.

Langkah 5: Siapkan perangkat Android

Untuk menjalankan aplikasi yang menggunakan Places SDK for Android, Anda harus men-deploy aplikasi tersebut ke perangkat Android atau emulator Android yang menggunakan Android 5.0 atau yang lebih tinggi dan menyertakan Google API.

• Untuk menggunakan perangkat Android, ikuti petunjuk pada halaman Menjalankan aplikasi di perangkat hardware.
• Untuk menggunakan Android Emulator, Anda dapat membuat perangkat virtual dan menginstal emulator dengan menggunakan AVD (Perangkat Virtual Android) Manager yang disertakan bersama Android Studio.
  Catatan: Jika memilih untuk menggunakan emulator Android, pastikan Anda memilih perangkat yang memiliki ikon Google Play, , yang ditampilkan di bawah kolom Play Store. Ikon ini menunjukkan bahwa profil tersebut sepenuhnya kompatibel dengan CTS dan dapat menggunakan image sistem yang menyertakan aplikasi Play Store:

  

Langkah berikutnya

Setelah project dikonfigurasi, Anda dapat menjelajahi aplikasi contoh.