電話番号に関するヒント

Phone Number Hint API は、Google Play 開発者サービスを備えたライブラリであり、ユーザーの（SIM ベース）電話番号をヒントとしてスムーズに表示する手段です。

電話番号のヒントを使用すると、次のようなメリットがあります。

• 追加の権限リクエストは必要ありません。
• ユーザーが電話番号を手動で入力する必要がなくなります。
• Google アカウントは不要
• ログイン/アップ ワークフローには関連付けられていない
• 自動入力と Android の幅広いサポート

始める前に

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

アプリを設定する

プロジェクト レベルの build.gradle ファイルで、buildscript セクションと allprojects セクションの両方に Google の Maven リポジトリを含めます。

buildscript {
  repositories {
    google()
    mavenCentral()
  }
}

allprojects {
  repositories {
    google()
    mavenCentral()
  }
}

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

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

仕組み

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

図 1. 電話番号のヒントの UI と設定

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

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

Kotlin

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

Java

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

電話番号のヒントをリクエストしています

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

Kotlin

val phoneNumberHintIntentResultLauncher: ActivityResultLauncher = ...

Identity.signInClient(activity)
  .getPhoneNumberHintIntent(request)
  .addOnSuccessListener(
      try {
          phoneNumberHintIntentResultLauncher.launch(request.getIntentSender())
      } 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: ActivityResultLauncher =
  registerForActivityResult(StartActivityForResult()) { result ->
      try {
          val phoneNumber = Identity.signInClient(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);
              }
          }
  });