Google 登录 JavaScript 客户端参考文档

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

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

身份验证设置

加载 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 Promise,在 onInit 函数完成时完成,或在发生初始化错误时拒绝。它使用 onInit 函数返回的值(如果有)进行解析。

错误代码

idpiframe_initialization_failed
未能初始化来自 Google 的必需 iframe,例如,由于环境不受支持。details 属性将提供有关引发的错误的更多信息。

gapi.auth2.ClientConfig

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

参数
client_id string 必需。应用的客户端 ID,可在 Google Developers Console 中找到并创建。
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 平台库。默认情况下,系统现在会禁止新创建的客户端 ID 使用平台库,而必须使用较新的 Google Identity 服务库。您可以选择任意值,建议使用描述性名称(如产品或插件名称),以便轻松识别。 示例: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;如果用户已退出帐号或 GoogleAuth 对象未初始化,则为 false

GoogleAuth.isSignedIn.listen(listener)

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

参数
listener 一个接受布尔值的函数。listen() 会在用户登录时将 true 传递给此函数,并在用户退出时将 false 传递给此函数。

GoogleAuth.signIn()

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

返回
Promise Promise,在用户成功进行身份验证并授予所请求的范围时,通过 GoogleUser 实例完成;如果发生错误,则通过包含 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 Promise,在用户成功进行身份验证并授予所请求的范围时,通过 GoogleUser 实例完成;如果发生错误,则通过包含 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.grantofflineAccess(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)。
成功 在用户成功登录时调用的回调函数。 此函数必须接受一个参数:gapi.auth2.GoogleUser 的实例(默认值:none)。
onfailure 登录失败时调用的回调函数。此函数不需要任何参数(默认值:none)。

高级

gapi.auth2.authorize(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 强制要求。应用的客户端 ID,可在 Google Developers Console 中找到并创建。
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 要在登录流程中预先选择的用户的电子邮件地址(即用户 ID)。用户很容易对其进行修改,除非使用 prompt: "none"
include_granted_scopes boolean 请求包含用户之前向应用授予的所有范围的访问令牌,还是仅请求当前调用中请求的范围。默认值为 true
plugin_name string 可选。如果设置了此字段,则 2022 年 7 月 29 日之前创建的客户端 ID 可以使用 Google 平台库。默认情况下,新创建的客户端 ID 无法使用平台库,而必须使用较新的 Google Identity 服务库。您可以选择任意值,建议使用描述性名称(如产品或插件名称),以便轻松识别。 示例: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 如果请求失败,这还可能包含与返回的错误代码有关的其他信息。