Android

The purpose of this article is to explain how to set up Google Authentication so that your game can be logged in through the Google channel using the Player Network login authentication service.

Prerequisites

1. Set up your game in the Google Play admin center

note

For the IEGG project, please contact [miaruan (Ruan Mingjun)] for Google Apps registration and configuration.

1. Create Google Apps

Follow the prompts to register an account on Google Play Console.

info

Google charges a $25 service fee.Please have your credit card ready in advance.

1. Go to Google Play Console.
2. On the All apps page, click Create app to create the game app.
   
3. Enter the application information.
   

2. Configuring the Play game service

Set up the Play game service to manage game metadata and automate game production and distribution tasks.

1. Go to Google Play Console.
2. In the left navigation bar, select Grow users > Play Games Services > Setup and management > Configuration.
3. Under Which Play Games Services project do you want to use, select the corresponding option to create a Play Games Services project.
4. In the Properties section, click Edit Properties.
5. Enter the basic information about the game and click Save changes.

3. add a credential that connects the OAuth 2.0 client ID to the game

1. Go to Google Cloud Platform.
2. In the left navigation bar, click OAuth consent screen.
3. Follow the instructions to set up the OAuth consent screen.
   
4. Click Clients on the left navigation bar.
5. On the Clients page, select CREATE CLIENT > Create OAuth Client ID to create an OAuth client ID.
   I
6. In the Application type list, click Android.
7. Enter Package Name and SHA-1 Certificate Fingerprint.
   Confirm Package Name and SHA-1 Certificate Fingerprint with the development team.The OAuth client for Android requires the user to configure the SHA-1 certificate fingerprint and package name in the KeyStore.Make sure these two values are correct.Otherwise, the login process will be abnormal.
   
8. Click SAVE to complete the configuration.
9. Go to the details page of the Android app to view the Customer ID and Customer Secret.
10. Click Audience > ADD USERS to add a login test user.
    

4. Adding game testers

1. Go to Google Play Console.
2. In the left navigation bar, select Grow users > Play Games Services > Setup and management > Testers.
3. In the Testers tab, click Add testers to add testers to your game.
   

note

Until the game app is released, only testers can log in.Make sure the application is in a test state.

5. Configuring achievements and leaderboards

Find the Achievements and Leaderboards features under the Play Game Services menu and configure them as needed.

6. Get Google API ID

Access the Info Center from the Google Cloud Platform panel.The Google API ID is the Project No. on this page.

7. Get the Client ID and Client secret.

Follow the steps in Add credentials to link OAuth 2.0 client IDs to the game to get application information.

2. Obtain Player Network Console login account.
3. Create a new project for your game, or join an existing one.
4. Download SDK.
5. Integrate the SDK.
6. Add Google as a business login authentication method in the Player Network console.

Step 1：Configure SDK for Google Sign-in

1. In the AndroidManifest file, make sure the required permissions are added.Google needs access to the web.

<uses-permission android:name="android.permission.INTERNET"/>

2. Open your project's INTLConfig.ini file:

INTLConfig.ini

[INTL environment]
# WARNING: You should change this URL to the production environment when you release your game.
INTL_URL = https://test.intlgame.com
GAME_ID = {INTL_GAME_ID}
SDK_KEY = {INTL_SDK_KEY}
[INTL Log]
LOG_LEVEL = 1
LOG_CONSOLE_OUTPUT_ENABLE = 1
LOG_FILE_OUTPUT_ENABLE = 1
LOG_ENCRYPT_ENABLE = 0
LOG_COMPRESS_ENABLE = 0
[Android LifeCycle]
LIFECYCLE = Google
[Google]
GOOGLE_CLIENT_KEY_ANDROID = {INTL_GOOGLE_CLIENT_KEY}

• Set the SDK backend environment to INTL_URL = https://test.intlgame.com.
• Replace {INTL_GAME_ID} and {INTL_SDK_KEY} with the GAME_ID and SDK_KEY values assigned by the Player Network console.
• Set LOG_LEVEL = 1, LOG_CONSOLE_OUTPUT_ENABLE = 1, LOG_FILE_OUTPUT_ENABLE = 1, LOG_ENCRYPT_ENABLE = 0 and LOG_COMPRESS_ENABLE = 0 to output console logs and log files without encrypting or compressing the output without encrypting or compressing the output.
• Add Google to LIFECYCLE.For more information, please see SDK Environment.
• Replace {INTL_GOOGLE_CLIENT_KEY} with Web Client Key.
  This is the client ID of the web application in the Credentials section of the API OAuth configuration process, also referred to as the Server Client ID in the API OAuth 2.5 configuration process.

3. Define manifestPlaceholders in the gradle file, replacing {INTL_GOOGLE_APP_ID} with Google App ID.

Unity

mainTemplate.gradle

android {
    defaultConfig {
      manifestPlaceholders = ["GOOGLE_APPID":"{INTL_GOOGLE_APP_ID}"]
    }
}

Unreal Engine

note

For Player Network SDK V1.17 and higher, edit INTLConfig_APL.xml.

For Player Network SDK V1.16.04 and earlier versions, please edit INTLCore_UPL.xml.

<buildGradleAdditions>
    <insert>
    <![CDATA[
    android{
        defaultConfig {
            manifestPlaceholders = ["GOOGLE_APPID":"{INTL_GOOGLE_APP_ID}"]
        }
    }]]>
    </insert>
</buildGradleAdditions>

Step 2: Add Google Login

All Google actions require a connection to Google services.

AuthLogin

During automatic sign-in, the device may not be able to connect to Google services.It is therefore recommended to let Player Network SDK connect to Google services during automatic login by default.(Game teams can disable this connection by configuring the GOOGLE_LOGOUT_NEED_CONNECT field in the Google Channel Configuration section of the INTLConfig configuration file.)

Login

Before calling Google Login, the Player Network SDK checks to see if Google Mobile Services (GMS) is available.The login service can only be invoked when GMS is available.If GMS is not available, the Player Network SDK will return the error code sent by Google to the game via the ThirdCode field of INTLAuthResult.

Return Code	Return value	misdescription
SERVICE_MISSING	1	GMS is not available on the device.
SERVICE_VERSION_UPDATE_REQUIRED	2	The installed version of GMS is out of date.
SERVICE_DISABLED	3	GMS is disabled.
SERVICE_INVALID	9	The version of GMS installed is incorrect.
SERVICE_UPDATING	18	The GMS on the device is being updated.

For more information, see Google Docs and Google Frequently Asked Questions

1. Register login-related callbacks.

Unity

// Add callbacks
public void AddAuthObserver()
{
    INTLAPI.AddAuthResultObserver(OnAuthResultEvent);
}

// Remove callbacks
public void RemoveAuthObserver()
{
    INTLAPI.RemoveAuthResultObserver(OnAuthResultEvent);
}

// Process the INTLAuthResult callback
public void OnAuthResultEvent(INTLAuthResult ret)
{
    Debug.Log($"MethodID: {ret.MethodId}");
    
    string methodTag = "";
    if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_LOGIN)
    {
        methodTag = "Login";
    }
    else if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_BIND)
    {
        methodTag = "Bind";
    }
    else if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_AUTOLOGIN)
    {
        methodTag = "AutoLogin";
    }
    else if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_QUERY_USER_INFO)
    {
        methodTag = "QueryUserInfo";
    }
    else if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_GET_AUTH_RESULT)
    {
        methodTag = "GetAuthResult";
    }
}

Unreal Engine

C++ Event Handling (above v1.15)

//configure callback
FINTLAuthEvent authEvent;
authEvent.AddUObject(this, &OnAuthResult_Implementation);
UINTLSDKAPI::SetAuthResultObserver(authEvent);
// Remove callbacks
UINTLSDKAPI::GetAuthResultObserver().Clear();

void OnAuthResult_Implementation(FINTLAuthResult ret)
{ 
    UE_LOG(LogTemp, Warning, TEXT("MethodID: %d"), ret.MethodId);
}

Unreal Event Handling

void OnAuthResult_Implementation(FINTLAuthResult ret)
{ 
    UE_LOG(LogTemp, Warning, TEXT("MethodID: %d"), ret.MethodId);
}

2. Call the AutoLogin interface to log in automatically.

Unity

INTLAPI.AutoLogin();

Unreal Engine

UINTLSDKAPI::AutoLogin();

3. If automatic login fails, call the Login interface to let the player log in manually.

Unity

INTLAPI.Login(INTLChannel.Google); 

Unreal Engine

UINTLSDKAPI::Login(EINTLLoginChannel::kChannelGoogle); 

4. Synchronize client authentication status with the game backend and wait for the final verification result.

[Optional] Set email permission

To get the player's email when logging in to Google, you need to set the corresponding permission, which will return email in the ChannelInfo of AuthResult.

• For compliance considerations, masking of returned email for specific origins can be done. Please contact Player Network Assistant to enable it if needed.
• In the background log, you can report the hash of base64(sha256(email)). Contact Player Network Assistant if needed.
• Can be used to verify whether the player's information or the binding list contains email information. Contact Player Network Assistant if needed.

Enable the email return feature in the Player Network Console by setting return_email to YES. For details, see Third-Party Channel Configuration.

Step 3: Acceptance testing for login functionality

Search for the keyword "AuthResult" in the Player Network SDK logs to confirm whether the channel name and OpenID are returned correctly.If correct, it means the integration configuration is successful, and login functionality has been successfully added.

If you encounter problems during the integration process, please refer to Frequently Asked Questions.

Step 4: Publish the game

Before you are ready to release the official version, create a test version using Android App Bundle.

The nice thing about releasing Beta is that users can download it from Google play, but don't have access to add comments.Specific channels are set up for users to submit feedback.

Creating official releases

1. Go to Google Play Console.

2. In the left navigation bar, select Release > Production.

   

3. Follow the instructions to create a production version.

Changing the Publishing Status

caution

Authentication may fail if the user does not release the application.

1. Go to the OAuth consent interface page for Google Cloud Platform (https://console.cloud.google.com/apis/credentials/consent).
2. Change PUBLISHING STATUS to PUBLISH APP.

Testing Google Login with APK

For more information, see Testing Google Sign-in with APKs.

Synchronized login state using Google Play Games Services

If the game requires access to Google Play Games for PC (Google PC Emulator), it is recommended that you use Google Play Games Services (GooglePGS) to sync the login state of the game on your Android device to the Google PC Emulator.

Using GooglePGS to synchronize the login state requires access to INTLGoogle with access to INTLGooglePGS.

Step 1: Configuring the SDK for GooglePGS

1. Add the following configuration in the INTLConfig.ini file:

   INTLConfig.ini

   [Android LifeCycle]
   LIFECYCLE = GooglePGS
   [GooglePGS]
   GOOGLEPGS_SERVER_PROJECT_ID = {INTL_GOOGLEPGS_SERVER_PROJECT_ID}
   GOOGLEPGS_ENABLE_PGS = 1

   • Replace {INTL_GOOGLEPGS_SERVER_PROJECT_ID} with the Web client key.
     This is the client ID of the web application in the Credentials section of the API OAuth configuration process, also referred to as the server client ID in the API OAuth 2.5 configuration process.
   • GOOGLEPGS_ENABLE_PGS indicates whether the SDK enables GooglePGS to synchronize the login state to the Google PC Simulator, GOOGLEPGS_ENABLE_PGS = 1 is enabled.

2. Define manifestPlaceholders in the gradle file, replacing {INTL_GOOGLEPGS_APP_ID} with the Google App ID.

Unity

mainTemplate.gradle

android {
    defaultConfig {
      manifestPlaceholders = ["GOOGLEPGS_APPID":"{INTL_GOOGLEPGS_APP_ID}"]
    }
}

Unreal Engine

note

For Player Network SDK V1.17 and higher, edit INTLConfig_APL.xml.

For Player Network SDK V1.16.04 and earlier versions, please edit INTLCore_UPL.xml.

<buildGradleAdditions>
    <insert>
    <![CDATA[
    android{
        defaultConfig {
            manifestPlaceholders = ["GOOGLEPGS_APPID":"{INTL_GOOGLEPGS_APP_ID}"]
        }
    }]]>
    </insert>
</buildGradleAdditions>

Step 2: On Google PC Emulator, use AutoLogin to get the login state

After completing the above steps, you can sync the login state on your Android device to Google PC Simulator via GooglePGS.Android devices and Google PC emulators need to be signed into the same Google account.

Unity

INTLAPI.AutoLogin();

Unreal Engine

UINTLSDKAPI::AutoLogin();