Android SDK

Available in Classic and VPC

This guide provides instructions for using the GAMEPOT Android SDK in the Android environment. You can integrate the game and dashboard by installing the SDK and configuring the environment.

Requirements

The recommended specifications required to use GAMEPOT SDK for Android are as follows:

• The minimum requirement is Android level 24 or higher. If you need support for earlier versions, please contact Ncloud Support with your request.

Install SDK and configure environment

You can install the Android SDK, configure the environment, and integrate the game and GAMEPOT dashboard to use features required for the game development.

The GAMEPOT SDK supports the following languages.

• Korean, English, Italian, Thai, Vietnamese, Japanese, Chinese (Simplified/Traditional), Indonesian, German, Spanish, French

When you reset GAMEPOT, the interface will automatically display in the language you selected during registration. Languages not supported will be displayed in English.

SDK installation

To install the GAMEPOT Android SDK and configure your project, follow these steps.

1. Add the NBase SDK to your build.gradle or build.gradle.kts file.
2. Starting with GAMEPOT 3.0, you can easily integrate external libraries via Gradle configuration.

Set Kotlin Gradle

For projects using the Kotlin DSL, add the following configuration.

1. Add the following configuration to the build.gradle.kts file in the project root.
   Kotlin:

dependencyResolutionManagement {
	repositories {
		...
		google()
		maven(url = "https://repo.nbase.io/repository/nbase-releases")
	}
}

2. Add the following configuration to the build.gradle.kts file in the app module (Module: app).

Kotlin:

dependencies {
	...
	implementation("io.nbase:nbasesdk:latest.release")
}

If you are using both Google Sign-In and Google Play payments, use the following example as a reference.

Kotlin:

dependencies {
	...
	implementation("io.nbase:nbasesdk:latest.release")
	implementation("io.nbase:nbase-adapter-provider-google:latest.release")
	implementation("io.nbase:nbase-adapter-billing-googleplay:latest.release")
}

Set Gradle for Java

For projects using Groovy DSL, add the following configuration.

1. Add the following configuration to the build.gradle file in the project root.
   Groovy:

allprojects {
	repositories {
		...
		google()
		maven { url "https://repo.nbase.io/repository/nbase-releases" }
	}
}

2. Add the following configuration to the build.gradle file in the app module (Module: app).

Groovy:

dependencies {
	...
	implementation("io.nbase:nbasesdk:latest.release")
}

If you are using both Google Sign-In and Google Play payments, use the following example as a reference.

Groovy:

dependencies {
	...
	implementation("io.nbase:nbasesdk:latest.release")
	implementation("io.nbase:nbase-adapter-provider-google:latest.release")
	implementation("io.nbase:nbase-adapter-billing-googleplay:latest.release")
}

Supported AOS-dependent modules are as follows:

Guest login is included in the basic module.

Preparation

Before implementing the SDK, verify the following required settings.

1. Copy the project ID and project key from Dashboard > Project settings.
2. To configure settings for login, the store, and integration, go to Dashboard > Project settings.
3. See Configuration by login method for each login, set it in the console and add it to the dashboard.
4. If you are using in-app purchases, see Configuration by store to configure them in the console and add them to the dashboard.
5. Register the items for in-app purchases for each store under Dashboard > Payment > In-app.

Reset

To perform an initialization, add the following code to the object used in the first scene loaded when the game starts.

Kotlin:

import android.util.Log
import com.nbase.sdk.NBase
import com.nbase.sdk.Store

NBase.initialize(activity, projectId, projectKey, storeId, language, region) { init, e ->
	if (e != null) {
		Log.e("NBase", e.message ?: "initialize fail")
	} else {
		Log.i("NBase", "initialize success: ${init.toString()}")
	}
}

Java:

import android.util.Log;
import com.nbase.sdk.NBase;
import com.nbase.sdk.Store;

NBase nBase = NBase.INSTANCE;
nBase.initialize(activity, projectId, projectKey, Store.GOOGLE, language, region, (init, e) -> {
	if (e != null) {
		Log.e("NBase", "initialize fail: " + e.getMessage());
	} else {
		Log.i("NBase", "initialize success: " + init.toString());
	}
	return null;
});

• Parameters

The following table describes the parameters required for initialization.

See the following table for store identifiers.

• Callback

The following table describes the information passed to the initialization callback.

Login feature

This section describes how to authenticate users using various authentication methods through the login feature.

Use login feature

To call the SDK login feature from the login UI implemented by the developer, see the following code.

Kotlin:

import android.content.Intent
import android.util.Log
import com.nbase.sdk.NBase
import com.nbase.sdk.Provider

NBase.signIn(activity, Provider.GOOGLE.toString()) { user, e -> 
    if (e != null) {
        if (e.errorCode == 414) { // Maintenance
            // Maintenance
            Log.e("NBase", "Maintenance: " + e.message) // Maintenance message
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, user?.appStatus) { status, err ->
                // Popup handling
            }
            */
        } else if (e.errorCode == 413) { // Update
            // Update
            Log.e("NBase", "Update: " + e.message) // Update message
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, user?.appStatus) { status, err ->
                // Popup handling
            }
            */
        } else {
            // signIn Failed
            Log.e("NBase", "signIn Failed: " + e.errorCode + ", " + e.message)
        }
    } else {
        // signIn Success
        Log.e("NBase", "signIn Success: " + user.toString())
    }
}

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    NBase.onActivityResult(requestCode, resultCode, data)
}

Java:

import android.content.Intent;
import android.util.Log;
import com.nbase.sdk.NBase;
import com.nbase.sdk.Provider;

NBase nBase = NBase.INSTANCE;

nBase.signIn(activity, Provider.GOOGLE.toString(), (user, e) -> {
    if (e != null) {
        if (e.getErrorCode() == 414) { // Maintenance
            // Maintenance
            Log.e("NBase", "Maintenance: " + e.getMessage()) // Maintenance message
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, user?.appStatus, (status, err) -> {
                // Popup handling
            }
            */
        } else if (e.getErrorCode() == 413) { // Update
            // Update
            Log.e("NBase", "Update: " + e.getMessage()) // Update message
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, user?.appStatus, (status, err) -> {
                // Popup handling
            }
            */
        } else {
            // signIn Failed
            Log.e("NBase", "signIn Failed: " + e.getErrorCode() + ", " + e.getMessage());
        }
    } else {
        // signIn Success
        Log.e("NBase", "signIn Success: " + user.toString());
    }
    return null;
});

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    nBase.onActivityResult(requestCode, resultCode, data);
}

If you use the pop-up provided by the SDK when updating or checking, add the following code.

Kotlin:

NBase.showAppStatusPopup(activity, appStatus){ status, e ->
    if (status.close){
        // App Close
    }
    else if (status.next){
        // Next, Optional update
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.showAppStatusPopup(activity, appStatus){ status, e ->
    if (status.getClose()){
        // App Close
    }
    else if (status.getNext()){
        // Next, Optional update
    }
}

• Provider

The following table describes the service types used in the login feature.

• User

The following table describes the fields of the User object.

• AppStatus

The following table describes the fields of the AppStatus object.

Login UI provided by SDK

You can use the login UI provided by GAMEPOT SDK in a completed form.
Use the following code to call the login UI provided by the SDK.

Kotlin:

NBase.openSignInUI(activity) { user, e -> 
    if (e != null) {
        if (e.errorCode == 414) { // Maintenance
            // Maintenance
            Log.e("NBase", "Maintenance: " + e.message) // Maintenance message
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, user?.appStatus) { status, err ->
                // Popup handling
            }
            */
        } else if (e.errorCode == 413) { // Update
            // Update
            Log.e("NBase", "Update: " + e.message) // Update message
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, user?.appStatus) { status, err ->
                // Popup handling
            }
            */
        } else {
            // signIn Failed
            Log.e("NBase", "signIn Failed: " + e.errorCode + ", " + e.message)
        }
    } else {
        // signIn Success
        Log.e("NBase", "signIn Success: " + user.toString())
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.openSignInUI(activity, (user, e) -> {
    if (e != null) {
        if (e.getErrorCode() == 414) { // Maintenance
            // Maintenance
            Log.e("NBase", "Maintenance: " + e.getMessage()) // Maintenance message
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, user?.appStatus, (status, err) -> {
                // Popup handling
            }
            */
        } else if (e.getErrorCode() == 413) { // Update
            // Update
            Log.e("NBase", "Update: " + e.getMessage()) // Update message
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, user?.appStatus, (status, err) -> {
                // Popup handling
            }
            */
        } else {
            // signIn Failed
            Log.e("NBase", "signIn Failed: " + e.getErrorCode() + ", " + e.getMessage());
        }
    } else {
        // signIn Success
        Log.e("NBase", "signIn Success: " + user.toString());
    }
    return null;
});

Auto login (optional)

After initialization, it may attempt to automatically log in with the last authentication method you logged in with. We recommend checking the last login provider type before attempting automatic login.

Kotlin:

// Check the last login provider type.
val lastProviderType = NBase.getLastProviderType()

if (lastProviderType != Provider.NONE) {
    // Attempt automatic login only when a valid provider is available.
    NBase.signInLastLoggedIn(activity) { user, e ->
        if (e != null) {
            if (e.errorCode == 414) { // Maintenance
                // Maintenance
                Log.e("NBase", "Maintenance: " + e.message) // Maintenance message
                /* case 1: Use in-game popup implemented directly by the developer
                case 2: Call the code below to use the SDK's own popup
                NBase.showAppStatusPopup(activity, user?.appStatus) { status, err ->
                    // Popup handling
                }
                */
            } else if (e.errorCode == 413) { // Update
                // Update
                Log.e("NBase", "Update: " + e.message) // Update message
                /* case 1: Use in-game popup implemented directly by the developer
                case 2: Call the code below to use the SDK's own popup
                NBase.showAppStatusPopup(activity, user?.appStatus) { status, err ->
                    // Popup handling
                }
                */
            } else {
                // signIn Failed
                Log.e("NBase", "signIn Failed: " + e.errorCode + ", " + e.message)
            }
        } else {
            // signIn Success
            Log.e("NBase", "signIn Success: " + user.toString())
        }
    }
} else {
    // No last login information
    Log.e("NBase", "No last login provider found")
}

Java:

NBase nBase = NBase.INSTANCE;

// Check the last login provider type.
Provider lastProviderType = nBase.getLastProviderType();

if (lastProviderType != Provider.NONE) {
    // Attempt automatic login only when a valid provider is available.
    nBase.signInLastLoggedIn(activity, (user, e) -> {
        if (e != null) {
            if (e.getErrorCode() == 414) { // Maintenance
                // Maintenance
                Log.e("NBase", "Maintenance: " + e.getMessage()) // Maintenance message
                /* case 1: Use in-game popup implemented directly by the developer
                case 2: Call the code below to use the SDK's own popup
                NBase.showAppStatusPopup(activity, user?.appStatus, (status, err) -> {
                    // Popup handling
                }
                */
            } else if (e.getErrorCode() == 413) { // Update
                // Update
                Log.e("NBase", "Update: " + e.getMessage()) // Update message
                /* case 1: Use in-game popup implemented directly by the developer
                case 2: Call the code below to use the SDK's own popup
                NBase.showAppStatusPopup(activity, user?.appStatus, (status, err) -> {
                    // Popup handling
                }
                */
            } else {
                // signIn Failed
                Log.e("NBase", "signIn Failed: " + e.getErrorCode() + ", " + e.getMessage());
            }
        } else {
            // signIn Success
            Log.e("NBase", "signIn Success: " + user.toString());
        }
        return null;
    });
} else {
    // No last login information
    Log.e("NBase", "No last login provider found");
}

• getLastProviderType()

Return the last logged in provider type.

The following table describes the return values of the getLastProviderType() method.

• signInLastLoggedIn() Parameter

It attempts to automatically log in using the authentication method used for the last login.
The following table describes the parameters of the signInLastLoggedIn() method.

• Callback

The following table describes the values passed to the automatic login callback.

Log out

Use the following code to log out of your GAMEPOT account.

Kotlin:

NBase.signOut(activity) { status, e ->
    if (e != null) {
        Log.e("NBase", "signOut Fail")
        Log.e("NBase", "error.message : " + e.message.toString())
    } else {
        Log.e("NBase", "signOut")
        Log.e("NBase", "status : " + status.toString())
        // Processing logic after successful logout
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.signOut(activity, (status, e) -> {
    if (e != null) {
        Log.e("NBase", "signOut Fail");
        Log.e("NBase", "error.message : " + e.getMessage());
    } else {
        Log.e("NBase", "signOut");
        Log.e("NBase", "status : " + status.toString());
        // Processing logic after successful logout
    }
    return null;
});

• Parameter

The following table describes the parameters of the getLastProviderType() method.

• Callback

The following table describes the values passed to the logout callback.

Withdraw from membership

Use the following code to use the SDK membership withdrawal feature.

Kotlin:

NBase.deleteMember(providerId) { status, e ->
    if (e != null) {
        Log.e("NBase", "deleteMember Fail")
        Log.e("NBase", "error.message : " + e.message.toString())
    } else {
        Log.e("NBase", "deleteMember")
        Log.e("NBase", "status : " + status.toString())
        // Logic after successful membership withdrawal
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.deleteMember(providerId, (status, e) -> {
    if (e != null) {
        Log.e("NBase", "deleteMember Fail");
        Log.e("NBase", "error.message : " + e.getMessage());
    } else {
        Log.e("NBase", "deleteMember");
        Log.e("NBase", "status : " + status.toString());
        // Logic after successful membership withdrawal
    }
    return null;
});

• Parameters

The following table, this section, describes the parameters that must be passed for a membership withdrawal.

• Callback

The following table describes the callback values for membership withdrawal.

Self-authentication with username and password (optional)

This is an authentication method that allows users to log in using their email address and password. It performs user authentication based on the user's email address and password.

Kotlin:

NBase.signInWithPassword(activity, username, password) { user, e ->
    if (e != null) {
        Log.e("NBase", e.message)
    } else {
        Log.e("NBase", user)
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.signInWithPassword(activity, username, password, (user, e) -> {
    if (e != null) {
        Log.e("NBase", "signInWithPassword fail: " + e.getMessage());
    } else {
        Log.e("NBase", "signInWithPassword success: " + user.toString());
    }
    return null;
});

Log in with credentials (optional)

Use the following code to log in using credentials (access tokens) obtained from external social accounts.

Kotlin:

NBase.signInWithCredential(activity, Provider.GOOGLE.ToString(), providerToken) { user, e ->
    if (e != null) {
        Log.e("NBase", e.message)
    } else {
        Log.e("NBase", user)
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.signInWithCredential(activity, Provider.GOOGLE.toString(), providerToken, (user, e) -> {
    if (e != null) {
        Log.e("NBase", "signInWithCredential fail: " + e.getMessage());
    } else {
        Log.e("NBase", "signInWithCredential success: " + user.toString());
    }
    return null;
});

• Parameter

The following table describes the parameters required for credential login.

• Callback

The following table describes the credential login callback values.

External account integration feature

This section describes the feature that allows you to integrate and manage external social accounts with your GAMEPOT user account.

Use external account integration feature

Use the following code to integrate another social account with your current GAMEPOT user account.

Kotlin:

NBase.createLinking(activity, providerId) { linkingId, e ->
    if (e != null) {
        Log.e("NBase", "createLinking Fail")
        Log.e("NBase", "error.message : " + e.message.toString())
    } else {
        Log.e("NBase", "createLinking")
        Log.e("NBase", "linkingId : " + linkingId.toString())
        // Processing logic after successful account integration
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.createLinking(activity, providerId, (linkingId, e) -> {
    if (e != null) {
        Log.e("NBase", "createLinking Fail");
        Log.e("NBase", "error.message : " + e.getMessage());
    } else {
        Log.e("NBase", "createLinking");
        Log.e("NBase", "linkingId : " + linkingId);
        // Processing logic after successful account integration
    }
    return null;
});

• Parameter

The following table describes the parameters required for account integration.

• Callback

The following table describes the callback values for account integration.

Check integration list

Use the following code to check the list of social accounts currently integrated with your GAMEPOT user account.

Kotlin:

NBase.getLinkedLists { linkings, e ->
    if (e != null) {
        Log.e("NBase", "getLinkedLists Fail")
        Log.e("NBase", "error.message : " + e.message.toString())
    } else {
        Log.e("NBase", "getLinkedLists")
        Log.e("NBase", "linkings : " + linkings.toString())
        // Processing logic after checking the integration list
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.getLinkedLists((linkings, e) -> {
    if (e != null) {
        Log.e("NBase", "getLinkedLists Fail");
        Log.e("NBase", "error.message : " + e.getMessage());
    } else {
        Log.e("NBase", "getLinkedLists");
        Log.e("NBase", "linkings : " + linkings.toString());
        // Processing logic after checking the integration list
    }
    return null;
});

• Callback

The following table describes the values provided when checking the account integration list.

• Linking

The following table describes the fields of the Linking object.

Remove integration

To remove a specific social account integration from your current GAMEPOT user account, use the following code.

Kotlin:

NBase.deleteLinking(linkingId) { status, e ->
    if (e != null) {
        Log.e("NBase", "deleteLinking Fail")
        Log.e("NBase", "error.message : " + e.message.toString())
    } else {
        Log.e("NBase", "deleteLinking")
        Log.e("NBase", "status : " + status.toString())
        // Processing logic after successful integration removal
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.deleteLinking(linkingId, (status, e) -> {
    if (e != null) {
        Log.e("NBase", "deleteLinking Fail");
        Log.e("NBase", "error.message : " + e.getMessage());
    } else {
        Log.e("NBase", "deleteLinking");
        Log.e("NBase", "status : " + status.toString());
        // Processing logic after successful integration removal
    }
    return null;
});

• Parameter

The following table describes the parameters required for account integration removal.

• Callback

The following table describes the callback values for account integration removal.

Check app status

Use the following code to check the client's current maintenance/update status.

Kotlin:

NBase.checkAppStatus(activity) { status, error ->
    when (status) {
        is NBaseAppStatus.Maintenance -> {
            // Maintenance
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, status) { popupStatus, e ->
                // Popup handling
            }
            */
        }
        is NBaseAppStatus.Update -> {
            // Update
            /* case 1: Use in-game popup implemented directly by the developer
            case 2: Call the code below to use the SDK's own popup
            NBase.showAppStatusPopup(activity, status) { popupStatus, e ->
                // Popup handling
            }
            */
        }
        null -> {
            // AppStatus Success or Error
            if (error != null) {
                Log.e("NBase", "checkAppStatus error: $error")
            } else {
                Log.e("NBase", "checkAppStatus success")
            }
        }
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.checkAppStatus(activity, (status, error) -> {
    if (status instanceof NBaseAppStatus.Maintenance) {
        // Maintenance
        /* case 1: Use in-game popup implemented directly by the developer
        case 2: Call the code below to use the SDK's own popup
        nBase.showAppStatusPopup(activity, status, (popupStatus, e) -> {
            // Popup handling
        });
        */
    } else if (status instanceof NBaseAppStatus.Update) {
        // Update
        /* case 1: Use in-game popup implemented directly by the developer
        case 2: Call the code below to use the SDK's own popup
        nBase.showAppStatusPopup(activity, status, (popupStatus, e) -> {
            // Popup handling
        });
        */
    } else if (status == null) {
        // AppStatus Success or Error
        if (error != null) {
            Log.e("NBase", "checkAppStatus error: " + error.toString());
        } else {
            Log.e("NBase", "checkAppStatus success");
        }
    }
    return null;
});

Troubleshooting

This section provides information on common errors and how to resolve them.

Q. An error occurs on Android indicating that the androidx.security.crypto.MasterKeys class cannot be found.
A. This error occurred because the MasterKeys class could not be found. Add the following dependencies to the build.gradle or build.gradle.kts file.

Groovy:

implementation("androidx.security:security-crypto:1.0.0")

Q. I’m getting the error 10: Developer console is not set up correctly. when logging in with Google.
A. Verify that the OAuth 2.0 client ID and client secret for the web application registered in the Google Cloud Console have been entered correctly in the GAMEPOT dashboard.

Q. I’m getting the error 16: Cannot find a matching credential. when logging in with Google.
A. Verify that the package name of the OAuth 2.0 Android client registered in the Google Cloud Console matches the app’s SHA-1 value.