GetGoogleIdOption

Kotlin |Java

class GetGoogleIdOption : GetCustomCredentialOption

kotlin.Any
↳	androidx.credentials.CredentialOption
	↳	androidx.credentials.GetCustomCredentialOption
		↳	com.google.android.libraries.identity.googleid.GetGoogleIdOption

---

ユーザーの Google ID トークンを取得するためのリクエスト。

例外
java.lang.IllegalArgumentException: java.lang.IllegalArgumentException	serverClientId が空の場合
java.lang.IllegalArgumentException: java.lang.IllegalArgumentException	filterByAuthorizedAccounts と requestVerifiedPhoneNumber の両方が true の場合。
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException: com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	バンドルから GetGoogleIdOption の作成中にエラーが発生しました。

まとめ

ネストされた型
class GetGoogleIdOption.Builder GetGoogleIdOption のビルダー。

パブリック コンパニオン関数
GetGoogleIdOption	createFrom(data: Bundle) 特定の Bundle から GetGoogleIdOption を作成するヘルパー関数。

パブリック コンストラクタ
GetGoogleIdOption(     serverClientId: String,     nonce: String?,     filterByAuthorizedAccounts: Boolean,     linkedServiceId: String?,     idTokenDepositionScopes: List<String>?,     requestVerifiedPhoneNumber: Boolean,     autoSelectEnabled: Boolean )

公開プロパティ
Boolean	autoSelectEnabled リクエストで自動選択動作を設定します。
Boolean	filterByAuthorizedAccounts アプリケーションへのログインが承認された Google アカウントからのユーザーの選択のみを許可するかどうかを指定します。デフォルト値は true です。
List<String>?	idTokenDepositionScopes Google がアプリケーションのバックエンド サーバーに Google ID トークンを付与するために必要な OAuth スコープ。
String?	linkedServiceId アカウントを Google アカウントにリンクするときに使用するサービス ID
String?	nonce ID トークンの生成時に使用するノンス
Boolean	requestVerifiedPhoneNumber 登録時に確認済みの電話番号をリクエストするかどうかを指定します。
String	serverClientId ID トークンが発行されるサーバーのクライアント ID

継承されるプロパティ
androidx.credentials.CredentialOption Set<ComponentName> allowedProviders Bundle candidateQueryData Boolean isAutoSelectAllowed Boolean isSystemProviderRequired Bundle requestData String type

パブリック コンパニオン関数

作成元

fun createFrom(data: Bundle): GetGoogleIdOption

特定の Bundle から GetGoogleIdOption を作成するヘルパー関数。

パラメータ
data: Bundle	GetGoogleIdOption に関する必要な情報をすべて含むバンドル。

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

GetGoogleIdOption

GetGoogleIdOption(
    serverClientId: String,
    nonce: String? = null,
    filterByAuthorizedAccounts: Boolean = true,
    linkedServiceId: String? = null,
    idTokenDepositionScopes: List<String>? = null,
    requestVerifiedPhoneNumber: Boolean = false,
    autoSelectEnabled: Boolean = false
)

公開プロパティ

autoSelectEnabled（自動選択が有効）

val autoSelectEnabled: Boolean

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

filterByAuthorizedAccounts

val filterByAuthorizedAccounts: Boolean

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

idTokenDepositionScopes

val idTokenDepositionScopes: List<String>?

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

リンクされたサービス ID

val linkedServiceId: String?

アカウントを Google アカウントにリンクするときに使用するサービス ID

nonce

val nonce: String?

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

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

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

serverClientId

val serverClientId: String

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