Gunakan klien login Sekali Ketuk untuk meminta izin dari pengguna guna mengambil salah satu kredensial yang sebelumnya mereka gunakan untuk login ke aplikasi Anda. Kredensial ini dapat berupa Akun Google atau kombinasi nama pengguna dan sandi yang disimpan di Google menggunakan Chrome, isi otomatis Android, atau Smart Lock untuk Sandi.
Setelah kredensial berhasil diambil, Anda dapat menggunakannya untuk memproses login pengguna ke aplikasi Anda dengan lancar.
Jika pengguna belum menyimpan kredensial apa pun, tidak ada UI yang akan ditampilkan, dan Anda dapat memberikan pengalaman logout seperti biasa.
Di mana saya harus menggunakan login dengan Sekali Ketuk?
Jika aplikasi Anda mengharuskan pengguna untuk login, tampilkan UI Sekali Ketuk di layar login. Hal ini dapat membantu meskipun Anda sudah memiliki tombol "Login dengan Google": karena UI Sekali Ketuk dapat dikonfigurasi untuk hanya menampilkan kredensial yang sebelumnya digunakan pengguna untuk login, fitur ini dapat menjadi pengingat bagi pengguna yang jarang login saat terakhir kali login, dan mencegah mereka secara tidak sengaja membuat akun baru dengan aplikasi Anda.
Jika proses login bersifat opsional untuk aplikasi Anda, pertimbangkan untuk menggunakan login Sekali Ketuk di layar apa pun yang memiliki pengalaman yang ditingkatkan dengan login. Misalnya, jika pengguna dapat menjelajahi konten dengan aplikasi Anda saat logout, tetapi hanya dapat memposting komentar atau menambahkan item ke keranjang belanja setelah login, itu akan menjadi konteks yang masuk akal untuk login Sekali Ketuk.
Aplikasi opsional untuk login juga harus menggunakan login Sekali Ketuk di layar login, karena alasan yang disebutkan di atas.
Sebelum memulai
- Siapkan project konsol Google API dan project Android Anda seperti yang dijelaskan dalam Memulai login Sekali Ketuk.
- Jika Anda mendukung login berbasis sandi, optimalkan aplikasi untuk isi otomatis (atau gunakan Smart Lock untuk Sandi) agar pengguna dapat menyimpan kredensial sandi mereka setelah login.
1. Mengonfigurasi klien login Sekali Ketuk
Anda dapat mengonfigurasi klien login Sekali Ketuk agar pengguna login dengan sandi tersimpan, Akun Google yang tersimpan, atau salah satu dari keduanya. (Sebaiknya dukung keduanya, guna mengaktifkan pembuatan akun sekali ketuk bagi pengguna baru dan login otomatis atau login sekali ketuk untuk sebanyak mungkin pengguna yang kembali.)
Jika aplikasi Anda menggunakan login dengan sandi, gunakan setPasswordRequestOptions() untuk
mengaktifkan permintaan kredensial sandi.
Jika aplikasi Anda menggunakan Login dengan Google, gunakan setGoogleIdTokenRequestOptions() untuk mengaktifkan dan mengonfigurasi permintaan token ID Google:
Setel client ID server ke ID yang Anda buat di konsol Google API. Perhatikan bahwa ini adalah client ID server Anda, bukan client ID Android.
Konfigurasikan klien untuk memfilter menurut akun yang diizinkan. Saat Anda mengaktifkan opsi ini, klien Sekali Ketuk hanya meminta pengguna untuk login ke aplikasi Anda dengan Akun Google yang telah mereka gunakan sebelumnya. Tindakan ini dapat membantu pengguna untuk berhasil login saat mereka tidak yakin apakah mereka sudah memiliki akun atau Akun Google mana yang mereka gunakan, serta mencegah pengguna membuat akun baru dengan aplikasi Anda secara tidak sengaja.
Jika Anda ingin membuat pengguna login secara otomatis, jika memungkinkan, aktifkan fitur tersebut dengan
setAutoSelectEnabled(). Login otomatis memungkinkan jika kriteria berikut terpenuhi:- Pengguna memiliki tepat satu kredensial yang disimpan untuk aplikasi Anda. Artinya, satu sandi tersimpan atau satu Akun Google tersimpan.
- Pengguna belum menonaktifkan login otomatis di setelan Akun Google mereka.
Meskipun opsional, sebaiknya Anda sangat mempertimbangkan penggunaan nonce untuk meningkatkan keamanan login dan menghindari serangan replay. Gunakan setNonce untuk menyertakan nonce dalam setiap permintaan. Lihat bagian Mendapatkan nonce SafetyNet untuk mendapatkan saran dan detail tambahan tentang cara membuat nonce.
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. Memeriksa pengguna yang login
Jika Aktivitas Anda dapat digunakan oleh pengguna yang login atau pengguna yang logout, periksa status pengguna sebelum menampilkan UI login Sekali Ketuk.
Anda juga harus melacak apakah pengguna sudah menolak untuk menggunakan fitur login Sekali Ketuk dengan menutup perintah atau mengetuk di luarnya. Hal ini dapat sesederhana properti boolean Aktivitas Anda. (Lihat Berhenti menampilkan UI Sekali Ketuk, di bawah.)
3. Menampilkan UI login Sekali Ketuk
Jika pengguna tidak login dan belum menolak untuk menggunakan login Sekali Ketuk,
panggil metode beginSignIn() objek klien, dan lampirkan pemroses ke
Task yang ditampilkan. Aplikasi biasanya melakukan hal ini dalam metode onCreate() Aktivitas
atau setelah transisi layar saat menggunakan arsitektur Aktivitas tunggal.
Klien Sekali Ketuk akan memanggil pemroses peristiwa sukses jika pengguna memiliki kredensial
tersimpan untuk aplikasi Anda. Pada pemroses yang berhasil, dapatkan intent yang tertunda dari hasil Task dan teruskan ke startIntentSenderForResult() untuk memulai
UI login Sekali Ketuk.
Jika pengguna tidak memiliki kredensial tersimpan, klien Sekali Ketuk akan memanggil pemroses kegagalan. Dalam hal ini, Anda tidak perlu melakukan tindakan apa pun: cukup lanjutkan menyajikan pengalaman logout aplikasi. Namun, jika mendukung pendaftaran Sekali Ketuk, Anda dapat memulai alur tersebut di sini untuk mendapatkan pengalaman pembuatan akun yang lancar. Lihat Membuat akun baru dengan sekali ketuk.
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. Menangani respons pengguna
Respons pengguna terhadap perintah login Sekali Ketuk akan dilaporkan ke aplikasi Anda
menggunakan metode onActivityResult() Aktivitas. Jika pengguna memilih untuk login, hasilnya akan menjadi kredensial yang disimpan. Jika pengguna menolak login, baik dengan menutup UI Sekali Ketuk atau mengetuk di luarnya, hasilnya akan ditampilkan dengan kode RESULT_CANCELED. Aplikasi Anda perlu menangani kedua kemungkinan tersebut.
Login dengan kredensial yang diambil
Jika pengguna memilih untuk berbagi kredensial dengan aplikasi, Anda dapat mengambilnya dengan
meneruskan data intent dari onActivityResult() ke metode getSignInCredentialFromIntent()
klien Sekali Ketuk. Kredensial tersebut akan memiliki properti googleIdToken non-null
jika pengguna membagikan kredensial Akun Google ke
aplikasi Anda, atau properti password non-null jika pengguna membagikan sandi tersimpan.
Gunakan kredensial tersebut untuk melakukan autentikasi dengan backend aplikasi Anda.
- Jika pasangan nama pengguna dan sandi diambil, gunakan keduanya untuk login dengan cara yang sama seperti yang Anda lakukan ketika pengguna memberikannya secara manual.
Jika kredensial Akun Google diambil, gunakan token ID untuk melakukan autentikasi dengan backend Anda. Jika Anda memilih untuk menggunakan nonce guna membantu menghindari serangan replay, periksa nilai respons di server backend Anda. Baca bagian Melakukan autentikasi dengan backend menggunakan token 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) {
// ...
}
}
}
}
// ...
}
Berhenti menampilkan UI Sekali Ketuk
Jika pengguna menolak login, panggilan ke getSignInCredentialFromIntent() akan menampilkan ApiException dengan kode status CommonStatusCodes.CANCELED.
Jika hal ini terjadi, sebaiknya Anda menonaktifkan UI login Sekali Ketuk untuk sementara agar
tidak mengganggu pengguna dengan perintah berulang. Contoh berikut melakukannya dengan menetapkan properti di Aktivitas, yang digunakan untuk menentukan apakah akan menawarkan fitur login Sekali Ketuk kepada pengguna. Namun, Anda juga dapat menyimpan nilai ke SharedPreferences atau menggunakan metode lain.
Penting untuk menerapkan pembatasan kapasitas perintah login Sekali Ketuk Anda sendiri. Jika tidak, dan pengguna membatalkan beberapa perintah secara berturut-turut, klien Sekali Ketuk tidak akan meminta pengguna selama 24 jam ke depan.
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. Menangani logout
Ketika pengguna logout dari aplikasi Anda, panggil metode signOut() klien Sekali Ketuk.
Memanggil signOut() akan menonaktifkan login otomatis hingga pengguna login lagi.
Meskipun Anda tidak menggunakan login otomatis, langkah ini penting karena memastikan bahwa saat pengguna logout dari aplikasi Anda, status autentikasi setiap API layanan Play yang Anda gunakan juga akan direset.
Langkah berikutnya
Jika Anda mengonfigurasi klien Sekali Ketuk untuk mengambil kredensial Google, aplikasi Anda kini bisa mendapatkan token ID Google yang mewakili Akun Google pengguna. Pelajari cara menggunakan token ini di backend.
Jika mendukung Login dengan Google, Anda juga dapat menggunakan klien Sekali Ketuk untuk menambahkan alur pembuatan akun dengan lancar ke aplikasi Anda.