Server-side access to Google Play Games Services

We recommend that you use GamesSignInClient to authenticate players and securely pass the player's identity to the backend server. This enables your game to securely retrieve the player's identity and other data without being exposed to potential tampering while passing through the device.

Once the player authenticates successfully, you can request a special single-use code (called the server auth code) from the Play Games Services v2 SDK, which the client passes to the server. Then, on the server, exchange the server auth code for an OAuth 2.0 token that the server can use to make calls to the Google Play Games Services API.

For additional guidance on adding authentication in your games, see Platform authentication for Android Games.

The following steps are required for offline access:

1. In the Google Play Console: Create a credential for your game server. The OAuth client type of the credential will be "web".
2. In the Android app: As part of platform authentication, request a server auth code for your server's credential, and pass that to your server. The GamesSigninClient can request three OAuth 2.0 scopes when requesting server-side access to Play Games Services web APIs. The optional scopes are EMAIL, PROFILE, and OPEN_ID. The two default scopes are DRIVE_APPFOLDER and GAMES_LITE.
3. On your game server: Exchange the server auth code for an OAuth access token using Google auth services, and then use this to call the Play Games Services REST APIs.

Before you begin

You'll first need to add your game in the Google Play Console, as described in Set Up Google Play Games Services, and integrate Play Games Services platform authentication with your game.

Create a server-side web app

Google Play Game services does not provide backend support for Web games. However, it does provide backend server support for your Android game's server.

If you want to use the REST APIs for Google Play Games services in your server-side app, follow these steps:

1. In the Google Play Console, select a game.
2. Go to Play Games Services > Setup and management > Configuration.
3. Select Add credential to be brought to the Add credential page. Select Game server as the credential type and continue onto the Authorization section.
   1. If your game server already has an OAuth client ID select it from the drop down menu. After saving your changes, move onto the next section.
   2. If you don't have an existing OAuth client ID for your game server, you can create one.
      1. Click Create OAuth client and follow the Create OAuth Client ID link.
      2. This will bring you to the Google Cloud Platform's Create OAuth Client ID page for your project associated with your game.
      3. Fill out the page's form and click create. Be sure to set the Application type to Web application.
      4. Return to the Add credential page's Authorization section, select the newly created OAuth client and save your changes.

Get the server auth code

To retrieve a server auth code that your game can use for access tokens on your backend server:

1. Call requestServerSideAccess from the client.
   1. Be sure that you use the OAuth Client ID registered for your game server and not the OAuth Client ID of your Android application.
   2. (Optional) If your game server requires offline access (long lived access using a refresh token) to Play Games Services, you can set the forceRefreshToken parameter to true.

2. (Optional) As part of the authentication, new users should encounter a single consent screen for additional scopes. Upon accepting the consent, you set the scopes parameter with EMAIL, PROFILE, and OPEN_ID OAuth scopes. If users decline the consent, only the two default scopes DRIVE_APPFOLDER and GAMES_LITE are sent to the backend.

   Consent screen for additional OAuth scopes.

   GamesSignInClientgamesSignInClient=PlayGames.getGamesSignInClient(this);
   gamesSignInClient.requestServerSideAccess(OAUTH_2_WEB_CLIENT_ID,/* forceRefreshToken= / false,
    / Additional AuthScope */scopes)
   .addOnCompleteListener(task->{
   if(task.isSuccessful()){
   AuthResponseauthresp=task.getResult();
   // Send the authorization code as a string and a
   // list of the granted AuthScopes that were granted by the
   // user. Exchange for an access token.
   // Verify the player with Play Games Services REST APIs.
   }else{
   // Failed to retrieve authentication code.
   }
   });
   

3. Send the OAuth auth code token to your backend server so it may be exchanged, the Player ID verified against the Play Games Services REST APIs, and then authenticated with your game.

Send the server auth code

Send the server auth code to your backend server to exchange for access and refresh tokens. Use the access token to call the Play Games Services API on behalf of the player and, optionally, store the refresh token to acquire a new access token when the access token expires.

For more information about how Player IDs work, see Next-generation Player IDs.

The following code snippet shows how you might implement the server-side code in the Java programming language to exchange the server auth code for access tokens.

/**
 * Exchanges the authcode for an access token credential. The credential
 * is 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.
 */
privateintexchangeAuthCode(StringauthCode,Playerplayer){
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 shouldn't be shared.
FilesecretFile=newFile("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!");
returnHttpServletResponse.SC_FORBIDDEN;
}
GoogleClientSecretsclientSecrets=GoogleClientSecrets.load(
JacksonFactory.getDefaultInstance(),new
FileReader(secretFile));
// Extract the application id of the game from the client id.
StringapplicationId=extractApplicationId(clientSecrets
.getDetails().getClientId());
GoogleTokenResponsetokenResponse=
newGoogleAuthorizationCodeTokenRequest(
HTTPTransport,
JacksonFactory.getDefaultInstance(),
"https://oauth2.googleapis.com/token",
clientSecrets.getDetails().getClientId(),
clientSecrets.getDetails().getClientSecret(),
authCode,
"")
.execute();
TokenVerifier(tokenResponse);
log("hasRefresh == "+(tokenResponse.getRefreshToken()!=null));
log("Exchanging authCode: "+authCode+" for token");
Credentialcredential=newCredential
.Builder(BearerToken.authorizationHeaderAccessMethod())
.setJsonFactory(JacksonFactory.getDefaultInstance())
.setTransport(HTTPTransport)
.setTokenServerEncodedUrl("https://www.googleapis.com/oauth2/v4/token")
.setClientAuthentication(newHttpExecuteInterceptor(){
@Override
publicvoidintercept(HttpRequestrequest)
throwsIOException{
}
})
.build()
.setFromTokenResponse(tokenResponse);
player.setCredential(credential);
// Now that we have a credential, we can access the Games API.
PlayGamesAPIapi=newPlayGamesAPI(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.
booleanok=api.verifyPlayer();
// Call a Games API on the server.
if(ok){
ok=api.updatePlayerInfo();
if(ok){
// persist the player.
savePlayer(api.getPlayer());
}
}
returnok?HttpServletResponse.SC_OK:
HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
}catch(IOExceptione){
e.printStackTrace();
}
returnHttpServletResponse.SC_INTERNAL_SERVER_ERROR;
}

You can retrieve the OAuth scopes using the Google API Client Libraries in Java or Python to get the GoogleIdTokenVerifier object. The following code snippet shows the implementation in Java programming language.

importcom.google.api.client.googleapis.auth.oauth2.GoogleIdToken;
importcom.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload;
importcom.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier;
/**
 * Gets the GoogleIdTokenVerifier object and additional OAuth scopes.
 * If additional OAuth scopes are not requested, the idToken will be null.
 *
 * @param tokenResponse - the tokenResponse passed from the exchangeAuthCode
 * function.
 *
 **/
voidTokenVerifier(GoogleTokenResponsetokenResponse){
stringidTokenString=tokenResponse.getIdToken();
GoogleIdTokenVerifierverifier=newGoogleIdTokenVerifier.Builder(transport,jsonFactory)
// Specify the WEB_CLIENT_ID of the app that accesses the backend:
.setAudience(Collections.singletonList(WEB_CLIENT_ID))
// Or, if multiple clients access the backend:
//.setAudience(Arrays.asList(WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3))
.build();
GoogleIdTokenidToken=verifier.verify(idTokenString);
// The idToken can be null if additional OAuth scopes are not requested.
if(idToken!=null){
Payloadpayload=idToken.getPayload();
// Print user identifier
StringuserId=payload.getSubject();
System.out.println("User ID: "+userId);
// Get profile information from payload
Stringemail=payload.getEmail();
booleanemailVerified=Boolean.valueOf(payload.getEmailVerified());
Stringname=(String)payload.get("name");
StringpictureUrl=(String)payload.get("picture");
Stringlocale=(String)payload.get("locale");
StringfamilyName=(String)payload.get("family_name");
StringgivenName=(String)payload.get("given_name");
// This ID is unique to each Google Account, making it suitable for use as
// a primary key during account lookup. Email is not a good choice because
// it can be changed by the user.
Stringsub=payload.getSubject();
// Use or store profile information
// ...
}else{
System.out.println("Invalid ID token.");
}
}

Call REST APIs from the server

See REST APIs for Google Play Games services for a full description of API calls available.

Examples of REST API calls that you may find useful include the following:

Player

Want to get the authenticated with player's ID and profile data? Call Players.get with 'me' as the ID.

Friends

See the Friends guide for details.

• To retrieve the player's list of friends, call Players.list with friends_all as the collection.

• To verify whether you have access to a friends list, call Players.get with me as the playerID, and view the profileSettings.friendsListVisibility field in the response.

Achievements

See the Achievements guide for details.

• To get a list of current achievements, call AchievementDefinitions.list.

• Combine that with a call to Achievements.list to find out which ones the player unlocked.

• Call Achievements.unlock to unlock a player achievement.

• Call Achievements.increment to report progress on an achievement, and find out if the player unlocked it.

• If you are debugging a game that hasn't reached production, you can call Achievements.reset or Achievements.resetAll from the Management APIs to reset achievements to their original state.

Leaderboards

See the Leaderboards guide for details.

• To get a list of all scoreboards in the game, call Leaderboards.list.

• If a player is done with a game, you can submit their score to Scores.submit and find out if it is a new high score.

• To display a leaderboard, get the data from Scores.list and show it to the user.

• Use Scores.listWindow to find an assortment of scores close to the user's high score.

• To get more information about the player's score in a particular leaderboard (for example, if the player is in the top 12% of all players), call Scores.get.

• If you are debugging a game, you can call Scores.reset from the Management APIs to reset all scores for that player from a particular leaderboard.