Dokumentacja klienta JavaScript logowania Google

W tym artykule znajdziesz opis metod i atrybutów klienta JavaScript, które będziesz wykorzystywać do implementacji Logowania przez Google w swoich aplikacjach internetowych.

Jeśli napotkasz problem z biblioteką, zgłoś go w naszym repozytorium GitHub.

Konfiguracja uwierzytelniania

Wczytaj bibliotekę platformy interfejsów API Google, aby utworzyć obiekt gapi:

<script src="https://apis.google.com/js/platform.js?onload=init" async defer></script>

Po wczytaniu biblioteki platformy wczytaj bibliotekę auth2:

function init() {
  gapi.load('auth2', function() {
    /* Ready. Make a call to gapi.auth2.init or some other API */
  });
}

gapi.auth2.init(params)

Inicjuje obiekt GoogleAuth. Musisz wywołać tę metodę przed wywołaniem metod metody gapi.auth2.GoogleAuth.

Gdy zainicjujesz obiekt GoogleAuth, skonfigurujesz go przy użyciu identyfikatora klienta OAuth 2.0 i dodatkowych opcji, które chcesz określić. Jeśli użytkownik się już zalogował, obiekt GoogleAuth przywraca stan logowania użytkownika z poprzedniej sesji.

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}

GoogleAuth.then(onInit, onError)

Wywołuje funkcję onInit po pełnym zainicjowaniu obiektu GoogleAuth. Jeśli podczas inicjowania wystąpi błąd (może się to zdarzyć w starszych nieobsługiwanych przeglądarkach), zamiast tego zostanie wywołana funkcja onError.

Kody błędów

idpiframe_initialization_failed

Nie udało się zainicjować wymaganego elementu iframe od Google, np. z powodu nieobsługiwanego środowiska. Więcej informacji o zgłoszonym błędzie znajdziesz w usłudze details.

gapi.auth2.ClientConfig

Interfejs, który reprezentuje różne parametry konfiguracji metody gapi.auth2.init.

Uwierzytelnianie

GoogleAuth to jednorazowa klasa, która udostępnia metody umożliwiające użytkownikowi zalogowanie się na konto Google, sprawdzenie jego aktualnego stanu logowania, pobranie określonych danych z profilu Google użytkownika, wysłanie prośby o dodatkowe zakresy i wylogowanie się z bieżącego konta.

gapi.auth2.getAuthInstance()

Zwraca obiekt GoogleAuth. Przed wywołaniem tej metody musisz zainicjować obiekt GoogleAuth za pomocą gapi.auth2.init().

GoogleAuth.isSignedIn.get()

Wskazuje, czy bieżący użytkownik jest obecnie zalogowany.

GoogleAuth.isSignedIn.listen(listener)

Wykrywaj zmiany stanu logowania bieżącego użytkownika.

GoogleAuth.signIn()

Loguje użytkownika z opcjami określonymi jako gapi.auth2.init().

Kody błędów

Zobacz GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

Loguje użytkownika przy użyciu określonych opcji.

Kody błędów

popup_closed_by_user

Użytkownik zamknął wyskakujące okienko przed zakończeniem procesu logowania.

access_denied

Użytkownik odmówił przyznania uprawnień do wymaganych zakresów.

immediate_failed

Nie udało się automatycznie wybrać żadnego użytkownika bez wyświetlenia prośby o zgodę na wykorzystanie danych. Podczas korzystania z signIn z opcją prompt: 'none' zgłaszany błąd. Nie musisz korzystać z tej opcji, ponieważ gapi.auth2.init automatycznie zaloguje użytkownika, jeśli zalogował się on w poprzedniej sesji.

gapi.auth2.SignInOptions

Interfejs, który reprezentuje różne parametry konfiguracji metody GoogleAuth.signIn(options).

GoogleAuth.signOut()

Wylogowuje bieżące konto z aplikacji.

GoogleAuth.disconnect()

Unieważnia wszystkie zakresy przyznane przez użytkownika.

GoogleAuth.grantOfflineAccess(options)

Uzyskaj od użytkownika uprawnienia dostępu do określonych zakresów w trybie offline.

{
  scope: 'profile email'
}

auth2.grantOfflineAccess().then(function(resp) {
  var auth_code = resp.code;
});

Kody błędów

popup_closed_by_user

Użytkownik zamknął wyskakujące okienko przed zakończeniem procesu uzyskiwania zgody.

access_denied

Użytkownik odmówił przyznania uprawnień do wymaganych zakresów.

immediate_failed

Nie udało się automatycznie wybrać żadnego użytkownika bez wyświetlenia prośby o zgodę na wykorzystanie danych. Podczas korzystania z signIn z opcją prompt: 'none' zgłaszany błąd. Nie musisz korzystać z tej opcji, ponieważ gapi.auth2.init automatycznie zaloguje użytkownika, jeśli zalogował się on w poprzedniej sesji.

gapi.auth2.OfflineAccessOptions

Interfejs, który reprezentuje różne parametry konfiguracji metody GoogleAuth.grantOfflineAccess(options).

GoogleAuth.attachClickHandler(container, options, onsuccess, onfailure)

Dołącza proces logowania do modułu obsługi kliknięcia określonego kontenera.

Użytkownicy

Obiekt GoogleUser reprezentuje jedno konto użytkownika. Obiekty GoogleUser są zwykle uzyskiwane przez wywołanie GoogleAuth.currentUser.get().

GoogleAuth.currentUser.get()

Zwraca obiekt GoogleUser, który reprezentuje obecnego użytkownika. W nowo zainicjowanej instancji GoogleAuth bieżący użytkownik nie został ustawiony. Aby uzyskać zainicjowaną instancję GoogleAuth, użyj metody currentUser.listen() lub GoogleAuth.then().

GoogleAuth.currentUser.listen(listener)

Wykrywaj zmiany w bieżącym koncie użytkownika.

GoogleUser.getId()

Pobierz unikalny ciąg identyfikatora użytkownika.

GoogleUser.isSignedIn()

Zwraca wartość „true”, jeśli użytkownik jest zalogowany.

GoogleUser.getHostedDomain()

Uzyskaj domenę G Suite użytkownika, jeśli użytkownik zalogował się na konto G Suite.

GoogleUser.getGrantedScopes()

Pobierz zakresy przyznane przez użytkownika w postaci ciągu rozdzielanego spacjami.

GoogleUser.getBasicProfile()

Pobierz podstawowe informacje z profilu użytkownika.

GoogleUser.getAuthResponse(includeAuthorizationData)

Pobierz obiekt odpowiedzi z sesji uwierzytelniania użytkownika.

GoogleUser.reloadAuthResponse()

Wymusza odświeżenie tokena dostępu, a następnie zwraca obietnicę nowej odpowiedzi AuthResponse.

gapi.auth2.AuthResponse

Odpowiedź zwrócona podczas wywoływania metod GoogleUser.getAuthResponse(includeAuthorizationData) lub GoogleUser.reloadAuthResponse().

GoogleUser.hasGrantedScopes(scopes)

Zwraca wartość „true”, jeśli użytkownik przyznał określone zakresy.

GoogleUser.grant(options)

Wyślij do użytkownika prośbę o dodatkowe zakresy.

Listę parametrów i kod błędu znajdziesz na stronie GoogleAuth.signIn().

GoogleUser.grantOfflineAccess(options)

Uzyskaj od użytkownika uprawnienia dostępu do określonych zakresów w trybie offline.

{
  scope: 'profile email'
}

GoogleUser.disconnect()

Unieważnia wszystkie zakresy, które użytkownik przyznał aplikacji.

Elementy interfejsu

gapi.signin2.render(id, options)

Renderuje przycisk logowania w elemencie o podanym identyfikatorze przy użyciu ustawień określonych przez obiekt options.

{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}

Zaawansowane

gapi.auth2.authorized(params, callback)

Przeprowadza jednorazową autoryzację OAuth 2.0. W zależności od używanych parametrów otworzy się wyskakujące okienko z prośbą o zalogowanie się przez Google lub spróbuje wczytać żądaną odpowiedź po cichu, bez działań ze strony użytkownika.

Oto kilka przypadków użycia tej metody:

• Aplikacja wysyła żądanie do punktu końcowego interfejsu API Google tylko raz, na przykład w celu wczytania ulubionych filmów użytkownika w YouTube przy pierwszym logowaniu.
• Twoja aplikacja ma własną infrastrukturę zarządzania sesjami i wymaga tylko jednego tokena identyfikatora do identyfikacji użytkownika w backendzie.
• Na jednej stronie używa się kilku identyfikatorów klienta.

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}

Przykład

gapi.auth2.authorize({
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}, function(response) {
  if (response.error) {
    // An error happened!
    return;
  }
  // The user authorized the application for the scopes requested.
  var accessToken = response.access_token;
  var idToken = response.id_token;
  // You can also now use gapi.client to perform authenticated requests.
});

Kody błędów

idpiframe_initialization_failed

Nie udało się zainicjować wymaganego elementu iframe od Google, np. z powodu nieobsługiwanego środowiska. Więcej informacji o zgłoszonym błędzie znajdziesz w usłudze details.

popup_closed_by_user

Użytkownik zamknął wyskakujące okienko przed zakończeniem procesu logowania.

access_denied

Użytkownik odmówił przyznania uprawnień do wymaganych zakresów.

immediate_failed

Nie udało się automatycznie wybrać żadnego użytkownika bez wyświetlenia prośby o zgodę na wykorzystanie danych. Podczas korzystania z signIn z opcją prompt: 'none' zgłaszany błąd.

gapi.auth2.AuthorizeConfig

Interfejs, który reprezentuje różne parametry konfiguracji metody gapi.auth2.authorize.

gapi.auth2.AuthorizeResponse

Odpowiedź została zwrócona na wywołanie zwrotne metody gapi.auth2.authorize.