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

ПРИМЕЧАНИЕ. Версия 2.0.0 и более поздние версии Places SDK для Android зависят от AndroidX. Начиная с этой версии старая библиотека поддержки больше не будет поддерживаться. Чтобы сохранить совместимость, необходимо перенести проекты на AndroidX.

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

Шаг 1. Настройте Android Studio

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

Примечание. Если в вашей среде разработки используется другая версия Android Studio или Gradle, возможно, вам придется скорректировать описанные ниже шаги. Дополнительные сведения вы найдете в разделе, посвященном совместимости плагина Android Gradle и Android Studio.

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

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

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

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

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

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

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

   Примечание. Для Places SDK для Android версии 3.5.0 требуется kotlin-bom версии 1.8.0 или более поздней. Подробнее kotlin-bom об использовании последней версии kotlin-stdlib в транзитивных зависимостях…

   Groovy

   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:6.0.2")
   }

4. В файле build.gradle.kts на уровне модуля присвойте compileSdk и minSdk следующие значения:
   Примечание. Убедитесь, что в compileSdk задано значение 34 или выше, а в minSdk – 23 или выше.

   Groovy

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

   Kotlin

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

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

   Groovy

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

   Kotlin

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

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

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

Чтобы упростить работу, используйте плагин Secrets Gradle для Android.

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

1. В Android Studio откройте файл build.gradle.kts или build.gradle верхнего уровня и добавьте в блок plugins приведенный ниже код.

   Kotlin

   plugins {
       // ...
       id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") version "2.0.1" apply false
   }

   Groovy

   plugins {
       // ...
       id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
   }

2. Откройте файл build.gradle.kts или build.gradle уровня модуля и добавьте в элемент plugins приведенный ниже код.

   Kotlin

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

   Groovy

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

3. Если вы используете Android Studio, синхронизируйте проект с Gradle.
4. Откройте файл secrets.properties в каталоге верхнего уровня и добавьте приведенный ниже код. Замените YOUR_API_KEY своим ключом API. Добавьте secrets.properties в файл .gitignore (или исключите его из системы управления версиями другим способом), чтобы ключ API не попал в систему управления версиями.
   Примечание. Если файла secrets.properties нет, создайте его в папке, где хранится файл local.properties.

   PLACES_API_KEY=YOUR_API_KEY

5. Создайте файл local.defaults.properties в каталоге верхнего уровня (там же, где хранится файл secrets.properties), а затем добавьте указанный ниже код.

   Примечание. Введите код точно так, как показано ниже. Не заменяйте DEFAULT_API_KEY своим ключом API.

   PLACES_API_KEY=DEFAULT_API_KEY

   Этот файл служит запасным хранилищем ключа API, чтобы обеспечить выполнение сборки, даже если система не обнаружит файл secrets.properties. Так может произойти, если вы скопируете приложение из системы управления версиями, игнорирующей файл secrets.properties, и не создадите secrets.properties с ключом API локально.

6. В Android Studio откройте файл build.gradle.kts или build.gradle на уровне модуля и измените свойство secrets. Если свойства secrets нет, добавьте его.

   Измените свойства плагина, чтобы задать для propertiesFileName значение "secrets.properties", для defaultPropertiesFileName – "local.defaults.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 root directory (the same folder as the root 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"
   }

   Groovy

   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root 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"
   }

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

Чтобы инициализировать Places SDK для Android в действии или фрагменте, передайте ключ API при вызове 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);
    

Важно! Никогда не добавляйте ключи API непосредственно в код приложения. В рабочих средах для управления ключами API рекомендуется использовать безопасный механизм.

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

Шаг 5. Настройте устройство Android

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

• Чтобы использовать устройство Android, следуйте инструкциям о том, как запускать приложения на физических устройствах.
• Чтобы использовать эмулятор Android, создайте виртуальное устройство и установите эмулятор с помощью Диспетчера устройств, который доступен в Android Studio.
  Примечание. Если вы используете эмулятор Android, выберите профиль устройства со значком Google Play () в столбце с названием сервиса. Этот значок подтверждает, что профиль полностью совместим с CTS и может использовать образы системы, которые содержат приложение Google Play.

Дальнейшие действия

После настройки проекта вы можете изучить примеры приложений.