使用 OAuth 連結 Google 帳戶

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

在「暗示」流程中，Google 會在使用者的瀏覽器中開啟您的授權端點。成功登入後，會將長期存取憑證傳回 Google。目前從 Google 發出的每個要求都會包含這個存取憑證。

在「授權碼」流程中，您需要兩個端點：

• Authorization 端點，可為尚未登入的使用者顯示登入 UI。授權端點也會建立短期的授權碼來記錄使用者。同意要求的存取權。

• 憑證交換端點，該端點負責兩種交換類型：

  1. 將授權碼提供給長期使用憑證和短期存取憑證。當使用者完成帳戶連結流程時，系統就會執行這個交換作業。
  2. 針對短期存取權杖交換長期更新權杖。 如果 Google 需要這個存取憑證過期，因此需要進行這個交換作業。

選擇 OAuth 2.0 流程

雖然隱含流程比較簡單，但 Google 建議採用隱含流程所核發的存取憑證永遠不會過期。這是因為憑證在隱含流程到期後，必須強制重新連結帳戶。如果您需要基於安全考量而要求憑證過期，強烈建議您改用授權碼流程。

注意：請使用以下按鈕選擇您要實作的 OAuth 2.0 流程。如有需要，系統會重新載入這份指南的內容，使其符合您的選擇。

隱含流程 授權碼

設計指南

本節說明您針對 OAuth 連結流程託管的使用者畫面設計要求和建議。在 Google 應用程式呼叫 API 後，您的平台會向使用者顯示登入 Google 頁面和帳戶連結同意畫面。使用者同意連結帳戶之後，系統就會將他們重新導向 Google 的應用程式。

圖 1.連結 Google 帳戶和同意畫面的帳戶連結。

必要條件

1. 您必須通知使用者的帳戶將連結至 Google，而不是特定的 Google 產品，例如 Google Home 或 Google 助理。

建議

建議您採取下列做法：

1. 顯示 Google 的隱私權政策。在同意畫面中加入 Google 隱私權政策連結。

2. 要分享的資料。使用簡明扼要的用詞告訴使用者 Google 需要哪些資料，以及收集這些資料的原因。

3. 加入明確的行動號召。在同意畫面上註明明確的行動號召 (例如「同意和連結」)。這是因為使用者必須瞭解需要與 Google 分享哪些資料，才能連結自己的帳戶。

4. 取消功能：如果使用者選擇不要進行連結，可以提供取消或取消訂閱的方式。

5. 清除登入程序。確保使用者明確能登入 Google 帳戶，例如使用者名稱和密碼欄位或使用 Google 帳戶登入欄位。

6. 取消連結。提供機制，讓使用者能取消連結，例如 您平台中帳戶設定的網址。您也可以加入 Google 帳戶連結，方便使用者管理已連結帳戶。

7. 可變更使用者帳戶。建議使用者切換帳戶的方法。如果使用者經常擁有多個帳戶，這項功能就特別實用。

   • 如果使用者必須先關閉同意畫面才能切換帳戶，請將可復原的錯誤傳送給 Google，讓使用者可透過 OAuth 連結和隱含流程登入所需帳戶。

8. 加入您的標誌。在同意畫面中顯示公司標誌。 請善用樣式指南來放置標誌。如果您希望一併顯示 Google 的標誌，請參閱標誌和商標一文。

圖 2.使用者登入 Google 和同意畫面的設計指南。

建立專案

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

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

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 同意畫面」頁面。
2. 如果出現提示，請選取您剛建立的專案。

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

   Application name (應用程式名稱)：要求同意的應用程式名稱。名稱必須如實反映您的應用程式，並與使用者在其他地方看到的應用程式名稱一致。應用程式名稱會顯示在「帳戶連結同意」畫面中。

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

   支援電子郵件：方便使用者與您聯絡，詢問同意聲明問題。

   Google API 的範圍：「範圍」可讓應用程式存取使用者的私人 Google 資料。就 Google 帳戶連結的情況而言，預設範圍 (電子郵件、設定檔、openid) 就已足夠，您不需要新增任何敏感範圍。一般而言，最佳做法是逐步要求範圍，且在需要時而非預先存取權。瞭解詳情。

   授權網域：為了保護您和您的使用者，Google 僅允許透過 OAuth 進行驗證的應用程式使用授權網域。您的應用程式連結必須託管於授權網域。瞭解詳情。

   應用程式首頁連結：應用程式的首頁。必須由授權網域代管。

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

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

   

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

4. 查看「驗證狀態」。若您的申請需要驗證，請按一下「提交驗證申請」按鈕，提交驗證申請。詳情請參閱「OAuth 驗證規定」一文。

實作 OAuth 伺服器

授权码流的的OAuth 2.0服务器实现由两个端点，通过HTTPS，你的服务使可用的。第一个端点是授权端点，它负责查找或获得用户对数据访问的同意。授权端点向尚未登录的用户显示登录 UI，并记录对请求访问的同意。第二个端点是令牌交换端点，用于获取加密字符串，称为令牌，授权用户访问您的服务。

当 Google 应用程序需要调用您的服务的某个 API 时，Google 会结合使用这些端点来获得您的用户的许可，以代表他们调用这些 API。

Google发起的一次OAuth 2.0授权码流会话流程如下：

1. Google 在用户的浏览器中打开您的授权端点。如果流程在 Action 的纯语音设备上开始，Google 会将执行转移到手机。
2. 用户登录（如果尚未登录）并授予 Google 使用您的 API 访问其数据的权限（如果他们尚未授予权限）。
3. 您的服务创建一个授权码，并返回给谷歌。为此，请将用户的浏览器重定向回 Google，并将授权代码附加到请求中。
4. 谷歌发送授权代码，您的令牌交换终结，从而验证代码的真实性，并返回一个访问令牌和刷新令牌。访问令牌是一个短期令牌，您的服务接受它作为访问 API 的凭据。刷新令牌是一个长期存在的令牌，Google 可以存储它并在它们到期时使用它来获取新的访问令牌。
5. 用户完成帐户关联流程后，从 Google 发送的每个后续请求都包含一个访问令牌。

处理授权请求

当您需要使用 OAuth 2.0 授权代码流执行帐户关联时，Google 会将用户发送到您的授权端点，并发送一个包含以下参数的请求：

授权端点参数
client_id	您分配给 Google 的客户 ID。
redirect_uri	您向其发送对此请求的响应的 URL。
state	传递回 Google 的簿记值在重定向 URI 中保持不变。
scope	可选：以空格分隔的集合，其指定谷歌正在请求授权的数据范围的字符串。
response_type	要在响应中返回的值的类型。对于的OAuth 2.0授权码流，响应类型总是code 。
user_locale	在谷歌帐户语言设置RFC5646格式，用于本地化用户的首选语言内容。

例如，如果您的授权端点可在https://myservice.example.com/auth ，请求看起来像下面这样：

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

对于处理登录请求的授权端点，请执行以下步骤：

1. 验证client_id您分配给谷歌的客户ID匹配，并且该redirect_uri由谷歌为您服务提供的重定向URL匹配。这些检查对于防止授予对意外或配置错误的客户端应用程序的访问权限非常重要。如果你支持多种OAuth 2.0流程的，也确认response_type是code 。
2. 检查用户是否已登录您的服务。如果用户未登录，请完成服务的登录或注册流程。
3. 生成供 Google 用于访问您的 API 的授权代码。授权码可以是任何字符串值，但必须唯一代表用户、token所针对的客户端、授权码的过期时间，并且不能被猜到。您通常会发出大约 10 分钟后过期的授权代码。
4. 确认URL指定由redirect_uri参数有以下形式：

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

5. 重定向用户的浏览器由指定的URL redirect_uri参数。当你通过附加重定向包括刚刚生成授权码和原始未修正的状态值code和state参数。以下是所得的URL的一个示例：

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

处理令牌交换请求

您的服务的令牌交换端点负责两种令牌交换：

• 交换访问令牌和刷新令牌的授权代码
• 交换刷新令牌以获取访问令牌

令牌交换请求包括以下参数：

令牌交换端点参数
client_id	将请求源标识为 Google 的字符串。此字符串必须在您的系统中注册为 Google 的唯一标识符。
client_secret	您在 Google 上为您的服务注册的秘密字符串。
grant_type	被交换的代币类型。这是不是authorization_code或refresh_token 。
code	当grant_type=authorization_code ，这个参数是从您登录或令牌交换终结收到谷歌的代码。
redirect_uri	当grant_type=authorization_code ，该参数是在初始授权请求中使用的URL。
refresh_token	当grant_type=refresh_token ，这个参数是令牌从令牌交换终结收到谷歌的刷新。

交换访问令牌和刷新令牌的授权代码

在用户登录并且您的授权端点向 Google 返回一个短期授权代码后，Google 会向您的令牌交换端点发送请求，以交换访问令牌和刷新令牌的授权代码。

对于这些请求，价值grant_type是authorization_code ，和值code是您先前授予给谷歌授权码的值。以下是为访问令牌和刷新令牌交换授权代码的请求示例：

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

要为访问Exchange授权码令牌和刷新令牌，您的令牌交换终结响应POST通过执行以下步骤要求：

1. 验证该client_id识别为授权原点，并且所述请求源client_secret预期值相匹配。
2. 验证授权码是否有效且未过期，以及请求中指定的客户端 ID 是否与与授权码关联的客户端 ID 匹配。
3. 确认URL中指定由redirect_uri参数是相同的初始授权请求中使用的值。
4. 如果您无法验证所有的上述标准，则返回一个HTTP 400错误的请求错误与{"error": "invalid_grant"}作为身体。
5. 否则，使用授权代码中的用户 ID 生成刷新令牌和访问令牌。这些令牌可以是任何字符串值，但它们必须唯一地代表令牌所针对的用户和客户端，并且不能被猜测。对于访问令牌，还要记录令牌的到期时间，通常是您发出令牌后的一个小时。刷新令牌不会过期。
6. 返回以下JSON对象在HTTPS响应的主体：

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "refresh_token": "REFRESH_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }
   

Google 为用户存储访问令牌和刷新令牌，并记录访问令牌的到期时间。当访问令牌过期时，Google 使用刷新令牌从您的令牌交换端点获取新的访问令牌。

交换刷新令牌以获取访问令牌

当访问令牌过期时，Google 会向您的令牌交换端点发送请求，以将刷新令牌交换为新的访问令牌。

对于这些请求，价值grant_type被refresh_token ，和值refresh_token是令牌先前授予谷歌刷新的值。以下是将刷新令牌交换为访问令牌的请求示例：

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

要交换令牌的访问令牌刷新，您的令牌交换终结响应POST通过执行以下步骤要求：

1. 验证client_id标识请求起源谷歌，那client_secret预期值相符。
2. 验证刷新令牌是否有效，以及请求中指定的客户端 ID 是否与与刷新令牌关联的客户端 ID 匹配。
3. 如果您无法验证所有的上述标准，则返回一个HTTP 400错误的请求错误与{"error": "invalid_grant"}作为身体。
4. 否则，使用刷新令牌中的用户 ID 生成访问令牌。这些令牌可以是任何字符串值，但它们必须唯一地代表令牌所针对的用户和客户端，并且它们不能被猜测。对于访问令牌，还要记录令牌的到期时间，通常是在您发出令牌后的一个小时。
5. 在 HTTPS 响应的正文中返回以下 JSON 对象：

   {
   "token_type": "Bearer",
   "access_token": " ACCESS_TOKEN ",
   "expires_in": SECONDS_TO_EXPIRATION
   }

注意：您可以选择返回一个新的refresh_token在你的回应。有关返回时新的更多信息refresh_token是首选，看工作有令牌。

處理用戶信息請求

該用戶信息終端是一個OAuth 2.0保護的資源，對鏈接的用戶返回的權利要求。實現和託管 userinfo 端點是可選的，以下用例除外：

• 鏈接帳戶登錄與谷歌一個水龍頭。
• 無摩擦訂閱的AndroidTV。

從您的令牌端點成功檢索訪問令牌後，Google 會向您的 userinfo 端點發送請求，以檢索有關鏈接用戶的基本個人資料信息。

userinfo 端點請求標頭
Authorization header	Bearer 類型的訪問令牌。

例如，如果你的用戶信息終端可在https://myservice.example.com/userinfo ，請求看起來像下面這樣：

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

要讓您的 userinfo 端點處理請求，請執行以下步驟：

1. 從 Authorization 標頭中提取訪問令牌並返回與訪問令牌關聯的用戶的信息。
2. 如果訪問令牌無效，返回HTTP 401錯誤未經授權使用的WWW-Authenticate響應頭。下面是一個userinfo的錯誤響應的一個示例：

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

   如果一個401未經授權，或任何其它不成功錯誤響應在關聯過程返回時，誤差將是不可恢復的，所檢索的令牌將被丟棄，並且用戶將必須再次啟動鏈接過程。

3. 如果訪問令牌是有效的，回國與以下JSON對象在HTTPS響應的身體HTTP 200回應：

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

   如果你的用戶信息端點返回一個HTTP 200成功響應，檢索到的令牌和索賠登記針對用戶的谷歌帳戶。

   用戶信息端點響應
   sub	標識系統中用戶的唯一 ID。
   email	用戶的電子郵件地址。
   given_name	可選：用戶的名字。
   family_name	可選：用戶的姓氏。
   name	可選：用戶的全名。
   picture	可選：用戶的檔案圖片。

驗證實作

You can validate your implementation by using the OAuth 2.0 Playground tool.

In the tool, do the following steps:

1. Click Configuration to open the OAuth 2.0 Configuration window.
2. In the OAuth flow field, select Client-side.
3. In the OAuth Endpoints field, select Custom.
4. Specify your OAuth 2.0 endpoint and the client ID you assigned to Google in the corresponding fields.
5. In the Step 1 section, don't select any Google scopes. Instead, leave this field blank or type a scope valid for your server (or an arbitrary string if you don't use OAuth scopes). When you're done, click Authorize APIs.
6. In the Step 2 and Step 3 sections, go through the OAuth 2.0 flow and verify that each step works as intended.

You can validate your implementation by using the Google Account Linking Demo tool.

In the tool, do the following steps:

1. Click the Sign-in with Google button.
2. Choose the account you'd like to link.
3. Enter the service ID.
4. Optionally enter one or more scopes that you will request access for.
5. Click Start Demo.
6. When prompted, confirm that you may consent and deny the linking request.
7. Confirm that you are redirected to your platform.