点按一下即可创建新帐号

如果您支持使用 Google 账号登录,则可以使用一键登录功能 同时为您的用户提供顺畅的账号创建体验 绝不会使它们脱离您应用的上下文。

一键注册界面

当您显示一键快捷界面时,系统会提示用户 安装您的应用。如果用户选择 要继续操作,您将获得包含基本个人资料信息的 ID 令牌, 姓名、个人资料照片和经过验证的电子邮件地址,这些信息可用于 创建新账号。

实现一键创建账号的过程包含两个部分:

  • 将一键式客户端集成到您的应用中,如本页所述。 这与使用一键登录大致相同, 配置。
  • 向后端添加通过 Google ID 创建用户账号的功能 令牌,详情请参阅在后端使用 ID 令牌

我应该在哪里使用一键注册功能?

在用户采用“一键注册”功能时,效果最好的情况是: 登录后即可启用新功能。首先,尝试使用 已保存的凭据。如果找不到已保存的凭据,询问是否创建新凭据 创建该用户的账号

准备工作

按照说明设置您的 Google API 控制台项目和 Android 项目 请参阅一键登录使用入门

1. 配置一键式客户端

要为账号创建配置一键式客户端,请执行以下操作:

  • 不启用密码凭据请求。(仅支持一键注册, 使用基于令牌的身份验证。)
  • 使用 setGoogleIdTokenRequestOptions() 和 这些设置:

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. 跟踪一键取消界面的操作

您应跟踪用户是否已拒绝使用一键快捷功能 来进行注册。这可以是 用作 Activity 的布尔属性。(请参阅停止显示“一键式” 界面。)

3. 显示一键注册界面

如果用户未拒绝使用一键快捷功能创建新账号,则调用 客户端对象的 beginSignIn() 方法,并将监听器附加到它的 Task 回车。应用通常会在一键登录请求找不到时执行此步骤 任何已保存的凭据,即在登录的失败监听器中 请求。

如果用户有一个或多个请求,一键式客户端将调用成功监听器 设备上设置的 Google 账号。在成功监听器中,获取待处理 intent 并将其传递给 startIntentSenderForResult()Task 启动一键快捷界面

如果用户设备上没有任何 Google 账号,一键快捷客户端 将调用失败监听器在这种情况下,您无需采取任何措施: 用户只需继续呈现在退出状态下使用的应用 即可按照常规账号创建流程进行注册。

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. 处理用户的响应

系统会将用户对一键注册提示的响应报告给您的应用 使用 Activity 的 onActivityResult() 方法。如果用户选择创建 则结果将是一个 Google ID 令牌。如果用户拒绝注册 无论是关闭一键快捷界面,还是点按界面以外,结果都会返回 代码为 RESULT_CANCELED。您的应用需要处理这两种可能性。

创建具有 Google ID 令牌的账号

如果用户选择使用 Google 账号注册,您可以获取以下 ID 令牌: 将 onActivityResult() 中的 intent 数据传递给一键快捷功能 客户端的 getSignInCredentialFromIntent() 方法。凭据的 非 null 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) {
                    // ...
            }
        }
    }
    // ...
}

停止显示一键式界面

如果用户拒绝登录,对 getSignInCredentialFromIntent() 的调用 会抛出状态代码为 CommonStatusCodes.CANCELEDApiException。 如果出现这种情况,您应暂时停止显示一键登录界面。 以免用户重复提示,让用户感到厌烦。以下示例 可以通过在 Activity 上设置属性来实现此目的,该属性用于 确定是否为用户提供一键登录;但您也可以 请将值保存到 SharedPreferences 或使用其他方法。

请务必自行对一键登录提示实施速率限制。 如果您未设置此政策,并且某位用户连续取消了多条提示,那么一键快捷客户端 在接下来的 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})")
                        }
                    }
                }
            }
        }
    }
    // ...
}

后续步骤

当用户完成一键注册流程后,您会获得一个 Google ID 令牌, 包含一些基本个人资料信息:用户的电子邮件地址、全名 和个人资料照片网址对于许多应用来说,这些信息足以让您 在后端对用户进行身份验证,然后创建一个新账号。

如果您需要其他信息才能完成账号创建,例如 用户的出生日期—向用户呈现注册详情流程,其中 您请求获取这些额外信息。然后,将其发送到后端以完成账号创建。