GetGoogleIdOption.Builder

public final class GetGoogleIdOption.Builder


GetGoogleIdOption의 빌더입니다.

요약

공개 생성자

공개 메서드

final @NonNull GetGoogleIdOption.Builder
associateLinkedAccounts(
    @NonNull String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes
)

사용자 계정에 연결된 Google 계정을 사용한 로그인을 지원할지 여부를 설정합니다.

final @NonNull GetGoogleIdOption
final @NonNull GetGoogleIdOption.Builder
setAutoSelectEnabled(boolean autoSelectEnabled)

요청에서 자동 선택 동작을 설정합니다.

final @NonNull GetGoogleIdOption.Builder

Google ID 토큰에 포함할 클레임을 설정합니다.

final @NonNull GetGoogleIdOption.Builder
setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

사용자가 애플리케이션에 로그인할 수 있도록 이미 승인된 Google 계정에서만 선택할 수 있도록 설정합니다.

final @NonNull GetGoogleIdOption.Builder
setHostedDomainFilter(String hostedDomainFilter)

호스팅 도메인 필터를 설정하여 Google 로그인을 특정 Google Workspace 도메인 내 계정으로 제한합니다.

final @NonNull GetGoogleIdOption.Builder

Google ID 토큰을 생성할 때 사용할 nonce를 설정합니다.

final @NonNull GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

가입 중에 인증된 전화번호를 요청할지 여부를 설정합니다.

final @NonNull GetGoogleIdOption.Builder
setServerClientId(@NonNull String serverClientId)

로그인 중에 생성된 Google ID 토큰의 잠재고객으로 사용할 서버의 클라이언트 ID를 설정합니다.

공개 생성자

빌더

public Builder()

공개 메서드

associateLinkedAccounts

public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
    @NonNull String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes
)

사용자 계정에 연결된 Google 계정을 사용한 로그인을 지원할지 여부를 설정합니다.

이러한 사용자 인증 정보가 선택되면 선택한 계정이 연결된 Google 계정의 Google ID 토큰이 먼저 서버에 입금된 후 사용자에게 반환됩니다. 일반 로그인과 마찬가지로 백엔드에서 ID 토큰을 사용하여 사용자를 로그인할 수 있습니다. 이 사용자 인증 정보를 사용하여 처음 로그인할 때만 ID 토큰이 증착됩니다. ID 토큰이 이미 사용자 계정과 연결되어 있으므로 이후 로그인에는 증착이 필요하지 않습니다.

매개변수
@NonNull String linkedServiceId

계정을 Google 계정에 연결할 때 사용되는 서비스 ID입니다.

List<@NonNull String> idTokenDepositionScopes

Google이 Google ID 토큰을 애플리케이션의 백엔드 서버에 입금하는 데 필요한 OAuth 범위입니다. 선택사항이며 null로 설정할 수 있습니다. Google에서 ID 토큰을 입금하기 위해 특정 범위가 필요한 경우에만 필요합니다.

build

public final @NonNull GetGoogleIdOption build()

setAutoSelectEnabled

public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)

요청에서 자동 선택 동작을 설정합니다.

선택한 사용자의 경우 자동 선택을 사용하면 사용자가 '계속' 버튼을 탭하는 등의 작업을 기다리지 않고도 사용자 인증 정보를 자동으로 선택할 수 있습니다. 사용자 인증 정보는 1) 로그인에 사용할 수 있는 사용자 인증 정보가 하나뿐이고 2) 이 사용자 인증 정보에 대해 추가 조치를 취할 필요가 없는 경우 (예: Google 계정에 대한 데이터 공유 권한이 이미 수집됨) 자동으로 선택될 수 있습니다.

setClaims

public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)

Google ID 토큰에 포함할 클레임을 설정합니다.

사용 가능한 클레임 목록은 문서를 참고하세요. 지원되지 않는 소유권 주장은 무시됩니다.

매개변수
@NonNull List<@NonNull Claim> claims

소유권 주장 목록

setFilterByAuthorizedAccounts

public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

사용자가 애플리케이션에 로그인할 수 있도록 이미 승인된 Google 계정에서만 선택할 수 있도록 설정합니다. 기본값은 true입니다.

{@code true}인 경우 사용자는 기본 프로필/이메일 데이터를 애플리케이션과 공유하기 위해 명시적 승인이 필요한 Google 계정을 선택할 수 없습니다. 이렇게 하면 로그인 사용자 여정에서 일부 불편함이 줄어들고 반환된 사용자 인증 정보가 '재방문 사용자'용임을 보장할 수 있지만, 기기의 모든 Google 계정 중에서 선택할 수 있는 사용자의 자유가 제한됩니다.

매개변수
boolean filterByAuthorizedAccounts

사용자가 애플리케이션에 로그인하도록 이미 승인된 Google 계정에서만 선택하도록 허용할지 여부

setHostedDomainFilter

public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)

호스팅 도메인 필터를 설정하여 Google 로그인을 특정 Google Workspace 도메인 내 계정으로 제한합니다.

null 또는 빈 문자열을 전달하면 필터링이 발생하지 않습니다.

매개변수
String hostedDomainFilter

필터링할 도메인입니다 (예: 'example.com')

setNonce

public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)

Google ID 토큰을 생성할 때 사용할 nonce를 설정합니다.

매개변수
String nonce

ID 토큰 생성 중에 사용할 nonce

setRequestVerifiedPhoneNumber

public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

가입 중에 인증된 전화번호를 요청할지 여부를 설정합니다.

이 기능을 사용하려면 [filterByAuthorizedAccounts] 필드를 명시적으로 false로 설정해야 합니다. 이 기능은 가입 중에만 사용할 수 있기 때문입니다.

setServerClientId

public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)

로그인 중에 생성된 Google ID 토큰의 잠재고객으로 사용할 서버의 클라이언트 ID를 설정합니다.

매개변수
@NonNull String serverClientId

ID 토큰이 발급될 서버의 클라이언트 ID