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	serverClientId が空の場合
java.lang.IllegalArgumentException	filterByAuthorizedAccounts と requestVerifiedPhoneNumber の両方が true の場合。
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,     claims: List<Claim>?,     hostedDomainFilter: String? )

パブリック プロパティ
Boolean	autoSelectEnabled リクエストで自動選択の動作を設定します。登録。
List<Claim>?	claims
Boolean	filterByAuthorizedAccounts ユーザーがアプリケーションへのログインをすでに承認している Google アカウントからのみ選択できるようにするかどうか。デフォルト値は true です。
String?	hostedDomainFilter フィルタリングするドメイン（例: "example.com")
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 Int typePriorityHint

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

createFrom

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,
    claims: List<Claim>? = null,
    hostedDomainFilter: String? = null
)

パブリック プロパティ

autoSelectEnabled

val autoSelectEnabled: Boolean

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

提出

val claims: List<Claim>?

filterByAuthorizedAccounts

val filterByAuthorizedAccounts: Boolean

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

hostedDomainFilter

val hostedDomainFilter: String?

フィルタリングするドメイン（例: "example.com")

idTokenDepositionScopes

val idTokenDepositionScopes: List<String>?

Google が Google ID トークンをアプリケーションのバックエンド サーバーにデポジットするために必要な OAuth スコープ。これは省略可能で、null に設定できます。Google が ID トークンをデポジットするために特定のスコープを必要とする場合にのみ必要です。

linkedServiceId

val linkedServiceId: String?

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

nonce

val nonce: String?

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

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

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

serverClientId

val serverClientId: String

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