ผสานรวม PGS Recall API ภายในเกม

หน้านี้จะอธิบายวิธีใช้ Recall API ในเกม โดยเริ่มจากการตั้งค่าเซิร์ฟเวอร์และไคลเอ็นต์เกมเพื่อรองรับ API จากนั้นจะอธิบายวิธีจัดเก็บและเรียกข้อมูลโทเค็น

การตั้งค่าเซิร์ฟเวอร์เกม

ตั้งค่าเซิร์ฟเวอร์เกมให้เรียกใช้ Recall API ไปยังเซิร์ฟเวอร์ของ Google

1. ตั้งค่าโปรเจ็กต์บริการเกมของ Play

(หากยังไม่ได้ดำเนินการ) ทำตามวิธีการในตั้งค่าบริการเกมของ Google Play

2. สร้างบัญชีบริการสำหรับเกม

ทำตามวิธีการสร้างบัญชีบริการ ในตอนท้าย คุณควรมีไฟล์ JSON ที่มีข้อมูลเข้าสู่ระบบของบัญชีบริการ

3. ดาวน์โหลดไลบรารี Java ฝั่งเซิร์ฟเวอร์สําหรับ PlayGamesServices

ดาวน์โหลด google-api-services-games library เวอร์ชันล่าสุดแล้วอัปโหลดไปยังเซิร์ฟเวอร์

4. เตรียมข้อมูลเข้าสู่ระบบสำหรับการเรียก API ของ Recall

ดูบริบทเพิ่มเติมได้ในการเตรียมการเรียก API ที่อนุญาต

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();

การตั้งค่าไคลเอ็นต์เกม

ตั้งค่าไคลเอ็นต์เกมให้ดึงรหัสเซสชันการเรียกคืนที่เซิร์ฟเวอร์ของคุณใช้เพื่อสื่อสารกับเซิร์ฟเวอร์ของ Google

Java SDK

ตั้งค่า Java SDK ภายในไคลเอ็นต์ และตรวจสอบว่าได้รวม com.google.android.gms:play-services-games-v2:19.0.0 และ com.google.android.gms:play-services-tasks:18.0.2 ขึ้นไปไว้ในไฟล์ gradle

หากต้องการสื่อสารกับเซิร์ฟเวอร์ของ Google ด้วยข้อมูลที่ถูกต้อง คุณต้องขอรหัสเซสชันการเรียกคืนจาก SDK ของไคลเอ็นต์ ซึ่งคุณส่งไปยังเซิร์ฟเวอร์ของเกม

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
    });

Unity SDK

ตั้งค่า Unity SDK ภายในไคลเอ็นต์ หากยังไม่ได้ดำเนินการ

หากต้องการสื่อสารกับเซิร์ฟเวอร์ของ Google ด้วยข้อมูลที่ถูกต้อง คุณต้องขอรหัสเซสชันการเรียกคืนจาก SDK ของไคลเอ็นต์ แล้วส่งไปยังเซิร์ฟเวอร์ของเกม

PlayGamesPlatform.Instance.RequestRecallAccess(
    recallAccess => {
        string recallSessionId = recallAccess.sessionId;
        // Send the recallSessionId to your game server
    });

ใช้ Recall API ภายในเซิร์ฟเวอร์เกม

หลังจากกำหนดค่าเซิร์ฟเวอร์และไคลเอ็นต์แล้ว คุณสามารถส่ง recallSessionID จากไคลเอ็นต์เกมไปยังเซิร์ฟเวอร์เกม แล้วทำตามคำแนะนำด้านล่างเพื่อเริ่มใช้ Java API ในการจัดเก็บ เรียกข้อมูล หรือลบโทเค็นการเรียกคืนฝั่งเซิร์ฟเวอร์

โทเค็นร้านค้า

คุณจัดเก็บข้อมูลบุคคลและโทเค็นเกมของผู้ใช้ได้โดยใช้ออบเจ็กต์ LinkPersonaRequest คุณต้องใช้ GoogleCredential เพื่อเรียกใช้ Google APIs (ดูบริบทได้จากการเรียกใช้ Google API) โปรดทราบว่าตามข้อจำกัด Cardinality 1:1 คุณจะลิงก์บุคคลิกได้ 1 รายการกับโปรไฟล์ PGS 1 รายการต่อครั้ง (และในทางกลับกัน) คุณควรตั้งค่านโยบายการแก้ปัญหาในกรณีที่โปรไฟล์ PGS นี้ลิงก์กับบุคคลิกอื่นอยู่แล้ว

คุณอาจเลือกกำหนด TTL ในโทเค็น ซึ่งจะประกาศระยะเวลาที่โทเค็นใช้งานได้โดยใช้ออบเจ็กต์ระยะเวลา (ไม่บังคับ) คุณอาจเลือกตั้งค่านี้โดยใช้ SetTtl() (ดังที่แสดงด้านล่าง) ซึ่งจะตั้งค่าวันที่หมดอายุจากระยะเวลาที่ระบุไว้ในเมธอด หรือ setExpireTime() ซึ่งช่วยให้คุณกำหนดเวลาที่แน่นอนเมื่อโทเค็นจะหมดอายุได้

คุณต้องเข้ารหัสข้อมูลผู้ใช้และโทเค็นเกม และข้อมูลดังกล่าวต้องไม่มีข้อมูลส่วนบุคคลที่ระบุตัวบุคคลนั้นได้ สตริงของบุคคลและโทเค็นมีความยาวได้สูงสุด 256 อักขระ และสามารถจัดเก็บโทเค็นหรือบุคคลได้สูงสุด 20 รายการต่อผู้เล่นต่อเกม

คุณจะจัดเก็บโทเค็นได้เพียง 1 รายการต่อบุคคลต่อผู้เล่นในช่วงเวลาหนึ่งๆ การพยายามจัดเก็บโทเค็นอื่นที่มีบุคคลเดียวกันจะเขียนทับโทเค็นเดิม

import com.google.api.services.games.Games.Recall.LinkPersona;
import com.google.api.services.games.model.LinkPersonaRequest;
import com.google.api.services.games.model.LinkPersonaResponse;
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
}

เรียกข้อมูลโทเค็น

การเรียกข้อมูลโทเค็นมี 3 ตัวเลือก โดยขึ้นอยู่กับความต้องการของเกม คุณสามารถขอสิ่งต่อไปนี้ได้

  • โทเค็นที่เชื่อมโยงกับเกมปัจจุบัน รวมถึงโทเค็นการเรียกคืนระดับเกม
  • โทเค็นล่าสุดที่จัดเก็บไว้ในเกมทั้งหมดที่บัญชีนักพัฒนาแอปเป็นเจ้าของ
  • รายการโทเค็นการเรียกคืนทั้งหมดที่เชื่อมโยงกับแต่ละเกมจากรายการเกมที่บัญชีนักพัฒนาแอปเป็นเจ้าของ

โทเค็นการเรียกคืนระดับเกม

หากต้องการเรียกข้อมูลโทเค็นการเรียกคืนจากเกมปัจจุบัน ให้รับ recallSessionId จากไคลเอ็นต์และส่งไปยัง retrieveTokens API ดังนี้

import com.google.api.services.games.Games;
import com.google.api.services.games.model.RetrievePlayerTokensResponse;
import com.google.api.services.games.model.RecallToken;

// ...

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
}

โทเค็นการเรียกคืนล่าสุดในเกมทั้งหมดที่บัญชีนักพัฒนาแอปเป็นเจ้าของ

หากต้องการเรียกข้อมูลโทเค็นล่าสุดที่จัดเก็บไว้ในเกมทั้งหมดที่บัญชีนักพัฒนาแอปเป็นเจ้าของใน Google Play Console คุณต้องรับ recallSessionId จากไคลเอ็นต์และส่งไปยัง lastTokenFromAllDeveloperGames API ดังที่แสดงในข้อมูลโค้ดต่อไปนี้ ในการตอบกลับ คุณสามารถตรวจสอบรหัสแอปพลิเคชันที่เชื่อมโยงกับโทเค็นนี้ได้

import com.google.api.services.games.Games;
import com.google.api.services.games.model.RetrieveDeveloperGamesLastPlayerTokenResponse;
import com.google.api.services.games.model.GamePlayerToken;
import com.google.api.services.games.model.RecallToken;

// ...

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

RetrieveDeveloperGamesLastPlayerTokenResponse response =
        gamesApi.recall().lastTokenFromAllDeveloperGames(recallSessionId)
        .execute();

if (response.hasGamePlayerToken()) {
    GamePlayerToken gamePlayerToken = response.getGamePlayerToken();

    // The ID of the application that the token is associated with.
    String applicationId = gamePlayerToken.getApplicationId();

    // Same string as was written in LinkPersona call.
    RecallToken recallToken = gamePlayerToken.getRecallToken();

    // Decrypt and recover in-game account.
}

โทเค็นการเรียกคืนทั้งหมดในรายการเกมที่บัญชีนักพัฒนาแอปเป็นเจ้าของ

หากต้องการเรียกข้อมูลโทเค็นทั้งหมดที่เชื่อมโยงกับรายการเกมที่เป็นของบัญชีนักพัฒนาแอปใน Google Play Console ให้รับ recallSessionId จากไคลเอ็นต์แล้วส่งไปยัง gamesPlayerTokens API ระบุรายการรหัสแอปพลิเคชัน

import com.google.api.services.games.Games;
import com.google.api.services.games.model.RetrieveGamesPlayerTokensResponse;
import com.google.api.services.games.model.GamePlayerToken;
import com.google.api.services.games.model.RecallToken;

// ...

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

// Application IDs for which you would like to retrieve the recall tokens.
List<String> applicationIds = ...

RetrieveGamesPlayerTokensResponse response =
gamesApiClient
        .recall()
        .gamesPlayerTokens(recallSessionId)
        .setApplicationIds(applicationIds)
        .execute();

for (GamePlayerToken gamePlayerToken : response.getGamePlayerTokens()) {
    // The ID of the application that the token is associated with.
    String applicationId  = gamePlayerToken.getApplicationId();


    // Same string as was written in LinkPersona call.
    RecallToken recallToken = gamePlayerToken.getRecallToken();

    // Decrypt and recover in-game account.
}

ลบโทเค็นการเรียกคืน

นอกจากนี้ คุณยังลบโทเค็นการเรียกคืนได้ด้วยการเรียกใช้ต่อไปนี้หากจำเป็น

import com.google.api.services.games.Games;
import com.google.api.services.games.model.UnlinkPersonaRequest;
import com.google.api.services.games.model.UnlinkPersonaResponse;

// ...

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();

boolean unlinked = unlinkPersonaResponse.isUnlinked();

เปิดใช้โหมดที่ไม่มีโปรไฟล์

คุณเปิดใช้ฟังก์ชันการทํางานของ Recall API แบบจํากัดสําหรับผู้ใช้ที่ไม่มีโปรไฟล์ PGS ได้โดยทําตามขั้นตอนต่อไปนี้

  1. เปิดใช้การเรียกคืนแบบไม่มีโปรไฟล์สำหรับโปรเจ็กต์เกม PGS ใน Play Developer Console เลือกตัวเลือก &quot;เปิดใช้พื้นที่เก็บข้อมูล&quot;
  2. โปรดอ่านข้อกำหนดเพิ่มเติมที่อธิบายไว้ในส่วนนี้
  3. เพิ่มแท็กข้อมูลเมตาต่อไปนี้ลงในไฟล์ Manifest ของแอป
<meta-data
  android:name="com.google.android.gms.games.PROFILELESS_RECALL_ENABLED"
  android:value="true" />

ข้อกำหนดเพิ่มเติม

นอกเหนือจากการปฏิบัติตามข้อกำหนดในการให้บริการของบริการเกมของ Play แล้ว คุณยอมรับว่าหากใช้ Recall API สำหรับผู้ใช้ที่ไม่มีโปรไฟล์ PGS ซึ่งจะเปิดใช้การแชร์ข้อมูลของผู้ใช้ปลายทางกับ Google โดยที่ผู้ใช้ปลายทางไม่มีโปรไฟล์บริการเกมของ Play คุณจะต้องแจ้งผู้ใช้ปลายทางให้ทราบก่อนแชร์ข้อมูลดังกล่าวกับ Google โดยให้รายละเอียดต่อไปนี้

  1. การแชร์ข้อมูลกับ Google เพื่อเปิดใช้ฟีเจอร์การลิงก์บัญชี Play Games
  2. ความพร้อมใช้งานของการตั้งค่าเพื่อจัดการการแชร์ดังกล่าว เช่น การตั้งค่าผ่าน Play Games
  3. การประมวลผลข้อมูลดังกล่าวภายใต้นโยบายความเป็นส่วนตัวของ Google และได้รับความยินยอมที่เหมาะสมจากผู้ใช้ปลายทางสำหรับการแชร์ดังกล่าวซึ่งเป็นไปตามข้อกำหนดทางกฎหมายที่เกี่ยวข้องทั้งหมด