Dokumentacja klienta JavaScript logowania Google

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

Jeśli napotkasz jakiś problem podczas korzystania z biblioteki, 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 załadowaniu biblioteki platformy załaduj 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 gapi.auth2.GoogleAuth.

Podczas inicjowania obiektu GoogleAuth konfigurujesz go, podając identyfikator klienta OAuth 2.0 i opcjonalnie inne opcje. Jeśli użytkownik jest już zalogowany, obiekt GoogleAuth przywraca stan logowania z poprzedniej sesji.

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

GoogleAuth.then(onInit, onError)

Funkcja onInit jest wywoływana, gdy obiekt GoogleAuth jest w pełni zainicjowany. Jeśli podczas inicjowania wystąpi błąd (może się to zdarzyć w starszych, nieobsługiwanych przez Google Chrome, 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, na przykład z powodu nieobsługiwanego środowiska. Właściwość details zawiera więcej informacji o wystąpił błąd.

gapi.auth2.ClientConfig

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

Uwierzytelnianie

GoogleAuth to klasa singleton, która udostępnia metody umożliwiające użytkownikowi zalogowanie się na konto Google, uzyskanie bieżącego stanu logowania użytkownika, uzyskanie określonych danych z profilu Google użytkownika, żądanie dodatkowych zakresów uprawnień oraz wylogowanie z bieżącego konta.

gapi.auth2.getAuthInstance()

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

GoogleAuth.isSignedIn.get()

Zwraca informację, czy bieżący użytkownik jest zalogowany.

GoogleAuth.isSignedIn.listen(listener)

Słuchaj zmian w stanie logowania bieżącego użytkownika.

GoogleAuth.signIn()

Loguje użytkownika z opcjami określonymi w opcji 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 przed zakończeniem procesu logowania.

access_denied

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

immediate_failed

Nie można automatycznie wybrać żadnego użytkownika bez wyświetlenia procesu uzyskiwania zgody. Wystąpił błąd podczas korzystania z opcji signIn z opcją prompt: 'none'. Nie powinno być to konieczne, ponieważ gapi.auth2.init automatycznie zaloguje użytkownika, jeśli był on zalogowany w poprzedniej sesji.

gapi.auth2.SignInOptions

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

GoogleAuth.signOut()

Wyloguje bieżące konto z aplikacji.

GoogleAuth.disconnect()

Unieważnia wszystkie uprawnienia przyznane przez użytkownika.

GoogleAuth.grantOfflineAccess(options)

Uzyskaj od użytkownika zgodę na dostęp do określonych zakresów 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 proces uzyskiwania zgody został zakończony.

access_denied

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

immediate_failed

Nie można automatycznie wybrać żadnego użytkownika bez wyświetlenia procesu uzyskiwania zgody. Wystąpił błąd podczas korzystania z opcji signIn z opcją prompt: 'none'. Nie powinno być to konieczne, ponieważ gapi.auth2.init automatycznie zaloguje użytkownika, jeśli był on zalogowany w poprzedniej sesji.

gapi.auth2.OfflineAccessOptions

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

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

Przyłącza proces logowania do obsługi kliknięcia w określonym kontenerze.

Użytkownicy

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

GoogleAuth.currentUser.get()

Zwraca obiekt GoogleUser, który reprezentuje bieżącego użytkownika. Pamiętaj, że w nowo zainicjowanej instancji GoogleAuth bieżący użytkownik nie został jeszcze ustawiony. Aby uzyskać zainicjowany obiekt GoogleAuth, użyj metody currentUser.listen() lub GoogleAuth.then().

GoogleAuth.currentUser.listen(listener)

Nasłuchiwanie zmian w currentUser.

GoogleUser.getId()

Pobierz unikalny ciąg znaków identyfikatora użytkownika.

GoogleUser.isSignedIn()

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

GoogleUser.getHostedDomain()

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

GoogleUser.getGrantedScopes()

Pobierz zakresy przyznane przez użytkownika jako ciąg znaków rozdzielony 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ź zwracana przez metody GoogleUser.getAuthResponse(includeAuthorizationData) lub GoogleUser.reloadAuthResponse().

GoogleUser.hasGrantedScopes(scopes)

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

GoogleUser.grant(options)

Poproś użytkownika o dodatkowe uprawnienia.

Aby poznać listę parametrów i kod błędu, zapoznaj się z artykułem GoogleAuth.signIn().

GoogleUser.grantOfflineAccess(options)

Uzyskaj od użytkownika zgodę na dostęp do określonych zakresów offline.

{
  scope: 'profile email'
}

GoogleUser.disconnect()

Unieważnia wszystkie zakresy przyznane przez użytkownika aplikacji.

Elementy interfejsu

gapi.signin2.render(id, options)

Wyświetla przycisk logowania w elemencie o danym identyfikatorze, używając ustawień określonych przez obiekt options.

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

Zaawansowane

gapi.auth2.authorize(params, callback)

Przeprowadza jednorazową autoryzację OAuth 2.0. W zależności od użytych parametrów otworzy to wyskakujące okienko logowania w Google lub spróbuje pobrać żądaną odpowiedź bez interakcji z użytkownikiem.

Oto kilka przykładów zastosowań, w których ta metoda jest przydatna:

• Aplikacja musi tylko raz wysłać żądanie do punktu końcowego interfejsu Google API, aby na przykład załadować ulubione filmy użytkownika w YouTube przy pierwszym logowaniu.
• Twoja aplikacja ma własną infrastrukturę zarządzania sesjami i wymaga użycia tokena ID tylko raz, aby zidentyfikować użytkownika na serwerze.
• Na tej samej stronie używasz 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, na przykład z powodu nieobsługiwanego środowiska. Właściwość details zawiera więcej informacji o wystąpił błąd.

popup_closed_by_user

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

access_denied

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

immediate_failed

Nie można automatycznie wybrać żadnego użytkownika bez wyświetlenia procesu uzyskiwania zgody. Wystąpił błąd podczas korzystania z opcji signIn z opcją prompt: 'none'.

gapi.auth2.AuthorizeConfig

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

gapi.auth2.AuthorizeResponse

Odpowiedź zwrócona do metody wywołania funkcji gapi.auth2.authorize.