JavaScript API-Referenz für reCAPTCHA Enterprise

Auf dieser Seite werden Methoden der reCAPTCHA Enterprise JavaScript API und ihre Konfigurationsparameter beschrieben, mit denen Sie die 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,
parameters
)

Rendert den Container als reCAPTCHA-Widget und gibt die ID des neu erstellten Widgets zurück.

Container

Das HTML-Element, das das reCAPTCHA-Widget rendert. 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

Optionale Widget-ID. Standardmäßig wird das erste erstellte Widget verwendet, wenn nichts angegeben ist.
grecaptcha.enterprise.execute (
opt_widget_id
)

Ruft programmatisch die reCAPTCHA Enterprise-Überprüfung auf.

opt_widget_id

Optionale Widget-ID. Standardmäßig wird das erste erstellte Widget verwendet, wenn nichts angegeben ist.

Weitere Informationen zur Verwendung dieser Methode finden Sie unter Punktzahlen-basierter Schlüssel in das Front-End einbinden.

grecaptcha.enterprise.ready ( )

Führt Ihre Funktion aus, wenn die reCAPTCHA-Bibliothek geladen wird.

Weitere Informationen zur Verwendung dieser Methode finden Sie unter Punktzahlen-basierter Schlüssel in das Front-End einbinden.

grecaptcha.enterprise.getResponse (
opt_widget_id
)

Ruft die Antwort für das reCAPTCHA-Widget ab.

opt_widget_id

Optionale Widget-ID. Standardmäßig wird das erste erstellte Widget verwendet, wenn nichts angegeben ist.

Konfiguration

JavaScript-Ressourcenparameter (enterprise.js)

In der folgenden Tabelle sind die Parameter der JavaScript-Ressource (enterprise.js) aufgeführt, mit der Sie ein Widget automatisch oder explizit auf einer Webseite rendern können.

Parameter Wert Beschreibung
onload Optional. Der Name Ihrer Callback-Funktion, die ausgeführt werden soll, sobald alle Abhängigkeiten geladen wurden.
render

Explizit

onload

Optional. Gibt an, ob das Widget explizit gerendert werden soll. Der Standardwert ist onload, wodurch das Widget im ersten gefundenen g-recaptcha-Tag gerendert wird.

Weitere Informationen zur Verwendung dieser Parameter finden Sie in den Beispielen unter reCAPTCHA-Widget im Front-End rendern.

hl Siehe 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 Tag-Attribute g-recaptcha und die entsprechenden grecaptcha.enterprise.render()-Parameter aufgeführt.

g-recaptcha-Tag-Attribut grecaptcha.enterprise.render Parameter Wert Default Beschreibung
data-sitekey sitekey reCAPTCHA-Schlüssel
data-action action Optional. String, die die aktuelle Aktion beschreibt. 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 andere Elemente auf Ihrer Seite tabindex verwenden, sollte sie so eingestellt werden, dass eine einfachere Navigation möglich ist.
data-callback callback Optional. Der Name Ihrer Callback-Funktion, die ausgeführt wird, wenn der Nutzer eine erfolgreiche Antwort sendet. Das g-recaptcha-response-Token wird an Ihren Callback übergeben.
data-expired-callback expired-callback Optional. Der Name Ihrer Callback-Funktion, die ausgeführt wird, wenn die reCAPTCHA-Antwort abläuft und der Nutzer sich noch einmal verifizieren muss.
data-error-callback error-callback Optional. Der Name Ihrer Callback-Funktion, die ausgeführt wird, wenn reCAPTCHA auf einen Fehler stößt (in der Regel die Netzwerkverbindung) und nicht fortfahren kann, bis die Verbindung wieder hergestellt ist. Wenn Sie hier eine Funktion angeben, sind Sie dafür verantwortlich, den Nutzer darüber zu informieren, dass er es noch einmal versuchen soll.