Note: This guide is for the Play Games Services v2 SDK. For information on the previous SDK, see the Play Games Services v1 documentation.

In order to access Google Play games services functionality, your game needs to provide the signed-in player’s account. This documentation describes how to implement a seamless sign-in experience in your game.

The Play Games Services v2 SDK brings a number of improvements that increase the number of users signed into your game, and make development easier:

This section shows how to do a new client integration with Play Games Services Sign In v2.

Add the Play Game Services SDK dependency to your app's root-level build.gradle file. If you are using Gradle, you can add or update the depency as follows:

To add the Play Games Services SDK project ID to your app, complete the following steps:

In your app's AndroidManifest.xml file, add the following element and attributes to the element:

Define the String resource reference @string/game_services_project_id using your games’ Game services project id as the value. Your Games services project id can be found under your game name in the Configuration page on the Google Play Console.

In your res/values/strings.xml file, add a string resource reference and set your project ID as the value. In Google Play Console, you can find your project ID under your game name in the Configuration page. For example:

Initialize Play Games SDK in the onCreate(..) callback of your Application class.

When your game launches, it will always attempt to sign in the user. To authenticate the user, you must verify that the user successfully signed in, and then get their Player ID.

To verify the sign in attempt, call GamesSignInClient.isAuthenticated() and use addOnCompleteListener to retrieve the results. For example:

If the user chooses not to sign in when the game launches, you may optionally choose to continue showing a button with the Play Games icon, and attempt to sign in the user again by calling GamesSignInClient.signIn() if the user presses the button.

After verifying that the user is signed in, you can retrieve the Player ID to identify the user. For example:

This section describes how to migrate your client code from Play Games Services v1 to v2.

The new SDK contains four major changes to increase sign-in success which you should be aware of:

Additionally, your game will experience additional logins due to automatic sign-in when the game launches. As a result, you should review your quota management to ensure that your game does not exceed the login request quota.

If you are using the Gradle build system, this can be done by changing your dependency to the com.google.android.gms:play-services-games-v2:+ artifact in your module’s build.gradle file. For example:

Initialize the Play Games SDK in the onCreate(..) callback of your Application class. For example:

If you specify no extra scopes, migrating your use case should be straightforward.

Remove sign-in calls using the GoogleSignIn API. Sign-in will always be performed at game launch. Instead, listen to the result of the automatic sign-in attempt using GamesSignInClient.isAuthenticated().

Remove all calls to sign out, as account management is now contained within the OS and Play Games app settings.

If the player is successfully signed in, remove the Play Games sign-in button from your game. If the user chooses not to sign in when the game launches, you may optionally choose to continue showing a button with the Play Games icon, and trigger the login process with GamesSignInClient.signIn().

After verifying that the user is signed-in, you can retrieve the Player ID to identify the user.

Remove your dependency on the GoogleSignIn API, if no longer in use.

When creating clients (e.g. LeaderboardsClient or AchievementsClient) use PlayGames.getFooClient() rather than Games.getFooClient().

When requesting server side access use GamesSignInClient.requestServerSideAccess() rather than GoogleSignInAccount.getServerAuthCode().

With Play Games Services v2 you cannot request any additional scopes. If you still need to request additional scopes, then we recommend you use the Google Sign In SDK alongside Play Games Services.

For older existing integrations your game may be depending on the GoogleApiClient API variation of the Play Games Services SDK. This was deprecated in late 2017 and replaced by “connectionless” clients. To migrate you can replace the GoogleApiClient class with a “connectionless” equivalent. You will then also have to follow the guidance above to migrate your game from v1 to v2. Below is a mapping of common classes: