輕觸一下即可建立新帳戶

如果您支援使用 Google 帳戶登入,也可以使用 One Tap 登入用戶端,為使用者提供無縫的帳戶建立體驗,讓他們不必離開應用程式。

輕觸一下註冊使用者介面

當您顯示 One Tap UI 時,系統會提示使用者使用裝置上的其中一個 Google 帳戶,透過應用程式建立新帳戶。如果使用者選擇繼續操作,您會取得 ID 權杖,其中包含基本個人資料 (使用者名稱、個人資料相片和已驗證的電子郵件地址),可用於建立新帳戶。

實作 One Tap 帳戶建立功能分為兩個部分:

  • 將 One Tap 用戶端整合至應用程式,請參閱本頁說明。這與使用 One Tap 登入的方式大致相同,但設定上有些許差異。
  • 在後端新增使用 Google ID 權杖建立使用者帳戶的功能,詳情請參閱「在後端使用 ID 權杖」一文。

在哪些情況下適合使用 One Tap 註冊?

向使用者提供 One Tap 註冊功能最有效的方式,是在登入後可啟用新功能的情況下。首先,請嘗試使用已儲存的憑證登入使用者。如果找不到已儲存的憑證,請為使用者建立新帳戶。

事前準備

按照「開始使用 One Tap 登入」一文的說明,設定 Google API 控制台專案和 Android 專案。

1. 設定 One Tap 用戶端

如要設定 One Tap 用戶端以建立帳戶,請按照下列步驟操作:

  • 請勿啟用密碼憑證要求。(One Tap 註冊功能僅適用於以權杖為基礎的驗證方式)。
  • 使用 setGoogleIdTokenRequestOptions() 和下列設定啟用 Google ID 權杖要求:

Java

public class YourActivity extends AppCompatActivity {

  // ...

  private SignInClient oneTapClient;
  private BeginSignInRequest signUpRequest;

  @Override
  public void onCreate(@Nullable Bundle savedInstanceState,
                       @Nullable PersistableBundle persistentState) {
      super.onCreate(savedInstanceState, persistentState);

      oneTapClient = Identity.getSignInClient(this);
      signUpRequest = BeginSignInRequest.builder()
              .setGoogleIdTokenRequestOptions(GoogleIdTokenRequestOptions.builder()
                      .setSupported(true)
                      // Your server's client ID, not your Android client ID.
                      .setServerClientId(getString(R.string.your_web_client_id))
                      // Show all accounts on the device.
                      .setFilterByAuthorizedAccounts(false)
                      .build())
              .build();

      // ...
  }
}

Kotlin

class YourActivity : AppCompatActivity() {
    // ...

    private lateinit var oneTapClient: SignInClient
    private lateinit var signUpRequest: BeginSignInRequest

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        oneTapClient = Identity.getSignInClient(this)
        signUpRequest = BeginSignInRequest.builder()
            .setGoogleIdTokenRequestOptions(
                BeginSignInRequest.GoogleIdTokenRequestOptions.builder()
                    .setSupported(true)
                    // Your server's client ID, not your Android client ID.
                    .setServerClientId(getString(R.string.your_web_client_id))
                    // Show all accounts on the device.
                    .setFilterByAuthorizedAccounts(false)
                    .build())
            .build()
        // ...
    }
    // ...
}

2. 追蹤 One Tap UI 取消作業

您應追蹤使用者是否已拒絕使用 One Tap 註冊功能,方法是關閉提示或輕觸提示以外的區域。這可以是簡單的布林值屬性,例如活動的布林值屬性。(請參閱下方的「停止顯示 One Tap UI」)。

3. 顯示 One Tap 註冊 UI

如果使用者未拒絕使用 One Tap 建立新帳戶,請呼叫用戶端物件的 beginSignIn() 方法,並將事件監聽器附加至所傳回的 Task。當 One Tap 登入要求找不到任何已儲存的憑證時,應用程式通常會執行這個步驟,也就是在登入要求的失敗事件監聽器中。

如果使用者在裝置上設定了一或多個 Google 帳戶,One Tap 用戶端就會呼叫成功事件監聽器。在成功事件監聽器中,從 Task 結果取得待處理意圖,並將其傳遞至 startIntentSenderForResult(),以啟動 One Tap UI。

如果使用者在裝置上沒有任何 Google 帳戶,One Tap 用戶端會呼叫失敗事件監聽器。在這種情況下,您不需要採取任何行動:您可以繼續呈現應用程式的登出體驗,使用者可以透過正常的帳戶建立流程註冊。

Java

oneTapClient.beginSignIn(signUpRequest)
        .addOnSuccessListener(this, new OnSuccessListener<BeginSignInResult>() {
            @Override
            public void onSuccess(BeginSignInResult result) {
                try {
                    startIntentSenderForResult(
                            result.getPendingIntent().getIntentSender(), REQ_ONE_TAP,
                            null, 0, 0, 0);
                } catch (IntentSender.SendIntentException e) {
                    Log.e(TAG, "Couldn't start One Tap UI: " + e.getLocalizedMessage());
                }
            }
        })
        .addOnFailureListener(this, new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // No Google Accounts found. Just continue presenting the signed-out UI.
                Log.d(TAG, e.getLocalizedMessage());
            }
        });

Kotlin

oneTapClient.beginSignIn(signUpRequest)
    .addOnSuccessListener(this) { result ->
        try {
            startIntentSenderForResult(
                result.pendingIntent.intentSender, REQ_ONE_TAP,
                null, 0, 0, 0)
        } catch (e: IntentSender.SendIntentException) {
            Log.e(TAG, "Couldn't start One Tap UI: ${e.localizedMessage}")
        }
    }
    .addOnFailureListener(this) { e ->
        // No Google Accounts found. Just continue presenting the signed-out UI.
        Log.d(TAG, e.localizedMessage)
    }

4. 處理使用者的回應

使用者對 One Tap 註冊提示的回應,會透過活動的 onActivityResult() 方法回報給應用程式。如果使用者選擇建立帳戶,結果會是 Google ID 權杖。如果使用者拒絕註冊 (例如關閉 One Tap UI 或輕觸 One Tap UI 以外的區域),結果會傳回 RESULT_CANCELED 代碼。您的應用程式必須處理這兩種可能性。

使用 Google ID 權杖建立帳戶

如果使用者選擇使用 Google 帳戶登入,您可以將意圖資料從 onActivityResult() 傳遞至 One Tap 用戶端的 getSignInCredentialFromIntent() 方法,為使用者取得 ID 權杖。憑證會包含非空值的 googleIdToken 屬性。

使用 ID 權杖在後端建立帳戶 (請參閱「使用 ID 權杖透過後端驗證」),然後讓使用者登入。

憑證還會包含您要求的其他詳細資料,例如帳戶的已驗證電話號碼 (如有)。

Java

public class YourActivity extends AppCompatActivity {

  // ...
  private static final int REQ_ONE_TAP = 2;  // Can be any integer unique to the Activity.
  private boolean showOneTapUI = true;
  // ...

  @Override
  protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
      super.onActivityResult(requestCode, resultCode, data);

      switch (requestCode) {
          case REQ_ONE_TAP:
              try {
                  SignInCredential credential = oneTapClient.getSignInCredentialFromIntent(data);
                  String idToken = credential.getGoogleIdToken();
                  if (idToken !=  null) {
                      // Got an ID token from Google. Use it to authenticate
                      // with your backend.
                      Log.d(TAG, "Got ID token.");
                  }
              } catch (ApiException e) {
                  // ...
              }
              break;
      }
  }
}

Kotlin

class YourActivity : AppCompatActivity() {

    // ...
    private val REQ_ONE_TAP = 2  // Can be any integer unique to the Activity
    private var showOneTapUI = true
    // ...

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)

        when (requestCode) {
             REQ_ONE_TAP -> {
                try {
                    val credential = oneTapClient.getSignInCredentialFromIntent(data)
                    val idToken = credential.googleIdToken
                    when {
                        idToken != null -> {
                            // Got an ID token from Google. Use it to authenticate
                            // with your backend.
                            Log.d(TAG, "Got ID token.")
                        }
                        else -> {
                            // Shouldn't happen.
                            Log.d(TAG, "No ID token!")
                        }
                    }
                } catch (e: ApiException) {
                    // ...
            }
        }
    }
    // ...
}

停止顯示 One Tap UI

如果使用者拒絕登入,對 getSignInCredentialFromIntent() 的呼叫會擲回 ApiException,並附上 CommonStatusCodes.CANCELED 狀態碼。發生這種情況時,您應暫時停止顯示 One Tap 登入使用者介面,以免使用者因重複提示而感到厭煩。以下範例會在活動上設定屬性,用於判斷是否要為使用者提供 One Tap 登入功能;不過,您也可以將值儲存至 SharedPreferences 或使用其他方法。

請務必為 One Tap 登入提示訊息實作自己的速率限制。如果您沒有這樣做,且使用者連續取消多次提示,One Tap 用戶端就不會在接下來的 24 小時內提示使用者。

Java

public class YourActivity extends AppCompatActivity {

  // ...
  private static final int REQ_ONE_TAP = 2;  // Can be any integer unique to the Activity.
  private boolean showOneTapUI = true;
  // ...

  @Override
  protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
      super.onActivityResult(requestCode, resultCode, data);

      switch (requestCode) {
          case REQ_ONE_TAP:
              try {
                  // ...
              } catch (ApiException e) {
                  switch (e.getStatusCode()) {
                      case CommonStatusCodes.CANCELED:
                          Log.d(TAG, "One-tap dialog was closed.");
                          // Don't re-prompt the user.
                          showOneTapUI = false;
                          break;
                      case CommonStatusCodes.NETWORK_ERROR:
                          Log.d(TAG, "One-tap encountered a network error.");
                          // Try again or just ignore.
                          break;
                      default:
                          Log.d(TAG, "Couldn't get credential from result."
                                  + e.getLocalizedMessage());
                          break;
                  }
              }
              break;
      }
  }
}

Kotlin

class YourActivity : AppCompatActivity() {

    // ...
    private val REQ_ONE_TAP = 2  // Can be any integer unique to the Activity
    private var showOneTapUI = true
    // ...

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)

        when (requestCode) {
            REQ_ONE_TAP -> {
                try {
                    // ...
                } catch (e: ApiException) {
                    when (e.statusCode) {
                        CommonStatusCodes.CANCELED -> {
                            Log.d(TAG, "One-tap dialog was closed.")
                            // Don't re-prompt the user.
                            showOneTapUI = false
                        }
                        CommonStatusCodes.NETWORK_ERROR -> {
                            Log.d(TAG, "One-tap encountered a network error.")
                            // Try again or just ignore.
                        }
                        else -> {
                            Log.d(TAG, "Couldn't get credential from result." +
                                " (${e.localizedMessage})")
                        }
                    }
                }
            }
        }
    }
    // ...
}

後續步驟

使用者完成 One Tap 註冊流程後,您會取得 Google ID 權杖,其中包含一些基本個人資料:使用者的電子郵件地址、全名和個人資料相片網址。對於許多應用程式而言,這項資訊就足以在後端驗證使用者,並建立新帳戶。

如果您需要其他資訊才能完成帳戶建立程序 (例如使用者的生日),請向使用者顯示註冊詳細資料流程,要求提供這些額外資訊,然後將這些資訊傳送至後端,完成帳戶建立程序。