Google Play ゲームサービスに対するサーバーサイドのアクセス

プレーヤーを認証し、プレーヤーの ID をバックエンド サーバーに安全に渡すことをおすすめします。そうすることでゲームは、プレーヤーの ID やその他のデータを安全に取得できます。デバイスを通過する間に改ざんの危険にさらされることはありません。

このシナリオでは、プレーヤーが正常にログインしたら、Play ゲームサービス v2 SDK から特別な 1 回限りのコード(サーバー認証コードといいます)をリクエストし、それをクライアントがサーバーに渡します。次に、サーバー認証コードを、サーバーで Google Play ゲームサービス API を呼び出すために使用できる OAuth 2.0 トークンに交換します。

ゲームにログインを追加するためのガイダンスについては、Android ゲームのログインをご覧ください。

オフライン アクセスに必要な手順は次のとおりです。

  1. Google Play Console で: ゲームサーバーの認証情報を作成します。認証情報の OAuth クライアント タイプは「web」です。
  2. Android アプリで: ログインの一環として、サーバーの認証情報についてサーバー認証コードをリクエストし、サーバーに渡します。
  3. ゲームサーバーで: Google 認証サービスを使用してサーバー認証コードを OAuth アクセス トークンに交換し、これを使用して Play ゲームサービスの REST API を呼び出します。

始める前に

まず、Google Play ゲームサービスをセットアップするで説明しているように、Google Play Console にゲームを追加し、Play ゲームサービスのログインをゲームに統合する必要があります。

サーバーサイド ウェブアプリを作成する

Google Play ゲームサービスは、ウェブゲームのバックエンド サポートを提供しません。ただし、Android ゲームのサーバーのバックエンド サポートは提供します。

Google Play ゲームサービスの REST API をサーバーサイド アプリで使用する場合は、次の手順を行います。

  1. Google Play Console のゲームから、[Play ゲームサービス] > [設定と管理] > [設定] に移動します。
  2. [認証情報を追加] を選択して [認証情報を追加] ページを表示します。認証情報タイプとして [ゲームサーバー] を選択し、[認証] セクションに進みます。
    1. すでにゲームサーバーに OAuth クライアント ID がある場合は、プルダウン メニューから選択します。変更を保存したら、次のセクションに進みます。
    2. ゲームサーバーに既存の OAuth クライアント ID がない場合は、作成します。
      1. [OAuth クライアントを作成] をクリックし、[OAuth クライアント ID の作成] のリンクを開きます。
      2. ゲームに関連付けられた Cloud Platform プロジェクトの Google Cloud Platform の [OAuth クライアント ID の作成] ページが表示されます。
      3. ページのフォームに記入して、[作成] をクリックします。[アプリケーションの種類] は [ウェブアプリ] に設定してください。
      4. [認証情報を追加] ページの [認証] セクションに戻り、新しく作成した OAuth クライアントを選択し、変更を保存します。

サーバー認証コードを取得する

ゲームがバックエンド サーバーのアクセス トークンに使用できるサーバー認証コードを取得するには:

  1. クライアントから requestServerSideAccess を呼び出します。

    1. Android アプリの OAuth クライアント ID ではなく、ゲームサーバーに登録されている OAuth クライアント ID を使用していることを確認してください。
    2. (省略可)ゲームサーバーで、Play ゲームサービスへのオフライン アクセス(更新トークンを使用した長期間有効なアクセス)が必要な場合は、forceRefreshToken パラメータを true に設定します。
    GamesSignInClient gamesSignInClient = PlayGames.getGamesSignInClient(this);
    gamesSignInClient
      .requestServerSideAccess(OAUTH_2_WEB_CLIENT_ID, /* forceRefreshToken= */ false)
      .addOnCompleteListener( task -> {
        if (task.isSuccessful()) {
          String serverAuthToken = task.getResult();
          // Send authentication code to the backend game server to be
          // exchanged for an access token and used to verify the player
          // via the Play Games Services REST APIs.
        } else {
          // Failed to retrieve authentication code.
        }
    });
    
  2. OAuth 認証コードトークンをバックエンド サーバーに送信して交換されるようにし、プレーヤー ID が Play ゲームサービスの REST API に対して検証され、ゲームに対して認証されるようにします。

サーバー認証コードを送信する

サーバー認証コードをバックエンド サーバーに送信し、アクセス トークン、更新トークンと交換します。アクセス トークンを使用して、プレーヤーに代わって Play ゲームサービス API を呼び出します。必要に応じて、更新トークンを保存し、アクセス トークンが期限切れになったときに新しいアクセス トークンを取得します。

次のコード スニペットは、サーバーサイド コードを Java プログラミング言語で実装し、サーバー認証コードをアクセス トークンと交換する方法を示しています。clientserverskeleton サンプルアプリを使用しています。

/**
 * Exchanges the authcode for an access token credential.  The credential
 * is the associated with the given player.
 *
 * @param authCode - the non-null authcode passed from the client.
 * @param player   - the player object which the given authcode is
 *                 associated with.
 * @return the HTTP response code indicating the outcome of the exchange.
 */
private int exchangeAuthCode(String authCode, Player player) {
try {

    // The client_secret.json file is downloaded from the Google API
    // console.  This is used to identify your web application.  The
    // contents of this file should not be shared.
    //
    File secretFile = new File("client_secret.json");

    // If we don't have the file, we can't access any APIs, so return
    // an error.
    if (!secretFile.exists()) {
        log("Secret file : " + secretFile
                .getAbsolutePath() + "  does not exist!");
        return HttpServletResponse.SC_FORBIDDEN;
    }

    GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(
            JacksonFactory.getDefaultInstance(), new
            FileReader(secretFile));

    // Extract the application id of the game from the client id.
    String applicationId = extractApplicationId(clientSecrets
            .getDetails().getClientId());

    GoogleTokenResponse tokenResponse =
            new GoogleAuthorizationCodeTokenRequest(
            HTTPTransport,
            JacksonFactory.getDefaultInstance(),
            "https://oauth2.googleapis.com/token",
            clientSecrets.getDetails().getClientId(),
            clientSecrets.getDetails().getClientSecret(),
            authCode,
            "")
            .execute();

    log("hasRefresh == " + (tokenResponse.getRefreshToken() != null));
    log("Exchanging authCode: " + authCode + " for token");
    Credential credential = new Credential
            .Builder(BearerToken.authorizationHeaderAccessMethod())
            .setJsonFactory(JacksonFactory.getDefaultInstance())
            .setTransport(HTTPTransport)
            .setTokenServerEncodedUrl("https://www.googleapis.com/oauth2/v4/token")
            .setClientAuthentication(new HttpExecuteInterceptor() {
                @Override
                public void intercept(HttpRequest request)
                        throws IOException {
                        }
            })
            .build()
            .setFromTokenResponse(tokenResponse);

    player.setCredential(credential);

    // Now that we have a credential, we can access the Games API.
    PlayGamesAPI api = new PlayGamesAPI(player, applicationId,
            HTTPTransport, JacksonFactory.getDefaultInstance());

    // Call the verify method, which checks that the access token has
    // access to the Games API, and that the player id used by the
    // client matches the playerId associated with the accessToken.
    boolean ok = api.verifyPlayer();

    // Call a Games API on the server.
    if (ok) {
        ok = api.updatePlayerInfo();
        if (ok) {
            // persist the player.
            savePlayer(api.getPlayer());
        }
    }

    return ok ? HttpServletResponse.SC_OK :
            HttpServletResponse.SC_INTERNAL_SERVER_ERROR;

  } catch (IOException e) {
    e.printStackTrace();
  }
  return HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
}

サーバーから REST API を呼び出す

利用可能な API 呼び出しの詳細については、Google Play ゲームサービスの REST API のページをご覧ください。

REST API 呼び出しのうち、有用だと思われるものの例を次に示します。

プレーヤー

ログインしているプレーヤーの ID とプロフィール データを取得する場合は、ID として 'me' を指定して [Players.get][] を呼び出します。

友だち

詳しくは、友だちのガイドをご覧ください。

  • プレーヤーの友だちリストを取得するには、friends_allcollection として Players.list を呼び出します。

  • 友だちリストにアクセスできるかどうかを確認するには、meplayerID として Players.get を呼び出し、レスポンスの profileSettings.friendsListVisibility フィールドを調べます。

実績

詳しくは、実績のガイドをご覧ください。

  • 現在の実績のリストを取得するには、AchievementDefinitions.list を呼び出します。

  • これを Achievements.list の呼び出しと組み合わせると、プレーヤーがどれをロック解除したのかがわかります。

  • Achievements.unlock を呼び出してプレーヤーの実績をロック解除します。

  • Achievements.increment を呼び出して実績の進捗状況をレポートし、プレーヤーがロック解除したかどうかを確認します。

  • 製品版になっていないゲームをデバッグする場合は、Management API から Achievements.reset または Achievements.resetAll を呼び出すことで、実績を元の状態にリセットできます。

リーダーボード

詳しくは、リーダーボードのガイドをご覧ください。

  • ゲームの全スコアボードのリストを取得する場合は、Leaderboards.list を呼び出します。

  • プレーヤーがゲームを終了したら、スコアを Scores.submit に送信して、新しいハイスコアかどうかを確認できます。

  • リーダーボードを表示するには、Scores.list からデータを取得してユーザーに表示します。

  • ユーザーのハイスコアに近いさまざまなスコアを検索するには、Scores.listWindow を使用します。

  • 特定のリーダーボードでのプレーヤーのスコアに関する詳細情報(たとえば、あるプレーヤーが全プレーヤーの上位 12% に入っているかどうか)を取得するには、Scores.get を呼び出します。

  • ゲームをデバッグする場合は、Management API から Scores.reset を呼び出すことで、特定のリーダーボードからそのプレーヤーのすべてのスコアをリセットできます。