Menyiapkan project Android Studio

Untuk mengonfigurasi aplikasi agar menggunakan Places SDK for Android, ikuti langkah-langkah berikut. Langkah-langkah 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.

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 {
        google()
        mavenCentral()
        gradlePluginPortal()
    }
}
  2. Di file settings.gradle.kts tingkat atas, sertakan repositori Maven Google dan repositori pusat Maven di bagian blok dependencyResolutionManagement: 
    dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    repositories {
        google()
        mavenCentral()
    }
}

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

    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:6.0.2")
}
  4. Dalam file build.gradle.kts tingkat modul, tetapkan compileSdk dan minSdk ke nilai berikut:

    Groovy

    android {
    compileSdk 34

    defaultConfig {
        minSdk 23
        // ...
    }
}

    Kotlin

    android {
    compileSdk = 34

    defaultConfig {
        minSdk = 23
        // ...
    }
}
  5. Di bagian buildFeatures file build.gradle tingkat 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 di direktori root project Anda dan kecualikan file tersebut dari kontrol versi. Untuk mengetahui informasi selengkapnya tentang file properti Gradle, lihat file properti Gradle.

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

Untuk menginstal Plugin Secrets Gradle untuk Android dan menyimpan kunci API Anda:

  1. Di Android Studio, buka file build.gradle.kts atau build.gradle tingkat teratas dan tambahkan kode berikut ke blok plugins.

    Kotlin

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

    Groovy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
}
  2. Buka file build.gradle.kts atau build.gradle tingkat modul dan tambahkan kode berikut ke elemen plugins.

    Kotlin

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

    Groovy

    plugins {
    id 'com.android.application'
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. Jika Anda menggunakan Android Studio, sinkronkan project Anda dengan Gradle.
  4. Buka file secrets.properties di direktori tingkat teratas, lalu tambahkan kode berikut. Ganti YOUR_API_KEY dengan kunci API Anda. Pastikan untuk menambahkan secrets.properties ke file .gitignore Anda (atau mengecualikannya dari sistem kontrol versi Anda) agar Anda tidak melakukan check in kunci API ke kontrol versi. 
    PLACES_API_KEY=YOUR_API_KEY

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

    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.

  6. Di Android Studio, buka file tingkat modul build.gradle.kts atau build.gradle 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 root directory (the same folder as the root 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 root directory (the same folder as the root 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

Untuk melakukan inisialisasi Places SDK for Android dalam aktivitas atau fragmen, 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);

Anda kini 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 Android Emulator yang menggunakan Android 6.0 atau yang lebih tinggi dan menyertakan API Google.

  • 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 Pengelola Perangkat yang disertakan bersama Android Studio.

Langkah berikutnya

Setelah project dikonfigurasi, Anda dapat menjelajahi aplikasi contoh.