Google Play Games サービスに対するサーバーサイドのアクセスを有効にする

ゲームでバックエンド サーバーを使用している場合は、Google ログインを使用してプレーヤーを認証し、プレーヤーの ID をバックエンド サーバーに安全に渡すことをおすすめします。また、これにより、ゲームはデバイスを通過する際に改ざんされることなく、プレーヤーの ID やその他のデータを安全に取得できます。

このシナリオでは、ゲームは通常どおり Google Play Games サービスにログインするようプレーヤーに促します。プレーヤーが正常にログインすると、GoogleSignInAccount オブジェクトに特別な 1 回限りのコード(サーバー認証コード)が含まれ、クライアントがサーバーに渡します。次に、サーバー認証コードを、サーバーで Google Play Games サービス API を呼び出すために使用できる OAuth 2.0 トークンに交換します。

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

Google ログインを使用してプレーヤーを認証する方法を示す詳細なコードサンプルについては、GitHub の clientserverskeleton サンプルをご覧ください。

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

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

始める前に

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

ゲームに関連付けられたサーバーサイド ウェブ アプリケーションを作成する

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

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

  1. Google Play Console の [リンク済みアプリ] セクションで、ゲームに関連付けられたウェブアプリを作成します。launch_url は、このフローでは使用されず、空白のままにできます。
  2. アプリの認証情報は、次の手順で取得できます。
    1. Google Play Console で、ゲームの [ゲームの詳細] をクリックします。
    2. [API Console プロジェクト] セクションまでスクロールし、API コンソール プロジェクトへのリンクをクリックします。
    3. Google API Console の [API とサービス] > [認証情報] 画面で、ウェブアプリの client_secret.json ファイルをダウンロードして、サーバーがアクセスできる場所に保存します。後で参照できるように、認証情報のクライアント ID を記録します。
  3. サーバーサイド アプリを再起動して、ゲームのクライアント アプリからのリクエストを受け入れる準備を整えます。

クライアントでログインを行う

GoogleSignInClient クラスは、現在ログインしているプレーヤーのアカウントを取得し、デバイス上のアプリでプレーヤーがログインしていない場合はログインするためのメイン エントリ ポイントです。

ログイン クライアントを作成する手順は次のとおりです。

  1. GoogleSignInOptions オブジェクトを使用してログイン クライアントを作成します。ログインを構成する GoogleSignInOptions.Builder で、GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN を指定する必要があります。
  2. また、サーバーのクライアント ID をパラメータとして GoogleSignInOptions.Builder.requestServerAuthCode() メソッドを呼び出して、ゲームにバックエンド サーバーの認証コードが必要であることを指定する必要があります。後でバックエンド サーバー上のアクセス トークンの認証コードを取得します。詳細については、サーバー認証コードを取得するをご覧ください。
  3. GoogleSignIn.getClient() メソッドを呼び出し、前もって構成したオプションを渡します。呼び出しが成功すると、Google Sign-In API は GoogleSignInClient のインスタンスを返します。
  4. GoogleSignInClient インスタンスを取得したら、サイレント ログインの実行で説明されているように、アクティビティの onResume() からプレーヤーをサイレント ログインに進める必要があります。

次の例をご覧ください。

private static final int RC_SIGN_IN = 9001;
private GoogleSignInClient mGoogleSignInClient;

private void startSignInForAuthCode() {

  // Client ID for your backend server.
  String webClientId = getString(R.string.webclient_id);

  GoogleSignInOptions signInOption = new
      GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN)
      .requestServerAuthCode(webClientId)
      .build();

  GoogleSignInClient signInClient = GoogleSignIn.getClient(this, signInOption);
  Intent intent = signInClient.getSignInIntent();
  startActivityForResult(intent, RC_SIGN_IN);
}

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

ゲームがバックエンド サーバーのアクセス トークンに使用できるサーバー認証コードを取得するには、プレーヤーのログインが成功したときに Google ログインから返される GoogleSignInAccount オブジェクトで getServerAuthCode() メソッドを呼び出します。

次の例をご覧ください。

// Auth code to send to backend server.
private String mServerAuthCode;

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
  super.onActivityResult(requestCode, resultCode, data);
  if (requestCode == RC_SIGN_IN) {
    GoogleSignInResult result = Auth.GoogleSignInApi.getSignInResultFromIntent(data);
    if (result.isSuccess()) {
      mServerAuthCode = result.getSignInAccount().getServerAuthCode();
    } else {
      String message = result.getStatus().getStatusMessage();
      if (message == null || message.isEmpty()) {
        message = getString(R.string.signin_other_error);
      }
      new AlertDialog.Builder(this).setMessage(message)
          .setNeutralButton(android.R.string.ok, null).show();
    }
  }
}

サーバー認証コードをサーバーのアクセス トークンと交換する

サーバー認証コードをバックエンド サーバーに送信して、アクセス トークンと更新トークンと交換します。アクセス トークンを使用して、プレーヤーの代わりに Google Play Games サービス 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;
}

ログインしたプレーヤーの代わりにバックエンド サーバーから Google API にアクセスする方法について詳しくは、サーバーサイド アクセスの有効化をご覧ください。

プレーヤーのログアウトを処理する

プレーヤーをゲームからログアウトするには、GoogleSignInClientsignOut() メソッドを呼び出します。コード スニペットの例については、プレーヤーのログアウトをご覧ください。

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

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

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

プレーヤー

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

フレンド機能

友だちの詳細については、友だちのガイドをご覧ください。

  • プレーヤーの友だちリストを取得しますか?'friends_all'collection として Players.list を呼び出します。
  • 友達リストにアクセスできるかどうかを確認します。me に対して 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 を呼び出して、特定のリーダーボードからそのプレーヤーのすべてのスコアをリセットします。