JavaScript API-Referenz für die Unterstützung von Zwischen-iFrames

Auf dieser Referenzseite wird die Intermediate iframe Support JavaScript API beschrieben, die von One Tap verwendet wird, um das Zwischen-Iframe in der nachfolgenden Benutzeroberfläche zu bearbeiten.

Informationen zur Verwendung von Zwischen-iFrames finden Sie im Leitfaden One Tap mit einem iFrame einbinden.

In der folgenden Tabelle sind alle verfügbaren Methoden und ihr Verhalten aufgeführt.

Methoden
verifyParentOrigin führt die Überprüfung des übergeordneten Ursprungs durch
notifyParentClose Benachrichtigt den übergeordneten Frame, dass der One Tap-UX-Ablauf übersprungen wird.
notifyParentDone benachrichtigt den übergeordneten Frame, dass der One Tap-UX-Ablauf abgeschlossen ist.
notifyParentResize benachrichtigt den übergeordneten Frame, die Größe des Zwischen-iFrames anzupassen.
notifyParentTapOutsideMode informiert den übergeordneten Frame darüber, ob der Zwischen-iFrame abgebrochen werden soll, wenn der Nutzer außerhalb des Zwischen-iFrames klickt.

JavaScript-Bibliothek zur Unterstützung von Zwischen-iFrames laden

Fügen Sie das folgende Code-Snippet in alle HTML-Seiten ein, auf denen der Zwischen-iFrame geladen werden soll:

<script src="https://accounts.google.com/gsi/intermediatesupport"></script>

Methode: google.accounts.id.intermediate.verifyParentOrigin

Die Methode google.accounts.id.intermediate.verifyParentOrigin führt die Überprüfung des übergeordneten Ursprungs durch. Hier ein Codebeispiel für die Methode:

google.accounts.id.intermediate.verifyParentOrigin(
    origins, verifiedCallback, verificationFailedCallback)

Das folgende Codebeispiel zeigt, wie die Benutzeroberfläche erst nach der Bestätigung des übergeordneten Ursprungs angezeigt wird:

<script>
  window.onload = () => {
    google.accounts.id.intermediate.verifyParentOrigin(
        "https://example.com", showUI, showError);
  };
</script>

In der folgenden Tabelle sind die Parameter aufgeführt:

Parameter
origins Die Ursprünge, die den Zwischen-iFrame einbetten dürfen.
verifiedCallback Die JavaScript-Callback-Methode, die ausgelöst wird, wenn der aktuelle übergeordnete Ursprung das Einbetten des Zwischen-iFrames zulassen darf.
verificationFailedCallback Die JavaScript-Callback-Methode, die ausgelöst wird, wenn der aktuelle übergeordnete Ursprung den Zwischen-iFrame nicht einbetten darf.

Ursprünge

Die Ursprünge, die den Zwischen-iFrame einbetten dürfen. Weitere Informationen finden Sie in der folgenden Tabelle:

Typ Erforderlich Beispiel
String, String-Array oder Funktion Optional allowed_parent_origin: "https://example.com"

In der folgenden Tabelle sind die unterstützten Werttypen und ihre Beschreibungen aufgeführt.

Werttypen
string Ein einzelner Domain-URI. „https://beispiel.de“
string array Ein Array von Domain-URIs. "https://news.example.com,https://local.example.com"

verifiedCallback

Dieses Feld ist eine JavaScript-Callback-Methode, die ausgelöst wird, wenn der aktuelle übergeordnete Ursprung das Zwischen-iFrame einbetten darf.

verificationFailedCallback

Dieses Feld ist eine JavaScript-Callback-Methode, die ausgelöst wird, wenn die Einbettung des Zwischen-iFrames durch den aktuellen übergeordneten Ursprung nicht zulässig ist.

Methode: google.accounts.id.intermediate.notifyParentClose

Die Methode google.accounts.id.intermediate.notifyParentClose benachrichtigt den übergeordneten Frame, das Zwischen-iFrame zu schließen, wenn der One Tap-Ablauf übersprungen wird. Hier ein Codebeispiel für die Methode:

google.accounts.id.intermediate.notifyParentClose()

Methode: google.accounts.id.intermediate.notifyParentDone

Die Methode google.accounts.id.intermediate.notifyParentClose benachrichtigt den übergeordneten Frame, das Zwischen-iFrame zu schließen und den Anmeldestatus zu aktualisieren. Hier ein Codebeispiel für die Methode:

google.accounts.id.intermediate.notifyParentDone()

Methode: google.accounts.id.intermediate.notifyParentResize

Die Methode google.accounts.id.intermediate.notifyParentResize benachrichtigt den übergeordneten Frame, die Größe des Zwischen-iFrames zu ändern. Hier ein Codebeispiel für die Methode:

google.accounts.id.intermediate.notifyParentResize(height)

Höhe

Die neue Höhe in Pixeln. Dieses Feld ist erforderlich. Der Wert muss eine nicht negative Zahl sein.

Wenn der Parameter „height“ größer als 0 ist, wird das Zwischen-iFrame auf die neue Höhe festgelegt. Wenn der Höhenparameter 0 ist, wird der Zwischen-iFrame unsichtbar. Ein ausgeblendetes iFrame ist nicht geschlossen. Sie kann später durch einen anderen Aufruf der Methode „resize“ angezeigt werden.

Methode: google.accounts.id.intermediate.notifyParentTapOutsideMode

Mit der Methode google.accounts.id.intermediate.notifyParentTapOutsideMode wird dem übergeordneten Frame mitgeteilt, ob der Zwischen-iFrame abgebrochen werden soll, wenn der Nutzer außerhalb des Zwischen-iFrames klickt. Hier ein Codebeispiel für die Methode:

google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)

Abbrechen

Dieser erforderliche boolesche Wert gibt an, ob das Zwischen-Iframe abgebrochen werden soll, wenn der Nutzer außerhalb des Zwischen-Iframes klickt.