Google 登录 JavaScript 客户端参考文档

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

本参考介绍了用于在 Web 应用中实现 Google 登录功能的 JavaScript 客户端方法和属性。

如果您在使用该库时遇到任何问题,请向我们的 GitHub 代码库报告该问题。

Auth 设置

加载 Google API 平台库以创建 gapi 对象:

<script src="https://apis.google.com/js/platform.js?onload=init" async defer></script>

平台库加载后,加载 auth2 库:

function init() {
  gapi.load('auth2', function() {
    /* Ready. Make a call to gapi.auth2.init or some other API */
  });
}

gapi.auth2.init(params)

初始化 GoogleAuth 对象。您必须先调用该方法,然后才能调用 gapi.auth2.GoogleAuth 的方法。

初始化 GoogleAuth 对象时,您需要为该对象配置 OAuth 2.0 客户端 ID 和要指定的任何其他选项。然后,如果用户已登录,GoogleAuth 对象会恢复用户在之前的会话中所处的登录状态。

参数
params 包含客户端配置数据键值对的对象。如需了解可配置的不同属性,请参阅 gapi.auth2.ClientConfig。例如:
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}
返回
gapi.auth2.GoogleAuth gapi.auth2.GoogleAuth 对象。使用 then() 方法获取可在 gapi.auth2.GoogleAuth 对象完成初始化时解析的 promise。

GoogleAuth.then(onInit, onError)

GoogleAuth 对象完全初始化时调用 onInit 函数。如果在初始化时发生错误(这种情况可能在不受支持的旧版浏览器中发生),系统将调用 onError 函数。

参数
onInit 使用完全初始化的 GoogleAuth 对象调用的函数。
onError 如果 GoogleAuth 初始化失败,则使用包含 error 属性的对象调用的函数。
返回
Promise onInit 函数完成后执行的 Promise,或者在发生初始化错误时被拒。它会根据 onInit 函数返回的值(如果有)进行解析。

错误代码

idpiframe_initialization_failed
例如,由于环境不受支持,Google 无法初始化所需的 iframe。details 属性会提供关于出现的错误的详细信息。

gapi.auth2.ClientConfig

接口,表示 gapi.auth2.init 方法的不同配置参数。

参数
client_id string 必需。在 Google Developers Console 中找到和创建的应用的客户端 ID。
cookie_policy string 要为其创建登录 Cookie 的网域。URI、single_host_originnone。如果未指定,则默认为 single_host_origin
scope string 要请求的范围(以空格分隔的字符串)。如果 fetch_basic_profile 未设置为 false,则可选。
fetch_basic_profile boolean 在用户登录时获取其基本个人资料信息。向请求的范围添加“profile”、“email”和“openid”。如果未指定,则为 True。
hosted_domain string 用户必须登录的 G Suite 网域。这很容易被客户端修改,因此请务必验证所返回用户的托管网域属性。在客户端上使用 GoogleUser.getHostedDomain(),并使用服务器上 ID 令牌中的 hd 声明来验证网域是否符合您的预期。
ux_mode string 用于登录流程的用户体验模式。默认情况下,它会在弹出式窗口中打开意见征求流程。有效值为 popupredirect
redirect_uri string 如果使用 ux_mode='redirect',此参数可让您覆盖将在用户意见征求流程结束时使用的默认 redirect_uri。默认 redirect_uri 是不含查询参数和哈希代码段的当前网址。
plugin_name string (可选)如果设置了此值,则 2022 年 7 月 29 日之前创建的新客户端 ID 可以使用旧版 Google Platform 库。 默认情况下,系统会阻止新创建的客户端 ID 使用平台库,而必须使用较新的 Google Identity Services 库。您可以选择任意值,但建议使用描述性名称(例如产品或插件名称)以便于识别。示例:plugin_name: 'YOUR_STRING_HERE'

身份验证

GoogleAuth 是一个单例类,它提供的方法可让用户使用 Google 帐号登录、获取用户当前的登录状态、从用户的 Google 个人资料获取特定数据、请求其他范围,以及从当前帐号退出。

gapi.auth2.getAuthInstance()

返回 GoogleAuth 对象。您必须先使用 gapi.auth2.init() 初始化 GoogleAuth 对象,然后才能调用此方法。

返回
gapi.auth2.GoogleAuth gapi.auth2.GoogleAuth 对象。使用此对象可调用 gapi.auth2.GoogleAuth 的方法。

GoogleAuth.isSignedIn.get()

返回当前用户是否已登录。

返回
布尔值 true(如果用户已登录)或 false(如果用户退出登录或 GoogleAuth 对象未初始化)。

GoogleAuth.isSignedIn.listen(listener)

监听当前用户的登录状态的变化。

参数
listener 接受布尔值的函数。listen() 在用户登录时向其传递 true,在用户退出时向其传递 false

GoogleAuth.signIn()

使用指定为 gapi.auth2.init() 的选项让用户登录。

返回
Promise 在用户成功进行身份验证并授予所请求的范围时,通过 GoogleUser 实例执行的 Promise;如果发生错误,则拒绝并返回包含 error 属性的对象(请参阅下文,了解错误代码)。

错误代码

请参阅GoogleAuth.signIn(options)

GoogleAuth.signIn (options)

使用指定选项让用户登录。

参数
options 请执行以下任一操作:
  • 包含登录参数键值对的 gapi.auth2.SignInOptions 对象。例如:
    {
      scope: 'profile email'
    }
  • gapi.auth2.SigninOptionsBuilder 的一个实例。例如:
    options = new gapi.auth2.SigninOptionsBuilder();
    options.setAppPackageName('com.example.app');
    options.setFetchBasicProfile(True);
    options.setPrompt('select_account');
    options.setScope('profile').setScope('email');
返回
Promise 在用户成功进行身份验证并授予所请求的范围时,通过 GoogleUser 实例执行的 Promise;如果发生错误,则拒绝并返回包含 error 属性的对象(请参阅下文,了解错误代码)。

错误代码

popup_closed_by_user
用户在完成登录流程之前关闭了弹出式窗口。
access_denied
用户拒绝授予所需范围的权限。
immediate_failed
在未提示用户选择意见征求流程的情况下,系统无法自动选择任何用户。将 signInprompt: 'none' 选项搭配使用时引发错误。此选项不是必需的,因为如果 gapi.auth2.init 将自动登录到以前在之前的会话中登录的用户。

gapi.auth2.SignInOptions

表示 GoogleAuth.signIn(options) 方法的不同配置参数的接口。

参数
prompt string 针对意见征求流程强制执行特定模式。可选。
可能的值包括:
  • consent
    授权服务器先提示用户同意,然后再将信息返回到应用。
  • select_account
    授权服务器会提示用户选择 Google 帐号。这样,拥有多个帐号的用户便可从可能拥有当前会话的多个帐号中进行选择。
  • none不推荐
    授权服务器不会显示任何身份验证或用户同意屏幕;如果用户尚未通过身份验证并且未同意请求的范围,就会返回错误。
    由于 gapi.auth2.init 会在用户之前自动登录应用的情况下,因此调用 signIn({prompt: 'none'}) 通常会失败。
scope string 要请求的范围(以空格分隔的字符串),在 gapi.auth2.init 参数中定义的范围之上。如果 fetch_basic_profile 未设置为 false,则可选。
ux_mode string 用于登录流程的用户体验模式。默认情况下,它会在弹出式窗口中打开意见征求流程。有效值为 popupredirect
redirect_uri string 如果使用 ux_mode='redirect',此参数可让您覆盖将在用户意见征求流程结束时使用的默认 redirect_uri。默认 redirect_uri 是不含查询参数和哈希代码段的当前网址。

GoogleAuth.signOut()

从应用中退出当前帐号。

返回
Promise 在用户退出登录后执行的 Promise

GoogleAuth.disconnect()

撤消用户授予的所有范围。

GoogleAuth.grant 线下访问权限(options)

向用户请求离线访问指定范围的权限。

参数
options 包含参数键值对的 gapi.auth2.OfflineAccessOptions 对象。例如:
{
  scope: 'profile email'
}
返回
Promise 在用户授权所请求的范围时传递的 Promise,它会将包含授权代码的对象传递给 Promise 的执行方式处理程序。例如:
auth2.grantOfflineAccess().then(function(resp) {
  var auth_code = resp.code;
});

错误代码

popup_closed_by_user
用户在完成意见征求流程之前关闭了弹出式窗口。
access_denied
用户拒绝授予所需范围的权限。
immediate_failed
在未提示用户选择意见征求流程的情况下,系统无法自动选择任何用户。将 signInprompt: 'none' 选项搭配使用时引发错误。此选项不是必需的,因为如果 gapi.auth2.init 将自动登录到以前在之前的会话中登录的用户。

gapi.auth2.OfflineAccessOptions

表示 GoogleAuth.grantOfflineAccess(options) 方法的不同配置参数的接口。

参数
prompt string 针对意见征求流程强制执行特定模式。可选。
可能的值包括:
  • consent
    授权服务器先提示用户同意,然后再将信息返回到应用。
  • select_account
    授权服务器会提示用户选择 Google 帐号。这样,拥有多个帐号的用户便可从可能拥有当前会话的多个帐号中进行选择。
scope string 要请求的范围(以空格分隔的字符串),在 gapi.auth2.init 参数中定义的范围之上。如果 fetch_basic_profile 未设置为 false,则可选。

GoogleAuth.attachClickHandler(container, options, onsuccess, onfailure)

将登录流程附加到指定容器的点击处理程序。

参数
container 附加到点击处理程序的 div 元素的 ID 或对它的引用。
options 一个形参,其中包含参数的键值对。请参阅 GoogleAuth.signIn()
onsuccess 登录完成后要调用的函数。
onfailure 在登录失败时调用的函数。

用户

GoogleUser 对象表示一个用户帐号。GoogleUser 对象通常通过调用 GoogleAuth.currentUser.get() 获取。

GoogleAuth.currentUser.get()

返回表示当前用户的 GoogleUser 对象。请注意,在新初始化的 GoogleAuth 实例中,尚未设置当前用户。使用 currentUser.listen() 方法或 GoogleAuth.then() 获取初始化的 GoogleAuth 实例。

返回
GoogleUser 当前用户

GoogleAuth.currentUser.listen(listener)

监听 currentUser 的更改。

参数
listener 接受 GoogleUser 参数的函数。 每次修改 currentUser 时,listen 都会将此函数的 GoogleUser 实例传递给此函数。

GoogleUser.getId()

获取用户的唯一 ID 字符串。

返回
字符串 用户的唯一 ID

GoogleUser.isSignedIn()

如果用户已登录,则返回 true。

返回
布尔值 如果用户已登录,则为 true

GoogleUser.getHostedDomain()

如果用户使用 G Suite 帐号登录,则获取用户的 G Suite 网域。

返回
字符串 用户的 G Suite 网域

GoogleUser.getGrantedScopes()

获取用户以空格分隔的字符串授予的范围。

返回
字符串 用户授予的范围

GoogleUser.getBasicProfile()

获取用户的基本个人资料信息。

返回
gapi.auth2.BasicProfile 您可以使用以下方法检索 gapi.auth2.BasicProfile 的属性:
  • BasicProfile.getId()
  • BasicProfile.getName()
  • BasicProfile.getGivenName()
  • BasicProfile.getFamilyName()
  • BasicProfile.getImageUrl()
  • BasicProfile.getEmail()

GoogleUser.getAuthResponse(includeAuthorizationData)

从用户的身份验证会话中获取响应对象。

参数
includeAuthorizationData 可选:一个布尔值,用于指定是否始终返回访问令牌和范围。默认情况下,当 fetch_basic_profile 为 true(默认值)且未请求其他范围时,系统不会返回访问令牌和请求的范围。
返回
gapi.auth2.AuthResponse gapi.auth2.AuthResponse 对象。

GoogleUser.reloadAuthResponse()

强制刷新访问令牌,然后为新的 AuthResponse 返回 promise。

返回
Promise 在重新加载 OAuth 令牌时,通过重新加载的 gapi.auth2.AuthResponse 完成的 Promise

gapi.auth2.AuthResponse

调用 GoogleUser.getAuthResponse(includeAuthorizationData)GoogleUser.reloadAuthResponse() 方法时返回的响应。

属性
access_token string 已授予访问令牌。
id_token string 授予的 ID 令牌。
scope string 访问令牌中授予的范围。
expires_in number 访问令牌到期前的秒数。
first_issued_at number 用户首次授予所请求的范围的时间戳。
expires_at number 访问令牌到期的时间戳。

GoogleUser.hasGrantedScopes(scopes)

如果用户授予了指定范围,则返回 true。

参数
scopes 以空格分隔的范围字符串。
返回
布尔值 如果范围已授予,则为 true

GoogleUser.grant(options)

向用户请求其他范围。

如需查看参数列表和错误代码,请参阅 GoogleAuth.signIn()

GoogleUser.grantofflineAccess(options)

向用户请求离线访问指定范围的权限。

参数
options 包含参数键值对的 gapi.auth2.OfflineAccessOptions 对象。例如:
{
  scope: 'profile email'
}

GoogleUser.disconnect()

撤消用户为应用授予的所有范围。

界面元素

gapi.signin2.render(id, options)

使用 options 对象指定的设置,在具有指定 ID 的元素中呈现登录按钮。

参数
id 要在其中呈现登录按钮的元素 ID。
options 包含用于呈现该按钮的设置的对象。例如:
{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}
您可以指定以下选项:
参数
范围 用户登录时请求的范围(默认值:profile)。
width 按钮的宽度,以像素为单位(默认为 120)。
高度 按钮的高度,以像素为单位(默认为 36)。
长标题 显示长标签,例如“使用 Google 帐号登录”,而不是“登录”(默认值:false)。使用长标题时,您应使按钮的宽度增加到默认值。
主题 按钮的颜色主题:lightdark(默认值:light)。
onsuccess 用户成功登录时要调用的回调函数。此函数必须采用一个参数:gapi.auth2.GoogleUser 的实例(默认值:无)。
失败 在登录失败时调用的回调函数。此函数不接受参数(默认值:none)。

高级

gapi.auth2.authorized(params, callback)

执行一次性 OAuth 2.0 授权。根据所使用的参数,这会打开 Google 登录流程的弹出式窗口,或尝试在不发出用户互动的情况下静默加载请求的响应。

此方法的一些用例包括:

  • 您的应用只需要请求一次 Google API 端点,例如,在用户首次登录时加载他们喜爱的 YouTube 视频。
  • 您的应用有自己的会话管理基础架构,只需使用一次 ID 令牌即可识别后端中的用户。
  • 同一网页中使用多个客户端 ID。
参数
params 一个包含配置数据的键值对的对象。如需了解可配置的不同属性,请参阅 gapi.auth2.AuthorizeConfig。例如:
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}
callback 一个在请求完成后(成功或失败)时用 gapi.auth2.AuthorizeResponse 对象调用的函数。

示例

gapi.auth2.authorize({
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}, function(response) {
  if (response.error) {
    // An error happened!
    return;
  }
  // The user authorized the application for the scopes requested.
  var accessToken = response.access_token;
  var idToken = response.id_token;
  // You can also now use gapi.client to perform authenticated requests.
});

错误代码

idpiframe_initialization_failed
例如,由于环境不受支持,Google 无法初始化所需的 iframe。details 属性会提供关于出现的错误的详细信息。
popup_closed_by_user
用户在完成登录流程之前关闭了弹出式窗口。
access_denied
用户拒绝授予所需范围的权限。
immediate_failed
在未提示用户选择意见征求流程的情况下,系统无法自动选择任何用户。将 signInprompt: 'none' 选项搭配使用时引发错误。

gapi.auth2.AuthorizeConfig

表示 gapi.auth2.authorize 方法的不同配置参数的接口。

属性
client_id string 强制要求。在 Google Developers Console 中找到和创建的应用的客户端 ID。
scope string 强制要求。要请求的范围(以空格分隔的字符串)。
response_type string 以空格分隔的响应类型列表。默认为 'permission'。可能的值包括:
  • id_token,用于检索 ID 令牌
  • permission(或 token),用于检索访问令牌
  • code,用于检索授权代码
prompt string 针对意见征求流程强制执行特定模式。可能的值包括:
  • consent
    授权服务器先提示用户同意,然后再将信息返回到应用。
  • select_account
    授权服务器会提示用户选择 Google 帐号。这样,拥有多个帐号的用户便可从可能拥有当前会话的多个帐号中进行选择。
  • none
    授权服务器不会显示任何身份验证或用户同意屏幕;如果用户尚未通过身份验证并且之前未同意所请求的范围,则会返回错误。
    如果请求 code 作为响应类型,返回的代码只能换为 access_token(而非 refresh_token)。
cookie_policy string 要为其创建登录 Cookie 的网域。URI、single_host_originnone。如果未指定,则默认为 single_host_origin
hosted_domain string 用户必须登录的 G Suite 网域。这很容易被客户端修改,因此请务必验证所返回用户的托管网域属性。
login_hint string 要在登录流程中预先选择的用户的电子邮件或 User-ID。除非使用 prompt: "none",否则用户很容易修改。
include_granted_scopes boolean 是请求获取包含用户之前向应用授予的所有范围的访问令牌,还是仅请求在当前调用中请求的范围的访问令牌。默认值为 true
plugin_name string (可选)如果已设置,在 2022 年 7 月 29 日之前创建的客户端 ID 可以使用 Google 平台库。默认情况下,系统会阻止新创建的客户端 ID 使用平台库,而必须使用较新的 Google Identity Services 库。您可以选择任何值,建议使用描述性名称(例如产品或插件名称)以便于识别。示例:plugin_name: 'YOUR_STRING_HERE'

gapi.auth2.AuthorizeResponse

返回给 gapi.auth2.authorize 方法回调的响应。

属性
access_token string 已授予访问令牌。仅当 response_type 中指定了 permissiontoken 时才存在。
id_token string 授予的 ID 令牌。仅当 response_type 中指定了 id_token 时才存在。
code string 授权代码已授予。仅当 response_type 中指定了 code 时才存在。
scope string 访问令牌中授予的范围。仅当 response_type 中指定了 permissiontoken 时才存在。
expires_in number 访问令牌到期的秒数。仅当 response_type 中指定了 permissiontoken 时才存在。
first_issued_at number 用户首次授予所请求范围的时间戳。仅当 response_type 中指定了 permissiontoken 时才存在。
expires_at number 访问令牌到期的时间戳。仅当 response_type 中指定了 permissiontoken 时才存在。
error string 如果请求失败,则包含错误代码
error_subtype string 请求失败时,其中可能包含与返回的错误代码有关的其他信息。