設定 Geocoding API

歐洲經濟區 (EEA) 開發人員

本文說明開始使用 Geocoding API 的必要步驟。

確認你符合先決條件。

在 Google Cloud 專案中啟用 API。

設定 API 金鑰或 OAuth，發出經過驗證的 API 要求。

Google Maps Platform 產品要求 API 呼叫必須包含 API 金鑰或 OAuth 權杖，以防未經授權的使用行為。您可以選擇符合部署環境的設定程序。

建立 OAuth 權杖

Geocoding API 支援 OAuth 2.0 驗證。Google 支援常見的 OAuth 2.0 情境，例如網路伺服器情境。

本文說明如何在開發環境中，將 OAuth 權杖傳遞至 Geocoding API 呼叫。如要進一步瞭解如何在正式環境中使用 OAuth，請參閱「Google 的驗證方式」。

您可以向伺服器發出 API 要求，直接呼叫 Google 地圖 API，也可以使用用戶端程式庫簡化程式碼。Google 地圖提供適用於 Go、Java、Node.js 和 Python 的用戶端程式庫。詳情請參閱「Geocoding API 用戶端程式庫」。

OAuth 總覽

您可以透過 OAuth 建立及管理存取權杖，方法取決於部署環境。

您可以使用 OAuth 2.0，在應用程式和 Google 服務之間進行伺服器對伺服器的互動。在這種情況下，您會使用與應用程式相關聯的服務帳戶，而非個別使用者。您可以使用服務帳戶發出 API 要求，不必直接涉及使用者。如要進一步瞭解驗證方法，請參閱「Google 的驗證方式」。

或者，您也可以將 Geocoding API 整合至 Android 或 iOS 行動應用程式。如要進一步瞭解如何使用 OAuth，以及管理不同部署環境的存取權杖，請參閱「使用 OAuth 2.0 存取 Google API」。

OAuth 範圍

如要搭配 Geocoding API 使用 OAuth，請務必為 OAuth 權杖指派正確的範圍。Geocoding API 支援下列範圍：

  • https://www.googleapis.com/auth/maps-platform.geocode—適用於所有 Geocoding API 方法。
  • https://www.googleapis.com/auth/maps-platform.geocode.address：僅適用於正向地理編碼，且只能與 GeocodeAddress 搭配使用。
  • https://www.googleapis.com/auth/maps-platform.geocode.location：僅與 GeocodeLocation 搭配使用，用於反向地理編碼。
  • https://www.googleapis.com/auth/maps-platform.geocode.place：僅適用於地點地理編碼的 GeocodePlace。

您也可以為所有 Geocoding API 方法使用一般 https://www.googleapis.com/auth/cloud-platform 範圍。在開發期間，這個範圍很有用，因為使用 gcloud CLI 建立權杖時，這是預設範圍。

範例：在本地開發環境中嘗試 REST API 呼叫

如果您沒有產生權杖的環境，但想使用 OAuth 權杖試用 Geocoding API，請按照本節的程序操作。

本範例說明如何使用應用程式預設憑證 (ADC) 提供的 OAuth 權杖進行呼叫。如要進一步瞭解如何使用 ADC 透過用戶端程式庫呼叫 Google API，請參閱「使用用戶端程式庫進行驗證」。

下列 REST 程序僅供開發或測試，不適用於正式環境。

必要條件

使用 ADC 發出 REST 要求前，請先使用 gcloud CLI 將憑證提供給 ADC：

  1. 安裝並初始化 gcloud CLI。詳情請參閱「安裝 gcloud CLI」。

  2. 使用 gcloud CLI 進行驗證：

    gcloud auth application-default login

  3. 完成登入程序，將憑證儲存在 ADC 使用的本機憑證檔案中。

詳情請參閱「為本機開發環境設定 ADC」。

發出 REST 要求

在本例中，您會傳遞兩個要求標頭：

  • 使用下列指令產生權杖，並在 Authorization 標頭中傳遞 OAuth 權杖：

    gcloud auth application-default print-access-token

    傳回的權杖範圍為 https://www.googleapis.com/auth/cloud-platform。

  • 在 X-Goog-User-Project 標頭中，傳遞已啟用帳單的 Google Cloud 雲端專案 ID 或名稱。

如要使用 OAuth 權杖呼叫 Geocoding API，請完成下列步驟：

  1. 在下列程式碼範例中，將 PROJECT_ID 替換為您的 Google Cloud 專案 ID：

    curl -X GET -H 'Content-Type: application/json' \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://geocode.googleapis.com/v4/geocode/address/1600+Amphitheatre+Parkway,+Mountain+View,+CA"

  2. 如要複製 curl 指令，請按一下程式碼範例中的「複製」。

  3. 將指令貼到終端機視窗，然後執行。

疑難排解

如果要求傳回錯誤訊息，指出這個 API 不支援使用者憑證，請參閱「排解 ADC 設定問題」。