Auf dieser Referenzseite wird die JavaScript API zur Unterstützung von Zwischen-iFrames beschrieben, mit der Sie den dazwischenliegenden iFrame in der nachfolgenden UX bearbeiten können.
Informationen zur Verwendung von Zwischen-iFrames finden Sie in der Anleitung 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 aus |
notifyParentClose |
informiert den übergeordneten Frame, dass der One Tap-UX-Ablauf übersprungen wird |
notifyParentDone |
informiert den übergeordneten Frame über den Abschluss des One Tap-UX-Vorgangs |
notifyParentResize |
informiert den übergeordneten Frame, die Größe des dazwischenliegenden iFrames anzupassen |
notifyParentTapOutsideMode |
informiert den übergeordneten Frame darüber, ob der Zwischen-iFrame abgebrochen werden soll, wenn der Nutzer auf eine Stelle außerhalb des Zwischen-iFrames klickt. |
JavaScript-Bibliothek für die Unterstützung von Iframes laden
Platzieren Sie das folgende Code-Snippet in allen HTML-Seiten, 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)
Das folgende Codebeispiel zeigt, wie die UI 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:
Parameter | |
---|---|
origins |
Die Ursprünge, die den dazwischenliegenden iFrame einbetten dürfen. |
verifiedCallback |
Die JavaScript-Callback-Methode, die ausgelöst wird, wenn der aktuelle übergeordnete Ursprung den dazwischenliegenden iFrame einbetten darf. |
verificationFailedCallback |
Die JavaScript-Callback-Methode, die ausgelöst wird, wenn der aktuelle übergeordnete Ursprung den dazwischenliegenden iFrame nicht einbetten darf. |
Ursprünge
Die Ursprünge, die den dazwischenliegenden iFrame einbetten dürfen. Weitere Informationen finden Sie in der folgenden Tabelle:
Typ | Erforderlich | Beispiel |
---|---|---|
String, Stringarray 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.beispiel.de,https://lokal.beispiel.de“ |
verifizierter Rückruf
Dieses Feld ist eine JavaScript-Callback-Methode, die ausgelöst wird, wenn der aktuelle übergeordnete Ursprung den dazwischenliegenden iFrame einbetten darf.
verificationFehlgeschlagenCallback
Dieses Feld ist eine JavaScript-Callback-Methode, die ausgelöst wird, wenn der aktuelle übergeordnete Ursprung den dazwischenliegenden iFrame nicht einbetten darf.
Methode: google.accounts.id.intermediate.notifyParentClose
Die Methode google.accounts.id.intermediate.notifyParentClose
benachrichtigt den übergeordneten Frame, den Zwischen-iFrame zu schließen, 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.notifyParentClose
weist den übergeordneten Frame an, den dazwischenliegenden 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
Über die Methode google.accounts.id.intermediate.notifyParentResize
wird der übergeordnete Frame benachrichtigt, dass die Größe des dazwischenliegenden iFrames angepasst werden soll. Hier ein Codebeispiel für die Methode:
google.accounts.id.intermediate.notifyParentResize(height)
height
Die neue Höhe in Pixel. Dies ist ein Pflichtfeld. Der Wert muss eine positive Zahl sein.
Wenn der Höhenparameter größer als 0 ist, wird der dazwischenliegende iFrame auf die neue Höhe gesetzt. Wenn der Höhenparameter 0 ist, wird der dazwischenliegende iFrame unsichtbar. Ein verborgener iFrame ist nicht geschlossen. Sie kann später durch einen anderen Aufruf der Methode zur Größenänderung angezeigt werden.
Methode: google.accounts.id.intermediate.notifyParentTapOutsideMode
Die Methode google.accounts.id.intermediate.notifyParentTapOutsideMode
informiert den übergeordneten Frame, ob der dazwischenliegende iFrame abgebrochen werden soll, wenn der Nutzer auf einen Bereich 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 auf eine Stelle außerhalb des Zwischen-iFrames klickt.