Use o cliente de login com um toque para solicitar a permissão do usuário para recuperar uma das credenciais usadas anteriormente para fazer login no app. Essas credenciais podem ser uma Conta do Google ou uma combinação de nome de usuário e senha salvas com o Google usando o Chrome, o preenchimento automático do Android ou o Smart Lock para senhas.
Quando as credenciais são recuperadas, você pode usá-las para fazer o login do usuário no seu app sem interrupções.
Se o usuário não tiver salvo nenhuma credencial, nenhuma interface será exibida, e você poderá oferecer sua experiência normal sem login.
Onde devo usar o login com um toque?
Se o app exigir que os usuários façam login, exiba a interface de um toque na tela de login. Isso pode ser útil mesmo que você já tenha um botão "Fazer login com o Google": como a interface de um toque pode ser configurada para mostrar apenas as credenciais que o usuário usou anteriormente para fazer login, ele pode ser um lembrete para os usuários que fizeram login com pouca frequência como fizeram login na última vez e evitar que eles criem novas contas acidentalmente com seu app.
Se o login for opcional para o app, considere usar o login com um toque em qualquer tela que tenha uma experiência aprimorada com o login. Por exemplo, se os usuários puderem navegar pelo conteúdo do app sem fazer login, mas só puderem postar comentários ou adicionar itens a um carrinho de compras depois de fazer login, esse seria um contexto adequado para o login com um toque.
Os apps opcionais de login também precisam usar o login com um toque nas telas de login pelos motivos mencionados acima.
Antes de começar
- Configure o projeto do Console de APIs do Google e o projeto Android conforme descrito em Primeiras etapas com o login com um toque.
- Se você oferece suporte ao login baseado em senha, otimize seu app para preenchimento automático (ou use o Smart Lock para senhas) para que os usuários possam salvar as credenciais de senha depois de fazer login.
1. Configurar o cliente de login com um toque
É possível configurar o cliente de login com um toque para fazer o login dos usuários com senhas, Contas do Google salvas ou qualquer uma dessas opções. É recomendável oferecer suporte a ambos para ativar a criação de contas com um toque para novos usuários e o login automático ou com um toque para o maior número possível de usuários recorrentes.
Se o app usa o login baseado em senha, use setPasswordRequestOptions() para
ativar solicitações de credenciais de senha.
Caso seu app use o Login do Google, use setGoogleIdTokenRequestOptions() para
ativar e configurar solicitações de token de ID do Google:
Defina o ID do cliente do servidor como o ID que você criou no console de APIs do Google. Esse é o ID do cliente do seu servidor, não o do Android.
Configurar o cliente para filtrar por contas autorizadas. Quando você ativa essa opção, o cliente de um toque solicita que os usuários façam login no app apenas com Contas do Google que já usaram no passado. Isso pode ajudar os usuários a fazer login quando não tiverem certeza se já têm uma conta ou qual Conta do Google foi usada, além de impedir que eles criem novas contas acidentalmente.
Se você quiser fazer login dos usuários automaticamente quando possível, ative o recurso com
setAutoSelectEnabled(). O login automático é possível quando os critérios a seguir são atendidos:- O usuário tem exatamente uma credencial salva para o app. Ou seja, uma senha ou Conta do Google salva.
- O usuário não desativou o login automático nas configurações da Conta do Google.
Embora seja opcional, recomendamos usar um valor de uso único para melhorar a segurança de login e evitar ataques de repetição. Use setNonce para incluir um valor de uso único em cada solicitação. Consulte a seção Receber um valor de uso único da SafetyNet para ver sugestões e outros detalhes sobre como gerar um valor de uso único.
Java
public class YourActivity extends AppCompatActivity {
// ...
private SignInClient oneTapClient;
private BeginSignInRequest signInRequest;
@Override
public void onCreate(@Nullable Bundle savedInstanceState,
@Nullable PersistableBundle persistentState) {
super.onCreate(savedInstanceState, persistentState);
oneTapClient = Identity.getSignInClient(this);
signInRequest = BeginSignInRequest.builder()
.setPasswordRequestOptions(PasswordRequestOptions.builder()
.setSupported(true)
.build())
.setGoogleIdTokenRequestOptions(GoogleIdTokenRequestOptions.builder()
.setSupported(true)
// Your server's client ID, not your Android client ID.
.setServerClientId(getString(R.string.default_web_client_id))
// Only show accounts previously used to sign in.
.setFilterByAuthorizedAccounts(true)
.build())
// Automatically sign in when exactly one credential is retrieved.
.setAutoSelectEnabled(true)
.build();
// ...
}
// ...
}
Kotlin
class YourActivity : AppCompatActivity() {
// ...
private lateinit var oneTapClient: SignInClient
private lateinit var signInRequest: BeginSignInRequest
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
oneTapClient = Identity.getSignInClient(this)
signInRequest = BeginSignInRequest.builder()
.setPasswordRequestOptions(BeginSignInRequest.PasswordRequestOptions.builder()
.setSupported(true)
.build())
.setGoogleIdTokenRequestOptions(
BeginSignInRequest.GoogleIdTokenRequestOptions.builder()
.setSupported(true)
// Your server's client ID, not your Android client ID.
.setServerClientId(getString(R.string.your_web_client_id))
// Only show accounts previously used to sign in.
.setFilterByAuthorizedAccounts(true)
.build())
// Automatically sign in when exactly one credential is retrieved.
.setAutoSelectEnabled(true)
.build()
// ...
}
// ...
}
2. Verificar se há um usuário conectado
Se a atividade puder ser usada por um usuário conectado ou desconectado, verifique o status do usuário antes de exibir a interface de login com um toque.
Também é necessário verificar se o usuário já recusou o login com um toque fechando a solicitação ou tocando fora dela. Isso pode ser tão simples quanto uma propriedade booleana da sua atividade. Consulte Parar de exibir a interface de um toque abaixo.
3. Exibir a interface de login com um toque
Se o usuário não estiver conectado e ainda não tiver recusado o login com um toque,
chame o método beginSignIn() do objeto do cliente e anexe listeners ao
Task retornado. Os apps normalmente fazem isso no método onCreate() da atividade
ou após transições de tela ao usar uma arquitetura de atividade única.
O cliente de um toque chamará o listener de êxito se o usuário tiver alguma credencial
salva para seu app. Nesse listener, receba a intent pendente do
resultado Task e a transmita para startIntentSenderForResult() para iniciar a
interface de login com um toque.
Se o usuário não tiver nenhuma credencial salva, o cliente de um toque chamará o listener de falhas. Nesse caso, nenhuma ação é necessária: você pode simplesmente continuar apresentando a experiência sem login do app. No entanto, se você aceitar a inscrição com um toque, poderá iniciar esse fluxo aqui para ter uma experiência de criação de conta simplificada. Saiba mais em Criar novas contas com um toque.
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 saved credentials found. Launch the One Tap sign-up flow, or
// do nothing and continue presenting the signed-out UI.
Log.d(TAG, e.getLocalizedMessage());
}
});
Kotlin
oneTapClient.beginSignIn(signInRequest)
.addOnSuccessListener(this) { result ->
try {
startIntentSenderForResult(
result.pendingIntent.intentSender, REQ_ONE_TAP,
null, 0, 0, 0, null)
} catch (e: IntentSender.SendIntentException) {
Log.e(TAG, "Couldn't start One Tap UI: ${e.localizedMessage}")
}
}
.addOnFailureListener(this) { e ->
// No saved credentials found. Launch the One Tap sign-up flow, or
// do nothing and continue presenting the signed-out UI.
Log.d(TAG, e.localizedMessage)
}
4. Processar a resposta do usuário
A resposta do usuário à solicitação de login com um toque será informada ao seu app
usando o método onActivityResult() da atividade. Se o usuário fizer login,
o resultado será uma credencial salva. Se o usuário recusar, fechando a interface de um toque ou tocando fora dela, o resultado retornará com o
código RESULT_CANCELED. Seu app precisa lidar com as duas possibilidades.
Fazer login com as credenciais recuperadas
Se o usuário compartilhar credenciais com seu app, você pode recuperá-las
transmitindo os dados de intent do onActivityResult() para o método getSignInCredentialFromIntent()
do cliente de um toque. A credencial terá uma propriedade googleIdToken
não nula se o usuário tiver compartilhado uma credencial da Conta do Google com
seu app ou uma propriedade password não nula se o usuário tiver compartilhado uma senha salva.
Use a credencial para autenticar com o back-end do app.
- Se um par de nome de usuário e senha for recuperado, use-os para fazer login da mesma maneira que você faria se o usuário tivesse fornecido manualmente.
Se as credenciais da Conta do Google tiverem sido recuperadas, use o token de ID para autenticar com o back-end. Se você optou por usar um valor de uso único para ajudar a evitar ataques de repetição, verifique o valor da resposta no servidor de back-end. Consulte Autenticar com um back-end usando tokens de 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();
String username = credential.getId();
String password = credential.getPassword();
if (idToken != null) {
// Got an ID token from Google. Use it to authenticate
// with your backend.
Log.d(TAG, "Got ID token.");
} else if (password != null) {
// Got a saved username and password. Use them to authenticate
// with your backend.
Log.d(TAG, "Got password.");
}
} 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
val username = credential.id
val password = credential.password
when {
idToken != null -> {
// Got an ID token from Google. Use it to authenticate
// with your backend.
Log.d(TAG, "Got ID token.")
}
password != null -> {
// Got a saved username and password. Use them to authenticate
// with your backend.
Log.d(TAG, "Got password.")
}
else -> {
// Shouldn't happen.
Log.d(TAG, "No ID token or password!")
}
}
} catch (e: ApiException) {
// ...
}
}
}
}
// ...
}
Parar de exibir a interface de um toque
Se o usuário se recusar a fazer login, a chamada para getSignInCredentialFromIntent()
gerará uma ApiException com um código de status CommonStatusCodes.CANCELED.
Quando isso acontecer, desative temporariamente a interface de login com um toque para não incomodar os usuários com solicitações repetidas. O exemplo a seguir faz
isso definindo uma propriedade na atividade, que é usada para determinar se
o usuário pode fazer login com um toque. No entanto, também é possível salvar um valor em
SharedPreferences ou usar outro método.
É importante implementar sua própria limitação de taxa para as solicitações de login com um toque. Se você não fizer isso e o usuário cancelar várias solicitações seguidas, o cliente de um toque não vai perguntar ao usuário nas próximas 24 horas.
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})")
}
}
}
}
}
}
// ...
}
5. Processar a saída
Quando um usuário sair do app, chame o método signOut() do cliente de um toque.
Chamar signOut() desativa o login automático até que o usuário faça login novamente.
Mesmo que você não use o login automático, essa etapa é importante porque garante que, quando os usuários saírem do app, o estado de autenticação de todas as APIs do Google Play Services usadas também seja redefinido.
Próximas etapas
Se você configurou o cliente de um toque para recuperar as credenciais do Google, agora seu app pode receber tokens de ID do Google que representam as Contas do Google dos seus usuários. Saiba como usar esses tokens no back-end.
Se você oferece suporte ao Login do Google, também pode usar o cliente de um toque para adicionar fluxos de criação de conta simples ao seu app.