reCAPTCHA Enterprise 的 JavaScript API 参考文档

本页面介绍了 reCAPTCHA Enterprise JavaScript API 的方法,以及可用于通过复选框网站密钥呈现网页的配置参数。

JavaScript API

下表列出了 reCAPTCHA Enterprise JavaScript API 的方法。

方法 说明
grecaptcha.enterprise.render(
容器
参数
)

将容器呈现为 reCAPTCHA 微件,并返回新创建的微件的 ID。

容器

用于呈现 reCAPTCHA 微件的 HTML 元素。指定容器的 ID(字符串)或 DOM 元素本身。

参数

一个对象,它包含作为键值对的参数,例如{"sitekey": "your_site_key", "theme": "light"}。

grecaptcha.enterprise.reset(
opt_widget_id
)

重置 reCAPTCHA 微件。

opt_widget_id

  可选的微件 ID,如果未指定,则默认为创建的第一个微件。
grecaptcha.enterprise.getResponse(
opt_widget_id
)

获取 reCAPTCHA 微件的响应。

opt_widget_id

可选的微件 ID,如果未指定,则默认为创建的第一个微件。

配置

JavaScript 资源 (enterprise.js) 参数

下表列出了可用于在网页上自动呈现或显式呈现微件的 JavaScript 资源 (enterprise.js) 的参数。

参数 说明
onload 可选。加载所有依赖项后要执行的回调函数的名称。
呈现

显式

onload

可选。是否显式呈现微件。默认为 onload,它将在找到的第一个 g-recaptcha 标签中呈现微件。

如需详细了解如何使用这些参数,请参阅在前端呈现 reCAPTCHA 微件中的示例。

hl 参阅语言代码 可选。强制微件以特定语言呈现。 如果未指定语言,则会自动检测用户的语言。

g-recaptcha 标签特性和 grecaptcha.enterprise.render 参数

下表列出了 g-recaptcha 标记属性和相应的 grecaptcha.enterprise.render() 参数。

g-recaptcha 标签特性 grecaptcha.enterprise.render 参数 默认 说明
data-sitekey sitekey reCAPTCHA 密钥
data-action 行动 可选。描述当前操作的字符串。 目前不受支持
data-theme 主题背景 深色 浅色 可选。微件的颜色主题背景。
data-size 大小 正常紧凑 正常 可选。微件的大小。
data-tabindex tabindex 0 可选。微件和挑战的 tabindex。如果页面中的其他元素使用 tabindex,则应对其进行设置使其可更为轻松地使用户导航。
data-callback callback 可选。当用户提交成功的响应时执行的回调函数的名称。g-recaptcha-response 令牌将传递给您的回调。
data-expired-callback expired-callback 可选。在 reCAPTCHA 响应到期且用户需要重新验证时执行的回调函数的名称,。
data-error-callback error-callback 可选。在 reCAPTCHA 遇到错误(通常是网络连接问题),并且在恢复连接之前无法继续时执行的回调函数名称。如果在此处指定功能,您需负责通知用户进行重试。