迁移到 Google Identity 服务

概览

为了获取用于调用 Google API 的每位用户访问令牌，Google 提供了多个 JavaScript 库：

本指南介绍了如何从这些库迁移到 Google Identity Services 库。

按照本指南中的说明操作，您将：

  • 将已废弃的平台库替换为 Identity 服务库，
  • 如果使用 API 客户端库，请移除已废弃的 gapi.auth2 模块及其方法和对象，并将其替换为 Identity Services 等效项。

如需了解 Identity Services JavaScript 库的变化，请参阅概览和用户授权的工作原理，查看关键术语和概念。

如果您要为用户注册和登录进行身份验证，请改为参阅从 Google 登录迁移。

确定授权流程

用户授权流程有两种：隐式授权和授权代码。

检查您的 Web 应用，确定当前使用的授权流程类型。

表明您的网络应用使用的是隐式流程的迹象：

表明您的 Web 应用使用的是授权代码流程的迹象：

在某些情况下，您的代码库可能同时支持这两个流程。

选择授权流程

在开始迁移之前，您需要确定继续使用现有流程还是采用其他流程最符合您的需求。

查看选择授权流程，了解这两个流程之间的主要区别和权衡。

在大多数情况下，建议使用授权代码流程，因为它可以提供最高级别的用户安全性。通过实现此流程，您的平台还可以更轻松地添加新的离线功能，例如提取更新以通知用户其日历、照片、订阅等发生的重大变化。

使用以下选择器选择授权流程。

隐式流

在用户在场时获取访问令牌以在浏览器中使用。

隐式流程示例展示了迁移到身份服务前后的 Web 应用。

授权代码流程

Google 为每位用户发出的授权代码会传送到您的后端平台，然后在该平台上交换为访问令牌和刷新令牌。

授权代码流程示例展示了迁移到 Identity Services 前后的 Web 应用。

在本指南中，请按照粗体列出的说明添加、移除、更新或替换现有功能。

更改浏览器内 Web 应用

本部分将介绍在迁移到 Google Identity 服务 JavaScript 库时，您需要对浏览器内 Web 应用进行的更改。

确定受影响的代码并进行测试

调试 Cookie 有助于查找受影响的代码并测试废弃后的行为。

在大型或复杂的应用中，可能很难找到受 gapi.auth2 模块废弃影响的所有代码。如需将即将弃用的功能的现有使用情况记录到控制台，请将 G_AUTH2_MIGRATION Cookie 的值设置为 informational。（可选）添加一个英文冒号后跟键值，以便同时记录到会话存储空间。登录并收到凭据后，检查或将收集的日志发送到后端以供日后分析。例如，informational:showauth2use 会将来源和网址保存到名为 showauth2use 的会话存储键。

如需在 gapi.auth2 模块不再加载时验证应用行为，请将 G_AUTH2_MIGRATION Cookie 的值设置为 enforced。这样，您便可以在强制执行日期之前测试弃用后的行为。

可能的 G_AUTH2_MIGRATION Cookie 值：

  • enforced 不加载 gapi.auth2 模块。
  • informational 将已废弃功能的使用情况记录到 JS 控制台。此外，在设置可选的键名称时，还会记录到会话存储空间：informational:key-name。

为了最大限度地降低对用户的影响，建议您在开发和测试期间先在本地设置此 Cookie，然后再在生产环境中使用。

库和模块

gapi.auth2 模块用于管理登录的用户身份验证和授权的隐式流程，请将此已废弃的模块及其对象和方法替换为 Google Identity 服务库。

将 Identity Services 库添加到您的网页应用，方法是将其添加到文档中：

<script src="https://accounts.google.com/gsi/client" async defer></script>

移除使用 gapi.load('auth2', function) 加载 auth2 模块的所有实例。

Google Identity 服务库取代了 gapi.auth2 模块的使用。您可以放心地继续使用适用于 JavaScript 的 Google API 客户端库中的 gapi.client 模块，并利用该模块从发现文档自动创建 Callable JS 方法、批量处理多个 API 调用和 CORS 管理功能。

Cookie

用户授权不要求使用 Cookie。

如需详细了解用户身份验证如何使用 Cookie，请参阅从 Google 登录迁移；如需详细了解其他 Google 产品和服务如何使用 Cookie，请参阅 Google 如何使用 Cookie。

凭据

Google Identity 服务将用户身份验证和授权分为两项不同的操作，并且用户凭据是分开的：用于标识用户的 ID 令牌与用于授权的访问令牌是分开返回的。

如需查看这些更改，请参阅示例凭据。

隐式流

从授权流程中移除用户个人资料处理，从而将用户身份验证与授权分开。

移除以下 Google 登录 JavaScript 客户端参考：

方法

  • GoogleUser.getBasicProfile()
  • GoogleUser.getId()

授权代码流程

Identity Services 会将浏览器内凭据分为 ID 令牌和访问令牌。此变更不适用于通过从后端平台直接调用 Google OAuth 2.0 端点或通过在平台上安全服务器上运行的库（例如 Google API Node.js 客户端）获取的凭据。

会话状态

以前，Google 登录可帮助您使用以下方式管理用户的登录状态：

您负责管理 Web 应用的登录状态和用户会话。

移除以下 Google 登录 JavaScript 客户端引用：

对象：

  • gapi.auth2.SignInOptions

方法：

  • GoogleAuth.attachClickHandler()
  • GoogleAuth.isSignedIn()
  • GoogleAuth.isSignedIn.get()
  • GoogleAuth.isSignedIn.listen()
  • GoogleAuth.signIn()
  • GoogleAuth.signOut()
  • GoogleAuth.currentUser.get()
  • GoogleAuth.currentUser.listen()
  • GoogleUser.isSignedIn()

客户端配置

更新您的 Web 应用，以针对隐式或授权代码流程初始化令牌客户端。

移除以下 Google 登录 JavaScript 客户端参考：

对象：

  • gapi.auth2.ClientConfig
  • gapi.auth2.OfflineAccessOptions

方法：

  • gapi.auth2.getAuthInstance()

  • GoogleUser.grant()

隐式流

按照初始化令牌客户端中的示例添加 TokenClientConfig 对象和 initTokenClient() 调用，以配置您的 Web 应用。

将 Google 登录 JavaScript 客户端参考替换为 Google Identity 服务：

对象：

  • gapi.auth2.AuthorizeConfig 与 TokenClientConfig 合作

方法：

  • gapi.auth2.init() 与 google.accounts.oauth2.initTokenClient() 合作

参数：

  • gapi.auth2.AuthorizeConfig.login_hint 替换为 TokenClientConfig.login_hint。
  • 使用 TokenClientConfig.hd 调用 gapi.auth2.GoogleUser.getHostedDomain()。

授权代码流程

按照初始化代码客户端中的示例添加 CodeClientConfig 对象和 initCodeClient() 调用，以配置您的 Web 应用。

从隐式授权流程切换到授权代码流程时：

移除 Google 登录 JavaScript 客户端引用

对象：

  • gapi.auth2.AuthorizeConfig

方法：

  • gapi.auth2.init()

参数：

  • gapi.auth2.AuthorizeConfig.login_hint
  • gapi.auth2.GoogleUser.getHostedDomain()

令牌请求

用户手势（例如按钮点击）会生成一个请求，该请求会导致访问令牌通过隐式流程直接返回到用户的浏览器，或者在将每位用户的授权代码换成访问令牌和刷新令牌后返回到您的后端平台。

隐式流

在用户已登录并与 Google 建立有效会话时，可以获取访问令牌并在浏览器中使用。对于隐式模式，即使之前已有请求，也需要用户手势来请求访问令牌。

将 Google 登录 JavaScript 客户端参考替换为 Google Identity 服务：

方法：

  • gapi.auth2.authorize() 与 TokenClient.requestAccessToken() 合作
  • GoogleUser.reloadAuthResponse() 与 TokenClient.requestAccessToken()

添加链接或按钮以调用 requestAccessToken()，以启动弹出式界面用户体验流程来请求访问令牌，或在现有令牌过期时获取新令牌。

更新代码库以便：

  • 使用 requestAccessToken() 触发 OAuth 2.0 令牌流程。
  • 使用 requestAccessToken 和 OverridableTokenClientConfig 将针对多个镜区的单个请求拆分为多个较小的请求，以支持增量授权。
  • 在现有令牌过期或被撤消时请求新的令牌。

若要使用多个镜重，您可能需要对代码库进行结构性更改，以便仅在需要时请求对镜重的访问权限，而不是一次性请求所有镜重，这称为增量授权。每个请求应包含尽可能少的镜重，最好只包含一个镜重。如需详细了解如何更新应用以实现增量授权，请参阅如何处理用户意见征求。

当访问令牌过期时，gapi.auth2 模块会自动为您的 Web 应用获取新的有效访问令牌。为提高用户安全性，Google Identity 服务库不支持此自动令牌刷新流程。您必须更新 Web 应用，才能检测到已过期的访问令牌并请求新的访问令牌。如需了解详情，请参阅下面的令牌处理部分。

授权代码流程

添加链接或按钮，以调用 requestCode() 来请求 Google 提供授权码。如需查看示例，请参阅触发 OAuth 2.0 代码流程。

如需详细了解如何响应过期或撤消的访问令牌，请参阅下面的“令牌处理”部分。

令牌处理

添加了错误处理功能，以便在使用已过期或已撤消的访问令牌时检测失败的 Google API 调用，并请求新的有效访问令牌。

使用已过期或已撤消的访问令牌时，Google API 会返回 HTTP 状态代码 401 Unauthorized 和 invalid_token 错误消息。如需查看示例，请参阅无效令牌响应。

令牌过期

访问令牌的有效期很短，通常只有几分钟。

令牌撤消

Google 账号所有者可以随时撤消之前授予的同意。这样做会使现有访问令牌和刷新令牌失效。撤消可通过您的平台使用 revoke() 或通过 Google 账号触发。

将 Google 登录 JavaScript 客户端引用替换为 Google Identity Services：

方法：

  • getAuthInstance().disconnect() 与 google.accounts.oauth2.revoke() 合作
  • GoogleUser.disconnect() 与 google.accounts.oauth2.revoke() 合作

当用户删除其在您平台上的账号，或希望撤消与您的应用共享数据的同意时，请调用 revoke。

当您的 Web 应用或后端平台请求访问令牌时，Google 会向用户显示意见征求对话框。查看 Google 向用户显示的意见征求对话框示例。

在向您的应用颁发访问令牌之前，系统需要先有一个现有且有效的 Google 会话来提示用户同意并记录结果。如果尚未建立现有会话，系统可能会要求用户登录 Google 账号。

用户登录

用户可以在单独的浏览器标签页中登录 Google 账号，也可以通过浏览器或操作系统原生登录。我们建议您在网站上添加使用 Google 账号登录，以便在用户首次打开您的应用时在 Google 账号和浏览器之间建立有效会话。这样做有以下好处：

  • 最大限度地减少用户必须登录的次数，如果当前尚不存在活跃会话，请求访问令牌将启动 Google 账号登录流程。
  • 直接将 JWT ID 令牌凭据 email 字段用作 CodeClientConfig 或 TokenClientConfig 对象中的 login_hint 参数的值。如果您的平台不维护用户账号管理系统，此功能会特别有用。
  • 查找 Google 账号并将其与您平台上现有的本地用户账号相关联，有助于最大限度地减少平台上重复的账号。
  • 创建新的本地账号时，注册对话框和注册流程可以与用户身份验证对话框和流程明确区分开来，从而减少所需的步骤数量并提高访问者流失率。

在登录后，在系统发出访问令牌之前，用户必须同意您的应用使用请求的范围。

同意后，系统会返回一个访问令牌，以及用户批准或拒绝的范围列表。

借助精细权限，用户可以批准或拒绝各个范围。请求访问多个镜重时，系统会独立授予或拒绝每个镜重。您的应用可根据用户的选择，选择启用依赖于各个作用域的功能。

隐式流

将 Google 登录 JavaScript 客户端参考替换为 Google Identity 服务：

对象：

  • gapi.auth2.AuthorizeResponse 与 TokenClient.TokenResponse 合作
  • gapi.auth2.AuthResponse 与 TokenClient.TokenResponse 合作

方法：

  • GoogleUser.hasGrantedScopes() 与 google.accounts.oauth2.hasGrantedAllScopes()
  • GoogleUser.getGrantedScopes() 与 google.accounts.oauth2.hasGrantedAllScopes()

移除 Google 登录 JavaScript 客户端参考：

方法：

  • GoogleUser.getAuthResponse()

按照此精细权限示例，使用 hasGrantedAllScopes() 和 hasGrantedAnyScope() 更新您的 Web 应用。

授权代码流程

按照身份验证代码处理中的说明，向后端平台更新或添加授权代码端点。

更新您的平台，按照使用代码模型指南中所述的步骤验证请求并获取访问令牌和刷新令牌。

更新您的平台，以便根据用户已批准的各个范围，选择启用或停用功能，具体方法是按照增量授权说明操作，并检查用户授予的访问范围。

隐式流示例

旧方法

GAPI 客户端库

在浏览器中运行 JavaScript 版 Google API 客户端库的示例，该库使用弹出式对话框征求用户同意。

gapi.auth2 模块由 gapi.client.init() 自动加载和使用，因此处于隐藏状态。

<!DOCTYPE html>
  <html>
    <head>
      <script src="https://apis.google.com/js/api.js"></script>
      <script>
        function start() {
          gapi.client.init({
            'apiKey': 'YOUR_API_KEY',
            'clientId': 'YOUR_CLIENT_ID',
            'scope': 'https://www.googleapis.com/auth/cloud-translation',
            'discoveryDocs': ['https://www.googleapis.com/discovery/v1/apis/translate/v2/rest'],
          }).then(function() {
            // Execute an API request which is returned as a Promise.
            // The method name language.translations.list comes from the API discovery.
            return gapi.client.language.translations.list({
              q: 'hello world',
              source: 'en',
              target: 'de',
            });
          }).then(function(response) {
            console.log(response.result.data.translations[0].translatedText);
          }, function(reason) {
            console.log('Error: ' + reason.result.error.message);
          });
        };

        // Load the JavaScript client library and invoke start afterwards.
        gapi.load('client', start);
      </script>
    </head>
    <body>
      <div id="results"></div>
    </body>
  </html>

JS 客户端库

在浏览器中运行的适用于客户端 Web 应用的 OAuth 2.0，使用弹出式对话框征求用户同意。

gapi.auth2 模块是手动加载的。

<!DOCTYPE html>
<html><head></head><body>
<script>
  var GoogleAuth;
  var SCOPE = 'https://www.googleapis.com/auth/drive.metadata.readonly';
  function handleClientLoad() {
    // Load the API's client and auth2 modules.
    // Call the initClient function after the modules load.
    gapi.load('client:auth2', initClient);
  }

  function initClient() {
    // In practice, your app can retrieve one or more discovery documents.
    var discoveryUrl = 'https://www.googleapis.com/discovery/v1/apis/drive/v3/rest';

    // Initialize the gapi.client object, which app uses to make API requests.
    // Get API key and client ID from API Console.
    // 'scope' field specifies space-delimited list of access scopes.
    gapi.client.init({
        'apiKey': 'YOUR_API_KEY',
        'clientId': 'YOUR_CLIENT_ID',
        'discoveryDocs': [discoveryUrl],
        'scope': SCOPE
    }).then(function () {
      GoogleAuth = gapi.auth2.getAuthInstance();

      // Listen for sign-in state changes.
      GoogleAuth.isSignedIn.listen(updateSigninStatus);

      // Handle initial sign-in state. (Determine if user is already signed in.)
      var user = GoogleAuth.currentUser.get();
      setSigninStatus();

      // Call handleAuthClick function when user clicks on
      //      "Sign In/Authorize" button.
      $('#sign-in-or-out-button').click(function() {
        handleAuthClick();
      });
      $('#revoke-access-button').click(function() {
        revokeAccess();
      });
    });
  }

  function handleAuthClick() {
    if (GoogleAuth.isSignedIn.get()) {
      // User is authorized and has clicked "Sign out" button.
      GoogleAuth.signOut();
    } else {
      // User is not signed in. Start Google auth flow.
      GoogleAuth.signIn();
    }
  }

  function revokeAccess() {
    GoogleAuth.disconnect();
  }

  function setSigninStatus() {
    var user = GoogleAuth.currentUser.get();
    var isAuthorized = user.hasGrantedScopes(SCOPE);
    if (isAuthorized) {
      $('#sign-in-or-out-button').html('Sign out');
      $('#revoke-access-button').css('display', 'inline-block');
      $('#auth-status').html('You are currently signed in and have granted ' +
          'access to this app.');
    } else {
      $('#sign-in-or-out-button').html('Sign In/Authorize');
      $('#revoke-access-button').css('display', 'none');
      $('#auth-status').html('You have not authorized this app or you are ' +
          'signed out.');
    }
  }

  function updateSigninStatus() {
    setSigninStatus();
  }
</script>

<button id="sign-in-or-out-button"
        style="margin-left: 25px">Sign In/Authorize</button>
<button id="revoke-access-button"
        style="display: none; margin-left: 25px">Revoke access</button>

<div id="auth-status" style="display: inline; padding-left: 25px"></div><hr>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<script async defer src="https://apis.google.com/js/api.js"
        onload="this.onload=function(){};handleClientLoad()"
        onreadystatechange="if (this.readyState === 'complete') this.onload()">
</script>
</body></html>

OAuth 2.0 端点

在浏览器中运行的适用于客户端 Web 应用的 OAuth 2.0，使用重定向到 Google 征求用户意见。

此示例展示了从用户的浏览器直接调用 Google 的 OAuth 2.0 端点，并且未使用 gapi.auth2 模块或 JavaScript 库。

<!DOCTYPE html>
<html><head></head><body>
<script>
  var YOUR_CLIENT_ID = 'REPLACE_THIS_VALUE';
  var YOUR_REDIRECT_URI = 'REPLACE_THIS_VALUE';
  var fragmentString = location.hash.substring(1);

  // Parse query string to see if page request is coming from OAuth 2.0 server.
  var params = {};
  var regex = /([^&=]+)=([^&]*)/g, m;
  while (m = regex.exec(fragmentString)) {
    params[decodeURIComponent(m[1])] = decodeURIComponent(m[2]);
  }
  if (Object.keys(params).length > 0) {
    localStorage.setItem('oauth2-test-params', JSON.stringify(params) );
    if (params['state'] && params['state'] == 'try_sample_request') {
      trySampleRequest();
    }
  }

  // If there's an access token, try an API request.
  // Otherwise, start OAuth 2.0 flow.
  function trySampleRequest() {
    var params = JSON.parse(localStorage.getItem('oauth2-test-params'));
    if (params && params['access_token']) {
      var xhr = new XMLHttpRequest();
      xhr.open('GET',
          'https://www.googleapis.com/drive/v3/about?fields=user&' +
          'access_token=' + params['access_token']);
      xhr.onreadystatechange = function (e) {
        if (xhr.readyState === 4 && xhr.status === 200) {
          console.log(xhr.response);
        } else if (xhr.readyState === 4 && xhr.status === 401) {
          // Token invalid, so prompt for user permission.
          oauth2SignIn();
        }
      };
      xhr.send(null);
    } else {
      oauth2SignIn();
    }
  }

  /*

    *   Create form to request access token from Google's OAuth 2.0 server.
 */
function oauth2SignIn() {
  // Google's OAuth 2.0 endpoint for requesting an access token
  var oauth2Endpoint = 'https://accounts.google.com/o/oauth2/v2/auth';

    // Create element to open OAuth 2.0 endpoint in new window.
    var form = document.createElement('form');
    form.setAttribute('method', 'GET'); // Send as a GET request.
    form.setAttribute('action', oauth2Endpoint);

    // Parameters to pass to OAuth 2.0 endpoint.
    var params = {'client_id': YOUR_CLIENT_ID,
                  'redirect_uri': YOUR_REDIRECT_URI,
                  'scope': 'https://www.googleapis.com/auth/drive.metadata.readonly',
                  'state': 'try_sample_request',
                  'include_granted_scopes': 'true',
                  'response_type': 'token'};

    // Add form parameters as hidden input values.
    for (var p in params) {
      var input = document.createElement('input');
      input.setAttribute('type', 'hidden');
      input.setAttribute('name', p);
      input.setAttribute('value', params[p]);
      form.appendChild(input);
    }

    // Add form to page and submit it to open the OAuth 2.0 endpoint.
    document.body.appendChild(form);
    form.submit();
  }
</script>

<button onclick="trySampleRequest();">Try sample request</button>
</body></html>

新方式

仅限 GIS

此示例仅显示了使用令牌模型的 Google Identity 服务 JavaScript 库和用于征求用户同意的弹出式对话框。此示例旨在说明配置客户端、请求和获取访问令牌以及调用 Google API 所需的最少步骤数。

<!DOCTYPE html>
<html>
  <head>
    <script src="https://accounts.google.com/gsi/client" onload="initClient()" async defer></script>
  </head>
  <body>
    <script>
      var client;
      var access_token;

      function initClient() {
        client = google.accounts.oauth2.initTokenClient({
          client_id: 'YOUR_CLIENT_ID',
          scope: 'https://www.googleapis.com/auth/calendar.readonly \
                  https://www.googleapis.com/auth/contacts.readonly',
          callback: (tokenResponse) => {
            access_token = tokenResponse.access_token;
          },
        });
      }
      function getToken() {
        client.requestAccessToken();
      }
      function revokeToken() {
        google.accounts.oauth2.revoke(access_token, () => {console.log('access token revoked')});
      }
      function loadCalendar() {
        var xhr = new XMLHttpRequest();
        xhr.open('GET', 'https://www.googleapis.com/calendar/v3/calendars/primary/events');
        xhr.setRequestHeader('Authorization', 'Bearer ' + access_token);
        xhr.send();
      }
    </script>
    <h1>Google Identity Services Authorization Token model</h1>
    <button onclick="getToken();">Get access token</button><br><br>
    <button onclick="loadCalendar();">Load Calendar</button><br><br>
    <button onclick="revokeToken();">Revoke token</button>
  </body>
</html>

GAPI async/await

以下示例展示了如何使用令牌模型添加 Google Identity Service 库、移除 gapi.auth2 模块，并使用适用于 JavaScript 的 Google API 客户端库调用 API。

Promise、async 和 await 用于强制执行库加载顺序，以及捕获和重试授权错误。只有在有有效的访问令牌后，才会进行 API 调用。

当页面首次加载时缺少访问令牌，或访问令牌过期后，用户应按“显示日历”按钮。

<!DOCTYPE html>
<html>
<head></head>
<body>
  <h1>GAPI with GIS async/await</h1>
  <button id="showEventsBtn" onclick="showEvents();">Show Calendar</button><br><br>
  <button id="revokeBtn" onclick="revokeToken();">Revoke access token</button>

  <script>

    const gapiLoadPromise = new Promise((resolve, reject) => {
      gapiLoadOkay = resolve;
      gapiLoadFail = reject;
    });
    const gisLoadPromise = new Promise((resolve, reject) => {
      gisLoadOkay = resolve;
      gisLoadFail = reject;
    });

    var tokenClient;

    (async () => {
      document.getElementById("showEventsBtn").style.visibility="hidden";
      document.getElementById("revokeBtn").style.visibility="hidden";

      // First, load and initialize the gapi.client
      await gapiLoadPromise;
      await new Promise((resolve, reject) => {
        // NOTE: the 'auth2' module is no longer loaded.
        gapi.load('client', {callback: resolve, onerror: reject});
      });
      await gapi.client.init({
        // NOTE: OAuth2 'scope' and 'client_id' parameters have moved to initTokenClient().
      })
      .then(function() {  // Load the Calendar API discovery document.
        gapi.client.load('https://www.googleapis.com/discovery/v1/apis/calendar/v3/rest');
      });

      // Now load the GIS client
      await gisLoadPromise;
      await new Promise((resolve, reject) => {
        try {
          tokenClient = google.accounts.oauth2.initTokenClient({
              client_id: 'YOUR_CLIENT_ID',
              scope: 'https://www.googleapis.com/auth/calendar.readonly',
              prompt: 'consent',
              callback: '',  // defined at request time in await/promise scope.
          });
          resolve();
        } catch (err) {
          reject(err);
        }
      });

      document.getElementById("showEventsBtn").style.visibility="visible";
      document.getElementById("revokeBtn").style.visibility="visible";
    })();

    async function getToken(err) {

      if (err.result.error.code == 401 || (err.result.error.code == 403) &&
          (err.result.error.status == "PERMISSION_DENIED")) {

        // The access token is missing, invalid, or expired, prompt for user consent to obtain one.
        await new Promise((resolve, reject) => {
          try {
            // Settle this promise in the response callback for requestAccessToken()
            tokenClient.callback = (resp) => {
              if (resp.error !== undefined) {
                reject(resp);
              }
              // GIS has automatically updated gapi.client with the newly issued access token.
              console.log('gapi.client access token: ' + JSON.stringify(gapi.client.getToken()));
              resolve(resp);
            };
            tokenClient.requestAccessToken();
          } catch (err) {
            console.log(err)
          }
        });
      } else {
        // Errors unrelated to authorization: server errors, exceeding quota, bad requests, and so on.
        throw new Error(err);
      }
    }

    function showEvents() {

      // Try to fetch a list of Calendar events. If a valid access token is needed,
      // prompt to obtain one and then retry the original request.
      gapi.client.calendar.events.list({ 'calendarId': 'primary' })
      .then(calendarAPIResponse => console.log(JSON.stringify(calendarAPIResponse)))
      .catch(err  => getToken(err))  // for authorization errors obtain an access token
      .then(retry => gapi.client.calendar.events.list({ 'calendarId': 'primary' }))
      .then(calendarAPIResponse => console.log(JSON.stringify(calendarAPIResponse)))
      .catch(err  => console.log(err)); // cancelled by user, timeout, etc.
    }

    function revokeToken() {
      let cred = gapi.client.getToken();
      if (cred !== null) {
        google.accounts.oauth2.revoke(cred.access_token, () => {console.log('Revoked: ' + cred.access_token)});
        gapi.client.setToken('');
      }
    }

  </script>

  <script async defer src="https://apis.google.com/js/api.js" onload="gapiLoadOkay()" onerror="gapiLoadFail(event)"></script>
  <script async defer src="https://accounts.google.com/gsi/client" onload="gisLoadOkay()" onerror="gisLoadFail(event)"></script>

</body>
</html>

GAPI 回调

以下示例展示了如何使用令牌模型添加 Google Identity Service 库、移除 gapi.auth2 模块，并使用适用于 JavaScript 的 Google API 客户端库调用 API。

变量用于强制执行库加载顺序。在返回有效的访问令牌后，系统会从回调中进行 GAPI 调用。

用户应在页面首次加载时按“显示日历”按钮，并在需要刷新日历信息时再次按该按钮。

<!DOCTYPE html>
<html>
<head>
  <script async defer src="https://apis.google.com/js/api.js" onload="gapiLoad()"></script>
  <script async defer src="https://accounts.google.com/gsi/client" onload="gisInit()"></script>
</head>
<body>
  <h1>GAPI with GIS callbacks</h1>
  <button id="showEventsBtn" onclick="showEvents();">Show Calendar</button><br><br>
  <button id="revokeBtn" onclick="revokeToken();">Revoke access token</button>
  <script>
    let tokenClient;
    let gapiInited;
    let gisInited;

    document.getElementById("showEventsBtn").style.visibility="hidden";
    document.getElementById("revokeBtn").style.visibility="hidden";

    function checkBeforeStart() {
       if (gapiInited && gisInited){
          // Start only when both gapi and gis are initialized.
          document.getElementById("showEventsBtn").style.visibility="visible";
          document.getElementById("revokeBtn").style.visibility="visible";
       }
    }

    function gapiInit() {
      gapi.client.init({
        // NOTE: OAuth2 'scope' and 'client_id' parameters have moved to initTokenClient().
      })
      .then(function() {  // Load the Calendar API discovery document.
        gapi.client.load('https://www.googleapis.com/discovery/v1/apis/calendar/v3/rest');
        gapiInited = true;
        checkBeforeStart();
      });
    }

    function gapiLoad() {
        gapi.load('client', gapiInit)
    }

    function gisInit() {
     tokenClient = google.accounts.oauth2.initTokenClient({
                client_id: 'YOUR_CLIENT_ID',
                scope: 'https://www.googleapis.com/auth/calendar.readonly',
                callback: '',  // defined at request time
            });
      gisInited = true;
      checkBeforeStart();
    }

    function showEvents() {

      tokenClient.callback = (resp) => {
        if (resp.error !== undefined) {
          throw(resp);
        }
        // GIS has automatically updated gapi.client with the newly issued access token.
        console.log('gapi.client access token: ' + JSON.stringify(gapi.client.getToken()));

        gapi.client.calendar.events.list({ 'calendarId': 'primary' })
        .then(calendarAPIResponse => console.log(JSON.stringify(calendarAPIResponse)))
        .catch(err => console.log(err));

        document.getElementById("showEventsBtn").innerText = "Refresh Calendar";
      }

      // Conditionally ask users to select the Google Account they'd like to use,
      // and explicitly obtain their consent to fetch their Calendar.
      // NOTE: To request an access token a user gesture is necessary.
      if (gapi.client.getToken() === null) {
        // Prompt the user to select a Google Account and asked for consent to share their data
        // when establishing a new session.
        tokenClient.requestAccessToken({prompt: 'consent'});
      } else {
        // Skip display of account chooser and consent dialog for an existing session.
        tokenClient.requestAccessToken({prompt: ''});
      }
    }

    function revokeToken() {
      let cred = gapi.client.getToken();
      if (cred !== null) {
        google.accounts.oauth2.revoke(cred.access_token, () => {console.log('Revoked: ' + cred.access_token)});
        gapi.client.setToken('');
        document.getElementById("showEventsBtn").innerText = "Show Calendar";
      }
    }
  </script>
</body>
</html>

授权代码流程示例

Google Identity Service 库弹出式窗口用户体验可以使用网址重定向直接向后端令牌端点返回授权代码，也可以使用用户浏览器中运行的 JavaScript 回调处理程序（将响应代理到您的平台）。无论是哪种情况，您的后端平台都会完成 OAuth 2.0 流程，以获取有效的刷新令牌和访问令牌。

旧方法

服务器端 Web 应用

在后端平台上运行的适用于服务器端应用的 Google 登录，使用重定向到 Google 来征求用户意见。

<!DOCTYPE html>
<html>
  <head>
    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
    <script src="https://apis.google.com/js/client:platform.js?onload=start" async defer></script>
    <script>
      function start() {
        gapi.load('auth2', function() {
          auth2 = gapi.auth2.init({
            client_id: 'YOUR_CLIENT_ID',
            api_key: 'YOUR_API_KEY',
            discovery_docs: ['https://www.googleapis.com/discovery/v1/apis/translate/v2/rest'],
            // Scopes to request in addition to 'profile' and 'email'
            scope: 'https://www.googleapis.com/auth/cloud-translation',
          });
        });
      }
      function signInCallback(authResult) {
        if (authResult['code']) {
          console.log("sending AJAX request");
          // Send authorization code obtained from Google to backend platform
          $.ajax({
            type: 'POST',
            url: 'YOUR_AUTHORIZATION_CODE_ENDPOINT_URL',
            // Always include an X-Requested-With header to protect against CSRF attacks.
            headers: {
              'X-Requested-With': 'XMLHttpRequest'
            },
            contentType: 'application/octet-stream; charset=utf-8',
            success: function(result) {
              console.log(result);
            },
            processData: false,
            data: authResult['code']
          });
        } else {
          console.log('error: failed to obtain authorization code')
        }
      }
    </script>
  </head>
  <body>
    <button id="signinButton">Sign In With Google</button>
    <script>
      $('#signinButton').click(function() {
        // Obtain an authorization code from Google
        auth2.grantOfflineAccess().then(signInCallback);
      });
    </script>
  </body>
</html>

使用重定向的 HTTP/REST

为 Web 服务器应用使用 OAuth 2.0，将授权代码从用户的浏览器发送到您的后端平台。通过将用户的浏览器重定向到 Google 来处理用户意见征求。

/\*
 \* Create form to request access token from Google's OAuth 2.0 server.
 \*/
function oauthSignIn() {
  // Google's OAuth 2.0 endpoint for requesting an access token
  var oauth2Endpoint = 'https://accounts.google.com/o/oauth2/v2/auth';
  // Create &lt;form> element to submit parameters to OAuth 2.0 endpoint.
  var form = document.createElement('form');
  form.setAttribute('method', 'GET'); // Send as a GET request.
  form.setAttribute('action', oauth2Endpoint);
  // Parameters to pass to OAuth 2.0 endpoint.
  var params = {'client\_id': 'YOUR_CLIENT_ID',
                'redirect\_uri': 'YOUR_AUTHORIZATION_CODE_ENDPOINT_URL',
                'response\_type': 'token',
                'scope': 'https://www.googleapis.com/auth/drive.metadata.readonly',
                'include\_granted\_scopes': 'true',
                'state': 'pass-through value'};
  // Add form parameters as hidden input values.
  for (var p in params) {
    var input = document.createElement('input');
    input.setAttribute('type', 'hidden');
    input.setAttribute('name', p);
    input.setAttribute('value', params[p]);
    form.appendChild(input);
  }

  // Add form to page and submit it to open the OAuth 2.0 endpoint.
  document.body.appendChild(form);
  form.submit();
}

新方式

GIS 弹出式窗口用户体验

此示例仅展示了 使用授权代码模型的 Google Identity 服务 JavaScript 库，其中包含用于征求用户同意的弹出式对话框，以及用于从 Google 接收授权代码的回调处理脚本。此示例旨在说明配置客户端、征求用户同意并向后端平台发送授权代码所需的最少步骤数。

<!DOCTYPE html>
<html>
  <head>
    <script src="https://accounts.google.com/gsi/client" onload="initClient()" async defer></script>
  </head>
  <body>
    <script>
      var client;
      function initClient() {
        client = google.accounts.oauth2.initCodeClient({
          client_id: 'YOUR_CLIENT_ID',
          scope: 'https://www.googleapis.com/auth/calendar.readonly',
          ux_mode: 'popup',
          callback: (response) => {
            var code_receiver_uri = 'YOUR_AUTHORIZATION_CODE_ENDPOINT_URI',
            // Send auth code to your backend platform
            const xhr = new XMLHttpRequest();
            xhr.open('POST', code_receiver_uri, true);
            xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
            xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
            xhr.onload = function() {
              console.log('Signed in as: ' + xhr.responseText);
            };
            xhr.send('code=' + response.code);
            // After receipt, the code is exchanged for an access token and
            // refresh token, and the platform then updates this web app
            // running in user's browser with the requested calendar info.
          },
        });
      }
      function getAuthCode() {
        // Request authorization code and obtain user consent
        client.requestCode();
      }
    </script>
    <button onclick="getAuthCode();">Load Your Calendar</button>
  </body>
</html>

GIS 重定向用户体验

授权代码模型支持弹出式窗口和重定向用户体验模式，可将每位用户的授权代码发送到由您的平台托管的端点。重定向用户体验模式如下所示：

<!DOCTYPE html>
<html>
  <head>
    <script src="https://accounts.google.com/gsi/client" onload="initClient()" async defer></script>
  </head>
  <body>
    <script>
      var client;
      function initClient() {
        client = google.accounts.oauth2.initCodeClient({
          client_id: 'YOUR_CLIENT_ID',
          scope: 'https://www.googleapis.com/auth/calendar.readonly \
                  https://www.googleapis.com/auth/photoslibrary.readonly',
          ux_mode: 'redirect',
          redirect_uri: 'YOUR_AUTHORIZATION_CODE_ENDPOINT_URI'
        });
      }
      // Request an access token
      function getAuthCode() {
        // Request authorization code and obtain user consent
        client.requestCode();
      }
    </script>
    <button onclick="getAuthCode();">Load Your Calendar</button>
  </body>
</html>

JavaScript 库

Google Identity 服务是一个用于用户身份验证和授权的单个 JavaScript 库，它整合并取代了多个不同库和模块中的功能：

迁移到 Identity Services 时要执行的操作：

现有 JS 库 新的 JS 库 备注
apis.google.com/js/api.js accounts.google.com/gsi/client 添加新库并遵循隐式流程。
apis.google.com/js/client.js accounts.google.com/gsi/client 添加了新库和授权码流程。

库快速参考

旧版 Google 登录 JavaScript 客户端库与新版 Google Identity 服务库之间的对象和方法对比，以及备注，其中包含迁移期间的更多信息和要执行的操作。

旧优惠 新 备注
GoogleAuth 对象及相关方法：
GoogleAuth.attachClickHandler() 移除
GoogleAuth.currentUser.get() 移除
GoogleAuth.currentUser.listen() 移除
GoogleAuth.disconnect() google.accounts.oauth2.revoke 将旧的替换为新的。您也可以通过 https://myaccount.google.com/permissions 撤消授权
GoogleAuth.grantOfflineAccess() 移除，然后按照授权代码流程操作。
GoogleAuth.isSignedIn.get() 移除
GoogleAuth.isSignedIn.listen() 移除
GoogleAuth.signIn() 移除
GoogleAuth.signOut() 移除
GoogleAuth.then() 移除
GoogleUser 对象和相关方法：
GoogleUser.disconnect() google.accounts.id.revoke 将旧的替换为新的。您也可以通过 https://myaccount.google.com/permissions 撤消授权
GoogleUser.getAuthResponse() requestCode() or requestAccessToken() 替换为新版
GoogleUser.getBasicProfile() 移除。请改用 ID 令牌，具体请参阅从 Google 登录迁移。
GoogleUser.getGrantedScopes() hasGrantedAnyScope() 将旧版替换为新版
GoogleUser.getHostedDomain() 移除
GoogleUser.getId() 移除
GoogleUser.grantOfflineAccess() 移除，然后按照授权代码流程操作。
GoogleUser.grant() 移除
GoogleUser.hasGrantedScopes() hasGrantedAnyScope() 将旧版替换为新版
GoogleUser.isSignedIn() 移除
GoogleUser.reloadAuthResponse() requestAccessToken() 移除旧令牌，调用新令牌以替换过期或已撤消的访问令牌。
gapi.auth2 对象及相关方法：
gapi.auth2.AuthorizeConfig 对象 TokenClientConfig 或 CodeClientConfig 替换为新版
gapi.auth2.AuthorizeResponse 对象 移除
gapi.auth2.AuthResponse 对象 移除
gapi.auth2.authorize() requestCode() or requestAccessToken() 将旧版替换为新版
gapi.auth2.ClientConfig() TokenClientConfig 或 CodeClientConfig 将旧版替换为新版
gapi.auth2.getAuthInstance() 移除
gapi.auth2.init() initTokenClient() or initCodeClient() 将旧版替换为新版
gapi.auth2.OfflineAccessOptions 对象 移除
gapi.auth2.SignInOptions 对象 移除
gapi.signin2 对象及相关方法：
gapi.signin2.render() 移除。g_id_signin 元素的 HTML DOM 加载或对 google.accounts.id.renderButton 的 JS 调用会触发用户登录 Google 账号。

凭据示例

现有凭据

Google 登录平台库、适用于 JavaScript 的 Google API 客户端库或直接调用 Google Auth 2.0 端点时，会在单个响应中同时返回 OAuth 2.0 访问令牌和 OpenID Connect ID 令牌。

同时包含 access_token 和 id_token 的示例响应：

  {
    "token_type": "Bearer",
    "access_token": "ya29.A0ARrdaM-SmArZaCIh68qXsZSzyeU-8mxhQERHrP2EXtxpUuZ-3oW8IW7a6D2J6lRnZrRj8S6-ZcIl5XVEqnqxq5fuMeDDH_6MZgQ5dgP7moY-yTiKR5kdPm-LkuPM-mOtUsylWPd1wpRmvw_AGOZ1UUCa6UD5Hg",
    "scope": "https://www.googleapis.com/auth/calendar.readonly",
    "login_hint": "AJDLj6I2d1RH77cgpe__DdEree1zxHjZJr4Q7yOisoumTZUmo5W2ZmVFHyAomUYzLkrluG-hqt4RnNxrPhArd5y6p8kzO0t8xIfMAe6yhztt6v2E-_Bb4Ec3GLFKikHSXNh5bI-gPrsI",
    "expires_in": 3599,
    "id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjkzNDFhYmM0MDkyYjZmYzAzOGU0MDNjOTEwMjJkZDNlNDQ1MzliNTYiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJhY2NvdW50cy5nb29nbGUuY29tIiwiYXpwIjoiNTM4MzQ0NjUzMjU1LTc1OGM1aDVpc2M0NXZnazI3ZDhoOGRlYWJvdnBnNnRvLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwiYXVkIjoiNTM4MzQ0NjUzMjU1LTc1OGM1aDVpc2M0NXZnazI3ZDhoOGRlYWJvdnBnNnRvLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwic3ViIjoiMTE3NzI2NDMxNjUxOTQzNjk4NjAwIiwiaGQiOiJnb29nbGUuY29tIiwiZW1haWwiOiJkYWJyaWFuQGdvb2dsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYXRfaGFzaCI6IkJBSW55TjN2MS1ZejNLQnJUMVo0ckEiLCJuYW1lIjoiQnJpYW4gRGF1Z2hlcnR5IiwicGljdHVyZSI6Imh0dHBzOi8vbGgzLmdvb2dsZXVzZXJjb250ZW50LmNvbS9hLS9BT2gxNEdnenAyTXNGRGZvbVdMX3VDemRYUWNzeVM3ZGtxTE5ybk90S0QzVXNRPXM5Ni1jIiwiZ2l2ZW5fbmFtZSI6IkJyaWFuIiwiZmFtaWx5X25hbWUiOiJEYXVnaGVydHkiLCJsb2NhbGUiOiJlbiIsImlhdCI6MTYzODk5MTYzOCwiZXhwIjoxNjM4OTk1MjM4LCJqdGkiOiI5YmRkZjE1YWFiNzE2ZDhjYmJmNDYwMmM1YWM3YzViN2VhMDQ5OTA5In0.K3EA-3Adw5HA7O8nJVCsX1HmGWxWzYk3P7ViVBb4H4BoT2-HIgxKlx1mi6jSxIUJGEekjw9MC-nL1B9Asgv1vXTMgoGaNna0UoEHYitySI23E5jaMkExkTSLtxI-ih2tJrA2ggfA9Ekj-JFiMc6MuJnwcfBTlsYWRcZOYVw3QpdTZ_VYfhUu-yERAElZCjaAyEXLtVQegRe-ymScra3r9S92TA33ylMb3WDTlfmDpWL0CDdDzby2asXYpl6GQ7SdSj64s49Yw6mdGELZn5WoJqG7Zr2KwIGXJuSxEo-wGbzxNK-mKAiABcFpYP4KHPEUgYyz3n9Vqn2Tfrgp-g65BQ",
    "session_state": {
      "extraQueryParams": {
        "authuser": "0"
      }
    },
    "first_issued_at": 1638991637982,
    "expires_at": 1638995236982,
    "idpId": "google"
  }

Google Identity 服务凭据

Google Identity Services 库会返回：

  • 用于授权的访问令牌：

    {
  "access_token": "ya29.A0ARrdaM_LWSO-uckLj7IJVNSfnUityT0Xj-UCCrGxFQdxmLiWuAosnAKMVQ2Z0LLqeZdeJii3TgULp6hR_PJxnInBOl8UoUwWoqsrGQ7-swxgy97E8_hnzfhrOWyQBmH6zs0_sUCzwzhEr_FAVqf92sZZHphr0g",
  "token_type": "Bearer",
  "expires_in": 3599,
  "scope": "https://www.googleapis.com/auth/calendar.readonly"
}

  • 或 ID 令牌（如果用于身份验证）：

    {
  "clientId": "538344653255-758c5h5isc45vgk27d8h8deabovpg6to.apps.googleusercontent.com",
  "credential": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImMxODkyZWI0OWQ3ZWY5YWRmOGIyZTE0YzA1Y2EwZDAzMjcxNGEyMzciLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJuYmYiOjE2MzkxNTcyNjQsImF1ZCI6IjUzODM0NDY1MzI1NS03NThjNWg1aXNjNDV2Z2syN2Q4aDhkZWFib3ZwZzZ0by5hcHBzLmdvb2dsZXVzZXJjb250ZW50LmNvbSIsInN1YiI6IjExNzcyNjQzMTY1MTk0MzY5ODYwMCIsIm5vbmNlIjoiZm9vYmFyIiwiaGQiOiJnb29nbGUuY29tIiwiZW1haWwiOiJkYWJyaWFuQGdvb2dsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYXpwIjoiNTM4MzQ0NjUzMjU1LTc1OGM1aDVpc2M0NXZnazI3ZDhoOGRlYWJvdnBnNnRvLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwibmFtZSI6IkJyaWFuIERhdWdoZXJ0eSIsInBpY3R1cmUiOiJodHRwczovL2xoMy5nb29nbGV1c2VyY29udGVudC5jb20vYS0vQU9oMTRHZ3pwMk1zRkRmb21XTF91Q3pkWFFjc3lTN2RrcUxOcm5PdEtEM1VzUT1zOTYtYyIsImdpdmVuX25hbWUiOiJCcmlhbiIsImZhbWlseV9uYW1lIjoiRGF1Z2hlcnR5IiwiaWF0IjoxNjM5MTU3NTY0LCJleHAiOjE2MzkxNjExNjQsImp0aSI6IjRiOTVkYjAyZjU4NDczMmUxZGJkOTY2NWJiMWYzY2VhYzgyMmI0NjUifQ.Cr-AgMsLFeLurnqyGpw0hSomjOCU4S3cU669Hyi4VsbqnAV11zc_z73o6ahe9Nqc26kPVCNRGSqYrDZPfRyTnV6g1PIgc4Zvl-JBuy6O9HhClAK1HhMwh1FpgeYwXqrng1tifmuotuLQnZAiQJM73Gl-J_6s86Buo_1AIx5YAKCucYDUYYdXBIHLxrbALsA5W6pZCqqkMbqpTWteix-G5Q5T8LNsfqIu_uMBUGceqZWFJALhS9ieaDqoxhIqpx_89QAr1YlGu_UO6R6FYl0wDT-nzjyeF5tonSs3FHN0iNIiR3AMOHZu7KUwZaUdHg4eYkU-sQ01QNY_11keHROCRQ",
  "select_by": "user"
}

令牌响应无效

尝试使用已到期、已撤消或无效的访问令牌发出 API 请求时，Google 给出的响应示例：

HTTP 响应标头

  www-authenticate: Bearer realm="https://accounts.google.com/", error="invalid_token"

响应正文

  {
    "error": {
      "code": 401,
      "message": "Request had invalid authentication credentials. Expected OAuth 2 access token, login cookie or other valid authentication credential. See https://developers.google.com/identity/sign-in/web/devconsole-project.",
      "errors": [
        {
          "message": "Invalid Credentials",
          "domain": "global",
          "reason": "authError",
          "location": "Authorization",
          "locationType": "header"
        }
      ],
      "status": "UNAUTHENTICATED"
    }
  }