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
setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

ユーザーが、アプリへのログインがすでに承認されている Google アカウントのみを選択できるようにするかどうかを設定します。

final @NonNull GetGoogleIdOption.Builder

Google ID トークンの生成時に使用するノンスを設定します。

final @NonNull GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

登録時に確認済みの電話番号をリクエストするかどうかを設定します。

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

ログイン時に生成される Google ID トークンのオーディエンスとして使用するサーバー側のクライアント ID を設定します。

パブリック コンストラクタ

Builder

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 に設定できます。ID トークンをデポジットするために特定のスコープを Google が要求している場合にのみ必要です。

build

public final @NonNull GetGoogleIdOption build()

setAutoSelectEnabled

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

リクエストの自動選択動作を設定します。

自動選択を有効にしたユーザーは、ユーザーの操作([続行] ボタンのタップルなど)を待たずに認証情報を自動的に選択できます。認証情報は、1)ログインに使用できる認証情報が 1 つだけの場合、および 2)この認証情報について追加の操作が不要な場合(Google アカウントのデータ共有権限がすでに収集されている場合など)に自動的に選択できます。

setFilterByAuthorizedAccounts

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

ユーザーが、アプリへのログインがすでに承認されている Google アカウントのみを選択できるようにするかどうかを設定します。デフォルト値は true です。

{@code true} の場合、ユーザーは、基本的なプロフィール/メールデータをアプリと共有するために明示的な承認が必要な Google アカウントを選択できません。これにより、ログイン ユーザー ジャーニーの煩雑さが軽減され、返された認証情報が「リピーター」のものであることを保証できますが、デバイス上のすべての Google アカウントからユーザーが自由に選択できる範囲が制限されます。

パラメータ
boolean filterByAuthorizedAccounts

アプリケーションへのログインがすでに承認されている Google アカウントのみを選択できるようにするかどうか

setNonce

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

Google ID トークンの生成時に使用するノンスを設定します。

パラメータ
String nonce

ID トークンの生成時に使用するノンス

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