Android गेम में सेव किए गए गेम की सुविधा

इस गाइड में, Google Play Games Services के स्नैपशॉट एपीआई का इस्तेमाल करके, सेव किए गए गेम को लागू करने का तरीका बताया गया है. एपीआई, com.google.android.gms.games.snapshot और com.google.android.gms.games पैकेज में मिल सकते हैं.

शुरू करने से पहले

अगर आपने अब तक ऐसा नहीं किया है, तो सेव किए गए गेम के कॉन्सेप्ट की समीक्षा करना आपके लिए मददगार हो सकता है.

स्नैपशॉट क्लाइंट पाना

स्नैपशॉट एपीआई का इस्तेमाल शुरू करने के लिए, आपके गेम को सबसे पहले एक SnapshotsClient ऑब्जेक्ट पाना होगा. ऐसा करने के लिए, Games.getSnapshotsClient() तरीके को कॉल करें और मौजूदा प्लेयर के लिए गतिविधि और GoogleSignInAccount को पास करें. खिलाड़ी के खाते की जानकारी वापस पाने का तरीका जानने के लिए, Android Games में साइन इन करना लेख पढ़ें.

Drive का स्कोप तय करना

सेव किए गए गेम के स्टोरेज के लिए, स्नैपशॉट एपीआई, Google Drive API पर निर्भर करता है. Drive API को ऐक्सेस करने के लिए, आपके ऐप्लिकेशन को Google साइन-इन क्लाइंट बनाते समय, Drive.SCOPE_APPFOLDER स्कोप की जानकारी देनी होगी.

साइन इन करने की गतिविधि के लिए, onResume() वाले तरीके में ऐसा करने का उदाहरण यहां दिया गया है:

private GoogleSignInClient mGoogleSignInClient;

@Override
protected void onResume() {
  super.onResume();
  signInSilently();
}

private void signInSilently() {
  GoogleSignInOptions signInOption =
      new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN)
          // Add the APPFOLDER scope for Snapshot support.
          .requestScopes(Drive.SCOPE_APPFOLDER)
          .build();

  GoogleSignInClient signInClient = GoogleSignIn.getClient(this, signInOption);
  signInClient.silentSignIn().addOnCompleteListener(this,
      new OnCompleteListener<GoogleSignInAccount>() {
        @Override
        public void onComplete(@NonNull Task<GoogleSignInAccount> task) {
          if (task.isSuccessful()) {
            onConnected(task.getResult());
          } else {
            // Player will need to sign-in explicitly using via UI
          }
        }
      });
}

सेव किए गए गेम दिखाना

अगर आपके गेम में खिलाड़ियों को अपनी प्रोग्रेस सेव करने या उसे वापस लाने का विकल्प मिलता है, तो वहां स्नैपशॉट एपीआई को इंटिग्रेट किया जा सकता है. आपका गेम, सेव करने/वापस लाने के लिए तय किए गए पॉइंट पर ऐसा विकल्प दिखा सकता है. इसके अलावा, खिलाड़ियों को किसी भी समय प्रोग्रेस सेव करने या वापस लाने की अनुमति भी दी जा सकती है.

जब खिलाड़ी आपके गेम में सेव/वापस लाने का विकल्प चुनते हैं, तो आपके गेम में वैकल्पिक तौर पर एक स्क्रीन दिख सकती है. इस स्क्रीन पर, खिलाड़ियों को सेव किए गए नए गेम की जानकारी डालने या वापस लाने के लिए मौजूदा गेम चुनने के लिए कहा जा सकता है.

डेवलपमेंट को आसान बनाने के लिए, स्नैपशॉट एपीआई, सेव किए गए गेम चुनने के लिए डिफ़ॉल्ट यूज़र इंटरफ़ेस (यूआई) उपलब्ध कराता है. इसका इस्तेमाल, बिना किसी बदलाव के किया जा सकता है. सेव किए गए गेम चुनने के यूज़र इंटरफ़ेस (यूआई) की मदद से, खिलाड़ी नया सेव किया गया गेम बना सकते हैं. साथ ही, सेव किए गए मौजूदा गेम की जानकारी देख सकते हैं और सेव किए गए पिछले गेम लोड कर सकते हैं.

सेव किए गए गेम का डिफ़ॉल्ट यूज़र इंटरफ़ेस (यूआई) लॉन्च करने के लिए:

  1. सेव किए गए गेम के डिफ़ॉल्ट यूज़र इंटरफ़ेस (यूआई) को लॉन्च करने के लिए, SnapshotsClient.getSelectSnapshotIntent() को कॉल करके Intent पाएं.
  2. startActivityForResult() को कॉल करें और उसमें Intent डालें. अगर कॉल पूरा हो जाता है, तो गेम में सेव किए गए गेम के विकल्पों का यूज़र इंटरफ़ेस (यूआई) दिखता है. साथ ही, आपके बताए गए विकल्प भी दिखते हैं.

सेव किए गए गेम चुनने के लिए, डिफ़ॉल्ट यूज़र इंटरफ़ेस (यूआई) को लॉन्च करने का उदाहरण यहां दिया गया है:

private static final int RC_SAVED_GAMES = 9009;

private void showSavedGamesUI() {
  SnapshotsClient snapshotsClient =
      Games.getSnapshotsClient(this, GoogleSignIn.getLastSignedInAccount(this));
  int maxNumberOfSavedGamesToShow = 5;

  Task<Intent> intentTask = snapshotsClient.getSelectSnapshotIntent(
      "See My Saves", true, true, maxNumberOfSavedGamesToShow);

  intentTask.addOnSuccessListener(new OnSuccessListener<Intent>() {
    @Override
    public void onSuccess(Intent intent) {
      startActivityForResult(intent, RC_SAVED_GAMES);
    }
  });
}

अगर खिलाड़ी सेव किया गया नया गेम बनाने या सेव किया गया कोई मौजूदा गेम लोड करने का विकल्प चुना जाता है, तो यूज़र इंटरफ़ेस (यूआई) Google Play Games Services को अनुरोध भेजता है. अगर अनुरोध पूरा हो जाता है, तो Google Play Games Services, onActivityResult() कॉलबैक के ज़रिए सेव किए गए गेम को बनाने या वापस लाने के लिए जानकारी दिखाता है. आपका गेम इस कॉलबैक को बदल सकता है, ताकि यह पता लगाया जा सके कि अनुरोध के दौरान कोई गड़बड़ी हुई है या नहीं.

यहां दिया गया कोड स्निपेट, onActivityResult() को लागू करने का सैंपल दिखाता है:

private String mCurrentSaveName = "snapshotTemp";

/**
 * This callback will be triggered after you call startActivityForResult from the
 * showSavedGamesUI method.
 */
@Override
protected void onActivityResult(int requestCode, int resultCode,
                                Intent intent) {
  if (intent != null) {
    if (intent.hasExtra(SnapshotsClient.EXTRA_SNAPSHOT_METADATA)) {
      // Load a snapshot.
      SnapshotMetadata snapshotMetadata =
          intent.getParcelableExtra(SnapshotsClient.EXTRA_SNAPSHOT_METADATA);
      mCurrentSaveName = snapshotMetadata.getUniqueName();

      // Load the game data from the Snapshot
      // ...
    } else if (intent.hasExtra(SnapshotsClient.EXTRA_SNAPSHOT_NEW)) {
      // Create a new snapshot named with a unique string
      String unique = new BigInteger(281, new Random()).toString(13);
      mCurrentSaveName = "snapshotTemp-" + unique;

      // Create the new snapshot
      // ...
    }
  }
}

सेव किए गए गेम

सेव किए गए गेम में कॉन्टेंट सेव करने के लिए:

  1. SnapshotsClient.open() की मदद से, किसी स्नैपशॉट को असिंक्रोनस तरीके से खोलें. इसके बाद, SnapshotsClient.DataOrConflict.getData() को कॉल करके, टास्क के नतीजे से Snapshot ऑब्जेक्ट को फिर से पाएं.
  2. SnapshotsClient.SnapshotConflict की मदद से, SnapshotContents इंस्टेंस को वापस पाएं.
  3. प्लेयर का डेटा बाइट फ़ॉर्मैट में सेव करने के लिए, SnapshotContents.writeBytes() को कॉल करें.
  4. सभी बदलाव लिखने के बाद, Google के सर्वर पर बदलाव भेजने के लिए, SnapshotsClient.commitAndClose() को कॉल करें. आपका गेम, मेथड कॉल में ज़्यादा जानकारी दे सकता है. इससे, Google Play Games Services को यह बताने में मदद मिलती है कि सेव किए गए इस गेम को खिलाड़ियों को कैसे दिखाया जाए. इस जानकारी को SnapshotMetaDataChange ऑब्जेक्ट में दिखाया जाता है. इसे आपका गेम, SnapshotMetadataChange.Builder का इस्तेमाल करके बनाता है.

नीचे दिए गए स्निपेट में बताया गया है कि आपका गेम, सेव किए गए गेम में बदलाव कैसे कर सकता है:

private Task<SnapshotMetadata> writeSnapshot(Snapshot snapshot,
                                             byte[] data, Bitmap coverImage, String desc) {

  // Set the data payload for the snapshot
  snapshot.getSnapshotContents().writeBytes(data);

  // Create the change operation
  SnapshotMetadataChange metadataChange = new SnapshotMetadataChange.Builder()
      .setCoverImage(coverImage)
      .setDescription(desc)
      .build();

  SnapshotsClient snapshotsClient =
      Games.getSnapshotsClient(this, GoogleSignIn.getLastSignedInAccount(this));

  // Commit the operation
  return snapshotsClient.commitAndClose(snapshot, metadataChange);
}

अगर आपका ऐप्लिकेशन SnapshotsClient.commitAndClose() को कॉल करते समय, खिलाड़ी का डिवाइस किसी नेटवर्क से कनेक्ट नहीं है, तो Google Play Games Services, सेव किए गए गेम डेटा को डिवाइस पर सेव करता है. डिवाइस के फिर से कनेक्ट होने पर, Google Play Games services, गेम में किए गए बदलावों को कैश मेमोरी में सेव करके, Google के सर्वर पर सिंक करता है.

सेव किए गए गेम लोड करना

फ़िलहाल साइन इन किए हुए खिलाड़ी के लिए, सेव किए गए गेम वापस पाने के लिए:

  1. SnapshotsClient.open() की मदद से, किसी स्नैपशॉट को असिंक्रोनस तरीके से खोलें. इसके बाद, SnapshotsClient.DataOrConflict.getData() को कॉल करके, टास्क के नतीजे से Snapshot ऑब्जेक्ट को फिर से पाएं. इसके अलावा, आपका गेम, सेव किए गए गेम चुनने के यूज़र इंटरफ़ेस (यूआई) की मदद से भी कोई खास स्नैपशॉट वापस ला सकता है. इस बारे में ज़्यादा जानने के लिए, सेव किए गए गेम दिखाना लेख पढ़ें.
  2. SnapshotsClient.SnapshotConflict की मदद से, SnapshotContents इंस्टेंस को वापस पाएं.
  3. स्नैपशॉट के कॉन्टेंट को पढ़ने के लिए, SnapshotContents.readFully() को कॉल करें.

यहां दिए गए स्निपेट में, सेव किए गए किसी गेम को लोड करने का तरीका बताया गया है:

Task<byte[]> loadSnapshot() {
  // Display a progress dialog
  // ...

  // Get the SnapshotsClient from the signed in account.
  SnapshotsClient snapshotsClient =
      Games.getSnapshotsClient(this, GoogleSignIn.getLastSignedInAccount(this));

  // In the case of a conflict, the most recently modified version of this snapshot will be used.
  int conflictResolutionPolicy = SnapshotsClient.RESOLUTION_POLICY_MOST_RECENTLY_MODIFIED;

  // Open the saved game using its name.
  return snapshotsClient.open(mCurrentSaveName, true, conflictResolutionPolicy)
      .addOnFailureListener(new OnFailureListener() {
        @Override
        public void onFailure(@NonNull Exception e) {
          Log.e(TAG, "Error while opening Snapshot.", e);
        }
      }).continueWith(new Continuation<SnapshotsClient.DataOrConflict<Snapshot>, byte[]>() {
        @Override
        public byte[] then(@NonNull Task<SnapshotsClient.DataOrConflict<Snapshot>> task) throws Exception {
          Snapshot snapshot = task.getResult().getData();

          // Opening the snapshot was a success and any conflicts have been resolved.
          try {
            // Extract the raw data from the snapshot.
            return snapshot.getSnapshotContents().readFully();
          } catch (IOException e) {
            Log.e(TAG, "Error while reading Snapshot.", e);
          }

          return null;
        }
      }).addOnCompleteListener(new OnCompleteListener<byte[]>() {
        @Override
        public void onComplete(@NonNull Task<byte[]> task) {
          // Dismiss progress dialog and reflect the changes in the UI when complete.
          // ...
        }
      });
}

सेव किए गए गेम से जुड़ी समस्याएं हल करना

अपने गेम में स्नैपशॉट एपीआई का इस्तेमाल करने पर, एक ही सेव किए गए गेम पर कई डिवाइसों से डेटा पढ़ा और लिखा जा सकता है. अगर किसी डिवाइस का नेटवर्क कनेक्शन कुछ समय के लिए बंद हो जाता है और फिर से कनेक्ट हो जाता है, तो इससे डेटा में अंतर हो सकता है. ऐसा तब होता है, जब किसी प्लेयर के डिवाइस पर सेव किया गया गेम, Google के सर्वर पर सेव किए गए गेम से सिंक नहीं होता.

स्नैपशॉट एपीआई, समस्या हल करने का एक तरीका उपलब्ध कराता है. यह पढ़ने के समय, सेव किए गए उन गेम के दोनों सेट दिखाता है जिनमें समस्या है. साथ ही, आपको अपने गेम के लिए समस्या हल करने की सही रणनीति लागू करने की सुविधा देता है.

जब Google Play Games Services को डेटा में कोई अंतर दिखता है, तो SnapshotsClient.DataOrConflict.isConflict() तरीका true की वैल्यू दिखाता है. इस स्थिति में, SnapshotsClient.SnapshotConflict क्लास से सेव किए गए गेम के दो वर्शन मिलते हैं:

  • सर्वर वर्शन: Google Play Games Services के मुताबिक, खिलाड़ी के डिवाइस के लिए सबसे सटीक वर्शन; और
  • लोकल वर्शन: ऐसा वर्शन जिसमें बदलाव किया गया हो और जिसे प्लेयर के किसी डिवाइस पर पाया गया हो. इसमें ऐसा कॉन्टेंट या मेटाडेटा हो सकता है जो नीति का उल्लंघन करता हो. यह ज़रूरी नहीं है कि यह वही वर्शन हो जिसे आपने सेव करने की कोशिश की थी.

आपके गेम को यह तय करना होगा कि इस समस्या को कैसे हल किया जाए. इसके लिए, वह दिए गए वर्शन में से किसी एक को चुन सकता है या सेव किए गए गेम के दो वर्शन के डेटा को मर्ज कर सकता है.

सेव किए गए गेम से जुड़ी समस्याओं का पता लगाने और उन्हें ठीक करने के लिए:

  1. SnapshotsClient.open() पर कॉल करें. टास्क के नतीजे में SnapshotsClient.DataOrConflict क्लास शामिल है.
  2. SnapshotsClient.DataOrConflict.isConflict() तरीके को कॉल करें. अगर नतीजा सही है, तो आपको एक टकराव हल करना होगा.
  3. SnaphotsClient.snapshotConflict इंस्टेंस को वापस पाने के लिए, SnapshotsClient.DataOrConflict.getConflict() को कॉल करें.
  4. कॉन्फ़िल्ट आईडी पाने के लिए SnapshotsClient.SnapshotConflict.getConflictId() को कॉल करें. यह आईडी, कॉन्फ़िल्ट की खास तौर पर पहचान करता है. आपके गेम को बाद में, विवाद को सुलझाने का अनुरोध भेजने के लिए, इस वैल्यू की ज़रूरत होगी.
  5. स्थानीय वर्शन पाने के लिए, SnapshotsClient.SnapshotConflict.getConflictingSnapshot() को कॉल करें.
  6. सर्वर का वर्शन पाने के लिए, SnapshotsClient.SnapshotConflict.getSnapshot() को कॉल करें.
  7. सेव किए गए गेम से जुड़ी समस्या को हल करने के लिए, वह वर्शन चुनें जिसे आपको सर्वर पर आखिरी वर्शन के तौर पर सेव करना है. इसके बाद, उसे SnapshotsClient.resolveConflict() तरीके पर पास करें.

यहां दिए गए स्निपेट में एक उदाहरण दिया गया है. इसमें बताया गया है कि आपका गेम, सेव किए गए गेम के बीच होने वाले संघर्ष को कैसे मैनेज कर सकता है. इसके लिए, वह सेव किए गए ऐसे गेम को चुनता है जिसमें हाल ही में बदलाव किया गया हो और उसे सेव करने के लिए फ़ाइनल वर्शन के तौर पर चुनता है:

private static final int MAX_SNAPSHOT_RESOLVE_RETRIES = 10;

Task<Snapshot> processSnapshotOpenResult(SnapshotsClient.DataOrConflict<Snapshot> result,
                                         final int retryCount) {

  if (!result.isConflict()) {
    // There was no conflict, so return the result of the source.
    TaskCompletionSource<Snapshot> source = new TaskCompletionSource<>();
    source.setResult(result.getData());
    return source.getTask();
  }

  // There was a conflict.  Try resolving it by selecting the newest of the conflicting snapshots.
  // This is the same as using RESOLUTION_POLICY_MOST_RECENTLY_MODIFIED as a conflict resolution
  // policy, but we are implementing it as an example of a manual resolution.
  // One option is to present a UI to the user to choose which snapshot to resolve.
  SnapshotsClient.SnapshotConflict conflict = result.getConflict();

  Snapshot snapshot = conflict.getSnapshot();
  Snapshot conflictSnapshot = conflict.getConflictingSnapshot();

  // Resolve between conflicts by selecting the newest of the conflicting snapshots.
  Snapshot resolvedSnapshot = snapshot;

  if (snapshot.getMetadata().getLastModifiedTimestamp() <
      conflictSnapshot.getMetadata().getLastModifiedTimestamp()) {
    resolvedSnapshot = conflictSnapshot;
  }

  return Games.getSnapshotsClient(theActivity, GoogleSignIn.getLastSignedInAccount(this))
      .resolveConflict(conflict.getConflictId(), resolvedSnapshot)
      .continueWithTask(
          new Continuation<
              SnapshotsClient.DataOrConflict<Snapshot>,
              Task<Snapshot>>() {
            @Override
            public Task<Snapshot> then(
                @NonNull Task<SnapshotsClient.DataOrConflict<Snapshot>> task)
                throws Exception {
              // Resolving the conflict may cause another conflict,
              // so recurse and try another resolution.
              if (retryCount < MAX_SNAPSHOT_RESOLVE_RETRIES) {
                return processSnapshotOpenResult(task.getResult(), retryCount + 1);
              } else {
                throw new Exception("Could not resolve snapshot conflicts");
              }
            }
          });
}

गेम में सेव किए गए डेटा में बदलाव करना, ताकि गेम में कोई समस्या न आए

अगर आपको सेव किए गए कई गेम का डेटा मर्ज करना है या किसी मौजूदा Snapshot में बदलाव करके, उसे सर्वर पर सेव करना है, तो यह तरीका अपनाएं:

  1. SnapshotsClient.open() पर कॉल करें .
  2. नया SnapshotContents ऑब्जेक्ट पाने के लिए, SnapshotsClient.SnapshotConflict.getResolutionSnapshotsContent() को कॉल करें.
  3. SnapshotsClient.SnapshotConflict.getConflictingSnapshot() और SnapshotsClient.SnapshotConflict.getSnapshot() के डेटा को, पिछले चरण के SnapshotContents ऑब्जेक्ट में मर्ज करें.
  4. अगर मेटाडेटा फ़ील्ड में कोई बदलाव होता है, तो SnapshotMetadataChange इंस्टेंस बनाएं. हालांकि, ऐसा करना ज़रूरी नहीं है.
  5. SnapshotsClient.resolveConflict() पर कॉल करें. अपने मेथड कॉल में, पहले आर्ग्युमेंट के तौर पर SnapshotsClient.SnapshotConflict.getConflictId() और दूसरे और तीसरे आर्ग्युमेंट के तौर पर, उन SnapshotMetadataChange और SnapshotContents ऑब्जेक्ट को पास करें जिनमें आपने पहले बदलाव किया था.
  6. अगर SnapshotsClient.resolveConflict() कॉल पूरा हो जाता है, तो एपीआई Snapshot ऑब्जेक्ट को सर्वर पर सेव करता है और आपके स्थानीय डिवाइस पर स्नैपशॉट ऑब्जेक्ट को खोलने की कोशिश करता है.
    • अगर कोई विरोध है, तो SnapshotsClient.DataOrConflict.isConflict() true दिखाता है. इस मामले में, आपका गेम दूसरे चरण पर वापस आ जाएगा. साथ ही, जब तक विरोधों को हल नहीं किया जाता, तब तक स्नैपशॉट में बदलाव करने के लिए, चरणों को दोहराएं.
    • अगर कोई विरोध नहीं है, तो SnapshotsClient.DataOrConflict.isConflict() false दिखाता है और Snapshot ऑब्जेक्ट को आपके गेम में बदलाव करने के लिए खोला जाता है.