GoogleIdTokenCredential

Kotlin |Java

public final class GoogleIdTokenCredential extends CustomCredential

java.lang.Object
↳	androidx.credentials.Credential
	↳	androidx.credentials.CustomCredential
		↳	com.google.android.libraries.identity.googleid.GoogleIdTokenCredential

---

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

例外
NullPointerException	id または idToken のいずれかが null の場合。
IllegalArgumentException	id または idToken のいずれかが空の場合、または idToken の形式が正しくないか、解析できない場合。

概要

ネストされたタイプ
public final class GoogleIdTokenCredential.Builder GoogleIdTokenCredential のビルダー

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

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

パブリック メソッド
static final @NonNull GoogleIdTokenCredential	createFrom(@NonNull Bundle data)
final String	getDisplayName() エントリに表示する表示名。
final String	getEmail() idToken から解析されたユーザーのメールアドレス。
final String	getFamilyName() ユーザーの姓。
final String	getGivenName() ユーザーの名。
final @NonNull String	getId() このメソッドは非推奨です。安定したユーザー識別子には uniqueId を、ユーザーのメールアドレスには email を使用します。
final @NonNull String	getIdToken() ユーザーの Google ID トークン。
final String	getPhoneNumber() このメソッドは非推奨です。電話番号のサポートは終了します。
final Uri	getProfilePictureUri() ユーザーのプロフィール写真の URI。
final @NonNull String	getUniqueId() idToken から解析されたユーザーの Google アカウントの一意の ID。

継承されるメソッド
From androidx.credentials.Credential final @NonNull Bundle getData() final @NonNull String getType()

定数

BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE

public static final @NonNull String BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE

SignInWithGoogleOption と GetGoogleIdTokenOption を区別するために、SignInWithGoogleOption リクエストと候補データバンドルでキーとして使用される定数。上記の 2 つのオプションはどちらも TYPE_GOOGLE_ID_TOKEN_CREDENTIAL 型ですが、SignInWithGoogleOption には、このキーに対してエンコードされたサブタイプ TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL があります。

TYPE_GOOGLE_ID_TOKEN_CREDENTIAL

public static final @NonNull String TYPE_GOOGLE_ID_TOKEN_CREDENTIAL

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

TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL

public static final @NonNull String TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL

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

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

GoogleIdTokenCredential

public GoogleIdTokenCredential(
    @NonNull String id,
    @NonNull String idToken,
    String displayName,
    String familyName,
    String givenName,
    Uri profilePictureUri,
    String phoneNumber
)

パブリック メソッド

createFrom

public static final @NonNull GoogleIdTokenCredential createFrom(@NonNull Bundle data)

getDisplayName

public final String getDisplayName()

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

getEmail

public final String getEmail()

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

getFamilyName

public final String getFamilyName()

ユーザーの姓。

getGivenName

public final String getGivenName()

ユーザーの名。

getId

public final @NonNull String getId()

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

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

getIdToken

public final @NonNull String getIdToken()

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

getPhoneNumber

public final String getPhoneNumber()

このメソッドは非推奨です。
電話番号はサポートされなくなります。

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

getProfilePictureUri

public final Uri getProfilePictureUri()

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

getUniqueId

public final @NonNull String getUniqueId()

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