Sign In With Google JavaScript API(使用 Google JavaScript API 参考文档)

本参考页面介绍了 Sign-In JavaScript API。您可以使用此 API 在网页上显示“一键式”提示或“使用 Google 账号登录”按钮。

方法:google.accounts.id.initialize

google.accounts.id.initialize 方法会根据配置对象初始化“使用 Google 账号登录”客户端。请参阅该方法的以下代码示例:

google.accounts.id.initialize(IdConfiguration)

以下代码示例使用 onload 函数实现 google.accounts.id.initialize 方法:

<script>
  window.onload = function () {
    google.accounts.id.initialize({
      client_id: 'YOUR_GOOGLE_CLIENT_ID',
      callback: handleCredentialResponse
    });
    google.accounts.id.prompt();
  };
</script>

google.accounts.id.initialize 方法会创建一个“使用 Google 账号登录”客户端实例,可供同一网页中的所有模块隐式使用。

  • 即使您在同一网页中使用多个模块(例如一键快捷按钮、个性化按钮、撤消等),也只需调用 google.accounts.id.initialize 方法一次。
  • 如果您多次调用 google.accounts.id.initialize 方法,系统只会记住并使用上次调用中的配置。

只要您调用 google.accounts.id.initialize 方法,实际上就会重置配置,同一网页中的所有后续方法都会立即使用新配置。

数据类型:IdConfiguration

下表列出了 IdConfiguration 数据类型的字段和说明:

字段
client_id 您的应用的客户端 ID
auto_select 启用自动选择功能。
callback 处理 ID 令牌的 JavaScript 函数。Google 一键快捷功能和“使用 Google 账号登录”按钮 popup 用户体验模式会使用此属性。
login_uri 登录端点的网址。“使用 Google 账号登录”按钮 redirect 用户体验模式会使用此属性。
native_callback 处理密码凭据的 JavaScript 函数。
cancel_on_tap_outside 在用户点击提示之外的位置时取消提示。
prompt_parent_id 一键式提示容器元素的 DOM ID
nonce ID 令牌的随机字符串
context 一键式提示中的标题和字词
state_cookie_domain 如果您需要在父网域及其子网域中调用一键快捷功能,请将父网域传递给此字段,以便使用单个共享 Cookie。
ux_mode “使用 Google 账号登录”按钮用户体验流程
allowed_parent_origin 可以嵌入中间 iframe 的来源。如果存在此字段,则会在中间 iframe 模式下运行一键快捷功能。
intermediate_iframe_close_callback 当用户手动关闭一键式按钮时,替换默认的中间 iframe 行为。
itp_support 在 ITP 浏览器上启用升级后的一键式用户体验。
login_hint 通过提供用户提示跳过账号选择。
hd 按网域限制帐号选择。
use_fedcm_for_prompt 允许浏览器控制用户登录提示,并在您的网站和 Google 之间协调登录流程。

client_id

此字段是应用的客户端 ID,您可以在 Google Cloud 控制台中找到并创建该 ID。如需了解详情,请参阅下表:

类型 必需 示例
string client_id: "CLIENT_ID.apps.googleusercontent.com"

auto_select

此字段用于确定当之前只有一个 Google 会话批准您的应用时,是否会在没有任何用户互动的情况下自动返回 ID 令牌。默认值为 false。如需了解详情,请参阅下表:

类型 必需 示例
boolean 选填 auto_select: true

callback

此字段是一个 JavaScript 函数,用于处理从一键快捷提示或弹出式窗口返回的 ID 令牌。如果使用了 Google 一键快捷功能或“使用 Google 账号登录”按钮 popup 用户体验模式,则必须提供此属性。如需了解详情,请参阅下表:

类型 必需 示例
功能 “一键快捷功能”和“popup”用户体验模式必须启用 callback: handleResponse

login_uri

此属性是您的登录端点的 URI。

该值必须与您在 Google Cloud 控制台中配置的 OAuth 2.0 客户端的某个已授权重定向 URI 完全匹配,并且必须符合我们的重定向 URI 验证规则

如果当前页面是您的登录页面,可以省略此属性,在这种情况下,凭据会默认发布到此页面。

当用户点击“使用 Google 账号登录”按钮并使用重定向用户体验模式时,ID 令牌凭据响应会发布到您的登录端点。

如需了解详情,请参阅下表:

类型 选填 示例
网址 默认值为当前页面的 URI 或您指定的值。
仅在已设置 ux_mode: "redirect" 时使用。
login_uri="https://www.example.com/login"

您的登录端点必须处理包含 credential 键且正文中含有 ID 令牌值的 POST 请求。

以下是发送到登录端点的示例请求:

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

credential=ID_TOKEN

native_callback

此字段是 JavaScript 函数的名称,该函数处理从浏览器的原生凭据管理器返回的密码凭据。如需了解详情,请参阅下表:

类型 必需 示例
功能 选填 native_callback: handleResponse

cancel_on_tap_outside

此字段用于设置是否在提示外点击时取消一键快捷请求。默认值为 true。如果您将该值设置为 false,则可以停用该功能。如需了解详情,请参阅下表:

类型 必需 示例
boolean 选填 cancel_on_tap_outside: false

prompt_parent_id

此属性用于设置容器元素的 DOM ID。如果您未设置此政策,窗口右上角会显示“一键点按”提示。如需了解详情,请参阅下表:

类型 必需 示例
string 选填 prompt_parent_id: 'parent_id'

nonce

此字段是 ID 令牌用于防范重放攻击的随机字符串。 如需了解详情,请参阅下表:

类型 必需 示例
string 选填 nonce: "biaqbm70g23"

Nonce 长度受限于您的环境支持的 JWT 大小上限以及各个浏览器和服务器 HTTP 大小限制。

context

此字段会更改一键式提示中的标题和消息文本。如需了解详情,请参阅下表:

类型 必需 示例
string 选填 context: "use"

下表列出了所有可用的上下文及其说明:

背景信息
signin “使用 Google 账号登录”
signup “使用 Google 账号注册”
use “使用 Google”

如果您需要在父网域及其子网域中显示一键快捷功能,请将父网域传递给此字段,以便使用单个共享状态 Cookie。如需了解详情,请参阅下表:

类型 必需 示例
string 选填 state_cookie_domain: "example.com"

ux_mode

使用此字段可设置“使用 Google 账号登录”按钮使用的用户体验流程。默认值为 popup。此属性对 OneTap 用户体验没有任何影响。如需了解详情,请参阅下表:

类型 必需 示例
string 选填 ux_mode: "redirect"

下表列出了可用的用户体验模式及其说明。

用户体验模式
popup 在弹出式窗口中执行登录用户体验流程。
redirect 通过整页重定向执行登录用户体验流程。

allowed_parent_origin

可以嵌入中间 iframe 的来源。如果存在此字段,则会在中间 iframe 模式下运行一键快捷功能。如需了解详情,请参阅下表:

类型 必需 示例
字符串或字符串数组 选填 allowed_parent_origin: "https://example.com"

下表列出了支持的值类型及其说明。

值类型
string 单个网域 URI。 "https://example.com"
string array 网域 URI 的数组。 ["https://news.example.com", "https://local.example.com"]

您还可以使用通配符前缀。例如,"https://*.example.com" 会在所有级别匹配 example.com 及其子网域(例如 news.example.comlogin.news.example.com)。使用通配符时,请注意以下事项:

  • 格式字符串不能由通配符和顶级域名组成。例如,https://.comhttps://.co.uk 无效;如上所述,"https://.example.com"example.com 及其子网域匹配。您也可以使用数组来表示 2 个不同的网域。例如,["https://example1.com", "https://.example2.com"] 与网域 example1.comexample2.comexample2.com 的子网域匹配
  • 通配符网域必须以安全的 https:// 架构开头,因此 "*.example.com" 被视为无效。

如果 allowed_parent_origin 字段的值无效,中间 iframe 模式的一键初始化将失败并停止。

intermediate_iframe_close_callback

当用户通过点按一键式界面中的“X”按钮手动关闭一键快捷功能时,替换默认的中间 iframe 行为。默认行为是立即从 DOM 中移除中间 iframe。

intermediate_iframe_close_callback 字段仅在中间 iframe 模式下生效。它只会影响中间 iframe,而不是一键式 iframe。在调用回调之前,系统会移除一键式界面。

类型 必需 示例
功能 选填 intermediate_iframe_close_callback: logBeforeClose

itp_support

此字段用于确定是否应在支持智能反跟踪 (ITP) 的浏览器上启用 升级后的一键式用户体验。默认值为 false。如需了解详情,请参阅下表:

类型 必需 示例
boolean 选填 itp_support: true

login_hint

如果您的应用事先知道应该让哪个用户登录,则可以向 Google 提供登录提示。验证成功后,将跳过账号选择。 接受的值包括电子邮件地址或 ID 令牌 sub 字段值。

如需了解详情,请参阅 OpenID Connect 文档中的 login_hint 字段。

类型 必需 示例
字符串、电子邮件地址或 ID 令牌 sub 字段中的值。 选填 login_hint: 'elisa.beckett@gmail.com'

高清

如果用户有多个帐号,并且只应使用其 Workspace 帐号登录,请使用该 ID 向 Google 提供域名提示。验证成功后,在帐号选择期间显示的用户帐号将仅限于所提供的网域。通配符值:* 仅向用户提供 Workspace 帐号,在选择帐号时排除消费者帐号 (user@gmail.com)。

有关详情,请参阅 OpenID Connect 文档中的 hd 字段。

类型 必需 示例
字符串。完全限定域名或 *。 选填 hd: '*'

use_fedcm_for_prompt

允许浏览器控制用户登录提示,并在您的网站和 Google 之间协调登录流程。默认值为 false。如需了解详情,请参阅迁移到 FedCM 页面。

类型 必需 示例
boolean 选填 use_fedcm_for_prompt: true

方法:google.accounts.id.prompt

调用 initialize() 方法后,google.accounts.id.prompt 方法会显示一键式提示或浏览器原生凭据管理器。请参阅该方法的以下代码示例:

 google.accounts.id.prompt(/**
 @type{(function(!PromptMomentNotification):void)=} */ momentListener)

通常,prompt() 方法会在网页加载时调用。由于 Google 的会话状态和用户设置,因此可能不会显示一键式提示界面。如需获取有关不同时刻的界面状态的通知,请传递一个函数来接收界面状态通知。

通知会在以下时刻触发:

  • 显示时刻:在调用 prompt() 方法后发生。通知包含一个布尔值,用于指示是否显示该界面。
  • 跳过时刻:当一键式提示因自动取消、手动取消或 Google 无法颁发凭据(例如当所选会话已退出 Google 账号)而关闭时,就会发生这种情况。

    在这些情况下,我们建议您继续联系其他身份提供方(如果有)。

  • 忽略时刻:当 Google 成功检索凭据或用户想要停止凭据检索流程时,就会发生这种情况。例如,当用户开始在登录对话框中输入用户名和密码时,您可以调用 google.accounts.id.cancel() 方法来关闭一键快捷提示并触发已关闭的时刻。

以下代码示例实现了跳过的时刻:

<script>
  window.onload = function () {
    google.accounts.id.initialize(...);
    google.accounts.id.prompt((notification) => {
      if (notification.isNotDisplayed() || notification.isSkippedMoment()) {
        // continue with another identity provider.
      }
    });
  };
</script>

数据类型:PromptMomentNotification

下表列出了 PromptMomentNotification 数据类型的方法和说明:

方法
isDisplayMoment() 此通知是针对展示时机的通知吗?

注意 启用 FedCM 时,系统不会触发此通知。如需了解详情,请参阅迁移到 FedCM 页面。
isDisplayed() 此通知是否为显示时刻的通知,是否显示界面?

注意 启用 FedCM 时,系统不会触发此通知。如需了解详情,请参阅迁移到 FedCM 页面。
isNotDisplayed() 此通知是否为显示时刻的通知,而未显示界面?

注意 启用 FedCM 时,系统不会触发此通知。如需了解详情,请参阅迁移到 FedCM 页面。
getNotDisplayedReason()

界面未显示的详细原因。以下是可能的值:

  • browser_not_supported
  • invalid_client
  • missing_client_id
  • opt_out_or_no_session
  • secure_http_required
  • suppressed_by_user
  • unregistered_origin
  • unknown_reason
注意 启用 FedCM 后,不支持此方法。如需了解详情,请参阅迁移到 FedCM 页面。
isSkippedMoment() 此通知是针对跳过的时刻吗?
getSkippedReason()

跳过片段的详细原因。以下是可能的值:

  • auto_cancel
  • user_cancel
  • tap_outside
  • issuing_failed
注意 启用 FedCM 后,不支持此方法。如需了解详情,请参阅迁移到 FedCM 页面。
isDismissedMoment() 此通知是针对已关闭的时刻吗?
getDismissedReason()

忽略的详细原因。以下是可能的值:

  • credential_returned
  • cancel_called
  • flow_restarted
getMomentType()

针对时刻类型返回字符串。以下是可能的值:

  • display
  • skipped
  • dismissed

数据类型:CredentialResponse

调用 callback 函数时,系统会传递 CredentialResponse 对象作为参数。下表列出了凭据响应对象中包含的字段:

字段
credential 此字段是返回的 ID 令牌。
select_by 此字段用于设置凭据的选择方式。
state 仅当用户点击“使用 Google 账号登录”按钮进行登录,且已指定该按钮的 state 属性时,系统才会定义此字段。

凭据

此字段是作为 base64 编码的 JSON Web 令牌 (JWT) 字符串形式的 ID 令牌。

解码后,JWT 应如以下示例所示:

header
{
  "alg": "RS256",
  "kid": "f05415b13acb9590f70df862765c655f5a7a019e", // JWT signature
  "typ": "JWT"
}
payload
{
  "iss": "https://accounts.google.com", // The JWT's issuer
  "nbf":  161803398874,
  "aud": "314159265-pi.apps.googleusercontent.com", // Your server's client ID
  "sub": "3141592653589793238", // The unique ID of the user's Google Account
  "hd": "gmail.com", // If present, the host domain of the user's GSuite email address
  "email": "elisa.g.beckett@gmail.com", // The user's email address
  "email_verified": true, // true, if Google has verified the email address
  "azp": "314159265-pi.apps.googleusercontent.com",
  "name": "Elisa Beckett",
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/e2718281828459045235360uler",
  "given_name": "Elisa",
  "family_name": "Beckett",
  "iat": 1596474000, // Unix timestamp of the assertion's creation time
  "exp": 1596477600, // Unix timestamp of the assertion's expiration time
  "jti": "abc161803398874def"
}

sub 字段是 Google 帐号的全局唯一标识符。使用 sub 字段作为用户的标识符,因为它在所有 Google 帐号中是唯一的,并且不得重复使用。请勿使用电子邮件地址作为标识符,因为一个 Google 帐号在不同时间点可以有多个电子邮件地址。

使用 emailemail_verifiedhd 字段,您可以确定 Google 是否由 Google 主机以及电子邮件地址的权威性。在 Google 具有权威性的情况下,用户被确认是合法的帐号所有者。

Google 具有权威性的情形:

  • email 具有 @gmail.com 后缀,这是一个 Gmail 账号。
  • email_verified 为 true 且 hd 已设置,则表示这是一个 Google Workspace 帐号。

用户可以在不使用 Gmail 或 Google Workspace 的情况下注册 Google 帐号。 当 email 不包含 @gmail.com 后缀且 hd 不存在时,Google 不具备权威性,建议使用密码或其他质询方法来验证用户。email_verfied 也可以是 true,因为 Google 在创建 Google 账号时最初验证了用户,但第三方电子邮件账号的所有权可能已发生变化。

exp 字段显示用于在服务器端验证令牌的到期时间。对于从“使用 Google 帐号登录”功能获取的 ID 令牌,该 1 小时是 1 小时。您需要在到期时间之前验证令牌请勿使用 exp 管理会话。ID 令牌过期并不意味着用户已退出帐号。您的应用负责用户的会话管理。

select_by

下表列出了 select_by 字段的可能值。与会话和同意情况一起使用的按钮类型用于设置值,

  • 用户按下了“一键式”按钮或“使用 Google 账号登录”按钮,或者使用了非接触式自动登录流程。

  • 找到了现有会话,或用户选择并登录了 Google 账号以建立新会话。

  • 在与您的应用共享 ID 令牌凭据之前,用户需要执行以下任一操作:

    • 按下“确认”按钮以同意共享凭据,或者
    • 并使用“选择账号”来选择 Google 账号。

此字段的值已设为以下类型之一:

说明
auto 让用户自动登录已有会话且之前已同意共享凭据的用户。
user 一位之前已进行同意参与的现有会话的用户按下了一键式“继续为”按钮以分享凭据。
user_1tap 已有会话的用户按下了一键式“继续为”按钮,以表示同意并共享凭据。仅适用于 Chrome v75 及更高版本。
user_2tap 没有现有会话的用户按一键“继续为”按钮来选择账号,然后按弹出式窗口中的“确认”按钮,以表示同意并共享凭据。适用于非基于 Chromium 的浏览器。
btn 之前参与过现有会话的用户按下了“使用 Google 账号登录”按钮,并从“选择账号”中选择一个 Google 账号来共享凭据。
btn_confirm 已有会话的用户按下了“使用 Google 账号登录”按钮,然后按下“确认”按钮,以表示同意并共享凭据。
btn_add_session 之前未同意参与的现有会话的用户按下了“使用 Google 账号登录”按钮,以选择 Google 账号并共享凭据。
btn_confirm_add_session 没有进行过现有会话的用户首先按下“使用 Google 账号登录”按钮来选择 Google 账号,然后按“确认”按钮来同意并共享凭据。

state

仅当用户点击“使用 Google 账号登录”按钮进行登录,且指定了被点击的按钮的 state 属性时,系统才会定义此字段。此字段的值与您在按钮的 state 属性中指定的值相同。

由于同一页面上可以呈现多个“使用 Google 帐号登录”按钮,因此您可以为每个按钮分配一个唯一的字符串。因此,您可以通过此 state 字段来确定用户点击的是哪个按钮进行登录。

方法:google.accounts.id.renderButton

google.accounts.id.renderButton 方法会在您的网页中显示“使用 Google 帐号登录”按钮。

请参阅该方法的以下代码示例:

google.accounts.id.renderButton(
      /** @type{!HTMLElement} */ parent,
      /** @type{!GsiButtonConfiguration} */ options
    )

数据类型:GsiButtonConfiguration

下表列出了 GsiButtonConfiguration 数据类型的字段和说明:

属性
type 按钮类型:图标或标准按钮。
theme 按钮主题。例如 filled_blue 或 filled_black。
size 按钮大小。例如,小或大。
text 按钮文字。例如,“使用 Google 账号登录”或“使用 Google 账号注册”。
shape 按钮形状。例如,矩形或圆形。
logo_alignment Google 徽标对齐方式:左对齐或居中。
width 按钮宽度(以像素为单位)。
locale 如果设置了此字段,则呈现按钮语言。
click_listener 如果设置了此字段,则点击“使用 Google 帐号登录”按钮时,系统会调用此函数。
state 如果设置,该字符串会返回 ID 令牌。

属性类型

以下部分包含有关每个属性类型的详细信息,以及一个示例。

类型

按钮类型。默认值为 standard

如需了解详情,请参阅下表:

类型 必需 示例
string type: "icon"

下表列出了可用的按钮类型及其说明:

类型
standard
包含文字或个性化信息的按钮。
icon
不含文本的图标按钮。

主题

按钮主题。默认值为 outline。如需了解详情,请参阅下表:

类型 必需 示例
string 选填 theme: "filled_blue"

下表列出了可用的主题及其说明:

主题
outline
标准按钮主题。
filled_blue
填充了蓝色的按钮主题。
filled_black
黑色填充的按钮主题。

大小

按钮大小。默认值为 large。如需了解详情,请参阅下表:

类型 必需 示例
string 选填 size: "small"

下表列出了可用的按钮大小及其说明:

大小
large
大号标准按钮 大图标按钮 一个个性化大按钮
大按钮。
medium
中等标准按钮 中等图标按钮
中等大小的按钮。
small
一个小按钮 一个小图标按钮
一个小按钮。

text

按钮文字。默认值为 signin_with。具有不同 text 属性的图标按钮的文本没有视觉差异。唯一的例外是系统读出文本以便于访问屏幕。

如需了解详情,请参阅下表:

类型 必需 示例
string 选填 text: "signup_with"

下表列出了所有可用的按钮文字及其说明:

文字
signin_with
按钮文字为“使用 Google 账号登录”。
signup_with
按钮文字为“使用 Google 账号注册”。
continue_with
按钮文字为“Continue with Google”。
signin
按钮文字为“登录”。

shape

按钮形状。默认值为 rectangular。如需了解详情,请参阅下表:

类型 必需 示例
string 选填 shape: "rectangular"

下表列出了可用的按钮形状及其说明:

形状
rectangular
矩形按钮。如果用于 icon 按钮类型,则其作用与 square 相同。
pill
药丸形状的按钮。如果用于 icon 按钮类型,则其作用与 circle 相同。
circle
圆形按钮。如果用于 standard 按钮类型,则其作用与 pill 相同。
square
方形按钮。如果用于 standard 按钮类型,则其作用与 rectangular 相同。

logo_alignment

Google 徽标的对齐方式。默认值为 left。此属性仅适用于 standard 按钮类型。如需了解详情,请参阅下表:

类型 必需 示例
string 选填 logo_alignment: "center"

下表列出了可用的对齐方式及其说明:

logo_alignment
left
与 Google 徽标左对齐。
center
居中对齐 Google 徽标。

宽度

按钮宽度下限(以像素为单位)。宽度上限为 400 像素。

如需了解详情,请参阅下表:

类型 必需 示例
string 选填 width: "400"

语言区域

可选。使用指定的语言区域显示按钮文字,否则默认采用用户的 Google 账号或浏览器设置。加载库时,请将 hl 参数和语言代码添加到 src 指令中,例如 gsi/client?hl=<iso-639-code>

如果未设置此属性,系统会使用浏览器的默认语言区域或 Google 会话用户的偏好设置。因此,不同的用户可能会看到不同版本的本地化按钮,并且可能会以不同的大小显示。

如需了解详情,请参阅下表:

类型 必需 示例
string 选填 locale: "zh_CN"

click_listener

您可以使用 click_listener 属性定义点击“使用 Google 帐号登录”按钮时调用的 JavaScript 函数。

  google.accounts.id.renderButton(document.getElementById("signinDiv"), {
      theme: 'outline',
      size: 'large',
      click_listener: onClickHandler
    });

  
  function onClickHandler(){
    console.log("Sign in with Google button clicked...")
  }
  

在此示例中,点击“使用 Google 账号登录”按钮后,控制台会记录 Sign in with Google button supported... 消息。

state

(可选)由于可以在同一个页面上呈现多个“使用 Google 帐号登录”按钮,因此您可以为每个按钮分配一个唯一的字符串。该字符串将与 ID 令牌一起返回,以便您识别用户点击哪个按钮进行了登录。

如需了解详情,请参阅下表:

类型 必需 示例
string 选填 data-state="button 1"

数据类型:凭据

调用 native_callback 函数时,Credential 对象会作为参数传递。下表列出了该对象中包含的字段:

字段
id 标识用户。
password 密码

方法:google.accounts.id.disableAutoSelect

当用户退出您的网站时,您需要调用 google.accounts.id.disableAutoSelect 方法,以在 Cookie 中记录状态。这样可以防止用户体验死循环。请参阅该方法的以下代码段:

google.accounts.id.disableAutoSelect()

以下代码示例使用 onSignout() 函数实现 google.accounts.id.disableAutoSelect 方法:

<script>
  function onSignout() {
    google.accounts.id.disableAutoSelect();
  }
</script>

方法:google.accounts.id.storeCredential

此方法是浏览器的原生凭据管理器 API 的 store() 方法的封装容器。因此,它只能用于存储密码凭据。请参阅该方法的以下代码示例:

google.accounts.id.storeCredential(Credential, callback)

以下代码示例使用 onSignIn() 函数实现 google.accounts.id.storeCredential 方法:

<script>
  function onSignIn() {
    let cred = {id: '...', password: '...'};
    google.accounts.id.storeCredential(cred);
  }
</script>

方法:google.accounts.id.cancel

如果您从依赖方 DOM 中移除提示,可以取消一键式流程。如果已选择凭据,则系统会忽略取消操作。请参阅该方法的以下代码示例:

google.accounts.id.cancel()

以下代码示例使用 onNextButtonClicked() 函数实现 google.accounts.id.cancel() 方法:

<script>
  function onNextButtonClicked() {
    google.accounts.id.cancel();
    showPasswordPage();
  }
</script>

库加载回调:onGoogleLibraryLoad

您可以注册 onGoogleLibraryLoad 回调。它会在“使用 Google 账号登录”JavaScript 库加载完成后收到通知:

window.onGoogleLibraryLoad = () => {
    ...
};

此回调只是 window.onload 回调的快捷方式。行为方面没有差异。

以下代码示例实现了 onGoogleLibraryLoad 回调:

<script>
  window.onGoogleLibraryLoad = () => {
   google.accounts.id.initialize({
     ...
   });
   google.accounts.id.prompt();
  };
</script>

方法:google.accounts.id.revoke

google.accounts.id.revoke 方法可撤消用于共享指定用户的 ID 令牌的 OAuth 授权。请参阅该方法的以下代码段: javascript google.accounts.id.revoke(login_hint, callback)

参数 类型 说明
login_hint string 用户 Google 帐号的电子邮件地址或唯一 ID。该 ID 是凭据载荷的 sub 属性。
callback 功能 (可选)RevocationResponse 处理程序。

以下代码示例展示了如何使用带有 ID 的 revoke 方法。

  google.accounts.id.revoke('1618033988749895', done => {
    console.log(done.error);
  });

数据类型:RevocationResponse

调用 callback 函数时,系统会传递 RevocationResponse 对象作为参数。下表列出了撤消响应对象中包含的字段:

字段
successful 此字段是方法调用的返回值。
error 此字段可视需要包含详细的错误响应消息。

成功

此字段是一个布尔值,如果撤消方法调用成功,则设为 true;如果撤消方法调用失败,则设为 false。

error

此字段是一个字符串值,包含详细的错误消息(如果撤消方法调用失败,则失败时未定义)。