此页面由 Cloud Translation API 翻译。

设置 Android Studio 项目
使用集合让一切井井有条根据您的偏好保存内容并对其进行分类。

如需将应用配置为使用 Places SDK for Android，请按以下步骤操作。所有使用 Places SDK for Android 的应用都必须遵循这些要求。

第 1 步：设置 Android Studio

本文档介绍的是使用 Android Studio Hedgehog 和 Android Gradle 插件 8.2 版的开发环境。

第 2 步：设置 SDK

您可以通过 Google 的 Maven 制品库获取 Places SDK for Android 库。要将 SDK 添加到您的应用中，请执行以下操作：

在顶级 settings.gradle.kts 文件的 pluginManagement 代码块下，添加 Gradle 插件门户、Google 的 Maven 制品库和 Maven 中央存储库。pluginManagement 代码块必须位于脚本中的任何其他语句之前。
```
pluginManagement {
    repositories {
        gradlePluginPortal()
        google()
        mavenCentral()
    }
} 
```

在顶级 settings.gradle.kts 文件的 dependencyResolutionManagement 代码块下，添加 Google 的 Maven 代码库和 Maven 中央代码库：

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

在模块级 build.gradle.kts 文件的 dependencies 部分中，向 Maps SDK for Android 添加依赖项：

注意：Android 版 Google 地图 SDK 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:4.1.0")
}

在模块级 build.gradle.kts 文件中，将 compileSdk 和 minSdk 设置为以下值：

注意：务必将 compileSdk 设置为 34 或更高版本，并将 minSdk 设置为 23 或更高版本。

Groovy

android {
    compileSdk 34

    defaultConfig {
        minSdk 23
        // ...
    }
}

Kotlin

android {
    compileSdk = 34

    defaultConfig {
        minSdk = 23
        // ...
    }
}

在模块级 build.gradle 文件的 buildFeatures 部分中，添加 BuildConfig 类；您可以使用该类访问此过程中稍后定义的元数据值：

Groovy

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

Kotlin

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

第 3 步：将您的 API 密钥添加到项目中

本部分介绍了如何存储 API 密钥，以便您的应用可以安全引用该密钥。您不应将 API 密钥签入版本控制系统，建议将其存储在项目根目录下的 secrets.properties 文件中。如需详细了解 secrets.properties 文件，请参阅 Gradle 属性文件。

为了简化此任务，建议您使用 Android 版 Secret Gradle 插件。

如需在 Google 地图项目中安装 Android 版 Secret Gradle 插件，请执行以下操作：

在 Android Studio 中，打开顶级 build.gradle.kts 或 build.gradle 文件，并将以下代码添加到 buildscript 下的 dependencies 元素中。

Kotlin

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

Groovy

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

打开模块级 build.gradle.kts 或 build.gradle 文件，并将以下代码添加到 plugins 元素中。

Kotlin

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

Groovy

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

在模块级 build.gradle.kts 或 build.gradle 文件中，请务必将 targetSdk 和 compileSdk 设置为 34。
将项目与 Gradle 同步。
在顶级目录中打开 secrets.properties 文件，然后添加以下代码。将 YOUR_API_KEY 替换为您的 API 密钥。secrets.properties 不会签入版本控制系统，因此请将您的密钥存储在此文件中。
注意： 如果 secrets.properties 文件不存在，请在 local.properties 文件所在的文件夹中创建该文件。
```
PLACES_API_KEY=YOUR_API_KEY
```
在顶级目录（即 secrets.properties 文件所在的文件夹）中创建 local.defaults.properties 文件，然后添加以下代码。

注意：请按下方所示输入代码。不要将 DEFAULT_API_KEY 替换为您的 API 密钥。
```
PLACES_API_KEY=DEFAULT_API_KEY
```
此文件的作用是为 API 密钥提供备用位置，以免在找不到 secrets.properties 文件的情况下构建失败。如果您是从省略 secrets.properties 的版本控制系统中克隆应用，而您还没有在本地创建 secrets.properties 文件来提供 API 密钥，就可能会出现构建失败。

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

Groovy

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 步：初始化 Places API 客户端

在 activity 或 fragment 中初始化 Places SDK for Android。您必须先决定要使用哪个版本的 SDK：Places SDK for Android 或 Places SDK for Android（新版）。如需详细了解产品版本，请参阅选择 SDK 版本。

以下示例展示了如何为这两个版本初始化 SDK。

Places SDK for Android（新版）

在调用 Places.initializeWithNewPlacesApiEnabled() 时传递 API 密钥：

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 for Android

在调用 Places.initialize() 时传递 API 密钥：

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.initialize(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.initialize(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);

现在，您可以开始使用 Places SDK for Android 了！

第 5 步：设置 Android 设备

如要运行使用 Places SDK for Android 的应用，您必须将其部署到搭载 Android 5.0 或更高版本且包含 Google API 的 Android 设备或 Android 模拟器。

如要使用 Android 设备，请按照在硬件设备上运行应用一文中的说明操作。
如要使用 Android 模拟器，您可以使用 Android Studio 随附的 Android 虚拟设备 (AVD) 管理器来创建虚拟设备并安装模拟器。
注意：如果您选择使用 Android 模拟器，请务必选择带有 Play 图标 （显示在 Play Store 列下方）的设备。此图标表明相应设备的配置完全符合 CTS 规范，并且可以使用包含 Play 商店应用的系统映像：

后续步骤

配置完项目后，您可以探索示例应用。

设置 Android Studio 项目 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

第 1 步：设置 Android Studio

第 2 步：设置 SDK

Groovy

Kotlin

Groovy

Kotlin

Groovy

Kotlin

第 3 步：将您的 API 密钥添加到项目中

Kotlin

Groovy

Kotlin

Groovy

Kotlin

Groovy

第 4 步：初始化 Places API 客户端

Places SDK for Android（新版）

Kotlin

Java

Places SDK for Android

Kotlin

Java

第 5 步：设置 Android 设备

后续步骤

设置 Android Studio 项目
使用集合让一切井井有条根据您的偏好保存内容并对其进行分类。