使用 API 金鑰

選取平台： Android iOS JavaScript 網路服務

事前準備

您的專案必須連結帳單帳戶並啟用 Places SDK for Android，才能開始使用 Places SDK for Android。請參閱這篇文章，進一步瞭解如何在 Cloud 控制台中進行設定。

建立 API 金鑰

API 金鑰是一組專屬 ID，用於驗證與您專案有關的使用權限及帳單處理請求。您的專案至少要有一個相關聯的 API 金鑰。

建立 API 金鑰的方法如下：

控制台

  1. 前往「Google 地圖平台」>「憑證」頁面。

    前往「憑證」頁面

  2. 在「憑證」頁面上，依序點選「建立憑證」>「API 金鑰」。
    「建立的 API 金鑰」對話方塊會顯示您新建立的 API 金鑰。
  3. 按一下「關閉」。
    新建立的 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 安全性最佳做法」。

當您限制 API 金鑰時，必須提供用於簽署應用程式的簽署金鑰 SHA-1 憑證指紋。憑證類型分為兩種：

  • 偵錯憑證：請僅將這種憑證類型用於您要測試的應用程式和其他不在實際生產環境使用的程式碼。請勿嘗試發布以偵錯憑證簽署的應用程式。執行偵錯版本時，Android SDK 工具會自動產生這個憑證。
  • 發布憑證：準備將應用程式發布到應用程式商店時，請使用這個憑證。執行發布子版本時，Android SDK 工具會產生這個憑證。

如要進一步瞭解數位憑證，請參閱「簽署應用程式」指南。

如要瞭解如何取得憑證指紋，請參閱「驗證用戶端」一文。如果您改為使用 Play 應用程式簽署功能，則必須前往 Play 管理中心的應用程式簽署頁面取得憑證指紋。

限制 API 金鑰的方法如下：

控制台

  1. 前往「Google 地圖平台」>「憑證」頁面。

    前往「憑證」頁面

  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. 從「選取 API」下拉式選單中選取 [Places API]。 如果畫面上未列出 Places API，則您必須啟用該 API。
  4. 如要完成變更，請按一下 [儲存]。

Cloud SDK

列出現有金鑰。 

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 金鑰以應用程式短版的數位憑證 (稱為「SHA-1 指紋」) 為基礎。如要顯示憑證的 SHA-1 指紋，請先確認您使用的憑證正確無誤。You may have two certificates:

  • 偵錯憑證：執行偵錯版本時，Android SDK 工具會自動產生這個憑證。請僅將這個憑證用於您正在測試的應用程式。 請勿嘗試發布以偵錯憑證簽署的應用程式。 如要進一步瞭解偵錯憑證，請參閱 Android 開發人員說明文件的登入偵錯模式。
  • 發布憑證：Android SDK 工具會在您執行發布子版本時產生這個憑證。您也可以使用 keytool 程式產生這個憑證。當您準備好要將應用程式發布上架時，請使用這個憑證。

使用 Gradle

Gradle 可讓您輕鬆取得應用程式的簽署資訊。只要執行 ./gradlew signingReport 即可。

畫面會顯示類似以下的輸出內容：

Task :app:signingReport

Variant: debug
Config: debug
Store: ~/.android/debug.keystore
Alias: AndroidDebugKey
MD5: 76:4E:BF:C3:59:DA:D3:8F:98:D6:3C:DB:87:A4:5B:E7
SHA1: 99:8E:73:B8:3A:A3:A3:C4:C1:D4:19:08:F6:7E:9E:F6:75:29:4C:B2
SHA-256: 6C:01:12:53:90:94:73:B5:66:D6:07:FF:A5:6F:AB:30:AE:99:20:55:0F:B3:12:22:4C:46:7E:02:3D:7E:6D:1D
Valid until: Friday, June 25, 2049
----------
Variant: release
Config: release
Store: app/keystore.jks
Alias: keystore
MD5: 1E:63:0F:14:67:E0:04:BD:98:4C:EB:2B:09:EF:7E:1E
SHA1: 2C:DF:9F:D1:A3:0D:1E:01:48:34:5D:91:52:0B:D8:8A:5A:07:45:C3
SHA-256: 12:66:CE:4B:90:FD:64:1A:4D:79:9E:78:AD:59:0C:21:D8:53:61:EE:2B:90:E4:67:CE:65:A0:76:04:13:23:89
Valid until: Tuesday, September 29, 2116

手動

請按照下列步驟，使用 keytool 程式搭配 -v 參數，即可顯示憑證的 SHA-1 指紋。如要進一步瞭解 Keytool，請參閱 Oracle 說明文件。

偵錯憑證

顯示偵錯憑證指紋

  1. 找出您的偵錯 KeyStore 檔案。檔案名稱為 debug.keystore，這是您第一次建立專案時建立的檔案。根據預設，檔案會儲存在與您的 Android 虛擬裝置 (AVD) 檔案相同的目錄中：

    • macOS 和 Linux：~/.android/
    • Windows Vista 和 Windows 7：C:\Users\your_user_name\.android\

  2. 列出 SHA-1 指紋：

    • 如果是 Linux 或 macOS，請開啟終端機視窗並輸入以下指令：

      keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android

    • 如果是 Windows Vista 或 Windows 7，請執行：

      keytool -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android

您應該會看到類似以下的輸出內容：

Alias name: androiddebugkey
Creation date: Jan 01, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4aa9b300
Valid from: Mon Jan 01 08:04:04 UTC 2013 until: Mon Jan 01 18:04:04 PST 2033
Certificate fingerprints:
     MD5:  AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6A:AC:F9
     SHA1: BB:0D:AC:74:D3:21:E1:43:07:71:9B:62:90:AF:A1:66:6E:44:5D:75
     Signature algorithm name: SHA1withRSA
     Version: 3

釋出憑證

顯示發布憑證指紋

  1. 找出您的發布憑證 KeyStore 檔案。發布 KeyStore 檔案並沒有預設名稱或位置。如果您在建構要發布的應用程式時未加以指定，版本會將您的 .apk 保持為未簽署狀態，而您必須先簽署才能發布應用程式。如使用發布憑證，您還需要別名和密碼，才能使用 KeyStore 和憑證。在 KeyStore 中輸入以下內容，即可列出所有金鑰的別名：

    keytool -list -keystore your_keystore_name

    以完整的 KeyStore 路徑和名稱 (包括 .keystore 副檔名) 取代 your_keystore_name。系統會提示您輸入 KeyStore 密碼，然後 keytool 就會顯示 KeyStore 中的所有別名。

  2. 輸入以下終端機或命令提示字元：

    keytool -list -v -keystore your_keystore_name -alias your_alias_name

    以完整的 KeyStore 路徑和名稱 (包括 .keystore 副檔名) 取代 your_keystore_name。以 your_alias_name 取代您在建立憑證時為其指定的別名。

您應該會看到類似以下的輸出內容：

Alias name: <alias_name>
Creation date: Feb 02, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4cc9b300
Valid from: Mon Feb 02 08:01:04 UTC 2013 until: Mon Feb 02 18:05:04 PST 2033
Certificate fingerprints:
    MD5:  AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6B:AC:F9
    SHA1: BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:90:AF:A1:66:6E:44:5D:75
    Signature algorithm name: SHA1withRSA
    Version: 3

開頭為 SHA1 的行包含憑證的 SHA-1 指紋。指紋為一系列 20 個雙位十六進位制數碼，以冒號分隔。

後續主題

取得 API 金鑰後，接下來請按照「設定 Android Studio 專案」一文中的說明來建立及設定專案。