Справочник по клиенту JavaScript для входа в Google

В этом справочнике описаны методы и атрибуты клиента JavaScript, которые вы будете использовать для реализации входа в Google в своих веб-приложениях.

Если вы столкнулись с какой-либо проблемой при использовании библиотеки, сообщите об этом в наш репозиторий GitHub . .

Настройка аутентификации

Загрузите библиотеку платформы API Google, чтобы создать объект gapi :

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

После загрузки библиотеки платформы загрузите библиотеку auth2 :

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

разрыв.auth2.init( params )

Инициализирует объект GoogleAuth . Вы должны вызвать этот метод перед вызовом gapi.auth2.GoogleAuth .

При инициализации объекта GoogleAuth вы настраиваете объект, используя свой идентификатор клиента OAuth 2.0 и любые дополнительные параметры, которые вы хотите указать. Затем, если пользователь уже вошел в систему, объект GoogleAuth восстанавливает состояние входа пользователя из предыдущего сеанса.

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

GoogleAuth.then( onInit , onError )

Вызывает функцию onInit , когда объект GoogleAuth полностью инициализирован. Если при инициализации возникает ошибка (это может произойти в старых неподдерживаемых браузерах), вместо этого будет вызвана функция onError .

Коды ошибок

idpiframe_initialization_failed

Не удалось инициализировать необходимый iframe от Google, например, из-за неподдерживаемой среды. Свойство details предоставит дополнительную информацию о возникшей ошибке.

gapi.auth2.ClientConfig

Интерфейс, представляющий различные параметры конфигурации для gapi.auth2.init .

Аутентификация

GoogleAuth — это одноэлементный класс, который предоставляет методы, позволяющие пользователю войти в систему с учетной записью Google, получить текущий статус входа пользователя, получить определенные данные из профиля Google пользователя, запросить дополнительные области и выйти из текущей учетной записи.

разрыв.auth2.getAuthInstance()

Возвращает объект GoogleAuth . Перед вызовом этого метода необходимо инициализировать объект GoogleAuth с помощью gapi.auth2.init() .

GoogleAuth.isSignedIn.get()

Возвращает, вошел ли текущий пользователь в систему.

GoogleAuth.isSignedIn.listen(прослушиватель)

Прослушивайте изменения в состоянии входа текущего пользователя.

GoogleAuth.signIn()

Выполняет вход пользователя с параметрами, указанными gapi.auth2.init() .

Коды ошибок

См. GoogleAuth.signIn(options) .

GoogleAuth.signIn( options )

Выполняет вход пользователя, используя указанные параметры.

Коды ошибок

popup_closed_by_user

Пользователь закрыл всплывающее окно, прежде чем завершить вход.

access_denied

Пользователь отклонил разрешение на необходимые области.

immediate_failed

Ни один пользователь не может быть выбран автоматически без запроса потока согласия. Ошибка возникает при использовании signIn prompt: 'none' . Эту опцию не следует использовать, так gapi.auth2.init автоматически войдет в систему пользователя, если он ранее вошел в систему во время предыдущего сеанса.

разрыв.auth2.SignInOptions

Интерфейс, представляющий различные параметры конфигурации для метода GoogleAuth.signIn( options ) .

GoogleAuth.signOut()

Выход из текущего аккаунта из приложения.

GoogleAuth.disconnect()

Отменяет все области, предоставленные пользователем.

GoogleAuth.grantOfflineAccess ( options )

Получите от пользователя разрешение на доступ к указанным областям в автономном режиме.

{
  scope: 'profile email'
}

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

Коды ошибок

popup_closed_by_user

Пользователь закрыл всплывающее окно до завершения потока согласия.

access_denied

Пользователь отклонил разрешение на необходимые области.

immediate_failed

Ни один пользователь не может быть выбран автоматически без запроса потока согласия. Ошибка возникает при использовании signIn prompt: 'none' . Эту опцию не следует использовать, так gapi.auth2.init автоматически войдет в систему пользователя, если он ранее вошел в систему во время предыдущего сеанса.

разрыв.auth2.OfflineAccessOptions

Интерфейс, представляющий различные параметры конфигурации для метода GoogleAuth.grantOfflineAccess( options ) .

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

Прикрепляет поток входа к обработчику кликов указанного контейнера.

Пользователи

Объект GoogleUser представляет одну учетную запись пользователя. Объекты GoogleUser обычно получаются путем вызова GoogleAuth.currentUser.get() .

GoogleAuth.currentUser.get()

Возвращает объект GoogleUser , представляющий текущего пользователя. Обратите внимание, что в только что инициализированном экземпляре GoogleAuth текущий пользователь не установлен. Используйте метод currentUser.listen() или GoogleAuth.then() чтобы получить инициализированный экземпляр GoogleAuth .

GoogleAuth.currentUser.listen( listener )

Прослушивайте изменения в currentUser.

GoogleUser.getId()

Получите уникальную строку идентификатора пользователя.

GoogleUser.isSignedIn()

Возвращает true, если пользователь вошел в систему.

GoogleUser.getHostedDomain()

Получите домен G Suite пользователя, если пользователь вошел в систему с учетной записью G Suite.

GoogleUser.getGrantedScopes()

Получите области, предоставленные пользователем, в виде строки, разделенной пробелами.

GoogleUser.getBasicProfile()

Получите основную информацию о профиле пользователя.

GoogleUser.getAuthResponse(includeAuthorizationData)

Получите объект ответа из сеанса аутентификации пользователя.

GoogleUser.reloadAuthResponse()

Принудительно обновляет токен доступа, а затем возвращает обещание для нового ответа AuthResponse.

gapi.auth2.AuthResponse

Ответ возвращается при вызове методов GoogleUser.getAuthResponse( includeAuthorizationData ) или GoogleUser.reloadAuthResponse() .

GoogleUser.hasGrantedScopes( scopes )

Возвращает true, если пользователь предоставил указанные области.

GoogleUser.grant( options )

Запросить дополнительные области для пользователя.

См. GoogleAuth.signIn() для получения списка параметров и кода ошибки.

GoogleUser.grantOfflineAccess( options )

Получите от пользователя разрешение на доступ к указанным областям в автономном режиме.

{
  scope: 'profile email'
}

GoogleUser.disconnect()

Отменяет все области, предоставленные пользователем приложению.

элементы пользовательского интерфейса

gapi.signin2.render( id , options )

Отображает кнопку входа в элементе с заданным идентификатором, используя настройки, заданные объектом options .

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

Передовой

gapi.auth2.authorize( params , callback )

Выполняет однократную авторизацию OAuth 2.0. В зависимости от используемых параметров откроется всплывающее окно для входа в Google или будет предпринята попытка загрузить запрошенный ответ автоматически, без взаимодействия с пользователем.

Некоторые случаи использования, где этот метод полезен, включают:

• Вашему приложению достаточно один раз запросить конечную точку API Google, например, чтобы загрузить любимые видео пользователя с YouTube при первом входе в систему.
• Ваше приложение имеет собственную инфраструктуру управления сеансами, и токен идентификатора требуется только один раз для идентификации пользователя в вашем серверном интерфейсе.
• На одной странице используются несколько идентификаторов клиента.

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

Пример

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.
});

Коды ошибок

idpiframe_initialization_failed

Не удалось инициализировать необходимый iframe от Google, например, из-за неподдерживаемой среды. Свойство details предоставит дополнительную информацию о возникшей ошибке.

popup_closed_by_user

Пользователь закрыл всплывающее окно, прежде чем завершить вход.

access_denied

Пользователь отклонил разрешение на необходимые области.

immediate_failed

Ни один пользователь не может быть выбран автоматически без запроса потока согласия. Ошибка возникает при использовании signIn prompt: 'none' .

разрыв.auth2.AuthorizeConfig

Интерфейс, представляющий различные параметры конфигурации для gapi.auth2.authorize .

разрыв.auth2.AuthorizeResponse

Ответ вернулся в обратный вызов gapi.auth2.authorize .