Mengintegrasikan PGS Recall API di game Anda

Halaman ini menjelaskan cara menerapkan Recall API dalam game Anda. Pertama-tama membahas menyiapkan server game dan klien untuk mendukung API, lalu melakukan cara menyimpan dan mengambil token.

Penyiapan server game

Siapkan server game untuk melakukan panggilan Recall API ke server Google.

Menyiapkan project Layanan game Play

(Jika belum selesai) Ikuti petunjuk di Menyiapkan Layanan game Google Play.

Catatan: Token recall dan persona tersedia berdasarkan per project PGS. Artinya, token dan persona akan disimpan per project PGS, dan untuk project PGS terpisah, terdapat kumpulan link terpisah antara profil PGS dan persona. Sebaiknya tinjau dokumentasi ini saat menentukan cara menyiapkan project PGS.

Menyiapkan akun layanan untuk game

Ikuti petunjuk tentang cara membuat akun layanan. Pada akhirnya, Anda akan memiliki file JSON dengan kredensial akun layanan.

Catatan: Recall API adalah server murni untuk server API. Oleh karena itu, Recall API menggunakan akun layanan untuk mengautentikasi server game, bukan 3-legged OAuth biasa yang digunakan oleh Game API lain untuk mengautentikasi server game dan pengguna akhir.

Mendownload library Java sisi server untuk Layanan game Play

Download library google-api-services-games terbaru, lalu upload ke server Anda.

Menyiapkan kredensial untuk panggilan Recall API

Lihat Menyiapkan panggilan API yang didelegasikan untuk konteks selengkapnya.

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.services.games.Games;
import com.google.api.services.games.GamesScopes;

// ...

GoogleCredential credential =
  GoogleCredential.fromStream(new FileInputStream("<credentials>.json"))
    .createScoped(Collections.singleton(GamesScopes.ANDROIDPUBLISHER));

Games gamesApi =
    new Games.Builder(httpTransport, JSON_FACTORY, credential).build();

Penyiapan klien game

Siapkan klien game Anda untuk mengambil ID sesi recall yang digunakan oleh server untuk berkomunikasi dengan server Google.

Java SDK

Menyiapkan Java SDK di dalam klien Anda, dan pastikan untuk menyertakan com.google.android.gms:play-services-games-v2:19.0.0 dan com.google.android.gms:play-services-tasks:18.0.2 atau yang lebih tinggi di Gradle .

Untuk berkomunikasi dengan server Google menggunakan informasi yang benar, mintalah Ingat ID sesi dari SDK klien yang Anda kirim ke server game:

Kotlin

PlayGames.getRecallClient(getActivity())
  .requestRecallAccess()
  .addOnSuccessListener { recallAccess -> val recallSessionId: String = recallAccess.getSessionId() }
  // Send the recallSessionId to your game server

Java

PlayGames.getRecallClient(getActivity())
  .requestRecallAccess()
  .addOnSuccessListener(
    recallAccess -> {
      String recallSessionId = recallAccess.getSessionId();
      // Send the recallSessionId to your game server
  });

Menggunakan Recall API di dalam server game

Setelah mengonfigurasi server dan klien, Anda dapat mengirim recallSessionID dari klien game ke server game, lalu ikuti panduan di bawah ini untuk mulai menggunakan Java API guna menyimpan, mengambil, atau menghapus sisi server token Recall.

Menyimpan token

Simpan persona dan token game pengguna menggunakan objek LinkPersonaRequest. Gunakan GoogleCredential untuk menghubungi Google Google Cloud API. Untuk mengikuti kardinalitas 1:1 batasan data, Anda juga dapat hanya menautkan satu persona ke satu profil PGS pada satu waktu, dan sebaliknya. Tetapkan kebijakan resolusi jika profil PGS ini sudah ditautkan dengan persona lain.

Secara opsional, Anda dapat menyetel TTL pada token, yang mendeklarasikan seberapa lama token berlaku menggunakan objek Durations. Anda dapat memilih untuk menyetelnya menggunakan SetTtl() (seperti yang ditunjukkan di bawah), yang menyetel tanggal kedaluwarsa dari jumlah waktu yang ditentukan dalam metode, atau setExpireTime(), yang memungkinkan Anda menetapkan waktu habis masa berlaku token.

Anda harus mengenkripsi persona dan token game, dan keduanya tidak boleh berisi informasi identitas pribadi. Panjang string persona dan token maksimal adalah 256 karakter, dan penyimpanan token atau persona per pemain per game dibatasi sebanyak 20.

Hanya satu token yang dapat disimpan per persona per pemain pada waktu tertentu. Jika Anda mencoba menyimpan token lain dengan persona yang sama, sistem akan menimpa token asli.

Catatan: Kunci enkripsi yang digunakan untuk mengenkripsi token harus unik untuk setiap aplikasi. Jika game ditransfer ke developer lain, kunci enkripsi harus diteruskan ke pemilik baru. Token recall tidak dapat didekripsi tanpa kunci enkripsi asli.

import com.google.api.services.games.Games.Recall.LinkPersona;
import com.google.protobuf.util.Durations;

// ...

Games gamesApi =
    new Games.Builder(httpTransport, JSON_FACTORY, credential).build();

String recallSessionId = ... // recallSessionID from game client
String persona = ... // encrypted opaque string, stable for in-game account
String token = ... // encrypted opaque string encoding the progress line

LinkPersonaRequest linkPersonaRequest =
  LinkPersonaRequest.newBuilder()
    .setSessionId(recallSessionId)
    .setPersona(persona)
    .setToken(token)
    .setCardinalityConstraint(ONE_PERSONA_TO_ONE_PLAYER)
    .setConflictingLinksResolutionPolicy(CREATE_NEW_LINK)
    .setTtl(Durations.fromDays(7)) // Optionally set TTL for token
    .build();

LinkPersonaResponse linkPersonaResponse =
  gamesApi.recall().linkPersona(linkPersonaRequest).execute();

if (linkPersonaResponse.getState() == LINK_CREATED) {
  // success
}

Mengambil token

Untuk mengambil token recall, dapatkan recallSessionId dari klien, dan teruskan ke retrieveTokens API:

import com.google.api.services.games.Games.Recall.RetrieveTokens;

// ...

String recallSessionId = ... // recallSessionID from game client

RetrievePlayerTokensResponse retrievePlayerTokensResponse =
  gamesApi.recall().retrieveTokens(recallSessionId).execute();

for (RecallToken recallToken : retrievePlayerTokensResponse.getTokens()) {
  String token recallToken.getToken();
  // Same string as was written in LinkPersona call
  // decrypt and recover in-game account
}

Catatan: String yang mewakili persona tidak ditampilkan kembali melalui API saat meminta token recall.

Menghapus token recall

Jika diperlukan, Anda juga dapat menghapus token recall dengan panggilan berikut:

import com.google.api.services.games.Games.Recall.UnlinkPersona;

// ...

String recallSessionId = ...
String persona = ...
String token = ...

Games gamesApi =
    new Games.Builder(httpTransport, JSON_FACTORY, credential).build();

UnlinkPersonaRequest unlinkPersonaRequest =
  UnlinkPersonaRequest.newBuilder()
    .setSessionId(recallSessionId)
    .setPersona(persona)
    // .setToken(token) - alternatively set token, but not both
    .build();

UnlinkPersonaResponse unlinkPersonaResponse =
  gamesApi.recall().unlinkPersona(unlinkPersonaRequest).execute();

// Confirm that the unlinking process completed successfully.
boolean unlinked = unlinkPersonaResponse.isUnlinked();

Aktifkan mode tanpa profil

Anda dapat mengaktifkan fungsi Recall API terbatas untuk pengguna yang tidak memiliki profil PGS dengan mengikuti langkah-langkah berikut:

1. Aktifkan recall tanpa profil untuk project game PGS Anda di Konsol Developer Play.
2. Tinjau istilah tambahan yang dijelaskan nanti di bagian ini.
3. Tambahkan tag metadata berikut ke manifes aplikasi Anda:

<meta-data
  android:name="com.google.android.gms.games.PROFILELESS_RECALL_ENABLED"
  android:value="true" />

Persyaratan tambahan

Selain tunduk pada Persyaratan Layanan Layanan game Play, Anda setuju bahwa jika menggunakan Recall API untuk pengguna tanpa profil PGS, yang memungkinkan berbagi data pengguna akhir dengan Google tanpa mereka memiliki profil Layanan game Play, Anda harus, sebelum membagikan data tersebut dengan Google, memberikan pemberitahuan yang sesuai kepada pengguna akhir yang menjelaskan 1) pembagian data Anda dengan Google untuk mengaktifkan fitur penautan akun Play Game, 2) ketersediaan setelan untuk mengelola pembagian tersebut seperti melalui setelan Play Game, dan 3) pemrosesan data tersebut berdasarkan Kebijakan Privasi Google, dan mendapatkan izin pengguna akhir yang sesuai untuk pembagian tersebut yang memenuhi semua persyaratan hukum yang berlaku.