Phone Number Hint API は、Google Play 開発者サービスを活用したライブラリです。この API を使用すると、ユーザーの(SIM ベース)電話番号をヒントとしてスムーズに表示できます。
電話番号のヒントを使用するメリットは次のとおりです。
- 追加の権限リクエストは必要ありません
- ユーザーが手動で電話番号を入力する必要がない
- Google アカウントは必要ありません
- ログイン/登録ワークフローに直接関係しない
- 自動入力と比べて Android バージョンのサポート範囲が拡大
始める前に
アプリを準備するには、以下のセクションに示す手順を完了します。
アプリを設定する
モジュールの Gradle ビルドファイル(通常は app/build.gradle
)に、Phone Number Hint API 用の Google Play 開発者サービスの依存関係を追加します。
apply plugin: 'com.android.application'
...
dependencies {
implementation 'com.google.android.gms:play-services-auth:21.2.0'
}
仕組み
Phone Number Hint API は、PendingIntent
を使用してフローを開始します。PendingIntent が起動すると、UI が表示され、すべての(SIM ベースの)電話番号が一覧表示されます。その後、ユーザーは使用する電話番号を選択するか、フローをキャンセルできます。選択した電話番号をデベロッパーが Intent
から取得できるようになります。
GetPhoneNumbeHintIntentRequest オブジェクトを作成する
まず、提供されている GetPhoneNumberHintIntentRequest.Builder()
メソッドを使用して、GetPhoneNumberHintIntentRequest
オブジェクトを作成します。このリクエスト オブジェクトを使用して Intent
を取得し、Phone Number Hint フローを開始できます。
Kotlin
val request: GetPhoneNumberHintIntentRequest = GetPhoneNumberHintIntentRequest.builder().build()
Java
GetPhoneNumberHintIntentRequest request = GetPhoneNumberHintIntentRequest.builder().build();
電話番号のヒントをリクエストする
SignInClient.getPhoneNumberHintIntent()
を呼び出して前の GetPhoneNumberHintIntentRequest
オブジェクトを渡して PendingIntent
を取得し、電話番号のヒントフローを開始します。
Kotlin
val phoneNumberHintIntentResultLauncher = ... Identity.getSignInClient(activity) .getPhoneNumberHintIntent(request) .addOnSuccessListener { result: PendingIntent -> try { phoneNumberHintIntentResultLauncher.launch( IntentSenderRequest.Builder(result).build() ) } catch (e: Exception) { Log.e(TAG, "Launching the PendingIntent failed") } } .addOnFailureListener { Log.e(TAG, "Phone Number Hint failed") }
Java
ActivityResultLauncherphoneNumberHintIntentResultLauncher = ... Identity.getSignInClient(activity) .getPhoneNumberHintIntent(request) .addOnSuccessListener( result -> { try { phoneNumberHintIntentResultLauncher.launch(result.getIntentSender()); } catch(Exception e) { Log.e(TAG, "Launching the PendingIntent failed", e); } }) .addOnFailureListener(e -> { Log.e(TAG, "Phone Number Hint failed", e); });
電話番号の取得
Intent
を SignInClient.getPhoneNumberFromIntent
に渡して電話番号を取得します。
Kotlin
val phoneNumberHintIntentResultLauncher = registerForActivityResult(ActivityResultContracts.StartIntentSenderForResult()) { result -> try { val phoneNumber = Identity.getSignInClient(activity).getPhoneNumberFromIntent(result.data) } catch(e: Exception) { Log.e(TAG, "Phone Number Hint failed") } }
Java
ActivityResultLauncherphoneNumberHintIntentResultLauncher = registerForActivityResult( new ActivityResultContracts.StartActivityForResult(), new ActivityResultCallback () { @Override public void onActivityResult(ActivityResult result) { try { String phoneNumber = Identity.getSignInClient(activity).getPhoneNumberFromIntent(result.getData()); } catch { Log.e(TAG, "Phone Number Hint failed", e); } } });