Menyiapkan project Android Studio

Halaman ini menjelaskan cara mengonfigurasi project Android Studio yang ada untuk menggunakan Maps SDK for Android tanpa menggunakan template Google Maps yang dijelaskan dalam Panduan Memulai.

Template Google Maps akan otomatis mengonfigurasi dan menambahkan peta dasar ke project Android Studio baru. Namun, Anda juga dapat menambahkan peta ke project Android yang menggunakan template Android Studio lain. Untuk melakukannya, Anda harus mengonfigurasi project secara manual, lalu menambahkan peta.

Langkah 1: Siapkan Android Studio

  1. Perlu Android Studio Arctic Fox atau versi yang lebih baru. Jika belum punya, download dan instal Android Studio versi tersebut.
  2. Pastikan Anda menggunakan plugin Android Gradle versi 7.0 atau yang lebih baru di Android Studio.

Langkah 2: Siapkan SDK

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

  1. Dalam file settings.gradle 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. Dalam file settings.gradle 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. Dalam file build.gradle tingkat modul, tambahkan dependensi layanan Google Play untuk Maps SDK for Android.
    dependencies {
        implementation 'com.google.android.gms:play-services-maps:18.1.0'
        // ...
    } 
  4. Dalam file build.gradle tingkat modul, tetapkan compileSdk dan minSdk ke nilai berikut:
    android {
        compileSdk 31
    
        defaultConfig {
            minSdk 19
            // ...
        }

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 local.properties, yang terletak di direktori utama project Anda. Untuk informasi selengkapnya tentang file local.properties, lihat file properti Gradle.

Untuk menyederhanakan tugas ini, sebaiknya Anda menggunakan Plugin Gradle Secret untuk Android. Untuk menginstal plugin dan menyimpan kunci API Anda:

  1. Di Android Studio, buka file build.gradle tingkat project dan tambahkan kode berikut ke elemen dependencies di bagian buildscript.
    plugins {
        // ...
        id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
    }
  2. Selanjutnya, buka file build.gradle tingkat modul dan tambahkan kode berikut ke elemen plugins.
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
        
  3. Simpan file dan sinkronkan project Anda dengan Gradle.
  4. Buka local.properties pada direktori tingkat project, lalu tambahkan kode berikut. Ganti YOUR_API_KEY dengan kunci API Anda.
    MAPS_API_KEY=YOUR_API_KEY
        
  5. Simpan file.
  6. Dalam file AndroidManifest.xml Anda, buka com.google.android.geo.API_KEY dan perbarui android:value attribute sebagai berikut:
    <meta-data
        android:name="com.google.android.geo.API_KEY"
        android:value="${MAPS_API_KEY}" />
        

Catatan: Seperti yang ditunjukkan di atas, com.google.android.geo.API_KEY adalah nama metadata yang disarankan untuk kunci API. Kunci dengan nama ini dapat digunakan untuk mengautentikasi beberapa API berbasis Google Maps sekaligus di platform Android, termasuk Maps SDK for Android. Untuk kompatibilitas mundur, API tersebut juga mendukung nama com.google.android.maps.v2.API_KEY. Nama lama ini hanya memungkinkan autentikasi untuk Android Maps API v2. Aplikasi hanya dapat menetapkan salah satu nama metadata kunci API. Jika keduanya ditetapkan, API akan memberikan pengecualian.

Langkah 4: Perbarui manifes aplikasi

Bagian ini menjelaskan setelan yang akan ditambahkan ke file AndroidManifest.xml.

Nomor versi layanan Google Play

Tambahkan deklarasi berikut dalam elemen application. Tindakan tersebut akan menyematkan versi layanan Google Play yang digunakan untuk mengompilasi aplikasi.

<meta-data
    android:name="com.google.android.gms.version"
    android:value="@integer/google_play_services_version" />

Izin akses lokasi

Jika aplikasi perlu mengakses lokasi pengguna, Anda perlu meminta izin akses lokasi di file AndroidManifest.xml. Opsinya adalah ACCESS_FINE_LOCATION, yang memberikan lokasi akurat perangkat, dan ACCESS_COARSE_LOCATION, yang tidak terlalu akurat. Untuk mengetahui detailnya, lihat panduan data lokasi.

Untuk meminta izin ACCESS_FINE_LOCATION, tambahkan kode ini ke elemen manifest:

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>

Izin penyimpanan eksternal

Jika menargetkan SDK layanan Google Play versi 8.3 atau yang lebih baru, Anda tidak memerlukan izin WRITE_EXTERNAL_STORAGE. Jika menargetkan SDK layanan Google Play versi sebelumnya, Anda harus meminta izin WRITE_EXTERNAL_STORAGE, di elemen manifest.

<uses-permission
        android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

Library Apache HTTP Legacy

Jika Anda menggunakan com.google.android.gms:play-services-maps:16.0.0 atau yang lebih lama dan aplikasi Anda menarget API level 28 (Android 9.0) atau yang lebih tinggi, Anda harus menyertakan deklarasi berikut dalam elemen <application> dari AndroidManifest.xml. Jika tidak, lewati deklarasi ini.

<uses-library
    android:name="org.apache.http.legacy"
    android:required="false" />

Langkah 5: Siapkan perangkat Android

Untuk menjalankan aplikasi yang menggunakan Maps SDK for Android, Anda harus men-deploy aplikasi tersebut ke perangkat Android atau Android Emulator yang didasarkan pada Android 4.0 atau yang lebih tinggi dan menyertakan Google API.

  • Untuk menggunakan perangkat Android, ikuti petunjuk pada halaman Menjalankan aplikasi di perangkat hardware.
  • Untuk menggunakan emulator Android, Anda dapat membuat perangkat virtual dan menginstal emulator dengan menggunakan AVD (Perangkat Virtual Android) Manager yang disertakan bersama Android Studio.

Langkah berikutnya

Setelah project dikonfigurasi, Anda dapat menambahkan peta.