使用 API 密钥

请选择平台： Android iOS JavaScript 网络服务

准备工作

在开始使用 Places SDK for Android 之前，请确保您的项目已关联结算账号并且 已启用 Places SDK for Android。如需了解详情，请参阅在 Cloud 控制台中进行设置。

创建 API 密钥

API 密钥是唯一标识符，用于对与您的项目相关联的请求进行身份验证，以便您使用相关产品和执行结算。您必须至少有一个与您项目相关联的 API 密钥。

如需创建 API 密钥，请执行以下操作：

控制台

  1. 前往 Google Maps Platform > 凭据页面。

    前往“凭据”页面

  2. 在凭据页面上，依次点击创建凭据 > API 密钥。
    已创建的 API 密钥对话框会显示您新创建的 API 密钥。
  3. 点击关闭。
    新的 API 密钥即会列在凭据页面的 API 密钥下。
    （在生产环境中使用 API 密钥之前，请务必对 API 密钥设置限制。）

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

详细了解 Google Cloud SDK、Cloud SDK 安装和以下命令：

限制 API 密钥

Google 强烈建议您限制 API 密钥，仅将其用于您的应用所需要的 API。限制 API 密钥可防止您的应用收到无正当理由的请求，从而提高应用安全性。如需了解详情，请参阅 API 安全性最佳实践。

当您限制 API 密钥时，必须提供用于为应用签名的签名密钥的 SHA-1 证书指纹。证书有两种：

  • 调试证书：此类证书只能用于要测试的应用和其他非生产代码。请勿尝试发布使用调试证书签名的应用。Android SDK 工具会在您运行调试 build 时自动生成此证书。
  • 发布证书：如果您已准备好将应用发布到应用商店，请使用此证书。Android SDK 工具会在您运行发布 build 时生成此证书。

如需详细了解 Android 应用签名和证书，请参阅为应用签名指南。

如需了解如何查找您的签名证书指纹，请查看以下参考文档：

如需限制 API 密钥，请执行以下操作：

控制台

  1. 前往 Google Maps Platform > 凭据页面。

    前往“凭据”页面

  2. 选择您要设置限制的 API 密钥。系统随即会显示 API 密钥属性页面。
  3. 在密钥限制下，设置以下限制：
    • 应用限制：
      1. 选择 Android 应用。
      2. 点击 + 添加软件包名称和指纹。
      3. 输入您的软件包名称和 SHA-1 证书指纹。例如： 
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • API 限制：
      1. 点击限制密钥。
      2. 选择 Places API 或 Places API（新） （但不能同时选择两者）。 如果 Places API 未列出，您需要 启用它。
  4. 点击保存以完成更改。

Cloud SDK

Places SDK for Android（新）

列出现有密钥。 

gcloud services api-keys list --project="PROJECT"

清除对现有密钥的现有限制。

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

为现有密钥设置新限制。 

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api-target="places.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

详细了解 Google Cloud SDK、Cloud SDK 安装和以下命令：

Places SDK for Android

列出现有密钥。 

gcloud services api-keys list --project="PROJECT"

清除对现有密钥的现有限制。

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

为现有密钥设置新限制。 

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api-target="places-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

详细了解 Google Cloud SDK、Cloud SDK 安装和以下命令：

后续步骤

现在您已经有了 API 密钥，请按照设置 Android Studio 项目中的说明创建和配置项目。