Интегрируйте API отзыва PGS в свою игру.

На этой странице объясняется, как реализовать Recall API в вашей игре. Сначала рассматривается настройка игрового сервера и клиента для поддержки API, а затем — хранение и извлечение токенов.

Настройка игрового сервера

Настройте свой игровой сервер для выполнения вызовов Recall API к серверам Google.

1. Настройте свой проект Play Games Services

(Если это еще не сделано) Следуйте инструкциям в разделе Настройка игровых сервисов Google Play .

2. Создайте учетную запись для игры.

Следуйте инструкциям по созданию учётной записи сервиса . В результате вы получите JSON-файл с учётными данными учётной записи сервиса.

3. Загрузите серверную библиотеку Java для PlayGamesServices.

Загрузите последнюю версию библиотеки google-api-services-games и загрузите ее на свой сервер.

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, предоставляя им корректную информацию, вам необходимо запросить идентификатор сеанса Recall у клиентского SDK, который вы отправите на сервер своей игры.

Котлин

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

Ява

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

Unity SDK

Если это еще не сделано, настройте Unity SDK в своем клиенте .

Чтобы обмениваться данными с серверами Google, предоставляя им корректную информацию, вам необходимо запросить идентификатор сеанса Recall у клиентского SDK и отправить его на сервер вашей игры.

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

Используйте Recall API на вашем игровом сервере

После настройки сервера и клиента вы можете отправить recallSessionID из вашего игрового клиента на ваш игровой сервер и следовать приведенным ниже инструкциям, чтобы начать использовать Java API для хранения, извлечения или удаления токенов Recall на стороне сервера.

Токены магазина

Персоны и игровые токены пользователей можно хранить с помощью объекта LinkPersonaRequest . Для вызова API Google необходимо использовать GoogleCredential (см. раздел Вызов API Google для получения подробной информации). Обратите внимание, что, согласно ограничению мощности 1:1 , одновременно можно связать только одну персону с одним профилем PGS (и наоборот). Необходимо настроить политику разрешения, если этот профиль PGS уже связан с другой персоной.

При желании вы можете установить для токена TTL, который определяет срок его действия, используя объект Durations . Вы можете задать это с помощью SetTtl() (как показано ниже), который устанавливает дату истечения срока действия из указанного в методе времени, или setExpireTime() , который позволяет задать точное время истечения срока действия токена.

Персона и игровой токен должны быть зашифрованы, и они не должны содержать персонально идентифицируемую информацию. Длина строк персон и токенов не должна превышать 256 символов, а для каждого игрока в каждой игре может храниться не более 20 токенов или персон.

Одновременно для каждого персонажа одного игрока может быть сохранен только один токен. Попытка сохранить другой токен с тем же персонажем перезапишет исходный токен.

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
}

Получить токены

Существует три способа получить токен, в зависимости от потребностей вашей игры. Вы можете запросить следующее:

  • Токены, связанные с текущей игрой, включая токены отзыва, относящиеся к игре.
  • Последний токен, сохраненный во всех играх, принадлежащих аккаунту разработчика.
  • Учитывая список игр, принадлежащих аккаунту разработчика, все токены отзыва, связанные с каждой игрой.

Жетоны отзыва в рамках игры

Чтобы извлечь токены отзыва из текущей игры, получите 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, необходимо получить от клиента параметр recallSessionId и передать его в API lastTokenFromAllDeveloperGames , как показано в следующем фрагменте кода. В ответе вы можете проверить идентификатор приложения , связанный с этим токеном.

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 от клиента и передайте его в API gamesPlayerTokens . Предоставьте список идентификаторов приложений .

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. Выберите опцию «Включить хранилище».
  2. Ознакомьтесь с дополнительными условиями, описанными далее в этом разделе.
  3. Добавьте следующий тег метаданных в манифест вашего приложения :
<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 Игр.
  2. Наличие настроек для управления таким обменом, например, через настройки Play Игр.
  3. Обработка таких данных осуществляется в соответствии с Политикой конфиденциальности Google , а также получение соответствующего согласия конечного пользователя на такой обмен, отвечающего всем применимым правовым требованиям.