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

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

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

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

Шаг 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:

    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:5.1.1")
}
  4. В файле build.gradle.kts на уровне модуля присвойте compileSdk и minSdk следующие значения:

    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, который находится в корневом каталоге проекта. Подробные сведения о файле secrets.properties можно найти в описании файлов свойств Gradle.

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

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

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

    Groovy

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

    Kotlin

    buildscript {
    dependencies {
        // ...
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}
  2. Откройте файл build.gradle на уровне приложения и добавьте в элемент plugins указанный ниже код.

    Groovy

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

    Kotlin

    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

Чтобы инициализировать 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);

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

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

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

  • Чтобы использовать устройство Android, следуйте инструкциям о том, как запускать приложения на физических устройствах.
  • Чтобы воспользоваться эмулятором Android, создайте виртуальное устройство и установите эмулятор с помощью Менеджера AVD, который доступен в Android Studio.

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

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