Aby skonfigurować aplikację do korzystania z pakietu SDK Miejsc na Androida, wykonaj te czynności. Są one wymagane w przypadku wszystkich aplikacji korzystających z pakietu SDK Miejsc na Androida.
Krok 1. Skonfiguruj Android Studio
W tym dokumencie opisujemy środowisko programistyczne korzystające z Androida Studio Hedgehog i wtyczki Androida do Gradle w wersji 8.2.
Krok 2. Konfigurowanie pakietu SDK
Biblioteka pakietu SDK Miejsc na Androida jest dostępna w repozytorium Google Maven. Aby dodać pakiet SDK do aplikacji:
- W pliku
settings.gradle.ktsnajwyższego poziomu dodaj portal wtyczek Gradle, repozytorium Google Maven i centralne repozytorium Maven w blokupluginManagement. BlokpluginManagementmusi występować przed wszystkimi innymi instrukcjami w skrypcie.pluginManagement { repositories { gradlePluginPortal() google() mavenCentral() } }
- W pliku
settings.gradle.ktsnajwyższego poziomu dodaj repozytorium Maven firmy Google i centralne repozytorium Maven w blokudependencyResolutionManagement:dependencyResolutionManagement { repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) repositories { google() mavenCentral() } }
-
W sekcji
dependenciesplikubuild.gradle.ktsna poziomie modułu dodaj zależność od pakietu SDK Miejsc na Androida:Zakręcony
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:5.0.0") }
- W pliku
build.gradle.ktsna poziomie modułu ustawcompileSdkiminSdkna te wartości:Zakręcony
android { compileSdk 34 defaultConfig { minSdk 23 // ... } }
Kotlin
android { compileSdk = 34 defaultConfig { minSdk = 23 // ... } }
- W sekcji
buildFeaturesplikubuild.gradlena poziomie modułu dodaj klasęBuildConfig, której użyjesz do uzyskiwania dostępu do wartości metadanych zdefiniowanych później w tej procedurze:Zakręcony
android { // ... buildFeatures { buildConfig true // ... } }
Kotlin
android { // ... buildFeatures { buildConfig = true // ... } }
Krok 3. Dodaj klucz interfejsu API do projektu
W tej sekcji opisujemy, jak przechowywać klucz interfejsu API, aby aplikacja mogła się do niego bezpiecznie odwoływać. Nie należy umieszczać klucza interfejsu API w systemie kontroli wersji, dlatego zalecamy przechowywanie go w pliku secrets.properties, który znajduje się w katalogu głównym projektu. Więcej informacji o pliku secrets.properties znajdziesz w artykule Pliki właściwości Gradle.
Aby uprościć to zadanie, zalecamy użycie wtyczki Gradle obiektów tajnych na Androida.
Aby zainstalować wtyczkę Gradle obiektów tajnych na Androida w projekcie Google Maps:
-
W Android Studio otwórz plik najwyższego poziomu
build.gradle.ktslubbuild.gradlei dodaj ten kod do elementudependenciesw sekcjibuildscript.Kotlin
plugins { alias(libs.plugins.android.application) apply false alias(libs.plugins.jetbrains.kotlin.android) apply false alias(libs.plugins.kotlin.compose) apply false alias(libs.plugins.secrets.gradle.plugin) apply false }
Zakręcony
buildscript { dependencies { classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1" } }
-
Otwórz plik
build.gradle.ktslubbuild.gradlena poziomie modułu i dodaj do elementupluginsten kod:Kotlin
plugins { // ... alias(libs.plugins.secrets.gradle.plugin) }
Zakręcony
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
- W pliku
build.gradle.ktslubbuild.gradlena poziomie modułu upewnij się, że wartościtargetSdkicompileSdkto 34. - Zsynchronizuj projekt z Gradle.
-
Otwórz plik
secrets.propertiesw katalogu najwyższego poziomu i dodaj ten kod: ZastąpYOUR_API_KEYswoim kluczem interfejsu API. Przechowuj klucz w tym pliku, ponieważsecrets.propertiesnie jest sprawdzany w systemie kontroli wersji.PLACES_API_KEY=YOUR_API_KEY
-
Utwórz plik
local.defaults.propertiesw katalogu najwyższego poziomu, tym samym folderze co pliksecrets.properties, a następnie dodaj ten kod.PLACES_API_KEY=DEFAULT_API_KEY
Ten plik służy jako lokalizacja kopii zapasowej klucza interfejsu API, jeśli nie można znaleźć pliku
secrets.properties, aby kompilacje nie kończyły się niepowodzeniem. Może się to zdarzyć, jeśli: sklonujesz aplikację z systemu kontroli wersji, który pomijasecrets.properties, i nie utworzysz jeszcze lokalnie plikusecrets.properties, aby podać klucz interfejsu API. -
W Android Studio otwórz plik
build.gradle.ktslubbuild.gradlena poziomie modułu i edytuj właściwośćsecrets. Jeśli właściwośćsecretsnie istnieje, dodaj ją.Edytuj właściwości wtyczki, aby ustawić
propertiesFileNamenasecrets.properties,defaultPropertiesFileNamenalocal.defaults.propertiesi skonfigurować inne właściwości.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" }
Zakręcony
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" }
Krok 4. Inicjowanie klienta interfejsu Places API
Aby zainicjować pakiet SDK Miejsc na Androida w aktywności lub fragmencie, przekaż klucz interfejsu API podczas wywoływania 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);
Możesz już zacząć korzystać z pakietu Places SDK na Androida.
Krok 5. Konfigurowanie urządzenia z Androidem
Aby uruchomić aplikację korzystającą z pakietu Places SDK na Androida, musisz wdrożyć ją na urządzeniu z Androidem lub emulatorze Androida opartym na Androidzie 5.0 lub nowszym, który zawiera interfejsy API Google.
- Aby używać urządzenia z Androidem, postępuj zgodnie z instrukcjami w artykule Uruchamianie aplikacji na urządzeniu.
- Aby używać emulatora Androida, możesz utworzyć urządzenie wirtualne i zainstalować emulator za pomocą menedżera urządzenia wirtualnego z Androidem (AVD), który jest częścią Android Studio.