使用 OAuth 連結 Google 帳戶

帳戶連結會使用業界標準的 OAuth 2.0 隱含和授權碼流程。您的服務必須支援符合 OAuth 2.0 標準的授權和權杖交換端點。

In the implicit flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from Google.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which presents the sign-in UI to your users that aren't already signed in. The authorization endpoint also creates a short-lived authorization code to record users' consent to the requested access.

• The token exchange endpoint, which is responsible for two types of exchanges:

  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Choose an OAuth 2.0 flow

Although the implicit flow is simpler to implement, Google recommends that access tokens issued by the implicit flow never expire. This is because the user is forced to link their account again after a token expires with the implicit flow. If you need token expiration for security reasons, we strongly recommend that you use the authorization code flow instead.

Note: Use the following buttons to choose which OAuth 2.0 flow you want to implement. If needed, the content of this guide will reload to match your choice.

Implicit flow Authorization code

Design guidelines

This section describes the design requirements and recommendations for the user screen that you host for OAuth linking flows. After it's called by Google's app, your platform displays a sign in to Google page and account linking consent screen to the user. The user is directed back to Google's app after giving their consent to link accounts.

Figure 1. Account linking user sign in to Google and consent screens.

Requirements

1. You must communicate that the user’s account will be linked to Google, not a specific Google product like Google Home or Google Assistant.

Recommendations

We recommend that you do the following:

1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

5. Clear sign-in process. Ensure that users have clear method for signing in to their Google account, such as fields for their username and password or Sign in with Google.

6. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

7. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

   • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking and the implicit flow.

8. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

Figure 2. Design guidelines for user sign in to Google and consent screens.

建立專案

注意： 您可以重複使用現有的專案，不必主要為了連結帳戶而建立新專案。

如要建立專案以使用帳戶連結，請按照下列步驟操作：

1. Go to the Google API Console.
2. 單擊創建項目 。
3. 輸入名稱或接受生成的建議。
4. 確認或編輯所有剩餘字段。
5. 點擊創建 。

要查看您的項目ID：

1. Go to the Google API Console.
2. 在登錄頁面的表格中找到您的項目。項目ID出現在ID列中。

設定 OAuth 同意畫面

Google 帳戶連結程序包含同意畫面，會向使用者說明應用程式要求存取其資料的目的、要求存取哪些資料，以及適用的條款。您必須先設定 OAuth 同意畫面，才能產生 Google API 用戶端 ID。

1. 開啟 Google API 控制台的「OAuth consent screen」頁面。
2. 如果出現提示，請選取您剛建立的專案。

3. 在「OAuth 同意畫面」頁面上填寫表單，然後按一下「儲存」按鈕。

   應用程式名稱：要求同意的應用程式名稱。名稱應準確反映您的應用程式，且與使用者在其他地方看到的應用程式名稱一致。應用程式名稱會顯示在帳戶連結同意畫面上。

   應用程式標誌：同意畫面上的圖片，協助使用者識別您的應用程式。標誌會顯示在帳戶連結同意畫面和帳戶設定上

   支援電子郵件：方便使用者與您聯絡，洽詢同意聲明相關事宜。

   Google API 的範圍：範圍可讓應用程式存取使用者的私人 Google 資料。對於 Google 帳戶連結用途，只要使用預設範圍 (電子郵件、個人資料、openid) 即可，不需要新增任何敏感範圍。一般而言，最佳做法是逐步要求範圍，只在需要存取權時逐步要求，而非事先要求範圍。瞭解詳情。

   授權網域：為保障您與使用者的安全，Google 只允許應用程式透過 OAuth 驗證使用授權網域。應用程式的連結必須託管在授權網域中。瞭解詳情。

   應用程式首頁連結：應用程式的首頁。必須託管在授權網域中。

   應用程式隱私權政策連結：會顯示在 Google 帳戶連結同意畫面中。必須在授權網域上代管。

   應用程式服務條款連結 (選用)：必須代管在授權網域上。

   

   圖 1. 虛構應用程式 Tunery 的 Google 帳戶連結同意聲明畫面

4. 檢查「驗證狀態」，如果應用程式需要驗證，請按一下「提交驗證」按鈕，提交應用程式進行驗證。詳情請參閱「OAuth 驗證規定」一文。

實作 OAuth 伺服器

如要支援 OAuth 2.0 隱含流程，服務會進行授權 並可透過 HTTPS 存取端點這個端點會負責驗證 徵得使用者同意，才能存取資料。授權端點 為使用者提供未登入並記錄登入的登入使用者介面 同意授予請求的存取權。

當 Google 應用程式需要呼叫服務的其中一個已授權 API 時， Google 會使用這個端點，向使用者取得呼叫這些 API 的權限 管理。

由 Google 發起的一般 OAuth 2.0 隱含流程工作階段，是 下列流程：

1. Google 會在使用者的瀏覽器中開啟授權端點。 使用者登入 (如果尚未登入)，並將權限授予 Google 透過您的 API 存取他們的資料 (如果尚未授予權限)。
2. 您的服務會建立存取權杖，並傳回給 Google。若要這麼做，請將使用者的瀏覽器重新導向回 Google，並授予存取權 附加至請求的權杖
3. Google 會呼叫服務的 API，並將存取權杖附加至 每個要求您的服務會確認存取權杖是否已授予 Google 授權存取 API，然後完成 API 呼叫。

處理授權要求

Google 應用程式需要透過 OAuth 2.0 進行帳戶連結時 隱含流程時，Google 會將使用者傳送至您的授權端點， ，其中包含下列參數：

授權端點參數
client_id	您指派給 Google 的用戶端 ID。
redirect_uri	您傳送回應到這項要求的網址。
state	傳回給 Google 的記帳金額，值維持不變 重新導向 URI
response_type	要在回應中傳回的值類型。以 OAuth 2.0 隱含 回應類型則一律為 token。
user_locale	中的 Google 帳戶語言設定 RFC5646 將內容翻譯成使用者慣用的語言。

舉例來說，如果您的授權端點位於 https://myservice.example.com/auth，要求可能如下所示：

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token&user_locale=LOCALE

如要讓授權端點處理登入要求，請按照下列步驟操作： 步驟：

1. 確認 client_id 和 redirect_uri 的值如下： 防止授予非預期或設定錯誤的用戶端應用程式存取權：

   • 確認 client_id 與您用戶端 ID 相符 而是指派給 Google
   • 確認 redirect_uri 指定的網址 參數的格式如下：

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
     https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
     

2. 檢查使用者是否已登入您的服務。如果使用者未簽署 的登入或申請流程。

3. 產生供 Google 存取 API 的存取權杖。 存取權杖可以是任何字串值，但必須明確代表 以及該權杖適用的用戶端，且不可猜測。

4. 傳送 HTTP 回應，將使用者的瀏覽器重新導向至網址 由 redirect_uri 參數指定。包含所有 網址片段中的下列參數：

   • access_token：您剛剛產生的存取權杖
   • token_type：字串 bearer
   • state：原始資料中未經修改的狀態值 要求

   以下是最終網址的範例：

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google 的 OAuth 2.0 重新導向處理常式收到存取權杖並確認 state 值未變更。Google 取得 服務存取權杖，Google 會將該權杖附加到後續的呼叫 以便將 API 新增至 Service API

处理 userinfo 请求

userinfo 端点是受 OAuth 2.0 保护的资源，会返回关联用户的声明。实现和托管 userinfo 端点是可选的，但以下用例除外：

• 使用 Google One Tap 登录关联的账号。
• Android TV 提供顺畅的订阅体验。

从您的令牌端点成功检索到访问令牌后，Google 会向您的 userinfo 端点发送请求，以检索关联用户的基本个人资料信息。

userinfo 端点请求标头
Authorization header	Bearer 类型的访问令牌。

例如，如果您的 userinfo 端点可通过 https://myservice.example.com/userinfo 时，请求可能如下所示：

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

为了让 userinfo 端点能够处理请求，请执行以下步骤：

1. 从 Authorization 标头中提取访问令牌，并返回与访问令牌相关联的用户的信息。
2. 如果访问令牌无效，则使用 WWW-Authenticate 响应标头返回 HTTP 401 Unauthorized 错误。下面是一个 userinfo 错误响应示例：

   HTTP/1.1 401 Unauthorized
   WWW-Authenticate: error="invalid_token",
   error_description="The Access Token expired"
   

   如果在关联过程中返回 401 未经授权错误或任何其他失败的错误响应，该错误将无法恢复，检索到的令牌将被舍弃，并且用户必须重新开始关联流程。

3. 如果访问令牌有效，则返回 HTTPS 正文中包含以下 JSON 对象的 HTTP 200 响应 回复：

   {
   "sub": "USER_UUID",
   "email": "EMAIL_ADDRESS",
   "given_name": "FIRST_NAME",
   "family_name": "LAST_NAME",
   "name": "FULL_NAME",
   "picture": "PROFILE_PICTURE",
   }
   

   如果您的 userinfo 端点返回 HTTP 200 成功响应，则系统会针对用户的 Google 账号注册检索到的令牌和声明。

   userinfo 端点响应
   sub	系统中用于识别用户的唯一 ID。
   email	用户的电子邮件地址。
   given_name	可选：用户的名字。
   family_name	可选：用户的姓氏。
   name	可选：用户的全名。
   picture	可选：用户的个人资料照片。

驗證實作

您可以使用 OAuth 2.0 Playground 工具驗證實作結果。

請在工具中按照下列步驟操作：

1. 點選「Configuration」圖示 ，開啟 OAuth 2.0 設定視窗。
2. 在「OAuth 流程」欄位中，選取「用戶端」。
3. 在「OAuth 端點」欄位中，選取「自訂」。
4. 在對應的欄位中指定 OAuth 2.0 端點，以及您指派給 Google 的用戶端 ID。
5. 在「步驟 1」部分中，請勿選取任何 Google 範圍。請改為將這個欄位留空，或輸入有效的伺服器範圍 (如果您不使用 OAuth 範圍，則輸入任意字串)。完成後，按一下「授權 API」。
6. 在「步驟 2」和「步驟 3」部分，請完成 OAuth 2.0 流程，並確認每個步驟都能正常運作。

您可以使用 Google 帳戶連結示範工具驗證實作成果。

在工具中執行下列步驟：

1. 按一下「使用 Google 帳戶登入」按鈕。
2. 選擇要連結的帳戶。
3. 輸入服務 ID。
4. 您可以選擇輸入一或多個要申請存取權的範圍。
5. 按一下「開始試用」。
6. 系統顯示提示時，請確認您可以同意或拒絕連結要求。
7. 確認系統是否會將你重新導向至平台。