GetGoogleIdOption.Builder
public final class GetGoogleIdOption.Builder
GetGoogleIdOption のビルダー。
概要
パブリック コンストラクタ |
|---|
Builder() |
パブリック メソッド |
|
|---|---|
final @NonNull GetGoogleIdOption.Builder |
associateLinkedAccounts(ユーザーのアカウントにリンクされている Google アカウントを使用したログインをサポートするかどうかを設定します。 |
final @NonNull GetGoogleIdOption |
build() |
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 トークンの生成時に使用するノンスを設定します。 |
final @NonNull GetGoogleIdOption.Builder |
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)登録時に確認済みの電話番号をリクエストするかどうかを設定します。 |
final @NonNull GetGoogleIdOption.Builder |
setServerClientId(@NonNull String serverClientId)ログイン時に生成される Google ID トークンのオーディエンスとして使用するサーバーのクライアント ID を設定します。 |
パブリック コンストラクタ
パブリック メソッド
associateLinkedAccounts
public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
@NonNull String linkedServiceId,
List<@NonNull String> idTokenDepositionScopes
)
ユーザーのアカウントにリンクされている Google アカウントを使用したログインをサポートするかどうかを設定します。
このような認証情報を選択すると、選択したアカウントがリンクされている Google アカウントの Google ID トークンが、まずサーバーにデポジットされ、その後、ユーザーに返されます。通常のログインと同様に、バックエンドで ID トークンを使用してユーザーをログインさせることができます。この認証情報を使用してログインするのは初回のみで、そのときに ID トークンがデポジットされることに注意してください。ID トークンはすでにユーザーのアカウントに関連付けられているため、以降のログインでは証拠提出は不要です。
setAutoSelectEnabled
public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)
リクエストで自動選択の動作を設定します。
自動選択を有効にすると、ユーザー操作（[続行] ボタンをタップするなど）を待たずに、認証情報を自動的に選択できます。認証情報が自動的に選択されるのは、1）ログインに使用できる認証情報が 1 つのみの場合、2）この認証情報に関してそれ以上の操作が必要ない場合（たとえば、Google アカウントのデータ共有権限がすでに収集されている場合）です。
setClaims
public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)
Google ID トークンに含めるクレームを設定します。
使用可能なクレームの一覧については、ドキュメントをご覧ください。サポートされていない申し立ては無視されます。
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 トークンの生成時に使用するノンスを設定します。
| パラメータ | |
|---|---|
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 を設定します。