GoogleIdTokenCredential

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	id または idToken のいずれかが null の場合。
java.lang.IllegalArgumentException	id または idToken のいずれかが空の場合、または idToken が不正な形式であるか、解析できない場合。

概要

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

定数
const String	BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE SignInWithGoogleOption と GetGoogleIdTokenOption を区別するために、SignInWithGoogleOption リクエストと候補データバンドルでキーとして使用される定数。
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?	email idToken から解析されたユーザーのメールアドレス。
String?	familyName ユーザーの姓。
String?	givenName ユーザーの名。
String	id このプロパティは非推奨です。安定したユーザー識別子には uniqueId を、ユーザーのメールアドレスには email を使用します。
String	idToken ユーザーの Google ID トークン。
String?	phoneNumber このプロパティは非推奨です。電話番号のサポートは終了します。
Uri?	profilePictureUri ユーザーのプロフィール写真の URI。
String	uniqueId idToken から解析されたユーザーの Google アカウントの一意の ID。

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

定数

BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE

const val BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE: String

SignInWithGoogleOption を GetGoogleIdTokenOption と区別するために、SignInWithGoogleOption リクエストと候補データバンドルでキーとして使用される定数。上記の 2 つのオプションはどちらも型が 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 トークン認証情報のタイプを表します。

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

createFrom

fun createFrom(data: Bundle): GoogleIdTokenCredential

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

GoogleIdTokenCredential

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

パブリック プロパティ

displayName

val displayName: String?

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

メール

val email: String?

idToken から解析されたユーザーのメールアドレス。

familyName

val familyName: String?

ユーザーの姓。

givenName

val givenName: String?

ユーザーの名。

id

val id: String

このプロパティは非推奨です。
安定したユーザー識別子には uniqueId を、ユーザーのメールアドレスには email を使用してください。

ユーザーの Google アカウントに関連付けられたメールアドレスを非推奨にしました。

idToken

val idToken: String

ユーザーの Google ID トークン。

phoneNumber

val phoneNumber: String?

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

非推奨のユーザーの保存済み電話番号。

profilePictureUri

val profilePictureUri: Uri?

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

uniqueId

val uniqueId: String

idToken から解析されたユーザーの Google アカウントの一意の ID。