このページでは、ウェブページで invisible reCAPTCHA を有効にしてカスタマイズする方法について説明します。
invisible reCAPTCHA を呼び出すには、次のいずれかを行います。
invisible reCAPTCHA をカスタマイズする方法については、構成をご覧ください。たとえば、言語やバッジの場所を指定できます。
ユーザーが CAPTCHA に正しく答えたかどうかを確認するには、ユーザーの回答を確認するをご覧ください。
チャレンジを自動的にボタンにバインドする
ページで invisible reCAPTCHA ウィジェットを使用する最も簡単な方法は、必要な JavaScript リソースを追加し、html ボタンにいくつかの属性を追加することです。必要な属性は、クラス名「g-recaptcha
」、data-sitekey
属性のサイトキー、data-callback
属性のキャプチャの完了を処理する JavaScript コールバックの名前です。
reCAPTCHA demo: Simple page
スクリプトは HTTPS プロトコルを使用して読み込む必要があり、ページのどの位置からでも制限なく含めることができます。
チャレンジをプログラムによってボタンにバインドするか、チャレンジを呼び出します。
バインディングを延期するには、onload コールバック関数を指定し、JavaScript リソースにパラメータを追加します。これは、通常の reCAPTCHA による確認と同じです。
プログラムでチャレンジを呼び出します。
reCAPTCHA 検証をプログラムで呼び出すには、属性 data-size="invisible"
を使用して div でチャレンジをレンダリングし、実行をプログラマティックに呼び出します。
data-size="invisible"
で div を作成します。JavaScript メソッドから grecaptcha.execute を呼び出します。
grecaptcha.execute();
コールバックの実行時に、JavaScript API から
grecaptcha.render
メソッドを呼び出すことができます。onload コールバック関数は、reCAPTCHA API を読み込む前に定義する必要があります。競合状態が発生しないようにするには、次のようにします。 - 最初にコールバックを指定してスクリプトを並べ替え、次に reCAPTCHA を
- `script` タグで `async` パラメータと `defer` パラメータを使用する
構成
JavaScript リソース(api.js)パラメータ
パラメータ | 値 | 説明 |
---|---|---|
onload | 省略可。すべての依存関係が読み込まれると実行されるコールバック関数の名前。 | |
レンダリング | 明示的 onload |
省略可。ウィジェットを明示的にレンダリングするかどうか。デフォルトは onload で、検出された最初の g-recaptcha タグでウィジェットがレンダリングされます。 |
hl | 言語コードをご覧ください | 省略可。ウィジェットを特定の言語で強制的にレンダリングします。指定されていない場合はユーザーの言語を自動検出します。 |
g-recaptcha タグの属性と grecaptcha.render パラメータ
g-recaptcha タグの属性 | grecaptcha.render パラメータ | 値 | デフォルト | 説明 |
---|---|---|---|---|
データのサイトキー | サイトキー | サイトキー。 | ||
データバッジ | バッジ | bottomright bottomleft inline | bottomright | 省略可。reCAPTCHA バッジの位置を変更します。「インライン」CSS を使って配置することができます。 |
データサイズ | サイズ | invisible | 省略可。div にバインドされ、プログラムで実行される非表示のウィジェットを作成するために使用します。 | |
data-tabindex | tabIndex | 0 | 省略可。チャレンジの tabindex。ページ内の他の要素が tabindex を使用する場合、ユーザー ナビゲーションを容易にするために設定する必要があります。 | |
データ コールバック | callback | 省略可。ユーザーが成功の応答を送信したときに実行されるコールバック関数の名前。g-recaptcha-response トークンがコールバックに渡されます。 |
||
データ期限切れのコールバック | expired-callback | 省略可。コールバック関数の名前。reCAPTCHA レスポンスの有効期限が切れ、ユーザーが再確認する必要があるときに実行されます。 | ||
データエラー コールバック | エラー コールバック | 省略可。reCAPTCHA がエラー(通常はネットワーク接続)を検出し、接続が復元されるまで続行できないときに実行されるコールバック関数の名前。ここで関数を指定すると、ユーザーに再試行を促す通知を行う必要があります。 | ||
隔離 | false | 省略可。プラグインの所有者が、ページへの既存の reCAPTCHA のインストールを妨げないようにします。true の場合、この reCAPTCHA インスタンスは別の ID 空間の一部になります。 |
JavaScript API
方式 | 説明 |
---|---|
grecaptcha.render( コンテナ
パラメータ
継承
)
|
コンテナを reCAPTCHA ウィジェットとしてレンダリングし、新しく作成されたウィジェットの ID を返します。 コンテナ reCAPTCHA ウィジェットをレンダリングするための HTML 要素。コンテナの ID(文字列)または DOM 要素自体を指定します。 パラメータ Key-Value ペアとしてパラメータを含むオブジェクト(例: {"sitekey": "your_site_key", "theme": "light"})。grecaptcha.render パラメータをご覧ください。 継承 対応するパラメータが指定されていない場合は、要素に既存の data-* 属性を使用します。パラメータは属性よりも優先されます。 |
grecaptcha.execute( opt_widget_id
)
|
reCAPTCHA チェックをプログラムで呼び出します。invisible reCAPTCHA が div にある場合に使用します。
使用できます。 opt_widget_id オプションのウィジェット ID。指定されていない場合のデフォルトは最初に作成されたウィジェット。 |
grecaptcha.リセット( opt_widget_id
)
|
reCAPTCHA ウィジェットをリセットします。 opt_widget_id オプションのウィジェット ID。指定されていない場合のデフォルトは最初に作成されたウィジェット。 |
grecaptcha.getResponse( opt_widget_id
)
|
reCAPTCHA ウィジェットのレスポンスを取得します。 opt_widget_id オプションのウィジェット ID。指定されていない場合のデフォルトは最初に作成されたウィジェット。 |
例
onload コールバック後の明示的なレンダリング
reCAPTCHA demo: Explicit render after an onload callback
クライアントサイドの検証後に invisible reCAPTCHA チャレンジを呼び出す。