Auf dieser Seite werden Methoden für die reCAPTCHA Enterprise JavaScript API und ihre Konfigurationsparameter beschrieben, mit denen Sie Webseiten mit einem Kästchen-Websiteschlüssel rendern können.
JavaScript API
In der folgenden Tabelle sind die Methoden der reCAPTCHA Enterprise JavaScript API aufgeführt.
| Methode | Beschreibung |
|---|---|
| grecaptcha.enterprise.render( container,
Parameter
|
Rendert den Container als reCAPTCHA-Widget und gibt die ID des neu erstellten Widgets zurück. Container Das HTML-Element zum Rendern des reCAPTCHA-Widgets. Geben Sie entweder die ID des Containers (String) oder das DOM-Element selbst an.
Parameter Ein Objekt, das Parameter als Schlüssel/Wert-Paare enthält, z. B. {"sitekey": "your_site_key", "theme": "light"}. |
|
grecaptcha.enterprise.reset(
opt_widget_id
|
Setzt das reCAPTCHA-Widget zurück. opt_widget_id [opt_widget_id] Optionale Widget-ID. Falls nicht angegeben, wird standardmäßig das erste erstellte Widget verwendet. |
|
grecaptcha.enterprise.getResponse
(
opt_widget_id
|
Ruft die Antwort für das reCAPTCHA-Widget ab. opt_widget_id [opt_widget_id] Optionale Widget-ID. Falls nicht angegeben, wird standardmäßig das erste erstellte Widget verwendet. |
Konfiguration
JavaScript-Ressourcenparameter (enterprise.js)
In der folgenden Tabelle sind die Parameter der JavaScript-Ressource (enterprise.js) aufgelistet, mit der du ein Widget automatisch oder explizit auf einer Webseite rendern kannst.
| Parameter | Wert | Beschreibung |
|---|---|---|
| onload | Optional. Der Name der Callback-Funktion, die ausgeführt werden soll, nachdem alle Abhängigkeiten geladen wurden. | |
| render | explizit onload |
Optional. Gibt an, ob das Widget explizit gerendert werden soll. Die Standardeinstellung ist "onload", mit der das Widget im ersten gefundenen Weitere Informationen zur Verwendung dieser Parameter finden Sie in den Beispielen unter RSS-Widget im Front-End rendern. |
| hl | Sprachcodes | Optional. Erzwingt das Rendern des Widgets in einer bestimmten Sprache. Erkennt automatisch die Sprache des Nutzers. |
g-recaptcha-Tag-Attribute und grecaptcha.enterprise.render-Parameter
In der folgenden Tabelle sind die g-recaptcha-Tag-Attribute und die zugehörigen grecaptcha.enterprise.render()-Parameter aufgeführt.
| g-recaptcha-Tag-Attribut | grecaptcha.enterprise.render-Parameter | Wert | Default | Beschreibung |
|---|---|---|---|---|
| Daten-Websiteschlüssel | sitekey | reCAPTCHA-Schlüssel | ||
| data-action | Aktion | Optional: String, die die aktuelle Aktion beschreibt. Derzeit nicht unterstützt. | ||
| data-theme | theme | dark light | light | Optional Das Farbdesign des Widgets. |
| data-size | size | compact normal | normal | Optional Die Größe des Widgets |
| data-tabindex | tabIndex | 0 | Optional Der Tabindex des Widgets und der Challenge. Wenn für andere Elemente auf Ihrer Seite Tabindex verwendet wird, sollte die Ansicht so gestaltet sein, dass die Nutzernavigation vereinfacht wird. | |
| data-callback | callback | Optional. Der Name Ihrer Callback-Funktion, die ausgeführt wird, wenn der Nutzer eine erfolgreiche Antwort sendet. Das Token g-recaptcha-response wird an Ihren Callback übergeben. |
||
| data-expired-callback | expired-callback | Optional. Der Name der Callback-Funktion, die ausgeführt wird, wenn die reCAPTCHA-Antwort abläuft und der Nutzer noch einmal bestätigen muss. | ||
| data-error-callback | error-callback | Optional. Der Name Ihrer Callback-Funktion, die ausgeführt wird, wenn reCAPTCHA einen Fehler (normalerweise eine Netzwerkverbindung) feststellt und erst fortgesetzt werden kann, wenn die Verbindung wiederhergestellt wurde. Wenn Sie hier eine Funktion angeben, müssen Sie den Nutzer selbst darüber informieren, dass er es noch einmal versuchen soll. |