Google HTML API 참조로 로그인

이 참조 페이지에서는 Google 계정으로 로그인 HTML 데이터 속성 API를 설명합니다. 이 API를 사용하여 웹페이지에 원탭 메시지 또는 Google 계정으로 로그인 버튼을 표시할 수 있습니다.

ID가 'g_id_onload'인 요소

<div> 및 <span>와 같이 표시되거나 표시되지 않는 모든 요소에 Google 계정으로 로그인 데이터 속성을 배치할 수 있습니다. 유일한 요구사항은 요소 ID를 g_id_onload로 설정하는 것입니다. 이 ID를 여러 요소에 적용하지 마세요.

데이터 속성

다음 표에는 데이터 속성과 설명이 나와 있습니다.

속성 유형

다음 섹션에는 각 속성의 유형에 대한 세부정보와 예가 포함되어 있습니다.

data-client_id

이 속성은 앱의 클라이언트 ID로, Google Cloud 콘솔에서 확인 및 생성됩니다. 자세한 내용은 다음 표를 참고하세요.

data-auto_prompt

이 속성은 원탭을 표시할지 여부를 결정합니다. 기본값은 true입니다. 값이 false인 경우 Google One 탭이 표시되지 않습니다. 자세한 내용은 다음 표를 참고하세요.

data-auto_select

이 속성은 하나의 Google 세션만 앱을 승인한 경우 사용자 상호작용 없이 ID 토큰을 자동으로 반환할지 결정합니다. 기본값은 false입니다. 자세한 내용은 다음 표를 참고하세요.

data-login_uri

이 속성은 로그인 엔드포인트의 URI입니다.

이 값은 API 콘솔에서 구성한 OAuth 2.0 클라이언트에 승인된 리디렉션 URI 중 하나와 정확히 일치해야 하며 리디렉션 URI 유효성 검사 규칙을 준수해야 합니다.

현재 페이지가 로그인 페이지인 경우 이 속성을 생략할 수 있으며, 이 경우 사용자 인증 정보가 기본적으로 이 페이지에 게시됩니다.

콜백 함수가 정의되지 않고 사용자가 Google 계정으로 로그인 또는 원탭 버튼을 클릭하거나 자동 서명이 발생할 때 ID 토큰 사용자 인증 정보 응답이 로그인 엔드포인트에 게시됩니다.

자세한 내용은 다음 표를 참고하세요.

로그인 엔드포인트는 본문에 ID 토큰 값이 있는 credential 키가 포함된 POST 요청을 처리해야 합니다.

다음은 로그인 엔드포인트에 대한 요청의 예입니다.

POST /login HTTP/1.1
Host: www.example.com
Content-Type: application/x-www-form-urlencoded

credential=ID_TOKEN

data-callback

이 속성은 반환된 ID 토큰을 처리하는 JavaScript 함수의 이름입니다. 자세한 내용은 다음 표를 참고하세요.

data-login_uri 및 data-callback 속성 중 하나가 사용될 수 있습니다. 다음 구성요소 및 UX 모드 구성에 따라 다릅니다.

• data-login_uri 속성은 data-callback 속성을 무시하는 Google 계정으로 로그인 버튼 redirect UX 모드에 필요합니다.

• Google One Tap 및 Google 로그인 버튼 popup UX 모드에는 이 두 속성 중 하나를 설정해야 합니다. 둘 다 설정하면 data-callback 속성의 우선순위가 더 높습니다.

네임스페이스 내의 JavaScript 함수는 HTML API에서 지원되지 않습니다. 대신 네임스페이스가 없는 전역 자바스크립트 함수를 사용하세요. 예를 들어 mylib.callback 대신 mylibCallback를 사용합니다.

data-native_login_uri

이 속성은 비밀번호 사용자 인증 정보 핸들러 엔드포인트의 URL입니다. data-native_login_uri 속성 또는 data-native_callback 속성을 설정하면 JavaScript 라이브러리는 Google 세션이 없을 때 기본 사용자 인증 정보 관리자로 대체됩니다. data-native_callback 및 data-native_login_uri 속성을 모두 설정할 수는 없습니다. 자세한 내용은 다음 표를 참고하세요.

data-native_callback

이 속성은 브라우저의 기본 사용자 인증 정보 관리자에서 반환된 비밀번호 사용자 인증 정보를 처리하는 JavaScript 함수의 이름입니다. data-native_login_uri 속성 또는 data-native_callback 속성을 설정하면 JavaScript 라이브러리는 Google 세션이 없을 때 기본 사용자 인증 정보 관리자로 대체됩니다. data-native_callback와 data-native_login_uri를 모두 설정할 수는 없습니다. 자세한 내용은 다음 표를 참고하세요.

네임스페이스 내의 JavaScript 함수는 HTML API에서 지원되지 않습니다. 대신 네임스페이스가 없는 전역 JavaScript 함수를 사용하세요. 예를 들어 mylib.callback 대신 mylibCallback를 사용합니다.

data-native_id_param

비밀번호 사용자 인증 정보 핸들러 엔드포인트에 비밀번호 사용자 인증 정보를 제출할 때 credential.id 필드에 매개변수 이름을 지정할 수 있습니다. 기본 이름은 email입니다. 자세한 내용은 다음 표를 참고하세요.

data-native_password_param

비밀번호 사용자 인증 정보를 비밀번호 사용자 인증 정보 핸들러 엔드포인트에 제출할 때 credential.password 값의 매개변수 이름을 지정할 수 있습니다. 기본 이름은 password입니다. 자세한 내용은 다음 표를 참고하세요.

data-cancel_on_tap_outside

이 속성은 사용자가 메시지 외부를 클릭할 때 원탭 요청을 취소할지 여부를 설정합니다. 기본값은 true입니다. 사용 중지하려면 값을 false로 설정합니다. 자세한 내용은 다음 표를 참고하세요.

data-prompt_parent_id

이 속성은 컨테이너 요소의 DOM ID를 설정합니다. 설정되어 있지 않으면 창 오른쪽 상단에 원탭 메시지가 표시됩니다. 자세한 내용은 다음 표를 참고하세요.

data-skip_prompt_cookie

지정된 쿠키에 비어 있지 않은 값이 있는 경우 이 속성은 원탭을 건너뜁니다. 자세한 내용은 다음 표를 참고하세요.

data-nonce

이 속성은 ID 토큰에서 재생 공격을 방지하기 위해 사용하는 임의의 문자열입니다. 자세한 내용은 다음 표를 참고하세요.

nonce 길이는 사용자 환경, 개별 브라우저 및 서버의 HTTP 크기 제약조건에서 지원되는 최대 JWT 크기로 제한됩니다.

데이터 컨텍스트

이 속성은 원탭 메시지에 표시되는 제목과 메시지의 텍스트를 변경합니다. 자세한 내용은 다음 표를 참고하세요.

다음 표에는 사용 가능한 모든 컨텍스트와 설명이 나와 있습니다.

데이터-모멘트_콜백

이 속성은 프롬프트 UI 상태 알림 리스너의 함수 이름입니다. 자세한 내용은 데이터 유형 PromptMomentNotification을 참고하세요.

자세한 내용은 다음 표를 참고하세요.

네임스페이스 내의 JavaScript 함수는 HTML API에서 지원되지 않습니다. 대신 네임스페이스가 없는 전역 자바스크립트 함수를 사용하세요. 예를 들어 mylib.callback 대신 mylibCallback를 사용합니다.

data-state_cookie_domain

상위 도메인과 하위 도메인에 원탭을 표시해야 하는 경우 단일 공유 상태 쿠키가 사용되도록 상위 도메인을 이 속성에 전달합니다. 자세한 내용은 다음 표를 참고하세요.

data-ux_mode

이 속성은 Google 계정으로 로그인 버튼에서 사용하는 UX 흐름을 설정합니다. 기본값은 popup입니다. 이 속성은 원탭 UX에 영향을 미치지 않습니다. 자세한 내용은 다음 표를 참고하세요.

다음 표에는 사용 가능한 UX 모드와 설명이 나와 있습니다.

data-allowed_parent_origin

중간 iframe을 삽입할 수 있는 출처입니다. 이 속성이 있는 경우 원탭이 중간 iframe 모드에서 실행됩니다. 자세한 내용은 다음 표를 참고하세요.

다음 표에는 지원되는 값 유형과 설명이 나와 있습니다.

data-allowed_parent_origin 속성의 값이 유효하지 않으면 중간 iframe 모드의 원탭 초기화가 실패하고 중지됩니다.

와일드 카드 프리픽스도 지원됩니다. 예를 들어 "https://*.example.com"는 모든 수준에서 example.com 및 하위 도메인 (예: news.example.com, login.news.example.com)과 일치합니다.와일드 카드를 사용할 때 유의해야 할 사항은 다음과 같습니다.

• 패턴 문자열은 와일드 카드와 최상위 도메인으로만 구성될 수 없습니다. 예를 들어 https://*.com 및 https://*.co.uk는 유효하지 않습니다. 위에서 언급한 대로 "https://*.example.com"는 example.com 및 그 하위 도메인과 일치합니다. 쉼표로 구분된 목록을 사용하여 2개의 서로 다른 도메인을 나타낼 수도 있습니다. 예를 들어 "https://example1.com,https://*.example2.com"는 example1.com, example2.com 도메인 및 example2.com의 하위 도메인과 일치합니다.
• 와일드 카드 도메인은 안전한 https:// 스키마로 시작해야 하므로 "*.example.com"은 잘못된 것으로 간주됩니다.

data-intermediate_iframe_close_callback

사용자가 원탭 UI에서 'X' 버튼을 탭하여 원탭을 수동으로 닫을 때 기본 중간 iframe 동작을 재정의합니다. 기본 동작은 DOM에서 중간 iframe을 즉시 삭제하는 것입니다.

data-intermediate_iframe_close_callback 필드는 중간 iframe 모드에서만 적용됩니다. 또한 원탭 iframe이 아닌 중간 iframe에만 영향을 미칩니다. 콜백이 호출되기 전에 원탭 UI가 삭제됩니다.

네임스페이스 내의 JavaScript 함수는 HTML API에서 지원되지 않습니다. 대신 네임스페이스가 없는 전역 JavaScript 함수를 사용하세요. 예를 들어 mylib.callback 대신 mylibCallback를 사용합니다.

data-itp_support

이 필드는 Intelligent Tracking Prevention(ITP)을 지원하는 브라우저에서 업그레이드된 원탭 UX를 사용 설정해야 하는지 결정합니다. 기본값은 false입니다. 자세한 내용은 다음 표를 참고하세요.

data-login_hint

애플리케이션에서 로그인해야 하는 사용자를 미리 알고 있으면 Google에 로그인 힌트를 제공할 수 있습니다. 성공하면 계정 선택을 건너뜁니다. 허용되는 값은 이메일 주소 또는 ID 토큰 sub 필드입니다.

자세한 내용은 login_hint의 OpenID Connect 문서를 참고하세요.

data-hd

사용자가 여러 계정을 가지고 있고 Workspace 계정으로만 로그인해야 하는 경우 이를 사용하여 Google에 도메인 이름 힌트를 제공합니다. 성공하면 계정 선택 중에 표시되는 사용자 계정이 제공된 도메인으로 제한됩니다. 와일드 카드 값: *는 사용자에게 Workspace 계정만 제공하고 계정 선택 중에 소비자 계정 (user@gmail.com)을 제외합니다.

자세한 내용은 hd의 OpenID Connect 문서를 참고하세요.

data-use_fedcm_for_prompt

브라우저가 사용자 로그인 메시지를 제어하고 웹사이트와 Google 간의 로그인 흐름을 중재하도록 허용합니다. 기본값은 false입니다. 자세한 내용은 FedCM으로 이전 페이지를 참고하세요.

data-enable_redirect_uri_validation

리디렉션 URI 유효성 검사 규칙을 준수하는 버튼 리디렉션 흐름을 사용 설정합니다.

'g_id_signin' 클래스가 포함된 요소

요소의 class 속성에 g_id_signin를 추가하면 요소가 Google 계정으로 로그인 버튼으로 렌더링됩니다.

동일한 페이지에 여러 개의 Google 계정으로 로그인 버튼을 렌더링할 수 있습니다. 각 버튼에는 고유한 시각적 설정이 있을 수 있습니다. 설정은 다음 데이터 속성으로 정의됩니다.

시각적 데이터 속성

다음 표에는 시각적 데이터 속성과 설명이 나와 있습니다.

속성 유형

다음 섹션에는 각 속성의 유형과 예에 관한 세부정보가 포함되어 있습니다.

데이터 유형

버튼 유형입니다. 기본값은 standard입니다. 자세한 내용은 다음 표를 참고하세요.

다음 표에는 사용 가능한 모든 버튼 유형과 설명이 나와 있습니다.

유형
standard
icon

data-theme

버튼 테마입니다. 기본값은 outline입니다. 자세한 내용은 다음 표를 참고하세요.

다음 표에는 사용 가능한 테마와 설명이 나와 있습니다.

테마
outline
filled_blue
filled_black

data-size

버튼 크기입니다. 기본값은 large입니다. 자세한 내용은 다음 표를 참고하세요.

다음 표에는 사용 가능한 버튼 크기와 설명이 나와 있습니다.

크기
large
medium
small

데이터 텍스트

버튼 텍스트입니다. 기본값은 signin_with입니다. data-text 속성이 다른 아이콘 버튼의 텍스트에는 시각적인 차이가 없습니다. 유일한 예외는 스크린 접근성을 위해 텍스트를 읽는 경우입니다.

자세한 내용은 다음 표를 참고하세요.

다음 표에는 사용 가능한 버튼 텍스트와 설명이 나와 있습니다.

텍스트
signin_with
signup_with
continue_with
signin

데이터 형태

버튼 모양입니다. 기본값은 rectangular입니다. 자세한 내용은 다음 표를 참고하세요.

다음 표에는 사용 가능한 버튼 모양과 설명이 나와 있습니다.

도형
rectangular
pill
circle
square

data-logo_alignment

Google 로고의 정렬입니다. 기본값은 left입니다. 이 속성은 standard 버튼 유형에만 적용됩니다. 자세한 내용은 다음 표를 참고하세요.

다음 표에는 사용 가능한 정렬 및 설명이 나와 있습니다.

logo_alignment
left
center

data-width

최소 버튼 너비(픽셀)입니다. 사용 가능한 최대 너비는 400픽셀입니다.

자세한 내용은 다음 표를 참고하세요.

data-locale

선택사항입니다. 지정된 언어를 사용하여 버튼 텍스트를 표시합니다. 그러지 않으면 사용자의 Google 계정 또는 브라우저 설정이 기본값으로 사용됩니다. 라이브러리를 로드할 때 src 디렉터리에 hl 매개변수와 언어 코드를 추가합니다(예: gsi/client?hl=<iso-639-code>).

설정하지 않으면 브라우저의 기본 언어 또는 Google 세션 사용자의 환경설정이 사용됩니다. 따라서 사용자마다 현지화된 버튼의 버전이 다르게 표시될 수 있으며 크기도 다를 수 있습니다.

자세한 내용은 다음 표를 참고하세요.

data-click_listener

data-click_listener 속성을 사용하여 Google 계정으로 로그인 버튼을 클릭할 때 호출할 JavaScript 함수를 정의할 수 있습니다.

  <script>
    function onClickHandler(){
      console.log("Sign in with Google button clicked...")
    }
  </script>
  .....
  <div class="g_id_signin"
      data-size="large"
      data-theme="outline"
      data-click_listener="onClickHandler">
  </div>

이 예시에서는 Google 계정으로 로그인 버튼을 클릭하면 Google 계정으로 로그인 버튼 클릭함... 메시지가 콘솔에 로깅됩니다.

data-state

선택사항입니다. 동일한 페이지에 여러 Google 계정으로 로그인 버튼을 렌더링할 수 있으므로 각 버튼에 고유한 문자열을 할당할 수 있습니다. 동일한 문자열이 ID 토큰과 함께 반환되므로 사용자가 로그인하기 위해 클릭한 버튼을 식별할 수 있습니다.

자세한 내용은 다음 표를 참고하세요.

서버 측 통합

서버 측 엔드포인트는 다음 HTTP POST 요청을 처리해야 합니다.

ID 토큰 핸들러 엔드포인트

ID 토큰 핸들러 엔드포인트가 ID 토큰을 처리합니다. 상응하는 계정의 상태에 따라 사용자를 로그인하고 가입 페이지로 안내하거나 추가 정보에 대한 계정 연결 페이지로 안내할 수 있습니다.

HTTP POST 요청에는 다음 정보가 포함됩니다.

사용자 인증정보

디코딩된 ID 토큰은 다음 예와 같습니다.

header
{
  "alg": "RS256",
  "kid": "f05415b13acb9590f70df862765c655f5a7a019e", // JWT signature
  "typ": "JWT"
}
payload
{
  "iss": "https://accounts.google.com", // The JWT's issuer
  "nbf":  161803398874,
  "aud": "314159265-pi.apps.googleusercontent.com", // Your server's client ID
  "sub": "3141592653589793238", // The unique ID of the user's Google Account
  "hd": "gmail.com", // If present, the host domain of the user's GSuite email address
  "email": "elisa.g.beckett@gmail.com", // The user's email address
  "email_verified": true, // true, if Google has verified the email address
  "azp": "314159265-pi.apps.googleusercontent.com",
  "name": "Elisa Beckett",
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/e2718281828459045235360uler",
  "given_name": "Eliza",
  "family_name": "Beckett",
  "iat": 1596474000, // Unix timestamp of the assertion's creation time
  "exp": 1596477600, // Unix timestamp of the assertion's expiration time
  "jti": "abc161803398874def"
}

sub 필드는 Google 계정의 전역 고유 식별자입니다. sub 필드는 모든 Google 계정에서 고유하며 재사용되지 않으므로 사용자의 식별자로 만 사용합니다. 하나의 Google 계정이 서로 다른 시점에 여러 이메일 주소를 가질 수 있으므로 이메일 주소를 식별자로 사용하지 마세요.

email, email_verified, hd 필드를 사용하면 Google이 이메일 주소를 호스팅하고 신뢰할 수 있는 이메일 주소인지 확인할 수 있습니다. Google이 신뢰할 수 있는 경우 사용자가 합법적인 계정 소유자임이 확인됩니다.

Google이 권한을 가진 케이스:

• email에 @gmail.com 접미사가 있으면 Gmail 계정입니다.
• email_verified이 true이고 hd가 설정된 경우 이 계정은 Google Workspace 계정입니다.

사용자는 Gmail 또는 Google Workspace를 사용하지 않고도 Google 계정에 등록할 수 있습니다. email에 @gmail.com 접미사가 포함되어 있지 않고 hd가 없으면 Google은 신뢰할 수 없으며 사용자를 인증하려면 비밀번호 또는 기타 챌린지 방법을 사용하는 것이 좋습니다. email_verified는 Google 계정이 생성될 때 Google에서 사용자를 처음 인증했기 때문에 true일 수도 있지만, 그 이후 서드 파티 이메일 계정의 소유권이 변경되었을 수 있습니다.

exp 필드는 서버 측에서 토큰을 확인할 수 있는 만료 시간을 나타냅니다. Google 계정으로 로그인에서 가져온 ID 토큰의 경우 1시간입니다. 만료 시간 전에 토큰을 확인해야 합니다. 세션 관리에는 exp를 사용하지 마세요. 만료된 ID 토큰은 사용자가 로그아웃되었음을 의미하지 않습니다. 앱은 사용자의 세션 관리를 담당합니다.

select_by

다음 표에는 select_by 필드의 가능한 값이 나와 있습니다. 세션 및 동의 상태와 함께 사용되는 버튼 유형은 값을 설정하는 데 사용됩니다.

• 사용자가 원탭 또는 Google 계정으로 로그인 버튼을 누르거나 터치 없는 자동 로그인 프로세스를 사용했습니다.

• 기존 세션이 발견되었거나 사용자가 Google 계정을 선택하고 로그인하여 새 세션을 설정했습니다.

• ID 토큰 사용자 인증 정보를 앱과 공유하기 전에 사용자는 다음 중 하나를 실행합니다.

  • 확인 버튼을 눌러 사용자 인증 정보 공유에 동의했습니다.
  • 이전에 동의한 후 '계정 선택'을 사용하여 Google 계정을 선택했습니다.

이 필드의 값은

주

이 매개변수는 사용자가 Google 계정으로 로그인 버튼을 클릭하여 로그인하고 클릭한 버튼의 data-state 속성이 지정된 경우에만 정의됩니다. 이 필드의 값은 버튼의 data-state 속성에 지정한 값과 동일합니다.

여러 개의 Google 계정으로 로그인 버튼을 동일한 페이지에서 렌더링할 수 있으므로 각 버튼에 고유한 문자열을 할당할 수 있습니다. 따라서 이 state 매개변수를 사용하여 사용자가 로그인하기 위해 클릭한 버튼을 식별할 수 있습니다.

비밀번호 사용자 인증 정보 핸들러 엔드포인트

비밀번호 사용자 인증 정보 핸들러 엔드포인트는 네이티브 사용자 인증 관리자가 가져오는 비밀번호 사용자 인증 정보를 처리합니다.

HTTP POST 요청에는 다음 정보가 포함됩니다.