Настройка проекта Android Studio

Чтобы настроить ваше приложение для использования Places SDK для Android, выполните следующие шаги. Они необходимы для всех приложений, использующих Places SDK для Android.

Шаг 1: Настройка Android Studio

В этом документе описывается среда разработки с использованием Android Studio Hedgehog и плагина Android Gradle версии 8.2.

Шаг 2. Настройка SDK.

Библиотека Places SDK для Android доступна через репозиторий Maven от Google . Чтобы добавить SDK в ваше приложение, выполните следующие действия:

1. В файле settings.gradle.kts верхнего уровня добавьте ссылки на портал плагинов Gradle , репозиторий Google Maven и центральный репозиторий Maven в блок pluginManagement . Блок pluginManagement должен располагаться перед любыми другими операторами в скрипте.

   pluginManagement {
       repositories {
           google()
           mavenCentral()
           gradlePluginPortal()
       }
   } 

2. В файле settings.gradle.kts верхнего уровня добавьте репозиторий Maven от Google и центральный репозиторий Maven в блок dependencyResolutionManagement :

   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
       repositories {
           google()
           mavenCentral()
       }
   } 

3. В разделе dependencies файла build.gradle.kts вашего модуля добавьте зависимость от Places SDK для Android:

   Классный

   dependencies {
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation("com.google.android.libraries.places:places:3.5.0")
   }

   Котлин

             dependencies {
   
       // Places and Maps SDKs
       implementation("com.google.android.libraries.places:places:5.1.1")
   }

4. В файле build.gradle.kts , расположенном на уровне модуля, установите для compileSdk и minSdk следующие значения:

   Классный

   android {
       compileSdk 34
   
       defaultConfig {
           minSdk 23
           // ...
       }
   }

   Котлин

   android {
       compileSdk = 34
   
       defaultConfig {
           minSdk = 23
           // ...
       }
   }

5. В разделе buildFeatures файла build.gradle вашего модуля добавьте класс BuildConfig , который вы будете использовать для доступа к значениям метаданных, определенным далее в этой процедуре:

   Классный

   android {
     // ...
     buildFeatures {
       buildConfig true
       // ...
     }
   }

   Котлин

   android {
     // ...
     buildFeatures {
       buildConfig = true
       // ...
     }
   }

Шаг 3: Добавьте свой API-ключ в проект.

В этом разделе описывается, как хранить ваш API-ключ, чтобы ваше приложение могло безопасно его использовать. Не следует добавлять API-ключ в систему контроля версий, поэтому мы рекомендуем хранить его в файле secrets.properties , который находится в корневом каталоге вашего проекта. Более подробную информацию о файле secrets.properties см. в разделе «Файлы свойств Gradle» .

Для упрощения этой задачи мы рекомендуем использовать плагин Secrets Gradle для Android .

Чтобы установить плагин Secrets Gradle для Android и сохранить свой API-ключ:

1. В Android Studio откройте корневой файл build.gradle и добавьте следующий код в элемент dependencies под buildscript .

   Классный

   buildscript {
       dependencies {
           // ...
           classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
       }
   }

   Котлин

   buildscript {
       dependencies {
           // ...
           classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
       }
   }

2. Откройте файл build.gradle вашего приложения и добавьте следующий код в элемент plugins .

   Классный

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

   Котлин

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

3. Если вы используете Android Studio, синхронизируйте свой проект с Gradle .
4. Откройте файл local.properties в директории вашего проекта и добавьте следующий код. Замените YOUR_API_KEY на ваш API-ключ.

   PLACES_API_KEY=YOUR_API_KEY

Шаг 4. Инициализация клиента Places API.

Для инициализации SDK Places для Android внутри активности или фрагмента передайте ключ API при вызове метода Places.initializeWithNewPlacesApiEnabled() :

    // 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)
    

    // 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);
    

Теперь вы готовы начать использовать Places SDK для Android!

Шаг 5: Настройка устройства Android

Для запуска приложения, использующего Places SDK для Android, необходимо развернуть его на устройстве Android или эмуляторе Android, работающем под управлением Android 5.0 или выше и включающем API Google.

• Чтобы использовать устройство Android, следуйте инструкциям в разделе «Запуск приложений на аппаратном устройстве» .
• Для использования эмулятора Android можно создать виртуальное устройство и установить эмулятор с помощью менеджера виртуальных устройств Android (AVD) , входящего в состав Android Studio.

Следующие шаги