GetGoogleIdOption.Builder

class GetGoogleIdOption.Builder


GetGoogleIdOption のビルダー。

まとめ

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

パブリック関数

GetGoogleIdOption.Builder
associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
)

ユーザー アカウントにリンクされている Google アカウントを使用したログインをサポートするかどうかを設定します。

GetGoogleIdOption
GetGoogleIdOption.Builder
setAutoSelectEnabled(autoSelectEnabled: Boolean)

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

GetGoogleIdOption.Builder
setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)

アプリケーションへのログインが承認された Google アカウントからのみ選択できるようにするかどうかを指定します。

GetGoogleIdOption.Builder
setNonce(nonce: String?)

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

GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)

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

GetGoogleIdOption.Builder
setServerClientId(serverClientId: String)

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

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

ビルダー

Builder()

パブリック関数

AssociateLinkedAccounts

fun associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
): GetGoogleIdOption.Builder

ユーザー アカウントにリンクされている Google アカウントを使用したログインをサポートするかどうかを設定します。

このような認証情報が選択されると、選択したアカウントがリンクされている Google アカウントの Google ID トークンがサーバーに配布され、ユーザーに返されます。通常のログインと同様に、バックエンドで ID トークンを使用してユーザーをログインさせることができます。ID トークンの配布は、この認証情報を使用して初めてログインしたときにのみ行われます。ID トークンはユーザーのアカウントとすでに関連付けられているため、その後のログインではデポジットは必要ありません。

パラメータ
linkedServiceId: String

アカウントを Google アカウントにリンクする際に使用されるサービス ID。

idTokenDepositionScopes: List<String>?

Google がアプリケーションのバックエンド サーバーに Google ID トークンを付与するために必要な OAuth スコープ。これはオプションであり、null に設定できます。Google が特定のスコープに ID トークンを付与できるようにする場合にのみ必要です。

build

fun build(): GetGoogleIdOption

setAutoSelectEnabled

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

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

オプトインしたユーザーは、自動選択によって、ユーザーのアクション(「続行」ボタンのタップなど)を待つことなく、認証情報を自動的に選択できます。認証情報は、1)ログインに 1 つの認証情報しか使用できないため、かつ 2)この認証情報に対して追加のアクションを行う必要がない場合(たとえば、Google アカウントのデータ共有権限がすでに収集されている場合)に、自動的に選択できます。

setFilterByAuthorizedAccounts

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

アプリケーションへのログインが承認された Google アカウントからのみ選択できるようにするかどうかを指定します。デフォルト値は true です。

{@code true} の場合、ユーザーは基本的なプロファイル/メールデータをアプリと共有するために明示的な承認を必要とする Google アカウントを選択できません。これにより、ログイン ユーザー エクスペリエンスの負担が軽減され、返される認証情報が「リピーター」であることが保証されますが、デバイス上のすべての Google アカウント間でユーザーが自由に選択できるようになります。

パラメータ
filterByAuthorizedAccounts: Boolean

アプリケーションへのログインが承認された Google アカウントからユーザーのみが選択できるようにするかどうかを指定します。

setNonce

fun setNonce(nonce: String?): GetGoogleIdOption.Builder

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

パラメータ
nonce: String?

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

setRequestVerifiedPhoneNumber を設定する

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

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

登録時にのみこの機能を使用できるため、この機能を使用するには [filterByAuthorizedAccounts] フィールドを明示的に false に設定する必要があります。

setServerClientId

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

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

パラメータ
serverClientId: String

ID トークンが発行されるサーバーのクライアント ID