GoogleIdToken 認証情報

Kotlin |Java

class GoogleIdTokenCredential : CustomCredential

kotlin.Any
↳	androidx.credentials.Credential
	↳	androidx.credentials.CustomCredential
		↳	com.google.android.libraries.identity.googleid.GoogleIdTokenCredential

---

アプリ ログインのためにユーザーが付与するユーザーの Google ID トークンを表します。

例外
java.lang.NullPointerException: java.lang.NullPointerException	id または idToken のいずれかが null の場合。
java.lang.IllegalArgumentException: java.lang.IllegalArgumentException	id または idToken のいずれかが空の場合

まとめ

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

定数
const String	BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE SignInWithGoogleOption リクエストと候補データバンドルのキーとして使用される定数。SignInWithGoogleOption を GetGoogleIdTokenOption と区別します。
const String	TYPE_GOOGLE_ID_TOKEN_CREDENTIAL 定数は、Google ID トークンの認証情報の種類を表します。
const String	TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL 定数は、SiWG ボタンから取得した Google ID トークンの認証情報の種類を表します。

パブリック コンパニオン関数
GoogleIdTokenCredential	createFrom(data: Bundle)

パブリック コンストラクタ
GoogleIdTokenCredential(     id: String,     idToken: String,     displayName: String?,     familyName: String?,     givenName: String?,     profilePictureUri: Uri?,     phoneNumber: String? )

公開プロパティ
String?	displayName エントリに表示する表示名。
String?	familyName ユーザーの姓。
String?	givenName ユーザーの名です。
String	id ユーザーの Google アカウントに関連付けられているメールアドレス。
String	idToken ユーザーの Google ID が必要です。
String?	phoneNumber このプロパティは非推奨となりました。電話番号はサポートされなくなります。
Uri?	profilePictureUri ユーザーのプロフィール写真の URI。

継承されるプロパティ
androidx.credentials.Credential Bundle data String type

定数

BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE

const val BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE: String

SignInWithGoogleOption リクエストと候補データバンドルのキーとして使用される定数。SignInWithGoogleOption を GetGoogleIdTokenOption と区別します。前述の両方のオプションのタイプは TYPE_GOOGLE_ID_TOKEN_CREDENTIAL ですが、SignInWithGoogleOption ではサブタイプとして TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL がエンコードされています。

TYPE_GOOGLE_ID_TOKEN_CREDENTIAL

const val TYPE_GOOGLE_ID_TOKEN_CREDENTIAL: String

定数は、Google ID トークンの認証情報の種類を表します。

TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL

const val TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL: String

定数は、SiWG ボタンから取得した Google ID トークンの認証情報の種類を表します。

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

作成元

fun createFrom(data: Bundle): GoogleIdTokenCredential

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

GoogleIdToken 認証情報

GoogleIdTokenCredential(
    id: String,
    idToken: String,
    displayName: String?,
    familyName: String?,
    givenName: String?,
    profilePictureUri: Uri?,
    phoneNumber: String?
)

公開プロパティ

displayName

val displayName: String?

エントリに表示する表示名。

familyName

val familyName: String?

ユーザーの姓。

givenName

val givenName: String?

ユーザーの名です。

id

val id: String

ユーザーの Google アカウントに関連付けられているメールアドレス。

idToken

val idToken: String

ユーザーの Google ID が必要です。

phoneNumber

val phoneNumber: String?

このプロパティは非推奨となりました。
電話番号はサポートされなくなります。

ユーザーが保存した電話番号。

profilePictureUri

val profilePictureUri: Uri?

ユーザーのプロフィール写真の URI。