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

Auf dieser Referenzseite wird die JavaScript API für die Unterstützung von Zwischen-iFrames beschrieben, die von One Tap verwendet wird, um den Zwischen-iFrame in der nachfolgenden UX zu bearbeiten.

Informationen zur Verwendung von Zwischen-iFrames finden Sie im Leitfaden One-Tap-Anmeldung über einen iFrame einbinden.

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

JavaScript-Bibliothek für die Unterstützung von Zwischen-iFrames laden

Fügen Sie das folgende Code-Snippet auf allen HTML-Seiten ein, auf denen Sie den Zwischen-iFrame laden möchten:

<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)

Im folgenden Codebeispiel wird gezeigt, wie die Benutzeroberfläche erst angezeigt wird, nachdem der übergeordnete Ursprung bestätigt wurde:

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

In der folgenden Tabelle sind die Parameter aufgeführt:

origins

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

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

verifiedCallback

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

verificationFailedCallback

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

Methode: google.accounts.id.intermediate.notifyParentClose

Die Methode google.accounts.id.intermediate.notifyParentClose benachrichtigt den übergeordneten Frame, dass der Zwischen-iFrame geschlossen werden soll, wenn der One Tap-UX-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.notifyParentDone benachrichtigt den übergeordneten Frame, den 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 anzupassen. 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 der Zwischen-iFrame auf die neue Höhe festgelegt. Wenn der height-Parameter 0 ist, wird der Zwischen-iFrame unsichtbar. Ein ausgeblendeter iFrame ist nicht geschlossen. Sie kann später durch einen weiteren Aufruf der Methode „resize“ angezeigt werden.

Methode: google.accounts.id.intermediate.notifyParentTapOutsideMode

Mit der Methode google.accounts.id.intermediate.notifyParentTapOutsideMode wird der übergeordnete Frame darüber informiert, 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 der Zwischen-Iframe abgebrochen werden soll, wenn der Nutzer außerhalb des Zwischen-Iframes klickt.