Настройка проекта 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 {
        gradlePluginPortal()
        google()
        mavenCentral()
    }
}
  2. В файле верхнего уровня settings.gradle.kts включите репозиторий Maven от Google и центральный репозиторий Maven в блок dependencyResolutionManagement : 
    dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    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.0.0")
}
  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 в вашем проекте Google Maps:

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

    Котлин 

    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
}

    Круто 

    buildscript {
    dependencies {
        classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
    }
}
  2. Откройте файл build.gradle.kts или build.gradle на уровне модуля и добавьте следующий код в элемент plugins .

    Котлин 

    plugins {
    // ...
    alias(libs.plugins.secrets.gradle.plugin)
}

    Круто 

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. В файле build.gradle.kts или build.gradle на уровне модуля убедитесь, что для targetSdk и compileSdk задано значение 34.
  4. Синхронизируйте свой проект с Gradle .
  5. Откройте файл secrets.properties в каталоге верхнего уровня и добавьте следующий код. Замените YOUR_API_KEY вашим ключом API. Сохраните свой ключ в этом файле, поскольку secrets.properties не подлежит проверке в системе контроля версий.
    PLACES_API_KEY=YOUR_API_KEY

  6. Создайте файл local.defaults.properties в каталоге верхнего уровня, в той же папке, что и файл secrets.properties , а затем добавьте следующий код.

    PLACES_API_KEY=DEFAULT_API_KEY

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

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

    Отредактируйте свойства плагина, чтобы задать для propertiesFileName secrets.properties , для defaultPropertiesFileName — значение local.defaults.properties , а также задать любые другие свойства.

    Котлин 

    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"
}

    Круто 

    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"
}

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

Чтобы инициализировать Places SDK для 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.

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

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