Ta strona referencyjna opisuje interfejs API logowania jednokrotnego. Za pomocą tego interfejsu API można wyświetlać na stronie internetowej monit jednym kliknięciem lub przycisk Zaloguj się przez Google.
Metoda: google.accounts.id.initialize
Metoda google.accounts.id.initialize
inicjuje klienta usługi Zaloguj się przez Google na podstawie obiektu konfiguracji. Oto przykładowy kod metody:
google.accounts.id.initialize(IdConfiguration)
Ten przykładowy kod implementuje metodę google.accounts.id.initialize
z funkcją onload
:
<script>
window.onload = function () {
google.accounts.id.initialize({
client_id: 'YOUR_GOOGLE_CLIENT_ID',
callback: handleCredentialResponse
});
google.accounts.id.prompt();
};
</script>
Metoda google.accounts.id.initialize
tworzy instancję klienta Zaloguj się przez Google, której można domyślnie używać we wszystkich modułach na tej samej stronie internetowej.
- Wywoływanie metody
google.accounts.id.initialize
jest konieczne tylko raz, nawet jeśli korzystasz z wielu modułów (takich jak 1 kliknięcie, spersonalizowany przycisk, unieważnienie itp.) na tej samej stronie internetowej. - Jeśli wywołasz metodę
google.accounts.id.initialize
wiele razy, zostaną zapamiętane i użyte tylko konfiguracje z ostatniego wywołania.
Konfiguracje resetujesz za każdym razem, gdy wywołujesz metodę google.accounts.id.initialize
, a wszystkie kolejne metody na tej samej stronie będą natychmiast używać nowych konfiguracji.
Typ danych: IdConfiguration
W tej tabeli podano pola i opisy typu danych IdConfiguration
:
Pole | |
---|---|
client_id |
Identyfikator klienta aplikacji |
auto_select |
Włącza automatyczny wybór. |
callback |
Funkcja JavaScript, która obsługuje tokeny identyfikatora. Użyj tego atrybutu, aby wybrać Google One i przycisk Zaloguj się przez Google popup . |
login_uri |
Adres URL punktu końcowego logowania. Przycisk „Zaloguj się przez Google”
redirect w trybie UX używa tego atrybutu. |
native_callback |
Funkcja JavaScript, która obsługuje dane logowania do hasła. |
cancel_on_tap_outside |
Anuluje je, jeśli użytkownik nie kliknie potwierdzenia. |
prompt_parent_id |
Identyfikator DOM elementu kontenera One Tap |
nonce |
losowy ciąg tokenów tożsamości, |
context |
Tytuł i słowa w powiadomieniu jednym dotknięciem |
state_cookie_domain |
Jeśli musisz wywołać jedno kliknięcie w domenie nadrzędnej i jej subdomenach, przekaż tę domenę do tego pola, tak aby móc używać jednego udostępnionego pliku cookie. |
ux_mode |
Proces logowania – przycisk Zaloguj się przez Google |
allowed_parent_origin |
Źródła, które mogą umieszczać pośredni element iframe. Jeśli to pole jest widoczne, kliknięcie zostanie uruchomione w pośrednim trybie iframe. |
intermediate_iframe_close_callback |
Zastępuje domyślne pośrednie działanie elementu iframe po ręcznym zamknięciu subskrypcji jednym dotknięciem. |
itp_support |
Włącza ulepszone jednym dotknięciem w przeglądarkach ITP. |
client_id
To pole to identyfikator klienta Twojej aplikacji, który możesz znaleźć i utworzyć w Google Developers Console. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Tak | client_id: "CLIENT_ID.apps.googleusercontent.com" |
automatyczny wybór
To pole określa, czy token identyfikatora jest automatycznie zwracany bez interakcji użytkownika, gdy tylko jedna sesja Google, która została wcześniej zatwierdzona przez Twoją aplikację. Wartością domyślną jest false
. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
wartość logiczna | Opcjonalnie | auto_select: true |
wywołanie zwrotne
To pole zawiera funkcję JavaScript, która obsługuje token identyfikatora zwracany w komunikacie o pierwszym kliknięciu lub w wyskakującym okienku. Ten atrybut jest wymagany, jeśli używa się trybu popup
One Tap lub Zaloguj się przez Google.
Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
funkcja | Wymagany w przypadku jednego kliknięcia i trybu UX popup |
callback: handleResponse |
login_uri
Ten atrybut to identyfikator URI punktu końcowego logowania. Może zostać pominięty, jeśli bieżąca strona jest Twoją stroną logowania. W takim przypadku dane logowania są na niej domyślnie publikowane.
Odpowiedź dotycząca danych logowania tokena tożsamości jest opublikowana w punkcie końcowym logowania, gdy użytkownik kliknie przycisk Zaloguj się przez Google i zostanie użyty tryb UX.
Więcej informacji znajdziesz w tabeli poniżej:
Typ | Opcjonalnie | Przykład |
---|---|---|
URL | Domyślnie przywraca identyfikator URI bieżącej strony lub określoną przez Ciebie wartość. Używana tylko wtedy, gdy ustawiona jest wartość ux_mode: "redirect" . |
login_uri="https://www.example.com/login" |
Punkt końcowy logowania musi obsługiwać żądania POST zawierające klucz credential
z wartością tokena identyfikatora w treści.
Oto przykładowe żądanie przesłane do punktu końcowego logowania:
POST /login HTTP/1.1
Host: www.example.com
Content-Type: application/x-www-form-urlencoded
credential=ID_TOKEN
natywne_callback
To pole zawiera nazwę funkcji JavaScript, która obsługuje dane logowania do haseł zwrócone przez natywnego menedżera danych logowania w przeglądarce. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
funkcja | Opcjonalnie | native_callback: handleResponse |
anuluj_poza_ekranem
To pole określa, czy użytkownik ma anulować żądanie jednym dotknięciem, jeśli użytkownik opuści pytanie. Wartością domyślną jest true
. Możesz go wyłączyć, ustawiając jego wartość na false
. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
wartość logiczna | Opcjonalnie | cancel_on_tap_outside: false |
potwierdzenie_nadrzędnego_identyfikatora
Ten atrybut ustawia identyfikator DOM elementu kontenera. Jeśli zasada nie jest skonfigurowana, w prawym górnym rogu okna wyświetla się potwierdzenie jednym dotknięciem. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | prompt_parent_id: 'parent_id' |
liczba jednorazowa
To pole jest losowym ciągiem używanym przez token identyfikatora, aby zapobiegać ponownym atakom. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | nonce: "biaqbm70g23" |
Długość jednorazowa jest ograniczona do maksymalnej wielkości tokena JWT obsługiwanego przez Twoje środowisko oraz ograniczeń dotyczących rozmiaru poszczególnych przeglądarek i serwerów.
sytuacja
Tekst w tym polu zmienia tekst tytułu i wiadomości w powiadomieniu jednokrotnym. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | context: "use" |
W tabeli poniżej znajdziesz dostępne konteksty i ich opisy:
Kontekst | |
---|---|
signin |
"Zaloguj się przez Google" |
signup |
"Zarejestruj się przez Google |
use |
"Używaj z Google; |
state_cookie_domain
Jeśli w domenie nadrzędnej i jej subdomenach chcesz wyświetlać 1 kliknięcie, przekaż domenę nadrzędną do tego pliku, aby móc używać 1 pliku cookie ze stanem udostępniania. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | state_cookie_domain: "example.com" |
tryb_ux
Korzystając z tego pola, możesz skonfigurować interfejs UX używany przez przycisk Zaloguj się przez Google. Wartością domyślną jest popup
. Ten atrybut nie ma wpływu na OneUX. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | ux_mode: "redirect" |
W tabeli poniżej znajdziesz dostępne tryby UX i ich opisy.
Tryb UX | |
---|---|
popup |
Wykonuje proces UX w wyskakującym okienku. |
redirect |
Wykonuje proces UX podczas logowania na całą stronę. |
dozwolone_źródło_nadrzędne
Źródła, które mogą umieszczać pośredni element iframe. Jeśli to pole jest widoczne, kliknięcie zostanie uruchomione w pośrednim trybie iframe. Więcej informacji znajdziesz w tej tabeli:
Typ | Wymagane | Przykład |
---|---|---|
Ciąg znaków lub tablica ciągu | Opcjonalnie | allowed_parent_origin: "https://example.com" |
Poniższa tabela zawiera listę obsługiwanych typów wartości i ich opisów.
Typy wartości | ||
---|---|---|
string |
Identyfikator URI pojedynczej domeny. | "https://example.com" |
string array |
Tablica identyfikatorów URI domeny. | ["https://news.example.com", "https://local.example.com"] |
Obsługiwane są też prefiksy z symbolami wieloznacznymi. Na przykład reguła "https://*.example.com"
pasuje do domeny example.com
i jej subdomen na wszystkich poziomach (np.news.example.com
, login.news.example.com
). O czym należy pamiętać, używając symboli wieloznacznych:
- Ciągi tekstowe wzorców nie mogą składać się tylko z symbolu wieloznacznego i domeny najwyższego poziomu. Na przykład zapis
https://*.com
ihttps://*.co.uk
jest nieprawidłowy. Jak wspomniano powyżej, tag"https://*.example.com"
będzie pasować do atrybutuexample.com
i jego subdomen. Możesz też użyć tablicy do reprezentowania 2 różnych domen. Na przykład reguła["https://example1.com", "https://*.example2.com"]
będzie pasować do domenexample1.com
,example2.com
i subdomenexample2.com
- Domeny zawierające symbole wieloznaczne muszą zaczynać się od bezpiecznego schematu https://. Adres
"*.example.com"
zostanie uznany za nieprawidłowy.
Jeśli wartość w polu allowed_parent_origin
jest nieprawidłowa, inicjowanie jednego kliknięcia pośredniego trybu iframe zakończy się niepowodzeniem i zostanie zatrzymane.
Pośredni element_iframe_close_callback
Zastępuje domyślny pośredni element iframe przy ręcznym zamykaniu strony jednym dotknięciem przycisku 'X' w interfejsie One Tap. Domyślnym działaniem jest natychmiastowe usunięcie pośredniego elementu iframe z elementu DOM.
Pole intermediate_iframe_close_callback
działa tylko w pośrednim trybie elementu iframe. Ma to wpływ tylko na pośredni element iframe, a nie na pojedynczy element iframe. Interfejs One Touch jest usuwany przed wywołaniem zwrotnym.
Typ | Wymagane | Przykład |
---|---|---|
funkcja | Opcjonalnie | intermediate_iframe_close_callback: logBeforeClose |
taka_pomoc
To pole określa, czy w przeglądarkach obsługujących technologię Intelligent Tracking Prevention (ITP) należy włączyć uaktualniony interfejs UX One. Wartością domyślną jest false
. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
wartość logiczna | Opcjonalnie | itp_support: true |
Metoda: google.accounts.id.prompt
Metoda google.accounts.id.prompt
wyświetla pytanie o uruchomienie jednym dotknięciem lub menedżer natywnych danych logowania w przeglądarce po wywołaniu metody initialize()
.
Oto przykładowy kod metody:
google.accounts.id.prompt(/**
@type{(function(!PromptMomentNotification):void)=} */ momentListener)
Metoda prompt()
jest zazwyczaj wywoływana podczas wczytywania strony. Ze względu na stan sesji i ustawienia użytkownika po stronie Google interfejs One Touch może nie być wyświetlany. Aby otrzymywać powiadomienia o stanie interfejsu w różnych momentach, przekaż funkcję odbierania powiadomień o stanie interfejsu.
Powiadomienia są uruchamiane w tych momentach:
- Wyświetlana chwila: ma miejsce po wywołaniu metody
prompt()
. Powiadomienie zawiera wartość logiczną, która wskazuje, czy interfejs użytkownika jest wyświetlany. Pominięty moment: dzieje się tak, gdy potwierdzenie jednym dotknięciem zostanie zamknięte przez automatyczne anulowanie, zostanie anulowane ręcznie lub gdy Google nie wyda danych uwierzytelniających, np. gdy użytkownik zostanie wylogowany z wybranej sesji.
W takich przypadkach zalecamy przejście do kolejnych dostawców tożsamości, jeśli istnieją.
Moment zamknięty: dzieje się tak, gdy Google pobiera dane logowania lub użytkownik chce zatrzymać ich pobieranie. Gdy na przykład w oknie dialogowym logowania użytkownik zacznie wpisywać swoją nazwę użytkownika i hasło, możesz wywołać metodę
google.accounts.id.cancel()
, aby zamknąć powiadomienie i wywołać zamknięcie.
Poniższy przykładowy kod implementuje pominięty moment:
<script>
window.onload = function () {
google.accounts.id.initialize(...);
google.accounts.id.prompt((notification) => {
if (notification.isNotDisplayed() || notification.isSkippedMoment()) {
// continue with another identity provider.
}
});
};
</script>
Typ danych: PromptMomentNotification
W tej tabeli podano metody i opisy typu danych PromptMomentNotification
:
Metoda | |
---|---|
isDisplayMoment() |
Czy to powiadomienie wyświetla się przez chwilę? |
isDisplayed() |
Czy to powiadomienie wyświetla się przez chwilę, a interfejs jest widoczny? |
isNotDisplayed() |
Czy to powiadomienie wyświetla się przez chwilę, a interfejs nie jest widoczny? |
getNotDisplayedReason() |
Szczegółowa przyczyna niewyświetlania interfejsu. Oto dostępne wartości:
|
isSkippedMoment() |
Czy to powiadomienie zostało pominięte? |
getSkippedReason() |
Szczegółowa przyczyna pominięcia momentu. Oto dostępne wartości:
|
isDismissedMoment() |
Czy to powiadomienie zostało odrzucone? |
getDismissedReason() |
Szczegółowa przyczyna odrzucenia. Oto dostępne wartości:
|
getMomentType() |
Zwraca ciąg znaków typu określonego momentu. Oto dostępne wartości:
|
Typ danych: CredentialResponse
Po wywołaniu funkcji callback
parametr jest przekazywany jako obiekt CredentialResponse
. W poniższej tabeli znajdują się pola zawarte w obiekcie odpowiedzi na dane logowania:
Pole | |
---|---|
credential |
To pole jest zwracanym tokenem identyfikatora. |
select_by |
To pole określa sposób wybierania danych logowania. |
dane logowania
To pole jest identyfikatorem identyfikatora w postaci ciągu tokena internetowego JSON zakodowanego w formacie base64.
Po zdekodowaniu token JWT wygląda tak:
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": "Elisa", "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" }
Pole sub
zawiera unikalny globalnie identyfikator konta Google.
Używając pól email
, email_verified
i hd
, możesz sprawdzić, czy Google hostuje dany adres e-mail i jest wiarygodny. W przypadkach, gdy Google jest wiarygodnym właścicielem, wiadomo, że użytkownik jest właścicielem konta.
Przypadki, w których Google jest wiarygodnym:
email
ma sufiks@gmail.com
, to jest konto Gmail.email_verified
ma wartość prawda, ahd
jest kontem G Suite.
Użytkownicy mogą rejestrować konta Google bez używania Gmaila i G Suite. Jeśli właściwość email
nie zawiera sufiksu @gmail.com
, a hd
nie jest podany, Google nie jest wiarygodne, a użytkownik powinien podać inne hasło zabezpieczające. email_verfied
może być też prawda, ponieważ użytkownik Google początkowo zweryfikował użytkownika podczas tworzenia konta Google, ale od tego czasu własność konta e-mail osoby trzeciej mogła ulec zmianie.
wybierz_według
W tabeli poniżej znajdziesz możliwe wartości pola select_by
. Typ przycisku użyty wraz ze sesją i stanem zgody użytkownika jest używany do określenia wartości.
Użytkownik nacisnął przycisk jednym dotknięciem lub Zaloguj się przez Google albo użył funkcji automatycznego logowania bezdotykowego.
Wykryto istniejącą sesję lub użytkownik wybrał i zalogował się na konto Google, aby utworzyć nową sesję.
Przed udostępnieniem użytkownikowi danych logowania tokena identyfikatora użytkownika
- kliknij przycisk Potwierdź, aby udzielić zgody na udostępnianie danych logowania, lub
- wyraził wcześniej zgodę i wybrał konto Google, wybierając konto.
Wartość w tym polu jest ustawiona na jeden z tych typów:
Wartość | Opis |
---|---|
auto |
Automatyczne logowanie użytkownika w ramach istniejącej sesji, który wcześniej udzielił zgody na udostępnianie danych logowania. |
user |
Użytkownik, który w ramach istniejącej sesji udzielił już zgody, nacisnął przycisk One Tap & #39; kontynuuj, aby udostępnić dane logowania. |
user_1tap |
Użytkownik korzystający z dotychczasowej sesji kliknął przycisk One Touch & #39;, aby wyrazić zgodę i udostępnić dane logowania. Dotyczy tylko Chrome w wersji 75 i nowszych. |
user_2tap |
Użytkownik bez istniejącej sesji nacisnął przycisk One Tap ' wybierz konto, a następnie przycisk Potwierdź w wyskakującym okienku, aby wyrazić zgodę i udostępnić dane logowania. Dotyczy przeglądarek, które nie są oparte na Chromium. |
btn |
Użytkownik z istniejącą sesją, który wcześniej udzielił zgody, kliknął przycisk Zaloguj się przez Google i wybrał konto Google za pomocą przycisku „Wybierz konto” w celu udostępnienia danych logowania. |
btn_confirm |
Użytkownik, który ma już sesję, kliknął przycisk Zaloguj się przez Google, a następnie Potwierdź, aby udzielić zgody i udostępnić dane logowania. |
btn_add_session |
Użytkownik bez dotychczasowej sesji, który wcześniej udzielił zgody, kliknął przycisk Zaloguj się przez Google, aby wybrać konto Google i udostępnić dane logowania. |
btn_confirm_add_session |
Użytkownik bez istniejącej sesji najpierw kliknął przycisk Zaloguj się przez Google, aby wybrać konto Google, a następnie przycisk Potwierdź, aby wyrazić zgodę na udostępnienie danych logowania. |
Metoda: google.accounts.id.renderButton
Metoda google.accounts.id.renderButton
renderuje przycisk Zaloguj się przez Google na Twoich stronach internetowych.
Oto przykładowy kod metody:
google.accounts.id.renderButton(
/** @type{!HTMLElement} */ parent,
/** @type{!GsiButtonConfiguration} */ options
)
Typ danych: GsiButtonConfiguration
W tej tabeli podano pola i opisy typu danych GsiButtonConfiguration
:
Atrybut | |
---|---|
type |
Typ przycisku: ikona lub przycisk standardowy. |
theme |
Motyw przycisku. na przykład filled_blue lub filled_black. |
size |
Rozmiar przycisku. np. mały lub duży. |
text |
Tekst przycisku. np. „"Zaloguj się przez Google” lub „Zarejestruj się przez Google”. |
shape |
Kształt przycisku. Na przykład prostokątne lub okrągłe. |
logo_alignment |
Wyrównanie logo Google do lewej lub do środka. |
width |
Szerokość przycisku w pikselach. |
locale |
Jeśli zasada jest skonfigurowana, język przycisku jest renderowany. |
Typy atrybutów
Poniższe sekcje zawierają szczegółowe informacje o poszczególnych typach atrybutów i przykład.
Typ
Typ przycisku. Wartością domyślną jest standard
.
Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Tak | type: "icon" |
W tabeli poniżej znajdziesz dostępne typy przycisków wraz z opisami:
Typ | |
---|---|
standard |
Przycisk z tekstem lub spersonalizowanymi informacjami:
![]() ![]() |
icon |
Przycisk ikony bez tekstu: ![]() |
motyw
Motyw przycisku. Wartością domyślną jest outline
. Więcej informacji znajdziesz w tej tabeli:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | theme: "filled_blue" |
W tabeli poniżej znajdziesz dostępne motywy i ich opisy:
Motyw | |
---|---|
outline |
Standardowy motyw przycisku:
![]() ![]() ![]() |
filled_blue |
Niebieski przycisk: ![]() ![]() ![]() |
filled_black |
Czarny przycisk z motywem:
![]() ![]() ![]() |
rozmiar
Rozmiar przycisku. Wartością domyślną jest large
. Więcej informacji znajdziesz w tej tabeli:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | size: "small" |
W tabeli poniżej znajdziesz dostępne rozmiary przycisków i ich opisy:
Rozmiar | |
---|---|
large |
Duży przycisk: ![]() ![]() ![]() |
medium |
Średni rozmiar przycisku: ![]() ![]() |
small |
Niewielki przycisk: ![]() ![]() |
Napisz wiadomość
Tekst przycisku. Wartością domyślną jest signin_with
. Tekst ikon przycisków o różnych atrybutach text
nie ulega zmianie.
Jedynym wyjątkiem jest sytuacja, gdy tekst jest odczytywany na potrzeby ułatwień dostępu na ekranie.
Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | text: "signup_with" |
Tabela zawiera dostępne przyciski i ich opisy:
Tekst | |
---|---|
signin_with |
Tekst przycisku to „Zaloguj się przez Google”:
![]() ![]() |
signup_with |
Tekst przycisku to „Zarejestruj się w Google”:
![]() ![]() |
continue_with |
Tekst przycisku to „Kontynuuj z Google”:
![]() ![]() |
signin |
Tekst przycisku to „Zaloguj się”: ![]() ![]() |
kształt
Kształt przycisku. Wartością domyślną jest rectangular
. Więcej informacji znajdziesz w tej tabeli:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | shape: "rectangular" |
W tabeli poniżej znajdziesz dostępne kształty przycisków i ich opisy:
Kształt | |
---|---|
rectangular |
Prostokątny przycisk. Jeśli jest używany jako typ przycisku icon , jest taki sam jak square .
![]() ![]() ![]() |
pill |
Przycisk w kształcie pigułki. Jeśli jest używany jako typ przycisku icon , jest taki sam jak circle .
![]() ![]() ![]() |
circle |
Przycisk w kształcie okręgu. Jeśli jest używany jako typ przycisku standard , jest taki sam jak pill .
![]() ![]() ![]() |
square |
Przycisk w kształcie kwadratu. Jeśli jest używany jako typ przycisku standard , jest taki sam jak rectangular .
![]() ![]() ![]() |
logo_dopasowanie
Wyrównanie logo Google. Wartością domyślną jest left
. Ten atrybut dotyczy tylko typu przycisku standard
. Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | logo_alignment: "center" |
W tabeli poniżej znajdziesz dostępne dopasowania i ich opisy:
logo_dopasowanie | |
---|---|
left |
Wyrównuje logo Google do lewej.
![]() |
center |
Wyrównuje logo Google do środka.
![]() |
szerokość
Minimalna szerokość przycisku w pikselach. Maksymalna szerokość to 400 pikseli.
Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | width: 400 |
język
Gotowe ustawienia języka tekstu przycisku. Jeśli nie jest skonfigurowana, używane są domyślne ustawienia przeglądarki lub użytkownika sesji Google. Dlatego użytkownicy mogą zobaczyć różne wersje zlokalizowanych przycisków, a nawet mieć różne rozmiary.
Więcej informacji znajdziesz w tabeli poniżej:
Typ | Wymagane | Przykład |
---|---|---|
tekst | Opcjonalnie | locale: "zh_CN" |
Typ danych: dane logowania
Po wywołaniu funkcji native_callback
jako parametr przekazywany jest obiekt Credential
. Poniższa tabela zawiera listę pól zawartych w obiekcie:
Pole | |
---|---|
id |
Identyfikuje użytkownika. |
password |
Hasło |
Metoda: google.accounts.id.disableAutoSelect
Gdy użytkownik wyloguje się z Twojej witryny, musisz wywołać metodę google.accounts.id.disableAutoSelect
, aby zarejestrować stan w plikach cookie. Zapobiegnie to pętli pętli UX. Oto fragment kodu metody:
google.accounts.id.disableAutoSelect()
Ten przykładowy kod implementuje metodę google.accounts.id.disableAutoSelect
z funkcją onSignout()
:
<script>
function onSignout() {
google.accounts.id.disableAutoSelect();
}
</script>
Metoda: google.accounts.id.storeCredentials
Jest to prosty kod metody store()
interfejsu natywnego menedżera danych logowania w przeglądarce. Można go więc używać tylko do przechowywania danych logowania do hasła. Oto przykładowy kod metody:
google.accounts.id.storeCredential(Credential, callback)
Ten przykładowy kod implementuje metodę google.accounts.id.storeCredential
z funkcją onSignIn()
:
<script>
function onSignIn() {
let cred = {id: '...', password: '...'};
google.accounts.id.storeCredential(cred);
}
</script>
Metoda: google.accounts.id.cancel
Możesz anulować przepływ pracy jednym dotknięciem, gdy usuniesz potwierdzenie z interfejsu DOM podmiotu stowarzyszonego. Operacja anulowania zostanie zignorowana, jeśli dane logowania zostały już wybrane. Oto przykładowy kod metody:
google.accounts.id.cancel()
Ten przykładowy kod implementuje metodę google.accounts.id.cancel()
z funkcją onNextButtonClicked()
:
<script>
function onNextButtonClicked() {
google.accounts.id.cancel();
showPasswordPage();
}
</script>
Wywołanie zwrotne biblioteki: onGoogleLibraryLoad
Możesz zarejestrować wywołanie zwrotne onGoogleLibraryLoad
. Jest ona powiadamiana po załadowaniu biblioteki JavaScript usługi Zaloguj się przez Google:
window.onGoogleLibraryLoad = () => {
...
};
To wywołanie zwrotne jest tylko skrótem wywołania zwrotnego window.onload
. Nie ma żadnych różnic w zachowaniu.
Ten przykładowy kod implementuje wywołanie zwrotne onGoogleLibraryLoad
:
<script>
window.onGoogleLibraryLoad = () => {
google.accounts.id.initialize({
...
});
google.accounts.id.prompt();
};
</script>
Metoda: google.accounts.id.revoke
Metoda google.accounts.id.revoke
anuluje przypisanie protokołu OAuth używanego do udostępniania tokena identyfikatora określonego użytkownika. Zobacz ten fragment kodu metody: google.accounts.id.revoke(hint, callback)
Parametr | Typ | Opis |
---|---|---|
hint |
tekst | Adres e-mail lub unikalny identyfikator konta Google użytkownika. Identyfikator to właściwość sub ładunku credential ładunku. |
callback |
funkcja | Opcjonalny moduł obsługi RevocationResponse. |
Poniższy przykładowy kod pokazuje, jak korzystać z metody revoke
z identyfikatorem.
google.accounts.id.revoke('1618033988749895', done => { console.log(done.error); });
Typ danych: RevocationResponse
Po wywołaniu funkcji callback
parametr jest przekazywany jako obiekt RevocationResponse
. W poniższej tabeli znajdują się pola zawarte w obiekcie odpowiedzi na odwołanie:
Pole | |
---|---|
successful |
To pole określa wartość zwracaną przez wywołanie metody. |
error |
To pole zawiera szczegółowy komunikat o błędzie. |
sukces
To pole to wartość logiczna ustawiona na „true”, jeśli wywołanie metody wywołania zakończyło się niepowodzeniem lub „false” w przypadku niepowodzenia.
błąd
To pole zawiera wartość ciągu znaków i zawiera szczegółowy komunikat o błędzie, jeśli nie można wywołać metody unieważnienia. Jest ona nieokreślona po sukcesie.