구글 (google) - 레퍼런스
연동을 마치셨나요?
SDK 메서드를 사용하기 위해선 필수 선행 작업으로 연동하기를 마쳐야합니다.
개요
google 네임스페이스는 구글 네이티브 로그인 기능을 제공하며, 사용자는 Google 계정을 통해 인증할 수 있습니다.
이 네임스페이스를 사용하여 로그인, 사용자 정 보 조회, 로그인 상태 확인, 로그아웃과 같은 기능을 수행할 수 있습니다.
타입 정의
GoogleResult
구글 로그인 및 요청의 결과 상태를 나타내는 타입입니다.
export declare type GoogleSuccessResult = {
status: 'success';
statusCode: 200;
};
export declare type GoogleErrorResult = {
status: 'error';
statusCode: number;
message: string;
};
export declare type GoogleResult = GoogleSuccessResult | GoogleErrorResult;
| 필드 | 타입 | 설명 |
|---|---|---|
status | 'error' | 'success' | 요청 성공 또는 실패 상태 |
statusCode | number | 상태 코드 (성공 시 200) |
message | string (optional) | 오류 메시지 (실패 시 반환) |
GoogleUserData
구글 사용자 데이터를 나타내는 타입입니다.
export declare type GoogleUserData = {
uid: string;
email?: string;
displayName?: string;
photoURL?: string;
phoneNumber?: string;
isEmailVerified: boolean;
providerId?: string;
};
| 필드 | 타입 | 설명 |
|---|---|---|
uid | string | 사용자 고유 식별자 |
email | string | 이메일 주소 (optional) |
displayName | string | 사용자 이름 (optional) |
photoURL | string | 프로필 사진 URL (optional) |
phoneNumber | string | 전화번호 (optional) |
isEmailVerified | boolean | 이메일 인증 여부 |
providerId | string | 인증 제공자 ID (optional) |
메서드 목록
| 메서드 | 설명 | 추가된 버전 |
|---|---|---|
login(callback) | 구글 네이티브 로그인 | v1.5.0 |
isLoggedIn(callback) | 로그인 상태 확인 | v1.5.0 |
getUserData(callback) | 사용자 데이터 요청 | v1.5.0 |
logout(callback) | 구글 네이티브 로그아웃 | v1.5.0 |
메서드 상세
login(callback: (result: GoogleResult, idToken?: string, userData?: GoogleUserData) => void): void
- since : v1.5.0
주의
연동하기가 완료되어야 사용할 수 있습니다.
설명
구글 네이티브 로그인 요청을 수행합니다.
로그인 성공 시 idToken 과 userData 를 콜백으로 반환합니다.