為 Android 應用程式設定 OAuth

Home API 使用 OAuth 2.0 授予住家裝置的存取權。OAuth 可讓使用者授權應用程式或服務,而不必公開登入憑證。

如果您已有經過驗證的 OAuth 用戶端 (例如來自已發布的應用程式),可以使用該用戶端測試 Home API,不必設定新的用戶端。詳情請參閱「如果您已有 OAuth 用戶端」。

簽署應用程式

首先,在 Android Studio 中執行應用程式,產生偵錯憑證。在 Android Studio 中執行或偵錯應用程式時,系統會自動產生用於開發和偵錯的偵錯憑證。如需完整說明,請參閱「Android Studio:簽署偵錯版本」。

應用程式執行後:

  1. 將行動裝置連接到本機電腦。 Android Studio 會依型號列出您的連結裝置。從清單中選取裝置,然後按一下「Run project」。這樣就會在行動裝置上建構及安裝範例應用程式。

    如需詳細操作說明,請參閱 Android 開發人員網站上的「在硬體裝置上執行應用程式」一文。

  2. 停止執行中的應用程式。

  3. 請按照 Google Cloud 控制台說明網站上的「設定 OAuth 2.0 / 原生應用程式 / Android」一文中的詳細操作說明,取得偵錯憑證的 SHA-1 指紋。

  1. 在 Google Cloud 控制台中,前往專案選取器資訊主頁,選取要用來建立 OAuth 憑證的專案。
  2. 前往「APIs and Services」(API 和服務) 頁面,然後按一下導覽選單中的「Credentials」(憑證)。
  3. 如果您尚未設定這項 Google Cloud 專案的同意畫面,系統會顯示「Configure consent screen」(設定同意畫面) 按鈕。在這種情況下,請按照下列程序設定同意畫面。否則,請繼續閱讀下一節。

    1. 按一下「設定同意畫面」。系統會顯示「OAuth consent screen」(OAuth 同意畫面) 頁面。
    2. 視用途選取「Internal」(內部) 或「External」(外部),然後按一下「Create」(建立)。系統會顯示「OAuth 同意畫面」窗格。
    3. 按照畫面上的指示,在「App information」(應用程式資訊) 頁面輸入資訊,然後按一下「Save and continue」(儲存並繼續)。系統會隨即顯示「Scopes」窗格。
    4. 您不需要新增任何範圍,因此請按一下「儲存並繼續」。系統會顯示「Test users」(測試使用者) 窗格。
    5. 依序點選「目標對象」和「+ 新增使用者」按鈕。
    6. 輸入測試使用者的電子郵件地址,然後按一下「儲存」按鈕。
    7. 按一下「儲存並繼續」。系統隨即會顯示「Summary」(摘要) 窗格。
    8. 查看 OAuth 同意畫面資訊,然後按一下「Back to dashboard」(返回資訊主頁)。

如需完整詳細資料,請參閱 Google Cloud 控制台說明網站上的「設定 OAuth 同意畫面」。

註冊應用程式並建立憑證

如要為 OAuth 2.0 註冊應用程式並建立 OAuth 憑證,請按照「設定 OAuth 2.0」中的操作說明進行。您需要指出應用程式類型,也就是原生/Android 應用程式。

請按照 Google Cloud 控制台說明網站上的「設定 OAuth 2.0 / 原生應用程式」一文操作,將簽署應用程式時取得的 SHA-1 指紋,新增至您在 Google Cloud 控制台設定的 OAuth 用戶端。

將行動裝置連線至本機電腦,從清單中選取裝置,然後再次點選「Run project」執行專案。如需詳細操作說明,請參閱 Android 開發人員網站上的「在硬體裝置上執行應用程式」一文。

如果您已有 OAuth 用戶端

如果您已為發布的應用程式建立經過驗證的 OAuth 用戶端,可以使用現有的 OAuth 用戶端測試 Home API。

測試及使用 Home API 時,不需註冊 Google Home Developer Console。不過,即使您已透過其他整合方式取得經過驗證的 OAuth 用戶端,仍須完成 Developer Console 註冊並通過核准,才能發布應用程式。

請注意以下事項:

  • 使用現有 OAuth 用戶端時,使用者人數上限為 100 人。如要瞭解如何新增測試使用者,請參閱「設定 OAuth 同意畫面。 除了 OAuth 驗證外,Home API 還規定最多只能有 100 位使用者可授予應用程式權限。完成 Developer Console 註冊後,這項限制就會解除。

  • Developer Console 註冊 應在您準備好透過 OAuth 限制裝置類型授權,以便使用 Home API 更新應用程式時,提交審查。

對於仍在等待 OAuth 驗證的Google Cloud應用程式,使用者必須等到驗證完成後,才能完成 OAuth 流程。嘗試授予權限時,會發生下列錯誤:

Access blocked: <Project Name> has not completed the Google verification process.