Navigation SDK tersedia melalui Maven. Sesudah Anda membuat proyek pengembangan, Anda dapat mengintegrasikan SDK ke dalamnya dengan menggunakan salah satu pendekatan berikut.
Menggunakan Maven untuk Navigation SDK (direkomendasikan)
Berikut ini menggunakan repositori Maven google()
, yang merupakan cara paling sederhana dan
cara yang disarankan untuk menambahkan Navigation SDK ke project Anda.
Tambahkan dependensi berikut ke konfigurasi Gradle atau Maven Anda, dengan mengganti placeholder
VERSION_NUMBER
untuk versi Navigation SDK for Android yang diinginkan.Gradle
Tambahkan kode berikut ke
build.gradle
level modul:dependencies { ... implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER' }
Maven
Tambahkan kode berikut ke
pom.xml
Anda:<dependencies> ... <dependency> <groupId>com.google.android.libraries.navigation</groupId> <artifactId>navigation</artifactId> <version>VERSION_NUMBER</version> </dependency> </dependencies>
Jika Anda memiliki dependensi yang menggunakan Maps SDK, Anda harus mengecualikan di setiap dependensi yang dideklarasikan yang bergantung pada Maps SDK.
Gradle
Tambahkan hal berikut ke
build.gradle
tingkat teratas:allprojects { ... // Required: you must exclude the Google Play service Maps SDK from // your transitive dependencies. This is to ensure there won't be // multiple copies of Google Maps SDK in your binary, as the Navigation // SDK already bundles the Google Maps SDK. configurations { implementation { exclude group: 'com.google.android.gms', module: 'play-services-maps' } } }
Maven
Tambahkan kode berikut ke
pom.xml
Anda:<dependencies> <dependency> <groupId>project.that.brings.in.maps</groupId> <artifactId>MapsConsumer</artifactId> <version>1.0</version> <exclusions> <!-- Navigation SDK already bundles Maps SDK. You must exclude it to prevent duplication--> <exclusion> <!-- declare the exclusion here --> <groupId>com.google.android.gms</groupId> <artifactId>play-services-maps</artifactId> </exclusion> </exclusions> </dependency> </dependencies>
Mengonfigurasi build
Setelah membuat project, Anda dapat mengonfigurasi setelan untuk keberhasilan build dan penggunaan Navigation SDK.
Memperbarui properti lokal
- Di folder Gradle Scripts, buka file
local.properties
dan tambahkanandroid.useDeprecatedNdk=true
.
Memperbarui skrip build Gradle
Buka file
build.gradle (Module:app)
dan gunakan panduan berikut untuk memperbarui pengaturan untuk memenuhi persyaratan untuk Navigation SDK, dan mempertimbangkan untuk menyetel serta opsi pengoptimalan.Setelan yang diperlukan untuk Navigation SDK
- Tetapkan
minSdkVersion
ke 23 atau yang lebih tinggi. - Tetapkan
targetSdkVersion
ke 33 atau lebih tinggi. - Tambahkan setelan
dexOptions
yang meningkatkanjavaMaxHeapSize
. - Tetapkan lokasi untuk library tambahan.
- Tambahkan
repositories
dandependencies
untuk Navigation SDK. - Mengganti nomor versi dalam dependensi dengan nomor versi terbaru versi yang tersedia.
Setelan opsional untuk mengurangi waktu build
- Aktifkan penyingkatan kode dan resource penyingkatan menggunakan R8/ProGuard untuk menghapus kode dan resource yang tidak digunakan dari dependensi. Jika langkah R8/ProGuard membutuhkan terlalu banyak waktu untuk dijalankan, sebaiknya aktifkan multidex untuk pengembangan perangkat lunak.
- Mengurangi jumlah terjemahan bahasa yang disertakan dalam build: Setel
resConfigs
untuk satu bahasa selama pengembangan. Untuk build akhir, menyetelresConfigs
untuk bahasa yang sebenarnya Anda gunakan. Secara default, Gradle menyertakan string resource untuk semua bahasa yang didukung oleh Navigation SDK.
Menambahkan desugaring untuk dukungan Java8
- Jika Anda membangun aplikasi menggunakan plugin Android Gradle 4.0.0 atau lebih tinggi, plugin memperluas dukungan untuk menggunakan sejumlah bahasa Java 8 Google Cloud Platform. Lihat Desugaring Java 8 tim dukungan untuk informasi selengkapnya. Lihat contoh cuplikan skrip build di bawah untuk mengetahui caranya kompilasi, dan opsi dependensi.
- Tetapkan
Berikut adalah contoh skrip build Gradle untuk aplikasi. Periksa aplikasi contoh untuk mengetahui kumpulan dependensi yang diperbarui, karena versi Navigation SDK yang Anda gunakan mungkin sedikit lebih baru atau lebih lama dari dokumentasi ini.
apply plugin: 'com.android.application'
ext {
navSdk = "__NAVSDK_VERSION__"
}
android {
compileSdk 33
buildToolsVersion='28.0.3'
defaultConfig {
applicationId "<your id>"
// Navigation SDK supports SDK 23 and later.
minSdkVersion 23
targetSdkVersion 33
versionCode 1
versionName "1.0"
// Set this to the languages you actually use, otherwise you'll include resource strings
// for all languages supported by the Navigation SDK.
resConfigs "en"
multiDexEnabled true
}
dexOptions {
// This increases the amount of memory available to the dexer. This is required to build
// apps using the Navigation SDK.
javaMaxHeapSize "4g"
}
buildTypes {
// Run ProGuard. Note that the Navigation SDK includes its own ProGuard configuration.
// The configuration is included transitively by depending on the Navigation SDK.
// If the ProGuard step takes too long, consider enabling multidex for development work
// instead.
all {
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
compileOptions {
// Flag to enable support for the new language APIs
coreLibraryDesugaringEnabled true
// Sets Java compatibility to Java 8
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
repositories {
// Navigation SDK for Android and other libraries are hosted on Google's Maven repository.
google()
}
dependencies {
// Include the Google Navigation SDK.
// Note: remember to exclude Google Play service Maps SDK from your transitive
// dependencies to avoid duplicate copies of the Google Maps SDK.
api "com.google.android.libraries.navigation:navigation:${navSdk}"
// Declare other dependencies for your app here.
annotationProcessor "androidx.annotation:annotation:1.7.0"
coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.9'
}
Menambahkan kunci API ke aplikasi
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 root project
Anda. Untuk informasi selengkapnya tentang file secrets.properties
, lihat
file properti Gradle.
Untuk menyederhanakan tugas ini, sebaiknya gunakan Plugin Secrets Gradle untuk Android.
Untuk menginstal Plugin Secrets Gradle untuk Android di project Google Maps:
-
Di Android Studio, buka file
build.gradle.kts
ataubuild.gradle
tingkat teratas dan tambahkan kode berikut ke elemendependencies
di bagianbuildscript
.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" } }
-
Buka file
build.gradle.kts
ataubuild.gradle
tingkat modul dan tambahkan kode berikut ke elemenplugins
.Kotlin
plugins { // ... id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
Groovy
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
- Di file
build.gradle.kts
ataubuild.gradle
tingkat modul, pastikan bahwatargetSdk
dancompileSdk
sudah disetel menjadi 34. - Simpan file dan sinkronkan project Anda dengan Gradle.
-
Buka file
secrets.properties
di direktori tingkat teratas, lalu tambahkan kode berikut. GantiYOUR_API_KEY
dengan kunci API Anda. Simpan kunci Anda dalam file ini karenasecrets.properties
tidak di-check in ke dalam sistem kontrol versi.NAV_API_KEY=YOUR_API_KEY
- Simpan file.
-
Buat file
local.defaults.properties
di direktori tingkat teratas, folder yang sama dengan filesecrets.properties
, lalu tambahkan kode berikut.NAV_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 menghapussecrets.properties
dan Anda belum membuat filesecrets.properties
secara lokal untuk memberikan Kunci API Anda. - Simpan file.
-
Di file
AndroidManifest.xml
, bukacom.google.android.geo.API_KEY
, lalu perbaruiandroid:value attribute
. Jika tag<meta-data>
tidak ada, buat tag tersebut sebagai turunan dari tag<application>
.<meta-data android:name="com.google.android.geo.API_KEY" android:value="${MAPS_API_KEY}" />
Catatan:
com.google.android.geo.API_KEY
adalah nama metadata yang direkomendasikan untuk kunci API. Sebuah kunci dengan nama ini dapat digunakan untuk mengotentikasi beberapa API berbasis Google Maps di platform Android, termasuk Navigation SDK untuk Android. Untuk kompatibilitas mundur, API juga mendukung namacom.google.android.maps.v2.API_KEY
. Warisan ini hanya memungkinkan autentikasi untuk Android Maps API v2. Aplikasi dapat menentukan hanya salah satu nama metadata kunci API. Jika keduanya ditetapkan, API menampilkan pengecualian. -
Di Android Studio, buka file
build.gradle.kts
ataubuild.gradle
tingkat modul dan edit propertisecrets
. Jika Propertisecrets
tidak ada, tambahkan.Edit properti plugin untuk menetapkan
propertiesFileName
kesecrets.properties
, tetapkandefaultPropertiesFileName
kelocal.defaults.properties
, dan tetapkan 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" // Configure which keys should be ignored by the plugin by providing regular expressions. // "sdk.dir" is ignored by default. ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore" ignoreList.add("sdk.*") // Ignore all keys matching the regexp "sdk.*" }
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" // Configure which keys should be ignored by the plugin by providing regular expressions. // "sdk.dir" is ignored by default. ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore" ignoreList.add("sdk.*") // Ignore all keys matching the regexp "sdk.*" }
Menyertakan atribusi yang diperlukan dalam aplikasi
Jika menggunakan Navigation SDK for Android di aplikasi, Anda harus menyertakan teks atribusi dan lisensi open source sebagai bagian dari pemberitahuan hukum aplikasi Anda bagian.
Anda dapat menemukan teks atribusi dan lisensi open source yang diperlukan di File ZIP Navigation SDK untuk Android:
NOTICE.txt
LICENSES.txt
Jika Anda adalah pelanggan Mobility atau Fleet Engine Deliveries
Jika Anda adalah pelanggan Mobility atau Fleet Engine Deliveries, pelajari penagihan dalam dokumentasi Mobility. Untuk mengetahui informasi selengkapnya tentang mencatat transaksi, melihat Menyiapkan penagihan, Mencatat transaksi yang dapat ditagih, Pelaporan, dan Mencatat transaksi yang dapat ditagih (Android).