Google 로그인 자바스크립트 클라이언트 참조

이 참조 페이지에서는 웹 애플리케이션에서 Google 로그인을 구현하는 데 사용할 자바스크립트 클라이언트 메서드와 속성을 설명합니다.

라이브러리 사용 중에 문제가 발생하면 GitHub 저장소에 신고하세요. .

인증 설정

Google API 플랫폼 라이브러리를 로드하여 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 */
  });
}

gapi.auth2.init(params)

GoogleAuth 객체를 초기화합니다. gapi.auth2.GoogleAuth의 메서드를 호출하기 전에 이 메서드를 호출해야 합니다.

GoogleAuth 객체를 초기화할 때 OAuth 2.0 클라이언트 ID와 지정할 추가 옵션으로 객체를 구성합니다. 사용자가 이미 로그인했다면 GoogleAuth 객체가 이전 세션에서 사용자의 로그인 상태를 복원합니다.

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

GoogleAuth.then(onInit, onError)

GoogleAuth 객체가 완전히 초기화되면 onInit 함수를 호출합니다. 초기화 중에 오류가 발생하면 (지원되지 않는 이전 브라우저에서 발생할 수 있음) onError 함수가 대신 호출됩니다.

오류 코드

idpiframe_initialization_failed

예를 들어 지원되지 않는 환경으로 인해 Google에서 필요한 iframe을 초기화하지 못했습니다. details 속성은 발생한 오류에 관한 자세한 정보를 제공합니다.

gapi.auth2.ClientConfig

gapi.auth2.init 메서드의 다양한 구성 매개변수를 나타내는 인터페이스입니다.

인증

GoogleAuth는 사용자가 Google 계정으로 로그인하고, 사용자의 현재 로그인 상태를 가져오고, 사용자의 Google 프로필에서 특정 데이터를 가져오고, 추가 범위를 요청하고, 현재 계정에서 로그아웃할 수 있는 메서드를 제공하는 싱글톤 클래스입니다.

gapi.auth2.getAuthInstance()

GoogleAuth 객체를 반환합니다. 이 메서드를 호출하기 전에 gapi.auth2.init()로 GoogleAuth 객체를 초기화해야 합니다.

GoogleAuth.isSignedIn.get()

현재 사용자가 로그인되어 있는지 여부를 반환합니다.

GoogleAuth.isSignedIn.listen(listener)

현재 사용자의 로그인 상태 변경을 리슨합니다.

GoogleAuth.signIn()

gapi.auth2.init()에 지정된 옵션으로 사용자를 로그인합니다.

오류 코드

GoogleAuth.signIn(options)을 참고하세요.

GoogleAuth.signIn(options)

지정된 옵션을 사용하여 사용자를 로그인 처리합니다.

오류 코드

popup_closed_by_user

사용자가 로그인 흐름을 완료하기 전에 팝업을 닫았습니다.

access_denied

사용자가 필요한 범위에 대한 권한을 거부했습니다.

immediate_failed

동의 절차를 안내하지 않고는 자동으로 선택되는 사용자가 없었습니다. prompt: 'none' 옵션과 함께 signIn를 사용할 때 발생하는 오류 이전 세션에서 로그인한 적이 있는 경우 gapi.auth2.init가 사용자를 자동으로 로그인하므로 이 옵션을 사용하지 않아도 됩니다.

gapi.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

동의 흐름을 표시하지 않으면 사용자를 자동으로 선택할 수 없습니다. prompt: 'none' 옵션과 함께 signIn를 사용할 때 발생하는 오류 이 옵션은 사용해야 할 필요가 없습니다. 이전 세션에서 로그인한 적이 있으면 gapi.auth2.init가 자동으로 사용자를 로그인하기 때문입니다.

gapi.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()

사용자의 고유 ID 문자열을 가져옵니다.

GoogleUser.isSignedIn()

사용자가 로그인되어 있으면 true를 반환합니다.

GoogleUser.getHostedDomain()

사용자가 G Suite 계정으로 로그인한 경우 사용자의 G Suite 도메인을 가져옵니다.

GoogleUser.getGrantedScopes()

사용자가 부여한 범위를 공백으로 구분된 문자열로 가져옵니다.

GoogleUser.getBasicProfile()

사용자의 기본 프로필 정보를 가져옵니다.

GoogleUser.getAuthResponse(includeAuthorizationData)

사용자의 인증 세션에서 응답 객체를 가져옵니다.

GoogleUser.reloadAuthResponse()

액세스 토큰을 강제로 새로고침한 다음 새 AuthResponse의 Promise를 반환합니다.

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()

사용자가 애플리케이션에 부여한 모든 범위를 취소합니다.

UI 요소

gapi.signin2.render(id, options)

options 객체에 지정된 설정을 사용하여 지정된 ID의 요소에 로그인 버튼을 렌더링합니다.

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

고급

gapi.auth2.authorize(params, callback)

일회성 OAuth 2.0 승인을 실행합니다. 사용되는 매개변수에 따라 Google 로그인 흐름 팝업이 열리거나 사용자 상호작용 없이 요청된 응답을 자동으로 로드하려고 시도합니다.

이 메서드가 유용한 사용 사례는 다음과 같습니다.

• 애플리케이션에서는 Google API 엔드포인트를 한 번만 요청하면 됩니다. 예를 들어 사용자가 처음 로그인할 때 즐겨찾는 YouTube 동영상을 로드할 수 있습니다.
• 애플리케이션에는 자체 세션 관리 인프라가 있으며 백엔드에서 사용자를 식별하는 데 ID 토큰이 한 번만 필요합니다.
• 여러 클라이언트 ID가 동일한 페이지 내에서 사용됩니다.

{
  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

지원되지 않는 환경으로 인해 Google에서 필수 iframe을 초기화할 수 없습니다. details 속성은 발생한 오류에 관한 자세한 정보를 제공합니다.

popup_closed_by_user

사용자가 로그인 흐름을 완료하기 전에 팝업을 닫았습니다.

access_denied

사용자가 필요한 범위에 대한 권한을 거부했습니다.

immediate_failed

동의 흐름을 표시하지 않으면 사용자를 자동으로 선택할 수 없습니다. prompt: 'none' 옵션과 함께 signIn를 사용할 때 발생하는 오류

gapi.auth2.AuthorizeConfig

gapi.auth2.authorize 메서드의 다양한 구성 매개변수를 나타내는 인터페이스입니다.

gapi.auth2.AuthorizeResponse

gapi.auth2.authorize 메서드의 콜백에 반환된 응답입니다.