Panduan ini mencantumkan persyaratan konfigurasi build untuk menggunakan Navigation SDK untuk Android. Petunjuknya mengasumsikan Anda memiliki Android IDE diinstal dan sudah terbiasa dengan pengembangan Android.
Persyaratan minimum untuk menggunakan Navigation SDK
Persyaratan ini berlaku untuk Navigation SDK for Android versi 4.99 dan yang lebih lama.
Project Konsol Google Cloud dengan Navigation SDK yang diaktifkan. Untuk penyediaan, tanyakan kepada perwakilan Google Maps Platform Anda.
Aplikasi Anda harus menargetkan API level 30 atau yang lebih tinggi.
Untuk menjalankan aplikasi yang dibuat dengan Navigation SDK, Android harus perangkat harus memiliki layanan Google Play diinstal dan diaktifkan.
Teks atribusi dan pemberian lisensi harus ditambahkan ke aplikasi.
Menyiapkan project: project Konsol Cloud dan project Android
Sebelum dapat membangun atau menguji aplikasi, Anda perlu membuat project Konsol Cloud dan menambahkan kredensial kunci API. Project harus memiliki penyediaan untuk mengakses Navigation SDK. Semua kunci dalam project Cloud Console diberi akses yang sama ke Navigation SDK. Kunci dapat memiliki lebih dari satu proyek pengembangan yang terkait. Jika sudah memiliki project konsol, Anda dapat menambahkan kunci ke project saat ini.
Untuk menyiapkan
- Di browser web favorit Anda, login ke Konsol Cloud dan buat Konsol Cloud proyek.
- Di IDE, seperti Android Studio, buat pengembangan aplikasi Android project dan mencatat nama paketnya.
- Hubungi perwakilan Google Maps Platform untuk memberikan akses ke Navigation SDK untuk Cloud Console proyek.
- Saat berada di dasbor Konsol Cloud pada browser web, membuat kredensial untuk menghasilkan kunci API dengan pembatasan.
- Di halaman API key, klik Android apps di Application restrictions area tersebut.
- Klik Add the package name and sidik jari, lalu masukkan paket nama proyek pengembangan Anda dan sidik jari SHA-1 untuk kunci tersebut.
- Klik Simpan.
Menambahkan Navigation SDK ke project Anda
Navigation SDK tersedia melalui Maven, atau sebagai Paket AAR. Setelah membuat proyek pengembangan, Anda dapat mengintegrasikan SDK ke dalamnya dengan menggunakan salah satu pendekatan berikut.
Menggunakan Maven untuk Navigation SDK v4.5 dan yang lebih baru (direkomendasikan)
Berikut ini menggunakan repositori Maven google()
, yang merupakan metode paling sederhana
dan cara yang disarankan untuk menambahkan Navigation SDK ke
rencana
Tambahkan dependensi berikut ke konfigurasi Gradle atau Maven Anda, mengganti placeholder
VERSION_NUMBER
dengan versi Navigation SDK untuk Android yang diinginkan.Gradle
Tambahkan kode berikut ke
build.gradle
level modul:dependencies { ... implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER' }
Jika mengupgrade dari repositori Maven asli, perhatikan bahwa grup dan nama artefak telah berubah, dan Plugin
com.google.cloud.artifactregistry.gradle-plugin
tidak lagi diperlukan.Dan tambahkan kode 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>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.
<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>
Menggunakan Maven untuk Navigation SDK sebelum v4.5, atau dengan Driver SDK
Navigation SDK akan terus tersedia melalui
repositori Maven asli hingga
versi v4 yang tersisa. Ini adalah
pustaka yang sama dengan semua pembaruan
yang sama seperti versi di atas, dan menyediakan
kompatibilitas dengan Driver SDK dan library lain selama transisi. Menggunakan
dependensi ini memerlukan login ke project cloud Anda melalui gcloud
saat
mengompilasi.
- Siapkan lingkungan Anda untuk mengakses repositori Maven Google seperti yang dijelaskan dalam Prasyarat dokumentasi SDK Konsumen. Akses ke Navigation SDK dikontrol melalui grup ruang kerja.
Tambahkan dependensi berikut ke konfigurasi Gradle atau Maven Anda, dengan mengganti Placeholder
VERSION_NUMBER
untuk versi Navigation SDK yang diinginkan.Gradle
Tambahkan kode berikut ke
build.gradle
level modul:dependencies { ... implementation 'com.google.android.maps:navsdk:VERSION_NUMBER' }
Dan tambahkan kode 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>com.google.android.maps</groupId> <artifactId>navsdk</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.
<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>
Menggunakan paket AAR yang didownload (tidak direkomendasikan)
Navigation SDK juga tersedia sebagai paket AAR. Setelah membuat project pengembangan, Anda dapat mengintegrasikan SDK. Petunjuk ini asumsikan penggunaan Android Studio untuk IDE Anda.
Download versi terbaru Navigation SDK dari Google Drive bersama dan ekstrak file tersebut. Jika Anda tidak memiliki akses, hubungi perwakilan Anda.
Di Android Studio, buka project dan tambahkan paket layanan Google Play menggunakan SDK Manager.
Dari direktori file zip, salin
libs/google_navigation_navmap.aar
ke direktoriapp/libs
project Anda.Tambahkan kode berikut ke
build.gradle
level modul:implementation(name: 'google_navigation_navmap', ext: 'aar')
Dan tambahkan kode 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' } } }
Mengonfigurasi build
Setelah membuat project, Anda dapat mengonfigurasi setelan untuk keberhasilan build dan penggunaan Navigation SDK.
Perbarui properti lokal
- Di folder Gradle Scripts, buka file
local.properties
dan tambahkanandroid.useDeprecatedNdk=true
.
Mengupdate skrip build Gradle
Buka file
build.gradle (Module:app)
dan gunakan panduan berikut untuk memperbarui setelan untuk memenuhi persyaratan Navigation SDK dan pertimbangkan untuk menetapkan opsi pengoptimalan.Setelan yang diperlukan untuk Navigation SDK
- Tetapkan
minSdkVersion
ke 23 atau lebih tinggi. - Tetapkan
targetSdkVersion
ke 30 atau lebih tinggi. - Tambahkan setelan
dexOptions
yang meningkatkanjavaMaxHeapSize
. - Tetapkan lokasi untuk library tambahan.
- Tambahkan
repositories
dandependencies
untuk Navigation SDK. - Ganti nomor versi dalam dependensi dengan versi terbaru yang tersedia.
Setelan opsional untuk mengurangi waktu build
- Aktifkan penyingkatan kode dan penyingkatan resource 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 pekerjaan pengembangan.
- Mengurangi jumlah terjemahan bahasa yang disertakan dalam build: Setel
resConfigs
untuk satu bahasa selama pengembangan. Untuk build akhir, tetapkanresConfigs
untuk bahasa yang sebenarnya Anda gunakan. Secara default, Gradle menyertakan string resource untuk semua bahasa yang didukung oleh Navigation SDK.
- Tetapkan
Di bawah ini adalah contoh skrip build Gradle untuk aplikasi. Periksa aplikasi contoh untuk kumpulan dependensi yang diupdate, Navigation SDK yang Anda gunakan mungkin sedikit lebih cepat atau di balik dokumentasi ini.
apply plugin: 'com.android.application'
apply plugin: 'com.google.cloud.artifactregistry.gradle-plugin'
ext {
androidxVersion = "1.0.0"
lifecycle_version = "1.1.1"
}
android {
compileSdkVersion 30
buildToolsVersion '28.0.3'
defaultConfig {
applicationId "<your id>"
// Navigation SDK supports SDK 23 and later.
minSdkVersion 23
targetSdkVersion 30
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 {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
// This tells Gradle where to look to find additional libraries - in this case, the
// google_navigation_navmap.aar file.
repositories {
flatDir {
dirs 'libs'
}
google()
// Required for accessing the Navigation SDK on Google's Maven repository.
maven {
url "artifactregistry://us-west2-maven.pkg.dev/gmp-artifacts/transportation"
}
}
dependencies {
// Include the Google Navigation SDK
implementation 'com.google.android.maps:navsdk:4.4.0'
// The included AAR file under libs can be used instead of the Maven repository.
// Uncomment the line below and comment out the previous dependency to use
// the AAR file instead. Ensure that you add the AAR file to the libs directory.
// implementation(name: 'google_navigation_navmap', ext: 'aar')
// These dependencies are required for the Navigation SDK to function
// properly at runtime.
implementation 'org.chromium.net:cronet-fallback:69.3497.100'
// Optional for Cronet users:
// implementation 'org.chromium.net:cronet-api:69.3497.100'
implementation 'androidx.appcompat:appcompat:${androidxVersion}'
implementation 'androidx.cardview:cardview:${androidxVersion}'
implementation 'com.google.android.material:material:${androidxVersion}'
implementation 'androidx.mediarouter:mediarouter:${androidxVersion}'
implementation 'androidx.preference:preference:${androidxVersion}'
implementation 'androidx.recyclerview:recyclerview:${androidxVersion}'
implementation 'androidx.legacy:legacy-support-v4:${androidxVersion}'
implementation 'com.github.bumptech.glide:glide:4.9.0'
implementation 'com.github.bumptech.glide:okhttp-integration:4.9.0'
implementation 'android.arch.lifecycle:common-java8:$lifecycle_version'
implementation 'com.android.support:multidex:1.0.3'
implementation 'com.google.android.datatransport:transport-api:2.2.0'
implementation 'com.google.android.datatransport:transport-backend-cct:2.2.0'
implementation 'com.google.android.datatransport:transport-runtime:2.2.0'
implementation 'joda-time:joda-time:2.9.9'
annotationProcessor 'androidx.annotation:annotation:1.1.0'
annotationProcessor 'com.github.bumptech.glide:compiler:4.9.0'
}
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 tahun. - 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}" />
Note:
com.google.android.geo.API_KEY
is the recommended metadata name for the API key. A key with this name can be used to authenticate to multiple Google Maps-based APIs on the Android platform, including the Navigation SDK for Android. For backwards compatibility, the API also supports the namecom.google.android.maps.v2.API_KEY
. This legacy name allows authentication to the Android Maps API v2 only. An application can specify only one of the API key metadata names. If both are specified, the API throws an exception. -
In Android Studio, open your module-level
build.gradle.kts
orbuild.gradle
file and edit thesecrets
property. If thesecrets
property does not exist, add it.Edit the properties of the plugin to set
propertiesFileName
tosecrets.properties
, setdefaultPropertiesFileName
tolocal.defaults.properties
, and set any other properties.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
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-08-22 UTC.
[{ "type": "thumb-down", "id": "missingTheInformationINeed", "label":"Informasi yang saya butuhkan tidak ada" },{ "type": "thumb-down", "id": "tooComplicatedTooManySteps", "label":"Terlalu rumit/langkahnya terlalu banyak" },{ "type": "thumb-down", "id": "outOfDate", "label":"Sudah usang" },{ "type": "thumb-down", "id": "translationIssue", "label":"Masalah terjemahan" },{ "type": "thumb-down", "id": "samplesCodeIssue", "label":"Masalah kode / contoh" },{ "type": "thumb-down", "id": "otherDown", "label":"Lainnya" }] [{ "type": "thumb-up", "id": "easyToUnderstand", "label":"Mudah dipahami" },{ "type": "thumb-up", "id": "solvedMyProblem", "label":"Memecahkan masalah saya" },{ "type": "thumb-up", "id": "otherUp", "label":"Lainnya" }]