設定及使用 OAuth

所有 Local Services API 呼叫都必須透過 OAuth 2.0 授權。這可以讓 Local Services API 用戶端應用程式存取使用者的在地生活服務服務帳戶，而不必處理或儲存使用者的登入資訊。

Local Services API 使用 OAuth 2.0 通訊協定來驗證使用者。如要進一步瞭解 OAuth 2.0，請參閱使用 OAuth 2.0 存取 Google API。

為 Local Services API 設定 Google API 控制台專案

如要驗證及授權 Google Ads 使用者，您必須擁有憑證才能存取 Google 的 OAuth 2.0 伺服器。這些憑證可供 Google 識別您的應用程式，並讓您產生 OAuth 憑證來管理 Google Ads 使用者。使用 Google API 控制台，管理您的 Google OAuth 2.0 憑證。

如要接收這些憑證，請按照下列步驟操作：

  1. 建立專案。方法是前往 Google API 控制台。按一下「Create project」(建立專案)，輸入名稱，然後按一下「Create」(建立)。

  2. 在專案中啟用 Local Services API：

    1. 在 Google API 控制台中開啟 API 程式庫。如果出現系統提示，請選取您的專案或建立新專案。API 程式庫會列出所有可用的 API，並按產品系列和熱門程度分組。

      如果清單中未顯示 Local Services API，請使用搜尋框來找出。

    2. 選取 Local Services API，然後按一下「啟用」。

  3. 選擇應用程式類型。Local Services API 使用的應用程式類型與 Google Ads API 相同。如要進一步瞭解要使用的應用程式類型，請參閱選擇應用程式類型。

  4. 建立用戶端 ID 和用戶端密鑰。針對 Local Services API，請按照相同步驟建立用於 Google Ads API 的用戶端 ID 和用戶端密鑰。這兩種用途的步驟都相同。

透過用戶端程式庫取得 OAuth 2.0 權杖

如需可用於提出 OAuth 2.0 授權要求的用戶端程式庫清單，請參閱用戶端程式庫。請參閱程式庫專屬操作說明，瞭解如何使用重新整理權杖取得新的存取權杖。

如何取得 OAuth 2.0 更新權杖

建議您在實際工作環境中使用用戶端程式庫來驗證使用者。如果您要將 HTTP 用戶端用於測試目的，請按照下列操作說明取得 OAuth 2.0 更新權杖與存取權杖。步驟 1、2 和 3 是一次性設定操作說明，您必須手動執行。在此之後，步驟 4 和 5 可以自動執行，而不必操作人工作業，例如 Cron 工作。

  1. 下載並安裝 curl，這是用於提出 HTTP 網路要求的指令列工具。

  2. 按照「OAuth Playground」頁面的操作說明取得 OAuth 2.0 更新權杖。請為 Local Services API 使用下列範圍：

    https://www.googleapis.com/auth/adwords

    這與 Google Ads API 使用的 OAuth 2.0 範圍相同。

    這個步驟結束時，您會收到兩個權杖，分別是更新權杖和存取權杖。同時儲存兩者。

  3. 在命令提示字元中執行下列指令，驗證前一個步驟是否成功：

    curl https://oauth2.googleapis.com/tokeninfo?access_token=<INSERT_ACCESS_TOKEN>

    如果指令輸出內容顯示瞭如下的訊息：成功：

    {
  "azp": "************-********************************.apps.googleusercontent.com",
  "aud": "************-********************************.apps.googleusercontent.com",
  "scope": "https://www.googleapis.com/auth/adwords [googleapis.com]",
  "exp": "1611183382",
  "expires_in": "3482",
  "access_type": "offline"
}

    如果發生錯誤或範圍有誤，請嘗試再次產生符記。

  4. 不必手動介入，即可產生新的存取權杖。由於存取權杖每小時會過期，因此非常重要。更新權杖的有效期限較長，因此您需要在不再需要時手動撤銷權杖。

    如要取得新的存取權杖，請執行下列指令：

    curl --data "refresh_token=<INSERT_REFRESH_TOKEN>&client_id=<INSERT_CLIENT_ID>&client_secret=<INSERT_CLIENT_SECRET>&grant_type=refresh_token" -X POST "https://oauth2.googleapis.com/token”

  5. 執行下列 API 呼叫：

    curl -H "Authorization: Bearer <INSERT_ACCESS_TOKEN>" https://localservices.googleapis.com/v1/accountReports:search?query=manager_customer_id:<INSERT_10_DIGIT_MANAGER_CUSTOMER_ID_WITHOUT_HYPHENS>

    如果呼叫成功，設定就大功告成。