授權錯誤

在授權程序期間,Google OAuth 可能會傳回錯誤。請參閱這份指南,瞭解這個程序中常見的錯誤。

疑難排解

如要進一步瞭解 Google OAuth,請參閱「使用 OAuth 2.0 存取 Google API」。

更新權杖持續到期

用戶端 ID 未獲核准可能是其中一個原因,這會導致重新整理權杖在 7 天後停止運作。7 天權杖到期日與商業或沙箱核准無關。服務或使用者帳戶必須取得 OAuth 2.0 用戶端 ID 核准,並投入實際作業,才能延長權杖的有效期限。詳情請參閱「更新權杖到期日」。

存取遭拒

如果您已在 Google Cloud 中設定 OAuth 同意畫面,且使用者類型外部,當您嘗試將帳戶連結至未列為應用程式測試使用者的 Google 帳戶時,系統會顯示「存取權遭拒」錯誤訊息。請務必將 Google 帳戶新增至 OAuth 同意畫面的「測試使用者」部分。

合作夥伴連線管理工具 (PCM) 錯誤

如需存取 PCM 時發生錯誤的相關說明,請參閱 Partner Connections Manager (PCM) 錯誤參考資料

這個應用程式未經 Google 驗證

SDM API 使用受限範圍,也就是說,如果未完成 OAuth API 驗證,在授權期間使用這個範圍的應用程式都會是「未經驗證」。如果您將 Device Access 用於個人用途,則不需要進行 OAuth API 驗證。

在授權程序期間,您可能會看到「Google 尚未驗證此應用程式」畫面,這是在 Google Cloud 的 OAuth 同意畫面中未設定 sdm.service 範圍時才會顯示。如要略過這個畫面,請按一下「進階」選項,然後點選「前往 專案名稱 (不安全)」

詳情請參閱未驗證的應用程式畫面

用戶端無效

嘗試取得存取權或重新整理權杖時,如果您提供的 OAuth 2.0 用戶端密碼不正確,系統會顯示「無效的用戶端」錯誤。請確認您在存取和更新憑證呼叫中使用的 client_secret 值,與您在 Google Cloud 憑證頁面中使用的 OAuth 2.0 用戶端 ID 所對應的值相同。

要求無效,缺少必要範圍

在 PCM 中授予權限後,您可能會遇到「缺少必要參數:範圍」的「無效要求」錯誤。請確認您在授權呼叫中使用的 scope 值,與您在 Google Cloud 憑證頁面中為 OAuth 2.0 用戶端設定的值相同。

重新導向 URI 不符

授權時,您可能會遇到「Redirect uri mismatch」錯誤。請確認您在授權呼叫中使用的 redirect_uri 值,與您在 Google Cloud 憑證頁面中為 OAuth 2.0 用戶端設定的值相同。

快速參考

您可以參考這份參考資料,快速執行授權user 和連結 Google 帳戶的步驟。

如要使用這份快速參照資料,請將程式碼範例中的每個預留位置變數,修改為特定整合項目的值,並視需要複製及貼上:

1 PCM

將 user 導向應用程式中的 PCM 連結,取代:

  1. project-id 改成您的 Device Access Project ID
  2. oauth2-client-id 使用 Google Cloud 憑證中的 OAuth2 用戶端 ID
  3. redirect-uri,其中包含您使用的 OAuth2 用戶端 ID 的重新導向 URI
  4. scope 與其中一個可用範圍
https://nestservices.google.com/partnerconnections/project-id/auth?redirect_uri=redirect-uri&access_type=offline&prompt=consent&client_id=oauth2-client-id&response_type=code&scope=https://www.googleapis.com/auth/scope

2 驗證碼

為所選範圍透過 PCM 授予權限後, user 應會重新導向至指定的重新導向 URI。授權碼會以網址中的 code 參數格式傳回,格式如下:

redirect-uri?code=authorization-code&scope=https://www.googleapis.com/auth/scope

3 存取權杖

使用授權碼擷取存取權杖,以便代表使用者呼叫 SDM API。

向 Google 的 OAuth 端點發出 POST 呼叫,並取代:

  1. oauth2-client-idoauth2-client-secret 使用 Google Cloud 憑證中的 OAuth2 用戶端 ID 和用戶端密鑰
  2. authorization-code 與您在上一個步驟中收到的代碼
  3. redirect-uri,其中包含您使用的 OAuth2 用戶端 ID 的重新導向 URI

Google OAuth 會傳回兩個權杖:存取權杖和更新權杖。

要求

curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&code=authorization-code&grant_type=authorization_code&redirect_uri=redirect-uri'

回應

{
  "access_token": "access-token",
  "expires_in": 3599,
  "refresh_token": "refresh-token",
  "scope": "https://www.googleapis.com/auth/scope",
  "token_type": "Bearer"
}

4 API 呼叫

您必須使用 user的存取權杖發出 API 呼叫,授權程序才算完成。這個初始呼叫會完成授權程序,並啟用事件。

必須使用指定範圍中列出的其中一個 API 呼叫,才能完成授權程序。

sdm.service

裝置

詳情請參閱 devices.list API 參考資料。

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

5. 更新權杖

如 Google OAuth 所傳回的 expires_in 參數所述,SDM API 的存取權憑證僅有效 1 小時。如果存取權存取金鑰到期,請使用更新憑證取得新的存取權存取金鑰。

向 Google 的 OAuth 端點發出 POST 呼叫,並取代:

  1. oauth2-client-idoauth2-client-secret 使用 Google Cloud 憑證中的 OAuth2 用戶端 ID 和用戶端密鑰
  2. refresh-token 與您首次取得存取權杖時收到的代碼。

Google OAuth 會傳回新的存取權杖。

要求

curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&refresh_token=refresh-token&grant_type=refresh_token'

回應

{
  "access_token": "new-access-token",
  "expires_in": 3599,
  "scope": "https://www.googleapis.com/auth/scope",
  "token_type": "Bearer"
}