電話番号に関するヒント

Phone Number Hints API は、Google Play 開発者サービスを利用するライブラリであり、ユーザーの（SIM ベース）電話番号をヒントとして表示する簡単な方法を提供します。

電話番号のヒントを使用するメリットは次のとおりです。

• 追加の権限リクエストは不要
• ユーザーが電話番号を手動で入力する必要がなくなります
• Google アカウントは不要
• ログイン/アップ ワークフローに直接関係していない
• 自動入力と比較した Android バージョンのサポートの拡大

始める前に

アプリを準備するには、以下のセクションに示す手順を完了します。

アプリを構成する

Phone Number Hint API に対する Google Play 開発者サービスの依存関係を、モジュールの Gradle ビルドファイル（通常は app/build.gradle）に追加します。

  apply plugin: 'com.android.application'

  ...

  dependencies {
    implementation 'com.google.android.gms:play-services-auth:20.4.1'
  }

仕組み

Phone Number Hint API は、PendingIntent を使用してフローを開始します。PendingIntent が開始すると、ユーザーに（SIM ベースの）すべての電話番号を一覧表示する UI が表示されます。ユーザーは、使用する電話番号を選択するか、フローをキャンセルできます。 選択した電話番号は、デベロッパーが Intent から取得できます。

GetPhoneNumbeHintIntentRequest オブジェクトを作成する

まず、用意されている GetPhoneNumberHintIntentRequest.Builder() メソッドを使用して、GetPhoneNumberHintIntentRequest オブジェクトを作成します。このリクエスト オブジェクトを使用すると、Intent を取得して電話番号ヒントのフローを開始できます。

val request: GetPhoneNumberHintIntentRequest = GetPhoneNumberHintIntentRequest.builder().build()

GetPhoneNumberHintIntentRequest request = GetPhoneNumberHintIntentRequest.builder().build();

電話番号のヒントのリクエスト

SignInClient.getPhoneNumberHintIntent() を呼び出して、以前の GetPhoneNumberHintIntentRequest オブジェクトを渡し、PendingIntent を取得して、電話番号のヒントフローを開始します。

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")
}

ActivityResultLauncher phoneNumberHintIntentResultLauncher = ...

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 に渡します。

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")
      }
  }

ActivityResultLauncher phoneNumberHintIntentResultLauncher =
  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);
              }
          }
  });