این سند نحوه انتقال بازیهای موجود از بازیهای v1 SDK به بازیهای v2 SDK را شرح میدهد.
قبل از شروع
می توانید از هر IDE ترجیحی مانند Android Studio برای انتقال بازی خود استفاده کنید. قبل از مهاجرت به بازی نسخه 2 مراحل زیر را کامل کنید:
- اندروید استودیو را دانلود و نصب کنید
- بازی شما باید از بازی ها v1 SDK استفاده کند
وابستگی ها را به روز کنید
در فایل
build.gradle
ماژول خود، این خط را در وابستگی های سطح ماژول پیدا کنید.implementation "com.google.android.gms:play-services-games-v1:+"
کد زیر را جایگزین کنید:
implementation "com.google.android.gms:play-services-games-v2:version"
version با آخرین نسخه SDK بازی ها جایگزین کنید.
پس از بهروزرسانی وابستگیها، مطمئن شوید که تمام مراحل این سند را کامل کردهاید.
مهاجرت از ورود به سیستم Google منسوخ شده
کلاس GoogleSignInClient
را با کلاس GamesSignInClient
جایگزین کنید.
جاوا
مکان فایل ها را با کلاس GoogleSignInClient
پیدا کنید.
import com.google.android.gms.auth.api.signin.GoogleSignIn;
import com.google.android.gms.auth.api.signin.GoogleSignInClient;
import com.google.android.gms.auth.api.signin.GoogleSignInOptions;
// ... existing code
@Override
public void onCreate(@Nullable Bundle bundle) {
super.onCreate(bundle);
// ... existing code
val signInOptions = GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN
// Client used to sign in to Google services
GoogleSignInClient googleSignInClient =
GoogleSignIn.getClient(this, signInOptions);
}
و به این صورت آپدیت کنید:
import com.google.android.gms.games.PlayGamesSdk;
import com.google.android.gms.games.PlayGames;
import com.google.android.gms.games.GamesSignInClient;
// ... existing code
@Override
public void onCreate(){
super.onCreate();
// Client used to sign in to Google services
GamesSignInClient gamesSignInClient =
PlayGames.getGamesSignInClient(getActivity());
}
کاتلین
مکان فایل ها را با کلاس GoogleSignInClient
پیدا کنید.
import com.google.android.gms.auth.api.signin.GoogleSignIn
import com.google.android.gms.auth.api.signin.GoogleSignInClient
import com.google.android.gms.auth.api.signin.GoogleSignInOptions
// ... existing code
val signInOptions = GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN
// ... existing code
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val googleSignInClient: GoogleSignInClient =
GoogleSignIn.getClient(this, signInOptions)
}
و به این صورت آپدیت کنید:
import com.google.android.gms.games.PlayGames
import com.google.android.gms.games.PlayGamesSdk
import com.google.android.gms.games.GamesSignInClient
// ... existing code
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
PlayGamesSdk.initialize(this)
// client used to sign in to Google services
val gamesSignInClient: GamesSignInClient =
PlayGames.getGamesSignInClient(this)
}
کد GoogleSignIn
به روز کنید
GoogleSignIn
API و دامنهها در بازیهای v2 SDK پشتیبانی نمیشوند. همانطور که در مثال زیر نشان داده شده است، کد GoogleSignIn
API را برای دامنه های OAuth 2.0 با GamesSignInClient
API جایگزین کنید:
جاوا
مکان فایلها را با کلاس GoogleSignIn
و دامنهها پیدا کنید.
// Request code used when invoking an external activity.
private static final int RC_SIGN_IN = 9001;
private boolean isSignedIn() {
GoogleSignInAccount account = GoogleSignIn.getLastSignedInAccount(this);
GoogleSignInOptions signInOptions =
GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN;
return GoogleSignIn.hasPermissions(account, signInOptions.getScopeArray());
}
private void signInSilently() {
GoogleSignInOptions signInOptions =
GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN;
GoogleSignInClient signInClient = GoogleSignIn.getClient(this, signInOptions);
signInClient
.silentSignIn()
.addOnCompleteListener(
this,
task -> {
if (task.isSuccessful()) {
// The signed-in account is stored in the task's result.
GoogleSignInAccount signedInAccount = task.getResult();
showSignInPopup();
} else {
// Perform interactive sign in.
startSignInIntent();
}
});
}
private void startSignInIntent() {
GoogleSignInClient signInClient = GoogleSignIn.getClient(this,
GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN);
Intent intent = signInClient.getSignInIntent();
startActivityForResult(intent, RC_SIGN_IN);
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if (requestCode == RC_SIGN_IN) {
GoogleSignInResult result =
Auth.GoogleSignInApi.getSignInResultFromIntent(data);
if (result.isSuccess()) {
// The signed-in account is stored in the result.
GoogleSignInAccount signedInAccount = result.getSignInAccount();
showSignInPopup();
} else {
String message = result.getStatus().getStatusMessage();
if (message == null || message.isEmpty()) {
message = getString(R.string.signin_other_error);
}
new AlertDialog.Builder(this).setMessage(message)
.setNeutralButton(android.R.string.ok, null).show();
}
}
}
private void showSignInPopup() {
Games.getGamesClient(requireContext(), signedInAccount)
.setViewForPopups(contentView)
.addOnCompleteListener(
task -> {
if (task.isSuccessful()) {
logger.atInfo().log("SignIn successful");
} else {
logger.atInfo().log("SignIn failed");
}
});
}
و به این صورت آپدیت کنید:
private void signInSilently() {
gamesSignInClient.isAuthenticated().addOnCompleteListener(isAuthenticatedTask -> {
boolean isAuthenticated =
(isAuthenticatedTask.isSuccessful() &&
isAuthenticatedTask.getResult().isAuthenticated());
if (isAuthenticated) {
// Continue with Play Games Services
} else {
// If authentication fails, either disable Play Games Services
// integration or
// display a login button to prompt players to sign in.
// Use`gamesSignInClient.signIn()` when the login button is clicked.
}
});
}
@Override
protected void onResume() {
super.onResume();
// When the activity is inactive, the signed-in user's state can change;
// therefore, silently sign in when the app resumes.
signInSilently();
}
کاتلین
مکان فایلها را با کلاس GoogleSignIn
و دامنهها پیدا کنید.
// Request codes we use when invoking an external activity.
private val RC_SIGN_IN = 9001
// ... existing code
private fun isSignedIn(): Boolean {
val account = GoogleSignIn.getLastSignedInAccount(this)
val signInOptions = GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN
return GoogleSignIn.hasPermissions(account, *signInOptions.scopeArray)
}
private fun signInSilently() {
val signInOptions = GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN
val signInClient = GoogleSignIn.getClient(this, signInOptions)
signInClient.silentSignIn().addOnCompleteListener(this) { task ->
if (task.isSuccessful) {
// The signed-in account is stored in the task's result.
val signedInAccount = task.result
// Pass the account to showSignInPopup.
showSignInPopup(signedInAccount)
} else {
// Perform interactive sign in.
startSignInIntent()
}
}
}
private fun startSignInIntent() {
val signInClient = GoogleSignIn.getClient(this, GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN)
val intent = signInClient.signInIntent
startActivityForResult(intent, RC_SIGN_IN)
}
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
if (requestCode == RC_SIGN_IN) {
val result = Auth.GoogleSignInApi.getSignInResultFromIntent(data)
if (result.isSuccess) {
// The signed-in account is stored in the result.
val signedInAccount = result.signInAccount
showSignInPopup(signedInAccount) // Pass the account to showSignInPopup.
} else {
var message = result.status.statusMessage
if (message == null || message.isEmpty()) {
message = getString(R.string.signin_other_error)
}
AlertDialog.Builder(this)
.setMessage(message)
.setNeutralButton(android.R.string.ok, null)
.show()
}
}
}
private fun showSignInPopup(signedInAccount: GoogleSignInAccount) {
// Add signedInAccount parameter.
Games.getGamesClient(this, signedInAccount)
.setViewForPopups(contentView) // Assuming contentView is defined.
.addOnCompleteListener { task ->
if (task.isSuccessful) {
logger.atInfo().log("SignIn successful")
} else {
logger.atInfo().log("SignIn failed")
}
}
}
و به این صورت آپدیت کنید:
private fun signInSilently() {
gamesSignInClient.isAuthenticated.addOnCompleteListener { isAuthenticatedTask ->
val isAuthenticated = isAuthenticatedTask.isSuccessful &&
isAuthenticatedTask.result.isAuthenticated
if (isAuthenticated) {
// Continue with Play Games Services
} else {
// To handle a user who is not signed in, either disable Play Games Services integration
// or display a login button. Selecting this button calls `gamesSignInClient.signIn()`.
}
}
}
override fun onResume() {
super.onResume()
// Since the state of the signed in user can change when the activity is
// not active it is recommended to try and sign in silently from when the
// app resumes.
signInSilently()
}
کد GamesSignInClient
را اضافه کنید
اگر بازیکن با موفقیت به سیستم وارد شد، دکمه ورود به سیستم خدمات بازیهای Play را از بازی خود حذف کنید. اگر کاربر تصمیم گرفت هنگام راهاندازی بازی وارد سیستم نشود، به نشان دادن یک دکمه با نماد خدمات بازیهای Play ادامه دهید و فرآیند ورود به سیستم را با GamesSignInClient.signIn()
شروع کنید.
جاوا
private void startSignInIntent() {
gamesSignInClient
.signIn()
.addOnCompleteListener( task -> {
if (task.isSuccessful() && task.getResult().isAuthenticated()) {
// sign in successful
} else {
// sign in failed
}
});
}
کاتلین
private fun startSignInIntent() {
gamesSignInClient
.signIn()
.addOnCompleteListener { task ->
if (task.isSuccessful && task.result.isAuthenticated) {
// sign in successful
} else {
// sign in failed
}
}
}
کد خروج از سیستم را حذف کنید
کد GoogleSignInClient.signOut
را حذف کنید.
کد نشان داده شده در مثال زیر را حذف کنید:
جاوا
// ... existing code
private void signOut() {
GoogleSignInClient signInClient = GoogleSignIn.getClient(this,
GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN);
signInClient.signOut().addOnCompleteListener(this,
new OnCompleteListener() {
@Override
public void onComplete(@NonNull Task task) {
// At this point, the user is signed out.
}
});
}
کاتلین
// ... existing code
private fun signOut() {
val signInClient = GoogleSignIn.getClient(this, GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN)
signInClient.signOut().addOnCompleteListener(this) {
// At this point, the user is signed out.
}
}
ورود موفقیت آمیز خودکار را بررسی کنید
کد زیر را وارد کنید تا بررسی کنید که آیا به طور خودکار وارد سیستم شده اید یا خیر و در صورت در دسترس بودن، منطق سفارشی را اضافه کنید.
جاوا
private void checkIfAutomaticallySignedIn() {
gamesSignInClient.isAuthenticated().addOnCompleteListener(isAuthenticatedTask -> {
boolean isAuthenticated =
(isAuthenticatedTask.isSuccessful() &&
isAuthenticatedTask.getResult().isAuthenticated());
if (isAuthenticated) {
// Continue with Play Games Services
// If your game requires specific actions upon successful sign-in,
// you can add your custom logic here.
// For example, fetching player data or updating UI elements.
} else {
// Disable your integration with Play Games Services or show a
// login button to ask players to sign-in. Clicking it should
// call GamesSignInClient.signIn().
}
});
}
کاتلین
private void checkIfAutomaticallySignedIn() {
gamesSignInClient.isAuthenticated()
.addOnCompleteListener { task ->
val isAuthenticated = task.isSuccessful && task.result?.isAuthenticated ?: false
if (isAuthenticated) {
// Continue with Play Games Services
} else {
// Disable your integration or show a login button
}
}
}
نام و متدهای کلاس کلاینت را به روز کنید
وقتی به بازیهای نسخه ۲ مهاجرت میکنید، روشهای مورد استفاده برای دریافت نام کلاس کلاینت متفاوت است. از متدهای PlayGames.getxxxClient()
مربوطه به جای متد Games.getxxxClient()
استفاده کنید.
به عنوان مثال، برای LeaderboardsClient
به جای متد Games.getLeaderboardsClient()
PlayGames.getLeaderboardsClient()
استفاده کنید.
جاوا
کد LeaderboardsClient
را پیدا کنید.
import com.google.android.gms.games.LeaderboardsClient;
import com.google.android.gms.games.Games;
@Override
public void onCreate(@Nullable Bundle bundle) {
super.onCreate(bundle);
// Get the leaderboards client using Play Games services.
LeaderboardsClient leaderboardsClient = Games.getLeaderboardsClient(this,
GoogleSignIn.getLastSignedInAccount(this));
}
و به این صورت آپدیت کنید:
import com.google.android.gms.games.LeaderboardsClient;
import com.google.android.gms.games.PlayGames;
@Override
public void onCreate(@Nullable Bundle bundle) {
super.onCreate(bundle);
// Get the leaderboards client using Play Games services.
LeaderboardsClient leaderboardsClient = PlayGames.getLeaderboardsClient(getActivity());
}
کاتلین
کد LeaderboardsClient
را پیدا کنید.
import com.google.android.gms.games.LeaderboardsClient
import com.google.android.gms.games.Games
// Initialize the variables.
private lateinit var leaderboardsClient: LeaderboardsClient
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
leaderboardsClient = Games.getLeaderboardsClient(this,
GoogleSignIn.getLastSignedInAccount(this))
}
و به این صورت آپدیت کنید:
import com.google.android.gms.games.LeaderboardsClient
import com.google.android.gms.games.PlayGames
// Initialize the variables.
private lateinit var leaderboardsClient: LeaderboardsClient
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
leaderboardsClient = PlayGames.getLeaderboardsClient(this)
}
به طور مشابه، از روشهای مربوطه برای کلاینتهای زیر استفاده کنید: AchievementsClient
، EventsClient
، GamesSignInClient
، PlayerStatsClient
، RecallClient
، SnapshotsClient
، یا PlayersClient
.
کلاس های دسترسی سمت سرور را به روز کنید
برای درخواست رمز دسترسی سمت سرور، به جای متد GamesSignInClient.requestServerSideAccess()
GoogleSignInAccount.getServerAuthCode()
استفاده کنید.
مثال زیر نحوه درخواست رمز دسترسی سمت سرور را نشان می دهد.
جاوا
کد کلاس GoogleSignInOptions
را پیدا کنید.
private static final int RC_SIGN_IN = 9001;
private GoogleSignInClient googleSignInClient;
private void startSignInForAuthCode() {
/** Client ID for your backend server. */
String webClientId = getString(R.string.webclient_id);
GoogleSignInOptions signInOption = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN)
.requestServerAuthCode(webClientId)
.build();
GoogleSignInClient signInClient = GoogleSignIn.getClient(this, signInOption);
Intent intent = signInClient.getSignInIntent();
startActivityForResult(intent, RC_SIGN_IN);
}
/** Auth code to send to backend server */
private String mServerAuthCode;
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if (requestCode == RC_SIGN_IN) {
GoogleSignInResult result = Auth.GoogleSignInApi.getSignInResultFromIntent(data);
if (result.isSuccess()) {
mServerAuthCode = result.getSignInAccount().getServerAuthCode();
} else {
String message = result.getStatus().getStatusMessage();
if (message == null || message.isEmpty()) {
message = getString(R.string.signin_other_error);
}
new AlertDialog.Builder(this).setMessage(message)
.setNeutralButton(android.R.string.ok, null).show();
}
}
}
و به این صورت آپدیت کنید:
private void startRequestServerSideAccess() {
GamesSignInClient gamesSignInClient = PlayGames.getGamesSignInClient(this);
gamesSignInClient
.requestServerSideAccess(OAUTH_2_WEB_CLIENT_ID, /* forceRefreshToken= */ false)
.addOnCompleteListener(task -> {
if (task.isSuccessful()) {
String serverAuthToken = task.getResult();
// Send authentication code to the backend game server.
// Exchange for an access token.
// Verify the player with Play Games Services REST APIs.
} else {
// Authentication code retrieval failed.
}
});
}
کاتلین
کد کلاس GoogleSignInOptions
را پیدا کنید.
// ... existing code
private val RC_SIGN_IN = 9001
private lateinit var googleSignInClient: GoogleSignInClient
// Auth code to send to backend server.
private var mServerAuthCode: String? = null
private fun startSignInForAuthCode() {
// Client ID for your backend server.
val webClientId = getString(R.string.webclient_id)
val signInOption = GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN)
.requestServerAuthCode(webClientId)
.build()
googleSignInClient = GoogleSignIn.getClient(this, signInOption)
val intent = googleSignInClient.signInIntent
startActivityForResult(intent, RC_SIGN_IN)
}
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
if (requestCode == RC_SIGN_IN) {
val result = Auth.GoogleSignInApi.getSignInResultFromIntent(data)
if (result.isSuccess) {
mServerAuthCode = result.signInAccount.serverAuthCode
} else {
var message = result.status.statusMessage
if (message == null || message.isEmpty()) {
message = getString(R.string.signin_other_error)
}
AlertDialog.Builder(this).setMessage(message)
.setNeutralButton(android.R.string.ok, null).show()
}
}
}
و به این صورت آپدیت کنید:
private void startRequestServerSideAccess() {
GamesSignInClient gamesSignInClient = PlayGames.getGamesSignInClient(this);
gamesSignInClient
.requestServerSideAccess(OAUTH_2_WEB_CLIENT_ID, /* forceRefreshToken= */ false)
.addOnCompleteListener(task -> {
if (task.isSuccessful()) {
String serverAuthToken = task.getResult();
// Send authentication code to the backend game server.
// Exchange for an access token.
// Verify the player with Play Games Services REST APIs.
} else {
// Authentication code retrieval failed.
}
});
}
از GoogleApiClient مهاجرت کنید
برای ادغامهای موجود قدیمیتر، ممکن است بازی شما به نوع GoogleApiClient
API مربوط به SDK خدمات بازیهای Play بستگی داشته باشد. این در اواخر سال 2017 منسوخ شد و با مشتریان "بدون اتصال" جایگزین شد. برای مهاجرت میتوانید کلاس GoogleApiClient
را با یک معادل «بدون اتصال» جایگزین کنید. جدول زیر نگاشت کلاس های رایج از بازی های v1 به بازی های v2 را فهرست می کند:
بازی های نسخه 2 (جاری) | بازی های نسخه 1 (میراث) |
---|---|
com.google.android.gms.games.AchievementsClient | com.google.android.gms.games.achievement.Achievements |
com.google.android.gms.games.LeaderboardsClient | com.google.android.gms.games.leaderboard.Leaderboard |
com.google.android.gms.games.SnapshotsClient | com.google.android.gms.games.snapshot.Snapshots |
com.google.android.gms.games.PlayerStatsClient | com.google.android.gms.games.stats.PlayerStats |
com.google.android.gms.games.PlayersClient | com.google.android.gms.games.Players |
com.google.android.gms.games.GamesClientStatusCodes | com.google.android.gms.games.GamesStatusCodes |
بازی را بسازید و اجرا کنید
برای ساخت و اجرا در Android Studio، به ساخت و اجرای برنامه خود مراجعه کنید.
بازی خود را تست کنید
با تست کردن، از عملکرد بازی خود همانطور که طراحی شده است اطمینان حاصل کنید. تست هایی که انجام می دهید به ویژگی های بازی شما بستگی دارد.
در زیر لیستی از تست های رایج برای اجرا آمده است.
ورود موفقیت آمیز
ورود خودکار کار می کند. کاربر باید پس از راهاندازی بازی، وارد «خدمات بازیهای Play» شود.
پنجره خوش آمد گویی نمایش داده می شود.
پیام های ثبت موفقیت آمیز نمایش داده می شود. دستور زیر را در ترمینال اجرا کنید:
adb logcat | grep com.google.android.
یک پیام ثبت موفقیت آمیز در مثال زیر نشان داده شده است:
[
$PlaylogGamesSignInAction$SignInPerformerSource@e1cdecc number=1 name=GAMES_SERVICE_BROKER>], returning true for shouldShowWelcomePopup. [CONTEXT service_id=1 ]
از سازگاری مؤلفه UI اطمینان حاصل کنید .
پاپآپها، تابلوهای امتیازات و دستاوردها بهطور صحیح و پیوسته در اندازهها و جهتهای مختلف صفحه در رابط کاربری (UI) خدمات بازیهای Play نمایش داده میشوند.
گزینه خروج از سیستم در رابط کاربری Play Games Services قابل مشاهده نیست.
مطمئن شوید که می توانید با موفقیت شناسه پخش کننده را بازیابی کنید، و در صورت وجود، قابلیت های سمت سرور همانطور که انتظار می رود کار می کنند.
اگر بازی از احراز هویت سمت سرور استفاده می کند، جریان
requestServerSideAccess
را به طور کامل آزمایش کنید. اطمینان حاصل کنید که سرور کد احراز هویت را دریافت کرده و می تواند آن را با یک نشانه دسترسی مبادله کند. سناریوهای موفقیت و شکست را برای خطاهای شبکه، سناریوهایclient ID
نامعتبر آزمایش کنید.
اگر بازی شما از یکی از ویژگیهای زیر استفاده میکرد، آنها را آزمایش کنید تا مطمئن شوید که مانند قبل از مهاجرت کار میکنند:
- تابلوهای امتیازات : امتیازات را ارسال کنید و تابلوهای امتیازات را مشاهده کنید. رتبه بندی صحیح و نمایش اسامی و امتیازات بازیکنان را بررسی کنید.
- دستاوردها : قفل دستاوردها را باز کنید و تأیید کنید که به درستی ثبت شده و در رابط کاربری بازیهای Play نمایش داده میشوند.
- بازیهای ذخیرهشده : اگر بازی از بازیهای ذخیرهشده استفاده میکند، مطمئن شوید که ذخیره و بارگیری پیشرفت بازی بدون نقص انجام میشود. این به ویژه برای آزمایش در چندین دستگاه و پس از به روز رسانی برنامه بسیار مهم است.
وظایف مهاجرت را ارسال کنید
پس از مهاجرت به بازی نسخه 2 مراحل زیر را کامل کنید.
بازی را منتشر کنید
APK(های) را بسازید و بازی را در Play Console منتشر کنید.
- در منوی Android Studio، Build > Build Bundles(s) / APK(s) > Build APK(s) را انتخاب کنید.
- بازی خود را منتشر کنید برای اطلاعات بیشتر، به انتشار برنامههای خصوصی از کنسول Play مراجعه کنید.