Auf dieser Seite wird erläutert, wie Sie die Recall API in Ihr Spiel implementieren. Zuerst wird beschrieben, wie Sie Ihren Gameserver und Client für die Unterstützung der API einrichten. Anschließend wird erläutert, wie Sie Tokens speichern und abrufen.
Gameserver-Einrichtung
Richten Sie Ihren Spielserver so ein, dass er Recall API-Aufrufe an Google-Server sendet.
1. Play-Spieldienste-Projekt einrichten
Falls noch nicht geschehen, folgen Sie der Anleitung unter Google Play-Spieldienste einrichten.
2. Dienstkonto für das Spiel einrichten
Folgen Sie der Anleitung zum Erstellen eines Dienstkontos. Am Ende sollten Sie eine JSON-Datei mit den Anmeldedaten für das Dienstkonto haben.
3. Serverseitige Java-Bibliothek für Play-Spieldienste herunterladen
Laden Sie die aktuelle google-api-services-games-Bibliothek herunter und laden Sie sie auf Ihren Server hoch.
4. Anmeldedaten für Recall API-Aufrufe vorbereiten
Weitere Informationen finden Sie unter Autorisierten API-Aufruf vorbereiten.
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();
Spieleclient einrichten
Richten Sie Ihren Spieleclient so ein, dass er die Recall-Sitzungs-IDs abruft, die von Ihrem Server für die Kommunikation mit Google-Servern verwendet werden.
Java SDK
Richten Sie das Java-SDK in Ihrem Client ein und fügen Sie com.google.android.gms:play-services-games-v2:19.0.0
und com.google.android.gms:play-services-tasks:18.0.2
oder höher in Ihre Gradle-Datei ein.
Damit Sie mit den Servern von Google mit den richtigen Informationen kommunizieren können, müssen Sie eine Recall-Sitzungs-ID vom Client-SDK anfordern, die Sie an den Server Ihres Spiels senden.
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
Falls noch nicht geschehen, richten Sie das Unity SDK in Ihrem Client ein.
Damit Sie mit den Servern von Google mit den richtigen Informationen kommunizieren können, müssen Sie eine Recall-Sitzungs-ID vom Client-SDK anfordern und an den Server Ihres Spiels senden.
PlayGamesPlatform.Instance.RequestRecallAccess(
recallAccess => {
string recallSessionId = recallAccess.sessionId;
// Send the recallSessionId to your game server
});
Recall API auf Ihrem Spielserver verwenden
Nachdem Sie Ihren Server und Client konfiguriert haben, können Sie das recallSessionID
von Ihrem Spieleclient an Ihren Gameserver senden und der Anleitung unten folgen, um die Java API zum serverseitigen Speichern, Abrufen oder Löschen der Recall-Tokens zu verwenden.
Tokens speichern
Die Persona und das Spieltoken von Nutzern können mit dem LinkPersonaRequest
-Objekt gespeichert werden. Sie müssen GoogleCredential
verwenden, um Google APIs aufzurufen (siehe Google APIs aufrufen). Gemäß der 1:1-Kardinalitätsbeschränkung können Sie jeweils nur eine Identität mit einem Play-Spieldienste-Profil verknüpfen und umgekehrt. Sie sollten die Richtlinie zur Konfliktlösung festlegen, falls dieses Play-Spieldienste-Profil bereits mit einer anderen Identität verknüpft wurde.
Optional können Sie eine TTL für das Token festlegen, die angibt, wie lange das Token gültig ist. Verwenden Sie dazu ein Durations-Objekt. Sie können das Ablaufdatum entweder mit SetTtl()
(siehe unten) festlegen, wobei das Ablaufdatum anhand des in der Methode angegebenen Zeitraums festgelegt wird, oder mit setExpireTime()
, wobei Sie einen genauen Zeitpunkt für das Ablaufen der Tokens festlegen können.
Sie müssen das Persona- und das Spiel-Token verschlüsseln. Sie dürfen keine personenidentifizierbaren Informationen enthalten. Persona- und Token-Strings dürfen maximal 256 Zeichen lang sein. Pro Spieler und Spiel können maximal 20 Tokens oder Personas gespeichert werden.
Pro Persona und Spieler kann jeweils nur ein Token gespeichert werden. Wenn Sie versuchen, ein weiteres Token mit derselben Persona zu speichern, wird das ursprüngliche Token überschrieben.
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
}
Tokens abrufen
Je nach den Anforderungen Ihres Spiels gibt es drei Möglichkeiten, ein Token abzurufen. Sie können Folgendes anfordern:
- Die mit dem aktuellen Spiel verknüpften Tokens, einschließlich spielbezogener Recall-Tokens.
- Das letzte Token, das in allen Spielen gespeichert wurde, die zum Entwicklerkonto gehören.
- Eine Liste der Spiele, die dem Entwicklerkonto gehören, sowie alle Rückruf-Tokens, die mit den einzelnen Spielen verknüpft sind.
Spielbezogene Rückruftokens
Um die Erinnerungstokens aus dem aktuellen Spiel abzurufen, holen Sie sich die recallSessionId
vom Client und übergeben Sie sie an die 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
}
Letztes Rückruf-Token für alle Spiele, die dem Entwicklerkonto gehören
Wenn Sie das letzte Token abrufen möchten, das in allen Spielen gespeichert ist, die dem Entwicklerkonto in der Google Play Console gehören, müssen Sie die recallSessionId
vom Client abrufen und an die lastTokenFromAllDeveloperGames
API übergeben, wie im folgenden Code-Snippet gezeigt. Als Teil der Antwort können Sie die Anwendungs-ID prüfen, die diesem Token zugeordnet ist.
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.
}
Alle Rückruftokens für eine bestimmte Liste von Spielen, die dem Entwicklerkonto gehören
Wenn Sie alle Tokens abrufen möchten, die mit einer Liste von Spielen verknüpft sind, die Ihrem Entwicklerkonto in der Google Play Console gehören, rufen Sie die recallSessionId
vom Client ab und übergeben Sie sie an die gamesPlayerTokens
API. Geben Sie eine Liste mit Anwendungs-IDs an.
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.
}
Recall-Token löschen
Bei Bedarf können Sie das Erinnerungstoken auch mit dem folgenden Aufruf löschen:
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();
Profilfreien Modus aktivieren
So können Sie die eingeschränkte Recall API-Funktionalität für Nutzer ohne Play-Spieldienste-Profil aktivieren:
- Aktivieren Sie in der Play Console für Ihr Play-Spieldienste-Spielprojekt den profilfreien Rückruf.
- Lesen Sie die zusätzlichen Bedingungen, die weiter unten in diesem Abschnitt beschrieben werden.
- Fügen Sie Ihrem App-Manifest das folgende Metadaten-Tag hinzu:
<meta-data
android:name="com.google.android.gms.games.PROFILELESS_RECALL_ENABLED"
android:value="true" />
Zusätzliche Bedingungen
Zusätzlich zu den Nutzungsbedingungen für Play-Spieldienste stimmen Sie zu, dass Sie, wenn Sie die Recall API für Nutzer ohne PGS-Profil verwenden, wodurch die Daten des Endnutzers an Google weitergegeben werden können, ohne dass dieser ein Play-Spieldienste-Profil hat, den Endnutzer vor der Weitergabe solcher Daten an Google entsprechend benachrichtigen müssen. Die Benachrichtigung muss Folgendes enthalten:
- Ihre Freigabe der Daten für Google, um die Kontoverknüpfung für Play Spiele zu ermöglichen.
- Die Verfügbarkeit von Einstellungen zur Verwaltung dieser Freigabe, z. B. über die Play Spiele-Einstellungen.
- Die Verarbeitung solcher Daten unterliegt der Datenschutzerklärung von Google. Sie müssen eine entsprechende Einwilligung der Endnutzer für die Weitergabe einholen, die allen anwendbaren rechtlichen Anforderungen entspricht.