Dokumentacja klienta JavaScript usługi logowania Google

W tym artykule znajdziesz opis metod i atrybutów klienta JavaScript, które będą służyć do implementowania Logowania przez Google w Twoich aplikacjach internetowych.

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

Konfiguracja uwierzytelniania

Wczytaj bibliotekę platformy Google API, 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 aplikacji gapi.auth2.GoogleAuth.

Podczas inicjowania obiektu GoogleAuth konfigurujesz go za pomocą identyfikatora klienta OAuth 2.0 i wszelkich dodatkowych opcji, które chcesz określić. Następnie, jeśli użytkownik jest już zalogowany, 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ę tak dziać w starych nieobsługiwanych przeglądarkach), zamiast tego wywołana będzie funkcja onError.

Kody błędów

idpiframe_initialization_failed

Nie udało się zainicjować wymaganego elementu iframe od Google na przykład z powodu nieobsługiwanego środowiska. Właściwość details zawiera więcej informacji o wykrytym błędzie.

gapi.auth2.ClientConfig

Interfejs reprezentujący różne parametry konfiguracji metody gapi.auth2.init.

Uwierzytelnianie

GoogleAuth to klasa samotna, która udostępnia metody umożliwiające użytkownikowi zalogowanie się za pomocą konta Google, sprawdzenie jego bieżącego stanu zalogowania się, pobranie określonych danych z profilu Google użytkownika, wysłanie prośby o przyznanie dodatkowych zakresów oraz wylogowanie się z bieżącego konta.

gapi.auth2.getAuthInstance()

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

GoogleAuth.isSignedIn.get()

Wskazuje, czy obecny użytkownik jest obecnie zalogowany.

GoogleAuth.isSignedIn.listen(słuchacz)

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

GoogleAuth.signIn()

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

Kody błędów

Zobacz GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

Loguje się przy użyciu określonych opcji.

Kody błędów

popup_closed_by_user

Użytkownik zamknął wyskakujące okienko, zanim zakończył proces logowania.

access_denied

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

immediate_failed

Żadnego użytkownika nie można wybrać automatycznie bez pytania użytkownika o zgodę na przetwarzanie danych osobowych. Podczas używania signIn z użyciem opcji prompt: 'none' wystąpił błąd. Ta opcja nie powinna być wymagana, ponieważ gapi.auth2.init zaloguje się automatycznie, jeśli użytkownik zalogował się wcześniej podczas poprzedniej sesji.

gapi.auth2.SignInOptions

Interfejs reprezentujący różne parametry konfiguracji metody GoogleAuth.signIn(options).

GoogleAuth.signOut()

Wylogowuje z konta bieżące konto.

GoogleAuth.disconnect()

Anuluje wszystkie zakresy przydzielone 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, zanim dokończy proces wyrażania zgody.

access_denied

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

immediate_failed

Żadnego użytkownika nie można wybrać automatycznie bez pytania użytkownika o zgodę na przetwarzanie danych osobowych. Podczas używania signIn z użyciem opcji prompt: 'none' wystąpił błąd. Ta opcja nie powinna być wymagana, ponieważ gapi.auth2.init zaloguje się automatycznie, jeśli użytkownik zalogował się wcześniej podczas poprzedniej sesji.

gapi.auth2.Opcje dostępu offline

Interfejs reprezentujący różne parametry konfiguracji metody GoogleAuth.grantOfflineAccess(options).

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

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

Użytkownicy

Obiekt GoogleUser reprezentuje jedno konto użytkownika. Obiekty GoogleUser zwykle uzyskuje się przez wywołanie GoogleAuth.currentUser.get().

GoogleAuth.currentUser.get()

Zwraca obiekt GoogleUser reprezentujący bieżącego użytkownika. Pamiętaj, że w nowo zainicjowanej instancji GoogleAuth bieżący użytkownik nie został skonfigurowany. Aby uzyskać zainicjowaną instancję GoogleAuth, użyj metody currentUser.listen() lub GoogleAuth.then().

GoogleAuth.currentUser.listen(listener)

Wykrywaj zmiany w bieżącym użytkowniku.

GoogleUser.getId()

Pobierz unikalny ciąg identyfikatora użytkownika.

GoogleUser.isSignedIn()

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

GoogleUser.getHostDomain()

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

GoogleUser.getGrantedScopes()

Pobierz zakresy, które użytkownik przyznał jako ciąg rozdzielany spacjami.

GoogleUser.getBasicProfile()

Uzyskaj podstawowe informacje na temat 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ść „prawda”, jeśli użytkownik udzielił określonych zakresów.

GoogleUser.grant(options)

Poproś użytkownika o dodatkowe zakresy.

Listę parametrów i kod błędu znajdziesz w sekcji 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 przyznane użytkownikowi przez aplikację.

Elementy interfejsu

gapi.signin2.render(id, options)

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

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

Zaawansowany

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 logowania Google lub spróbuje załadować żądaną odpowiedź bez powiadomienia użytkownika.

Oto przykłady zastosowania tej metody:

• Aplikacja wysyła żądanie tylko do punktu końcowego interfejsu API Google tylko raz, aby na przykład wczytać ulubione filmy użytkownika YouTube przy pierwszym logowaniu.
• Twoja aplikacja ma własną infrastrukturę do zarządzania sesją, a identyfikację użytkownika w backendzie wymaga tylko tokena identyfikatora.
• Na tej samej stronie jest używanych kilka 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 na przykład z powodu nieobsługiwanego środowiska. Właściwość details zawiera więcej informacji o wykrytym błędzie.

popup_closed_by_user

Użytkownik zamknął wyskakujące okienko, zanim zakończył proces logowania.

access_denied

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

immediate_failed

Żadnego użytkownika nie można wybrać automatycznie bez pytania użytkownika o zgodę na przetwarzanie danych osobowych. Podczas używania signIn z użyciem opcji prompt: 'none' wystąpił błąd.

gapi.auth2.AuthorizeConfig

Interfejs reprezentujący różne parametry konfiguracji metody gapi.auth2.authorize.

gapi.auth2.AuthorizeResponse.

Odpowiedź zwrotna dla metody gapi.auth2.authorize.