您可以使用 Google Play 遊戲服務,讓玩家登入以 Firebase 建構的 Android 遊戲。如要透過 Firebase 使用 Google Play 遊戲服務登入功能,請先讓玩家使用 Google Play 遊戲登入,並在登入時要求 OAuth 2.0 授權碼。接著,將授權碼傳遞至 PlayGamesAuthProvider,產生 Firebase 憑證,以便用於 Firebase 驗證。
事前準備
如要透過 Firebase 使用 Google Play Games services 登入,請完成下列設定步驟:
設定 Android 專案
如果您尚未將 Firebase 新增至 Android 專案,請先新增。
在模組 (應用程式層級) Gradle 檔案 (通常是
<project>/<app-module>/build.gradle.kts或<project>/<app-module>/build.gradle) 中,新增 Android 專用 Firebase Authentication 程式庫的依附元件。建議使用 Firebase Android BoM 控制程式庫版本管理。此外,在設定 Firebase Authentication 時,您也需要將 Google Play 服務 SDK 新增至應用程式。
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:35.2.0")) // Add the dependency for the Firebase Authentication library // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-auth")
// Also add the dependency for the Google Play services library and specify its version implementation("com.google.android.gms:play-services-auth:22.0.0") }只要使用 Firebase Android BoM,應用程式就會一律使用相容的 Firebase Android 程式庫版本。
(替代方案) 不使用 BoM,新增 Firebase 程式庫依附元件
如果選擇不使用 Firebase BoM,則必須在依附元件行中指定每個 Firebase 程式庫版本。
請注意,如果您的應用程式使用多個 Firebase 程式庫,強烈建議您使用 BoM 管理程式庫版本,確保所有版本都相容。
dependencies { // Add the dependency for the Firebase Authentication library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-auth:25.0.0")
// Also add the dependency for the Google Play services library and specify its version implementation("com.google.android.gms:play-services-auth:22.0.0") }
設定 Firebase 專案
在 Firebase 控制台中,依序前往「Security」(安全性) >「Authentication」(驗證)。
在「Settings」分頁中,設定遊戲的 SHA-1 指紋。
您可以使用 gradle
signingReport指令,取得簽署憑證的 SHA 雜湊:./gradlew signingReport
啟用 Google Play 遊戲做為登入供應商:
找出專案的網路伺服器用戶端 ID 和用戶端密鑰。網路伺服器用戶端 ID 會向 Google Play 驗證伺服器識別您的 Firebase 專案。
如要找出這些值,請按照下列步驟操作:
- 在 Google API 控制台憑證頁面中開啟 Firebase 專案。
- 在「OAuth 2.0 client IDs」(OAuth 2.0 用戶端 ID) 區段中,開啟「Web client (auto created by Google Service)」(網頁用戶端 (由 Google 服務自動建立)) 詳細資料頁面。這個頁面會列出網路伺服器用戶端 ID 和密鑰。
返回 Firebase 控制台,依序前往「Security」(安全性) > 「Authentication」(驗證)。
在「登入方式」分頁中,啟用「Play 遊戲」登入供應商。您必須指定專案的網路伺服器用戶端 ID 和用戶端密鑰,這些資訊可從 Google Cloud 控制台取得。
使用 Firebase 應用程式資訊設定 Play Games services
在 Google Play 控制台中,開啟或建立 Google Play 應用程式。
在「拓展」部分,依序點選「Play Games services」>「設定與管理」>「設定」。
按一下「Yes, my game already uses Google APIs」,從清單中選取 Firebase 專案,然後按一下「Use」。
在 Play Games services 設定頁面上,按一下「Add Credential」(新增憑證)。
- 選取「遊戲伺服器」類型。
- 在「OAuth client」(OAuth 用戶端) 欄位中,選取專案的網頁用戶端 ID。請務必使用您在啟用 Play Games 登入功能時指定的用戶端 ID。
- 儲存變更。
在 Play Games services 設定頁面中,再次點選「Add Credential」(新增憑證)。
- 選取「Android」類型。
- 在「OAuth client」(OAuth 用戶端) 欄位中,選取專案的 Android 用戶端 ID。(如果找不到 Android 用戶端 ID,請務必在 Firebase 控制台中設定遊戲的 SHA-1 指紋)。
- 儲存變更。
在「測試人員」頁面中,新增在遊戲發布至 Play Store 前,需要登入遊戲的使用者電子郵件地址。
在遊戲中整合 Play 遊戲登入功能
首先,請將 Play 遊戲登入功能整合至應用程式。詳情請參閱「登入 Android 遊戲」。
在整合中建構 GoogleSignInOptions 物件時,請使用 DEFAULT_GAMES_SIGN_IN 設定並呼叫 requestServerAuthCode:
Kotlin
val gso = GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN) .requestServerAuthCode(getString(R.string.default_web_client_id)) .build()
Java
GoogleSignInOptions gso = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN) .requestServerAuthCode(getString(R.string.default_web_client_id)) .build();
您必須將網路伺服器用戶端 ID 傳遞至 requestServerAuthCode 方法。這個 ID 是您在 Firebase 控制台中啟用 Play 遊戲登入功能時提供的 ID。
使用 Firebase 驗證
在應用程式中加入 Play 遊戲登入功能後,您需要設定 Firebase,才能使用玩家成功登入 Play 遊戲時取得的 Google 帳戶憑證。
首先,在登入活動的
onCreate方法中,取得FirebaseAuth物件的共用例項:Kotlin
private lateinit var auth: FirebaseAuth // ... // Initialize Firebase Auth auth = Firebase.auth
Java
private FirebaseAuth mAuth; // ... // Initialize Firebase Auth mAuth = FirebaseAuth.getInstance();
初始化 Activity 時,請檢查玩家是否已使用 Firebase 登入:
Kotlin
override fun onStart() { super.onStart() // Check if user is signed in (non-null) and update UI accordingly. val currentUser = auth.currentUser updateUI(currentUser) }
Java
@Override public void onStart() { super.onStart(); // Check if user is signed in (non-null) and update UI accordingly. FirebaseUser currentUser = mAuth.getCurrentUser(); updateUI(currentUser); }
如果玩家未登入,請向玩家顯示遊戲的登出體驗,包括登入選項。
玩家透過 Play 遊戲自動或互動登入後,請從
GoogleSignInAccount物件取得驗證碼,並將其兌換為 Firebase 憑證,然後使用 Firebase 憑證向 Firebase 進行驗證:Kotlin
// Call this both in the silent sign-in task's OnCompleteListener and in the // Activity's onActivityResult handler. private fun firebaseAuthWithPlayGames(acct: GoogleSignInAccount) { Log.d(TAG, "firebaseAuthWithPlayGames:" + acct.id!!) val auth = Firebase.auth val credential = PlayGamesAuthProvider.getCredential(acct.serverAuthCode!!) auth.signInWithCredential(credential) .addOnCompleteListener(this) { task -> if (task.isSuccessful) { // Sign in success, update UI with the signed-in user's information Log.d(TAG, "signInWithCredential:success") val user = auth.currentUser updateUI(user) } else { // If sign in fails, display a message to the user. Log.w(TAG, "signInWithCredential:failure", task.exception) Toast.makeText( baseContext, "Authentication failed.", Toast.LENGTH_SHORT, ).show() updateUI(null) } // ... } }
Java
// Call this both in the silent sign-in task's OnCompleteListener and in the // Activity's onActivityResult handler. private void firebaseAuthWithPlayGames(GoogleSignInAccount acct) { Log.d(TAG, "firebaseAuthWithPlayGames:" + acct.getId()); final FirebaseAuth auth = FirebaseAuth.getInstance(); AuthCredential credential = PlayGamesAuthProvider.getCredential(acct.getServerAuthCode()); auth.signInWithCredential(credential) .addOnCompleteListener(this, new OnCompleteListener<AuthResult>() { @Override public void onComplete(@NonNull Task<AuthResult> task) { if (task.isSuccessful()) { // Sign in success, update UI with the signed-in user's information Log.d(TAG, "signInWithCredential:success"); FirebaseUser user = auth.getCurrentUser(); updateUI(user); } else { // If sign in fails, display a message to the user. Log.w(TAG, "signInWithCredential:failure", task.getException()); Toast.makeText(MainActivity.this, "Authentication failed.", Toast.LENGTH_SHORT).show(); updateUI(null); } // ... } }); }
如果
signInWithCredential呼叫成功,您可以使用getCurrentUser方法取得使用者的帳戶資料。
後續步驟
使用者首次登入後,系統會建立新的使用者帳戶,並連結至其 Play 遊戲 ID。這個新帳戶會儲存在 Firebase 專案中,可用於識別專案中所有應用程式的使用者。
在遊戲中,您可以從 FirebaseUser 物件取得使用者的 Firebase UID:
Kotlin
val user = auth.currentUser user?.let { val playerName = it.displayName // The user's Id, unique to the Firebase project. // Do NOT use this value to authenticate with your backend server, if you // have one; use FirebaseUser.getIdToken() instead. val uid = it.uid }
Java
FirebaseUser user = mAuth.getCurrentUser(); String playerName = user.getDisplayName(); // The user's Id, unique to the Firebase project. // Do NOT use this value to authenticate with your backend server, if you // have one; use FirebaseUser.getIdToken() instead. String uid = user.getUid();
在 Firebase 即時資料庫和 Cloud Storage 安全性規則中,您可以從 auth 變數取得已登入使用者的專屬 ID,並用來控管使用者可存取的資料。
如要取得使用者的 Play 遊戲玩家資訊或存取 Play Games 服務,請使用 Google Play Games SDK 提供的 API。
如要登出使用者,請呼叫 FirebaseAuth.signOut:
Kotlin
Firebase.auth.signOut()
Java
FirebaseAuth.getInstance().signOut();