Dokumentacja klienta JavaScript logowania Google

W tym artykule znajdziesz opis metod i atrybutów klienta w języku JavaScript, których możesz używać do implementacji Logowania przez Google w swoich aplikacjach internetowych.

Jeśli podczas korzystania z biblioteki napotkasz jakiś problem, zgłoś go 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 jej wywołaniem metod gapi.auth2.GoogleAuth.

Po zainicjowaniu obiektu GoogleAuth konfigurujesz go przy użyciu identyfikatora klienta OAuth 2.0 i wszelkich dodatkowych opcji, które chcesz określić. Następnie, jeśli użytkownik był już zalogowany, obiekt GoogleAuth przywraca stan logowania użytkownika z poprzedniej sesji.

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

Uwierzytelnianie Google(onInit, onError)

Wywołuje funkcję onInit, gdy obiekt GoogleAuth jest w pełni zainicjowano. Jeśli podczas inicjowania pojawi się błąd (może się tak zdarzyć w starszych nieobsługiwanych przeglądarkach): funkcja onError zostanie wywołana.

Kody błędów

idpiframe_initialization_failed

Nie udało się zainicjować wymaganego elementu iframe od Google, np. z powodu nieobsługiwanego elementu dla środowiska. Właściwość details podaje więcej informacji o zgłoszonym błędzie.

gapi.auth2.ClientConfig

Interfejs przedstawiający różne parametry konfiguracji parametru gapi.auth2.init.

Uwierzytelnianie

GoogleAuth to pojedyncza klasa, która udostępnia metody umożliwiające użytkownikowi zalogowanie się na konto Google, sprawdzenie bieżącego stanu logowania użytkownika, pobieranie określonych danych z profilu Google użytkownika, wysyłanie próśb o dodatkowe zakresy i wylogowywanie 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 bieżący użytkownik jest zalogowany.

GoogleAuth.isSignedIn.listen(listener)

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

GoogleAuth.signIn()

Loguje użytkownika z wykorzystaniem opcji określonych w polu gapi.auth2.init().

Kody błędów

Zobacz GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

Loguje użytkownika za pomocą określonych opcji.

Kody błędów

popup_closed_by_user

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

access_denied

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

immediate_failed

Nie można automatycznie wybrać żadnego użytkownika bez pytania o zgodę na przetwarzanie danych. Błąd zgłoszony podczas za pomocą polecenia signIn z opcją prompt: 'none'. Ta opcja nie powinna być nie jest wymagane, ponieważ gapi.auth2.init automatycznie zaloguje użytkownika, jeśli użytkownik był zalogowany podczas poprzedniej sesji.

gapi.auth2.SignInOptions

Interfejs przedstawiający różne parametry konfiguracji parametru Metoda 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 offline do określonych zakresów.

{
  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 ukończeniem procesu uzyskiwania zgody.

access_denied

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

immediate_failed

Nie można automatycznie wybrać żadnego użytkownika bez pytania o zgodę na przetwarzanie danych. Błąd zgłoszony podczas za pomocą polecenia signIn z opcją prompt: 'none'. Ta opcja nie powinna być nie jest wymagane, ponieważ gapi.auth2.init automatycznie zaloguje użytkownika, jeśli użytkownik był zalogowany podczas poprzedniej sesji.

gapi.auth2.OfflineAccessOptions

Interfejs przedstawiający różne parametry konfiguracji parametru GoogleAuth.grantOfflineAccess(options) .

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

Łączy proces logowania do modułu obsługi kliknięć podanego 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 reprezentującego obecnego użytkownika. Pamiętaj, że w nowo zainicjowanym GoogleAuth, bieżący użytkownik nie został skonfigurowany. Użyj Metoda currentUser.listen() lub GoogleAuth.then() aby uzyskać zainicjowaną instancję GoogleAuth.

GoogleAuth.currentUser.listen(listener)

Wykrywaj zmiany dotyczące bieżącego użytkownika.

GoogleUser.getId()

Pobierz unikalny identyfikator użytkownika.

GoogleUser.isSignedIn()

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

GoogleUser.getHostedDomain()

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

GoogleUser.getGrantedScopes()

Pobierz zakresy przypisane przez użytkownika w postaci ciągu znaków rozdzielanego spacjami.

GoogleUser.getBasicProfile()

Uzyskaj podstawowe informacje o 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ę dla nowej odpowiedzi AuthResponse.

gapi.auth2.AuthResponse

Odpowiedź zwrócona podczas połączenia GoogleUser.getAuthResponse(includeAuthorizationData) lub GoogleUser.reloadAuthResponse() .

GoogleUser.hasGrantedScopes(scopes)

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

GoogleUser.grant(options)

Poproś użytkownika o dodatkowe zakresy.

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

GoogleUser.grantOfflineAccess(options)

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

{
  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, używając: ustawienia określone 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żytych parametrów spowoduje to otwarcie pojawi się wyskakujące okienko z procesem logowania Google lub spróbuj wczytać żądaną odpowiedź dyskretnie, bez interakcji ze strony użytkownika.

Metoda ta przydaje się między innymi w tych przypadkach:

• Aplikacja musi zażądać punktu końcowego Google API tylko raz, np. w celu załadowania ulubione filmy użytkownika w YouTube przy pierwszym zalogowaniu się.
• Twoja aplikacja ma własną infrastrukturę zarządzania sesjami i wymaga jedynie Token identyfikatora raz, który pozwala zidentyfikować użytkownika w backendzie.
• Na tej samej stronie używanych jest 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, np. z powodu nieobsługiwanego elementu dla środowiska. Właściwość details podaje więcej informacji o zgłoszonym błędzie.

popup_closed_by_user

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

access_denied

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

immediate_failed

Nie można automatycznie wybrać żadnego użytkownika bez pytania o zgodę na przetwarzanie danych. Błąd zgłoszony podczas za pomocą polecenia signIn z opcją prompt: 'none'.

gapi.auth2.AuthorizeConfig

Interfejs przedstawiający różne parametry konfiguracji parametru Metoda gapi.auth2.authorize.

gapi.auth2.AuthorizeResponse

Odpowiedź zwrócona na wywołanie zwrotne Metoda gapi.auth2.authorize.