reCAPTCHA Enterprise の JavaScript API リファレンス

このページでは、reCAPTCHA Enterprise JavaScript API のメソッドと、チェックボックス サイトキーを使用してウェブページをレンダリングする際に使用できる構成パラメータについて説明します。

JavaScript API

次の表に、reCAPTCHA Enterprise JavaScript API のメソッドを示します。

メソッド 説明
grecaptcha.enterprise.render(
container,
parameters
)

コンテナを reCAPTCHA ウィジェットとしてレンダリングし、新しく作成されたウィジェットの ID を返します。

コンテナ

コンテナ reCAPTCHA ウィジェットをレンダリングするための HTML 要素。コンテナの ID(文字列)または DOM 要素自体を指定します。

parameters

パラメータを key=value ペアとして含むオブジェクト。例: {"sitekey"、"your_site_key"、"theme"、"light"}

grecaptcha.enterprise.reset(
opt_widget_id
)

reCAPTCHA ウィジェットをリセットします。

opt_widget_id

オプションのウィジェット ID。指定されていない場合のデフォルトは最初に作成されたウィジェット。
grecaptcha.enterprise.execute (
opt_widget_id
)

reCAPTCHA Enterprise 検証をプログラムで呼び出します。

opt_widget_id

オプションのウィジェット ID。指定されていない場合のデフォルトは最初に作成されたウィジェットです。

このメソッドの使用に関する詳細については、スコアベースのサイトキーとフロントエンドの統合をご覧ください。

grecaptcha.enterprise.ready ( )

reCAPTCHA ライブラリが読み込まれるときに関数を実行します。

このメソッドの使用に関する詳細については、スコアベースのサイトキーとフロントエンドの統合をご覧ください。

grecaptcha.enterprise.getResponse (
opt_widget_id
)

reCAPTCHA ウィジェットのレスポンスを取得します。

opt_widget_id

オプションのウィジェット ID。指定されていない場合のデフォルトは最初に作成されたウィジェット。

構成

JavaScript リソース(enterprise.js)パラメータ

次の表に、ウィジェットを自動的または明示的にウェブページにレンダリングするための JavaScript リソース(enterprise.js)のパラメータを示します。

パラメータ 説明
onload 省略可。すべての依存関係が読み込まれると実行されるコールバック関数の名前。
render

明示

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 action 省略可。現在のアクションを説明する文字列 非対応
data-theme theme ダークライト ライト 省略可。ウィジェットのカラーテーマ
data-size 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 がエラー(通常はネットワーク接続)を検出し、接続が復元されるまで続行できないときに実行されるコールバック関数の名前。ここで関数を指定すると、ユーザーに再試行を促す通知を行う必要があります。