HTML API-Referenz für „Über Google anmelden“

Auf dieser Referenzseite wird die HTML Data Attribute API für „Über Google anmelden“ beschrieben. Sie können die API verwenden, um die Aufforderung zum schnellen Anmelden oder die Schaltfläche „Über Google anmelden“ auf Ihren Webseiten anzuzeigen.

Element mit der ID „g_id_onload“

Du kannst „Über Google anmelden“-Datenattribute in alle sichtbaren oder unsichtbaren Elemente wie <div> und <span> einfügen. Die einzige Anforderung besteht darin, dass die Element-ID auf g_id_onload festgelegt ist. Diese ID darf nicht für mehrere Elemente verwendet werden.

Datenattribute

In der folgenden Tabelle sind die Datenattribute mit ihren Beschreibungen aufgeführt:

Attributtypen

In den folgenden Abschnitten finden Sie Details zum Typ jedes Attributs und ein Beispiel.

data-client_id

Dieses Attribut ist die Client-ID Ihrer App, die in der Google Cloud Console gefunden und erstellt wird. Weitere Informationen finden Sie in der folgenden Tabelle:

data-auto_prompt

Mit diesem Attribut wird festgelegt, ob „One Tap“ angezeigt wird oder nicht. Der Standardwert ist true. Google One-Tippen wird nicht angezeigt, wenn dieser Wert false ist. Weitere Informationen finden Sie in der folgenden Tabelle:

data-auto_select

Mit diesem Attribut wird festgelegt, ob ein ID-Token automatisch und ohne Nutzerinteraktion zurückgegeben wird, wenn Ihre App nur von einer Google-Sitzung genehmigt wurde. Der Standardwert ist false. Weitere Informationen finden Sie in der folgenden Tabelle:

Daten-Anmelde-URI

Dieses Attribut ist der URI Ihres Anmeldeendpunkts.

Der Wert muss genau mit einem der autorisierten Weiterleitungs-URIs für den OAuth 2.0-Client übereinstimmen, die Sie in der API Console konfiguriert haben. Außerdem muss er unseren Validierungsregeln für Weiterleitungs-URIs entsprechen.

Dieses Attribut kann weggelassen werden, wenn die aktuelle Seite Ihre Anmeldeseite ist. In diesem Fall werden die Anmeldedaten standardmäßig auf dieser Seite gepostet.

Die Antwort mit den Anmeldedaten des ID-Tokens wird an Ihren Anmeldeendpunkt gesendet, wenn keine Rückruffunktion definiert ist und ein Nutzer auf die Schaltfläche „Über Google anmelden“ oder „One Tap“ klickt oder eine automatische Anmeldung erfolgt.

Weitere Informationen finden Sie in der folgenden Tabelle:

Ihr Anmeldeendpunkt muss POST-Anfragen verarbeiten, die einen credential-Schlüssel mit einem ID-Tokenwert im Text enthalten.

Das folgende Beispiel zeigt eine Anfrage an deinen Anmeldeendpunkt:

POST /login HTTP/1.1
Host: www.example.com
Content-Type: application/x-www-form-urlencoded

credential=ID_TOKEN

data-callback

Dieses Attribut ist der Name der JavaScript-Funktion, die das zurückgegebene ID-Token verarbeitet. Weitere Informationen finden Sie in der folgenden Tabelle:

Hierfür kann eines der Attribute data-login_uri und data-callback verwendet werden. Sie hängt von den folgenden Komponenten- und UX-Modus-Konfigurationen ab:

• Das Attribut data-login_uri ist für den UX-Modus der Schaltfläche „Über Google anmelden“ redirect erforderlich. Dabei wird das Attribut data-callback ignoriert.

• Eines dieser beiden Attribute muss für Google One Tap und die Schaltfläche „Über Google anmelden“ popup im UX-Modus festgelegt werden. Wenn beide festgelegt sind, hat das data-callback-Attribut Vorrang.

JavaScript-Funktionen innerhalb eines Namespace werden von der HTML API nicht unterstützt. Verwenden Sie stattdessen eine globale JavaScript-Funktion ohne Namensbereich. Verwenden Sie z. B. mylibCallback anstelle von mylib.callback.

data-native_login_uri

Dieses Attribut ist die URL des Endpunkts Ihres Passwort-Anmeldedaten-Handlers. Wenn Sie entweder das Attribut data-native_login_uri oder das Attribut data-native_callback festlegen, greift die JavaScript-Bibliothek bei fehlender Google-Sitzung auf den nativen Anmeldedaten-Manager zurück. Sie können nicht gleichzeitig die Attribute data-native_callback und data-native_login_uri festlegen. Weitere Informationen finden Sie in der folgenden Tabelle:

data-native_callback

Dieses Attribut ist der Name der JavaScript-Funktion, die die Anmeldedaten für das Passwort verarbeitet, die vom nativen Anmeldedaten-Manager des Browsers zurückgegeben werden. Wenn Sie entweder das data-native_login_uri-Attribut oder das data-native_callback-Attribut festlegen, greift die JavaScript-Bibliothek bei fehlender Google-Sitzung auf den nativen Anmeldedaten-Manager zurück. Sie können nicht sowohl data-native_callback als auch data-native_login_uri festlegen. Weitere Informationen finden Sie in der folgenden Tabelle:

JavaScript-Funktionen innerhalb eines Namespace werden von der HTML API nicht unterstützt. Verwenden Sie stattdessen eine globale JavaScript-Funktion ohne Namensbereich. Verwenden Sie beispielsweise mylibCallback anstelle von mylib.callback.

data-native_id_param

Wenn Sie die Anmeldedaten für das Passwort an den Endpunkt des Passwort-Anmeldedaten-Handlers senden, können Sie den Parameternamen für das Feld credential.id angeben. Der Standardname ist email. Weitere Informationen finden Sie in der folgenden Tabelle:

data-native_password_param

Wenn Sie die Anmeldedaten an den Handler-Endpunkt für Passwort-Anmeldedaten senden, können Sie den Parameternamen für den Wert credential.password angeben. Der Standardname ist password. Weitere Informationen findest du in der folgenden Tabelle:

data-cancel_on_tap_outside

Dieses Attribut legt fest, ob die One Tap-Anfrage abgebrochen wird, wenn der Nutzer auf eine Stelle außerhalb der Aufforderung klickt. Der Standardwert ist true. Wenn Sie sie deaktivieren möchten, legen Sie den Wert auf false fest. Weitere Informationen finden Sie in der folgenden Tabelle:

data-prompt_parent_id

Mit diesem Attribut wird die DOM-ID des Containerelements festgelegt. Ist die Richtlinie nicht konfiguriert, wird oben rechts im Fenster die Aufforderung „One Tap“ angezeigt. Weitere Informationen finden Sie in der folgenden Tabelle:

data-skip_prompt_cookie

Dieses Attribut überspringt One Tap, wenn das angegebene Cookie einen nicht leeren Wert hat. Weitere Informationen finden Sie in der folgenden Tabelle:

data-nonce

Dieses Attribut ist ein zufälliger String, der vom ID-Token verwendet wird, um Replay-Angriffe zu verhindern. Weitere Informationen finden Sie in der folgenden Tabelle:

Die Länge der Nonce ist auf die maximale JWT-Größe beschränkt, die von Ihrer Umgebung unterstützt wird, sowie auf die individuellen HTTP-Größenbeschränkungen von Browsern und Servern.

data-context

Mit diesem Attribut wird der Text des Titels und der Meldungen geändert, die im One-Tap-Prompt angezeigt werden. Weitere Informationen finden Sie in der folgenden Tabelle:

In der folgenden Tabelle sind alle verfügbaren Kontexte und ihre Beschreibungen aufgeführt:

Datenmoment_Callback

Dieses Attribut ist der Funktionsname des Listeners für Benachrichtigungen zum Status der Benutzeroberfläche. Weitere Informationen finden Sie im Hilfeartikel zum Datentyp PromptMomentNotification.

Weitere Informationen finden Sie in der folgenden Tabelle:

JavaScript-Funktionen innerhalb eines Namespace werden von der HTML API nicht unterstützt. Verwenden Sie stattdessen eine globale JavaScript-Funktion ohne Namensbereich. Verwenden Sie z. B. mylibCallback anstelle von mylib.callback.

data-state_cookie_domain

Wenn Sie One Tap in einer übergeordneten Domain und ihren Subdomains anzeigen möchten, übergeben Sie die übergeordnete Domain an dieses Attribut, damit ein einzelnes Cookie mit freigegebenen Status verwendet wird. Weitere Informationen finden Sie in der folgenden Tabelle:

data-ux_mode

Dieses Attribut legt den UX-Vorgang für die Schaltfläche „Über Google anmelden“ fest. Der Standardwert ist popup. Dieses Attribut hat keine Auswirkungen auf die One Tap-UX. Weitere Informationen finden Sie in der folgenden Tabelle:

In der folgenden Tabelle sind die verfügbaren UX-Modi und ihre Beschreibungen aufgeführt.

data-allowed_parent_origin

Die Ursprünge, die den Zwischen-iFrame einbetten dürfen. Wenn dieses Attribut vorhanden ist, wird One Tap im Zwischen-iFrame-Modus ausgeführt. Weitere Informationen finden Sie in der folgenden Tabelle:

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

Wenn der Wert des Attributs data-allowed_parent_origin ungültig ist, schlägt die One Tap-Initialisierung des iFrame-Zwischenmodus fehl und wird beendet.

Platzhalterpräfixe werden ebenfalls unterstützt. Beispiel: "https://*.example.com" stimmt mit example.com und seinen Subdomains auf allen Ebenen überein (z. B. news.example.com, login.news.example.com). Beachten Sie bei der Verwendung von Platzhaltern Folgendes:

• Musterstrings dürfen nicht nur aus einem Wildcard-Zeichen und einer Top-Level-Domain bestehen. https://*.com und https://*.co.uk sind beispielsweise ungültig. Wie oben erwähnt, entspricht "https://*.example.com" example.com und seinen Subdomains. Sie können auch eine durch Kommas getrennte Liste verwenden, um zwei unterschiedliche Domains anzugeben. Beispiel: "https://example1.com,https://*.example2.com" stimmt mit den Domains example1.com, example2.com und den Subdomains von example2.com überein.
• Domains mit Platzhaltern müssen mit dem sicheren Protokoll „https://“ beginnen. Daher gilt "*.example.com" als ungültig.

data-intermediate_iframe_close_callback

Überschreibt das standardmäßige iFrame-Verhalten, wenn Nutzer One Tap manuell schließen, indem sie auf der One Tap-Benutzeroberfläche auf die Schaltfläche „X“ tippen. Standardmäßig wird der Zwischen-iframe sofort aus dem DOM entfernt.

Das Feld data-intermediate_iframe_close_callback wirkt sich nur im Zwischen-Iframe-Modus aus. Außerdem wirkt sich die Änderung nur auf den Zwischen-iframe aus, nicht auf den One Tap-iframe. Die One Tap-UI wird entfernt, bevor der Callback aufgerufen wird.

JavaScript-Funktionen innerhalb eines Namespace werden von der HTML API nicht unterstützt. Verwenden Sie stattdessen eine globale JavaScript-Funktion ohne Namensbereich. Verwenden Sie beispielsweise mylibCallback anstelle von mylib.callback.

data-itp_support

In diesem Feld wird festgelegt, ob die aktualisierte One Tap-Benutzeroberfläche in Browsern aktiviert werden soll, die Intelligent Tracking Prevention (ITP) unterstützen. Der Standardwert ist false. Weitere Informationen finden Sie in der folgenden Tabelle:

data-login_hint

Wenn durch deine Anwendung im Voraus ermittelt wird, welcher Nutzer angemeldet sein muss, kann sie Google einen Anmeldehinweis senden. Bei Erfolg wird die Kontoauswahl übersprungen. Zulässige Werte sind eine E-Mail-Adresse oder ein sub Feld für das ID-Token.

Weitere Informationen finden Sie in der OpenID Connect-Dokumentation für login_hint.

data-hd

Wenn ein Nutzer mehrere Konten hat und sich nur mit seinem Workspace-Konto anmelden soll, verwenden Sie diesen Parameter, um Google einen Domainnamenshinweis zu geben. Wenn der Vorgang erfolgreich war, sind die Nutzerkonten, die bei der Kontoauswahl angezeigt werden, auf die angegebene Domain beschränkt. Platzhalterwert: * bietet dem Nutzer nur Workspace-Konten an und schließt Privatnutzerkonten (nutzer@gmail.com) bei der Kontoauswahl aus.

Weitere Informationen finden Sie in der OpenID Connect-Dokumentation für hd.

data-use_fedcm_for_prompt

Dem Browser erlauben, Aufforderungen zur Nutzeranmeldung zu steuern und den Anmeldevorgang zwischen Ihrer Website und Google zu vermitteln Die Standardeinstellung ist "false". Weitere Informationen finden Sie auf der Seite Zu FedCM migrieren.

data-enable_redirect_uri_validation

Aktivieren Sie den Weiterleitungsfluss für Schaltflächen, der den Validierungsregeln für Weiterleitungs-URIs entspricht.

Element mit der Klasse „g_id_signin“

Wenn Sie dem class-Attribut eines Elements g_id_signin hinzufügen, wird das Element als Schaltfläche „Über Google anmelden“ gerendert.

Sie können auf derselben Seite mehrere Schaltflächen für die Anmeldung über Google rendern. Für jede Schaltfläche können eigene visuelle Einstellungen festgelegt werden. Die Einstellungen werden durch die folgenden Datenattribute definiert.

Attribute für visuelle Daten

In der folgenden Tabelle sind die Attribute für visuelle Daten und ihre Beschreibungen aufgeführt:

Attributtypen

Die folgenden Abschnitte enthalten Details zum jeweiligen Attributtyp und ein Beispiel.

Datentyp

Der Schaltflächentyp. Der Standardwert ist standard. Weitere Informationen finden Sie in der folgenden Tabelle:

In der folgenden Tabelle sind alle verfügbaren Schaltflächentypen und ihre Beschreibungen aufgeführt:

Typ
standard
icon

data-theme

Das Schaltflächendesign. Der Standardwert ist outline. Weitere Informationen finden Sie in der folgenden Tabelle:

In der folgenden Tabelle sind die verfügbaren Themen und ihre Beschreibungen aufgeführt:

Design
outline
filled_blue
filled_black

data-size

Die Größe der Schaltfläche. Der Standardwert ist large. Weitere Informationen finden Sie in der folgenden Tabelle:

In der folgenden Tabelle sind die verfügbaren Schaltflächengrößen und ihre Beschreibungen aufgeführt.

Größe
large
medium
small

data-text

Der Schaltflächentext. Der Standardwert ist signin_with. Es gibt keine visuellen Unterschiede beim Text von Symbolschaltflächen mit unterschiedlichen data-text-Attributen. Die einzige Ausnahme ist, wenn der Text für die Barrierefreiheit vorgelesen wird.

Weitere Informationen finden Sie in der folgenden Tabelle:

In der folgenden Tabelle sind die verfügbaren Schaltflächentexte und ihre Beschreibungen aufgeführt:

Text
signin_with
signup_with
continue_with
signin

data-shape

Die Form der Schaltfläche. Der Standardwert ist rectangular. Weitere Informationen finden Sie in der folgenden Tabelle:

In der folgenden Tabelle sind die verfügbaren Schaltflächenformen und ihre Beschreibungen aufgeführt:

Form
rectangular
pill
circle
square

Datenlogo-Ausrichtung

Die Ausrichtung des Google-Logos. Der Standardwert ist left. Dieses Attribut gilt nur für den standard-Schaltflächentyp. Weitere Informationen finden Sie in der folgenden Tabelle:

In der folgenden Tabelle sind die verfügbaren Ausrichtungen und ihre Beschreibungen aufgeführt:

logo_alignment
left
center

data-width

Die minimale Breite der Schaltfläche in Pixeln. Die maximale Breite beträgt 400 Pixel.

Weitere Informationen finden Sie in der folgenden Tabelle:

data-locale

Optional. Der Schaltflächentext wird in der angegebenen Sprache angezeigt. Andernfalls wird der Standardtext aus dem Google-Konto oder den Browsereinstellungen des Nutzers verwendet. Fügen Sie beim Laden der Bibliothek den Parameter hl und den Sprachcode zur src-Anweisung hinzu, z. B.: gsi/client?hl=<iso-639-code>.

Ist die Richtlinie nicht konfiguriert, wird die Standardsprache des Browsers oder die Einstellung des Nutzers der Google-Sitzung verwendet. Daher sehen verschiedene Nutzer möglicherweise unterschiedliche Versionen von lokalisierten Schaltflächen, möglicherweise auch in unterschiedlichen Größen.

Weitere Informationen finden Sie in der folgenden Tabelle:

data-click_listener

Mit dem Attribut data-click_listener können Sie eine JavaScript-Funktion definieren, die aufgerufen wird, wenn auf die Schaltfläche „Über Google anmelden“ geklickt wird.

  <script>
    function onClickHandler(){
      console.log("Sign in with Google button clicked...")
    }
  </script>
  .....
  <div class="g_id_signin"
      data-size="large"
      data-theme="outline"
      data-click_listener="onClickHandler">
  </div>

In diesem Beispiel wird die Meldung Über Google anmelden-Schaltfläche wurde angeklickt in der Konsole protokolliert, wenn auf die Schaltfläche „Über Google anmelden“ geklickt wird.

data-state

Optional: Da auf derselben Seite mehrere „Über Google anmelden“-Schaltflächen gerendert werden können, kannst du jeder Schaltfläche einen eindeutigen String zuweisen. Derselbe String wird zusammen mit dem ID-Token zurückgegeben, damit Sie erkennen können, auf welche Schaltfläche der Nutzer geklickt hat, um sich anzumelden.

Weitere Informationen finden Sie in der folgenden Tabelle:

Serverseitige Integration

Ihre serverseitigen Endpunkte müssen die folgenden HTTP-POST-Anfragen verarbeiten.

Der Handler-Endpunkt des ID-Tokens

Der Endpunkt des ID-Token-Handlers verarbeitet das ID-Token. Je nach Status des entsprechenden Kontos kannst du den Nutzer anmelden und ihn entweder auf eine Registrierungsseite oder auf eine Seite zur Kontoverknüpfung weiterleiten, um weitere Informationen zu erhalten.

Die HTTP-Anfrage POST enthält die folgenden Informationen:

Anmeldedaten

Nach der Dekodierung sieht das ID-Token in etwa so aus:

header
{
  "alg": "RS256",
  "kid": "f05415b13acb9590f70df862765c655f5a7a019e", // JWT signature
  "typ": "JWT"
}
payload
{
  "iss": "https://accounts.google.com", // The JWT's issuer
  "nbf":  161803398874,
  "aud": "314159265-pi.apps.googleusercontent.com", // Your server's client ID
  "sub": "3141592653589793238", // The unique ID of the user's Google Account
  "hd": "gmail.com", // If present, the host domain of the user's GSuite email address
  "email": "elisa.g.beckett@gmail.com", // The user's email address
  "email_verified": true, // true, if Google has verified the email address
  "azp": "314159265-pi.apps.googleusercontent.com",
  "name": "Elisa Beckett",
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/e2718281828459045235360uler",
  "given_name": "Eliza",
  "family_name": "Beckett",
  "iat": 1596474000, // Unix timestamp of the assertion's creation time
  "exp": 1596477600, // Unix timestamp of the assertion's expiration time
  "jti": "abc161803398874def"
}

Das Feld sub ist eine global eindeutige Kennung für das Google-Konto. Verwenden Sie nur das Feld sub als Kennung für den Nutzer, da es für alle Google-Konten eindeutig ist und nie wiederverwendet wird. Verwenden Sie keine E-Mail-Adresse als Kennung, da ein Google-Konto zu verschiedenen Zeitpunkten mehrere E-Mail-Adressen haben kann.

Anhand der Felder email, email_verified und hd können Sie feststellen, ob Google eine E-Mail-Adresse hostet und für sie maßgebend ist. Wenn Google berechtigt ist, wird bestätigt, dass der Nutzer der rechtmäßige Kontoinhaber ist.

Fälle, in denen Google maßgebend ist:

• email hat das Suffix @gmail.com. Dies ist ein Gmail-Konto.
• Wenn email_verified wahr ist und hd festgelegt ist, handelt es sich um ein Google Workspace-Konto.

Nutzer können sich für Google-Konten registrieren, ohne Gmail oder Google Workspace zu verwenden. Wenn email kein @gmail.com-Suffix enthält und hd nicht vorhanden ist, ist Google nicht autoritativ. Es werden dann Passwort- oder andere Methoden zur Identitätsbestätigung empfohlen, um den Nutzer zu bestätigen. email_verified kann auch wahr sein, da Google den Nutzer ursprünglich bei der Erstellung des Google-Kontos bestätigt hat. Die Inhaberschaft des E-Mail-Kontos des Drittanbieters hat sich jedoch möglicherweise geändert.

Das Feld exp zeigt die Ablaufzeit für die Überprüfung des Tokens auf Ihrer Serverseite an. Für das ID-Token, das über „Über Google anmelden“ abgerufen wird, beträgt sie eine Stunde. Sie müssen das Token vor Ablauf bestätigen. Verwenden Sie exp nicht für die Sitzungsverwaltung. Ein abgelaufenes ID-Token bedeutet nicht, dass der Nutzer abgemeldet ist. Ihre Anwendung ist für die Sitzungsverwaltung Ihrer Nutzer verantwortlich.

select_by

In der folgenden Tabelle sind die möglichen Werte für das Feld select_by aufgeführt. Der Schaltflächentyp, die Sitzung und der Einwilligungsstatus werden verwendet, um den Wert festzulegen.

• Der Nutzer hat entweder die Schaltfläche „One Tap“ oder „Über Google anmelden“ gedrückt oder die berührungslose automatische Anmeldung verwendet.

• Es wurde eine vorhandene Sitzung gefunden oder der Nutzer hat sich zum Erstellen einer neuen Sitzung in einem Google-Konto angemeldet.

• Bevor der Nutzer Anmeldedaten für ID-Tokens für Ihre App freigibt, muss er

  • die Schaltfläche „Bestätigen“ gedrückt hat, um seine Einwilligung zur Weitergabe von Anmeldedaten zu erteilen, oder
  • die zuvor ihre Einwilligung erteilt und mit „Konto auswählen“ ein Google-Konto ausgewählt haben.

Der Wert dieses Felds ist auf einen der folgenden Typen festgelegt:

Bundesstaat

Dieser Parameter wird nur definiert, wenn der Nutzer zum Anmelden auf die Schaltfläche „Über Google anmelden“ klickt und das data-state-Attribut der angeklickten Schaltfläche angegeben ist. Der Wert dieses Felds entspricht dem Wert, den Sie im Attribut data-state der Schaltfläche angegeben haben.

Da auf einer Seite mehrere „Über Google anmelden“-Schaltflächen gerendert werden können, können Sie jeder Schaltfläche einen eindeutigen String zuweisen. Mit diesem Parameter state können Sie also ermitteln, auf welche Schaltfläche der Nutzer geklickt hat, um sich anzumelden.

Endpunkt für den Passwort-Anmeldedaten-Handler

Der Endpunkt des Passwort-Anmeldedaten-Handlers verarbeitet Passwort-Anmeldedaten, die vom nativen Anmeldedaten-Manager abgerufen werden.

Die HTTP-POST-Anfrage enthält die folgenden Informationen: