電話番号のヒント

Phone Number Hint API は Google Play 開発者サービスによるライブラリで、ユーザーの（SIM ベースの）電話番号をヒントとして簡単に表示できるようにします。

Phone Number Hint を使用するメリットは次のとおりです。

  • 追加の権限リクエストは不要
  • ユーザーが電話番号を手動で入力する必要がない
  • Google アカウントは不要
  • ログインまたは登録のワークフローに直接関連しない
  • 自動入力よりも幅広い Android バージョンをサポート

仕組み

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

電話番号のヒントの UI と設定。
図 1.Phone Number Hint の UI と設定

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

アプリを設定する

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

  apply plugin: 'com.android.application'

  ...

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

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

まず、指定された GetPhoneNumberHintIntentRequest.Builder() メソッドを使用して GetPhoneNumberHintIntentRequest オブジェクトを作成します。このリクエスト オブジェクトを使用して、Phone Number Hint フローを開始する Intent を取得できます。

Kotlin

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

Java

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

Phone Number Hint をリクエストする

前の GetPhoneNumberHintIntentRequest オブジェクトを渡して SignInClient.getPhoneNumberHintIntent() を呼び出し、Phone Number Hint フローを開始する 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

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 に渡して、電話番号を取得します。

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

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