Intégrer l'API Recall des services de jeux Play (Play Games Services ou PGS) à votre jeu

Cette page explique comment implémenter l'API Recall dans votre jeu. Il couvre d'abord qui configure votre serveur et votre client de jeu pour qu'ils prennent en charge l'API, puis passe par comment stocker et récupérer des jetons.

Configuration du serveur de jeu

Configurez votre serveur de jeu pour effectuer des appels de l'API Recall auprès des serveurs Google.

Configurer votre projet lié aux services de jeux Play

(Si ce n'est pas déjà fait) Suivez les instructions de la section Configurer les services de jeux Google Play.

Remarque : Les jetons de rappel et les personas sont disponibles par projet PGS. Cela signifie que les jetons et les personas sont stockés par projet PGS et que pour des projets PGS distincts, il existe des collections distinctes de liens entre les profils et les personas PGS. Nous vous recommandons de consulter cette documentation pour déterminer comment définir pour configurer vos projets PGS.

Configurer un compte de service pour le jeu

Suivez les instructions pour créer un compte de service. À la fin, vous devriez obtenir un fichier JSON contenant les identifiants du compte de service.

Remarque : L'API Recall est une API de serveur à serveur pure. De ce fait, l'API Recall utilise des comptes de service pour authentifier le serveur de jeu, et non le protocole OAuth en trois étapes standard qui est utilisé par d'autres API Jeux pour authentifier à la fois les serveurs de jeu et les utilisateurs finaux.

Télécharger la bibliothèque Java côté serveur pour les services de jeux Play

Téléchargez la dernière version de google-api-services-games bibliothèque et l'importer sur votre serveur.

Préparer les identifiants pour les appels de l'API Recall

Pour en savoir plus, consultez la section Préparer un appel d'API délégué.

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

Configuration du client de jeu

Configurez votre client de jeu de sorte qu'il récupère les ID de session de rappel utilisés par votre serveur pour communiquer avec les serveurs Google.

SDK Java

Configurer le SDK Java dans votre client et veillez à inclure com.google.android.gms:play-services-games-v2:19.0.0 et com.google.android.gms:play-services-tasks:18.0.2 ou version ultérieure dans Gradle .

Pour communiquer avec les serveurs de Google avec les bonnes informations, demandez un Rappelez l'ID de session du SDK client, que vous envoyez au serveur de votre jeu:

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

Utiliser l'API Recall dans votre serveur de jeu

Après avoir configuré votre serveur et votre client, vous pouvez envoyer le recallSessionID de votre client de jeu à votre serveur de jeu, puis suivre les instructions ci-dessous pour commencer à utiliser l'API Java pour stocker, récupérer ou supprimer les jetons de rappel côté serveur.

Stocker des jetons

Stockez le persona et le jeton de jeu de l'utilisateur à l'aide de l'objet LinkPersonaRequest. Utilisez GoogleCredential pour appeler des API Google. Pour suivre la cardinalité de 1:1 , vous pouvez n'associer qu'un seul persona à un profil PGS à la fois, et inversement. Définissez le paramètre règle de résolution au cas où ce profil PGS a déjà été associé à un autre persona.

Vous pouvez éventuellement choisir de définir une valeur de durée de vie pour le jeton, qui déclare sa durée de validité à l'aide d'un objet Durations. Vous pouvez choisir de définir cette valeur à l'aide de SetTtl() (comme indiqué ci-dessous), qui définit la date d'expiration de la période spécifiée dans la méthode ; ou setExpireTime(), qui vous permet de définir l'heure d'expiration exacte des jetons.

Vous devez chiffrer le persona et le jeton de jeu, et ils ne peuvent pas contenir d'informations permettant d'identifier personnellement l'utilisateur. Les chaînes de personas et de jetons peuvent comporter jusqu'à 256 caractères, et 20 jetons ou personas au maximum peuvent être stockés par joueur et par jeu.

Un seul jeton par persona et par joueur peut être stocké à la fois. Si vous essayez pour stocker un autre jeton avec le même persona, le système écrase le jeton d'origine à partir d'un jeton d'accès.

Remarque : La clé de chiffrement utilisée pour chiffrer les jetons doit être propre à chaque application. Si le jeu est transféré à un autre développeur, la clé de chiffrement doit lui être transmise également. Les jetons de rappel ne peuvent pas être déchiffrés sans la clé de chiffrement d'origine.

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
}

Récupérer des jetons

Pour récupérer le jeton de rappel, obtenez le recallSessionId auprès du client et transmettez-le à l'API retrieveTokens :

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
}

Remarque : Les chaînes représentant le persona ne sont pas renvoyées via l'API lorsque vous demandez des jetons de rappel.

Supprimer le jeton de rappel

Si nécessaire, vous pouvez également supprimer le jeton de rappel à l'aide de l'appel suivant :

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

Activer le mode sans profil

Pour activer une fonctionnalité limitée de l'API Recall pour les utilisateurs qui ne disposent pas de profils de services Play Jeux, procédez comme suit :

1. Activez le rappel sans profil pour votre projet de jeu PGS dans Play Developer la console Cloud.
2. Consultez les termes supplémentaires décrits plus loin dans cette section.
3. Ajoutez la balise de métadonnées suivante dans votre fichier manifeste d'application :

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

Conditions supplémentaires

En plus d'être soumis aux Conditions d'utilisation des services Play Jeux, vous acceptez que si vous utilisez l'API Recall pour les utilisateurs sans profil PGS, ce qui permet de partager les données de l'utilisateur final avec Google sans qu'il dispose d'un profil Play Jeux, vous devez, avant de partager ces données avec Google, fournir à l'utilisateur final un avis approprié décrivant : 1) votre partage des données avec Google pour activer la fonctionnalité de liaison de compte de Play Jeux, 2) la disponibilité de paramètres pour gérer ce partage, tels que ceux via les paramètres de Play Jeux, et 3) le traitement de ces données conformément aux Règles de confidentialité de Google, et obtenir le consentement approprié de l'utilisateur final pour ce partage, qui répond à toutes les exigences légales applicables.