Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gameball.co/llms.txt

Use this file to discover all available pages before exploring further.

Show your customer’s profile including all details and progress on your Android app. Showing the Gameball widget on your mobile application is slightly different than showing it on the website. You have two options; first, if you want to design your customer interface, you will use our set of REST APIs. To know more information, you can use the Configurations API 👑. The other option as this section is describing is using the Android SDK to show the Gameball customer widget.

​
Showing Gameball Customer Profile

To show the Gameball customer profile that contains the customer details, available reward campaigns, and the leaderboard use the showProfile() SDK method. Using the SDK, you can open the Gameball customer profile with the magic of a press of button in your app, programmatically when someone does a specific action, or from a persistent button (ex: FAB) that sits over your app’s UI. When you trigger the Gameball customer profile, your customer is presented with a default screen that is configurable inside Gameball to change the look and feel of it. From there, your customer can check their progress across different Gameball programs as per your configurations. 
gameballApp.showProfile(this, "{CUST_ID}", "{openDetail}", "{hideNavigation}");
Use showProfile with a button and call this method in the onClick() method of this button to show the customer profile.
​
activity
Activity
required
Current activity instance holding the GameballApp which will be used in showing the customer’s profile.
​
customerId
string
required
Unique identifier for the customer that you can reference across the customer’s whole lifetime. Could be a database ID, random string, email or anything that uniquely identifies the customer.
​
openDetail
string
Specify if you want the widget to open on a specific view. See available values
​
hideNavigation
boolean
Set to true to stop widget navigation, otherwise leave as null

​
Change Customer Profile Widget language

changeLanguage(String language) Use changeLanguage SDK method to change the widget language. The language provided should be as per configured languages in your account. If not provided the Gameball profile widget will be shown with your account default language. Example: "en", "fr", "ar" 
gameballApp.changeLanguage("en");

​
Register/Update Customer

To register your customers with Gameball, use registerCustomer method which can be used to create or update the customer details at Gameball. Ideally, it is called when your login or register network call is successful.
​
activity
Activity
deprecated
Current activity instance holding the GameballApp which will be used in showing the customer’s profile.
​
intent
Intent
deprecated
An intent instance that will be used in combination with the Activity to detect the referral code from the dynamic link.
​
customerId
string
required
Unique identifier for the customer that you can reference across the customer’s whole lifetime. Could be a database ID, random string, email or anything that uniquely identifies the customer.
​
customerEmail
string
Customer’s unique Email address.
​
customerMobile
string
Customer’s unique Mobile number.
​
customerAttributes
object
Additional customer-specific attributes. Includes attributes such as the customer’s name, contact details, and purchase history.
​
referralCode
string
Customer’s referrer’s referral code
​
isGuest
boolean
Flag indicating the customer is guest or not (if null, isGuest is set to false by default)
​
callback
function
Callback is used for providing the developer with the response status and payload.
Every time the SDK is initialized with a new customerId, the customer profile is created or updated on Gameball side. You may consider enriching your Gameball customer profile with attributes that are not available to the UI by using server side Create/Update Customer API
Choose an Unchangeable Customer IDGameball user profile gets created using the customerId. It is highly recommended to have the unique ID as an identifier that would NEVER be changed. If this unique ID changes for a given customer, you risk losing all original data for that customer and hence losing their points and rewards on Gameball. Accordingly, it is NOT recommended to use the email address or the mobile number as the unique ID as both can be changed by the user at anytime.
Note that if you set a Preferred Language, it will override the language value provided in the init method. If neither were provided, the device’s default locale will be used.
You can find the complete list of Customer Attributes here, if its not included in the CustomerAttributes builder you can add them as Key/Value pairs using withAdditionalAttribute builder method and it will automatically added upon request.

​
An example to create CustomerAttributes object

CustomerAttributes customerAttributes = new CustomerAttributes.Builder()
        .withDisplayName("John Doe")
        .withFirstName("John")
        .withLastName("Doe")
        .withMobileNumber("0123456789")
        .withPreferredLanguage("en")
        .withCustomAttribute("{key}", "{Value}")
        .withAdditionalAttribute("{key}", "{Value}")
        .build();
The previous example will return an object of CustomerAttributes with the configured attributes.

​
Register the Customer

Using the previously created GameballApp instance or by creating a new one, call the registerCustomer() method as shown below
Since Firebase Dynamic Links will soon be deprecated, we’ve deprecated its usage on our side, and started depending on either Branch.io or Adjust providers to provide for referral links, depending on your implementation, you should be able to fetch the referralCode from the sent query param GBReferral and provide it to the register customer method.
gameballApp.registerCustomer(
    "{customerId}", 
    customerAttributes,
    "{referralCode}",
    false, //isGuest
    new Callback<CustomerRegisterResponse>() {
        @Override
        public void onSuccess(CustomerRegisterResponse customerRegisterResponse) {
            // TODO Handle on success result.
        }
    
        @Override
        public void onError(Throwable e) {
            // TODO Handle on failure result.
        }
    }
);

//Overloaded with Email and Mobile Number
gameballApp.registerCustomer(
    "{customerId}", 
    "{customerEmail}",
    "{customerMobile}",
    customerAttributes, 
    "{referralCode}",
    false, //isGuest
    new Callback<CustomerRegisterResponse>() {
        @Override
        public void onSuccess(CustomerRegisterResponse customerRegisterResponse) {
            // TODO Handle on success result.
        }

        @Override
        public void onError(Throwable e) {
            // TODO Handle on failure result.
        }
    }
);

​
Deprecated Register Customer overloads

Due to the deprecation of Firebase Dynamic Links in the old manner, we’ve updated the usage approach. If you still need to use the old method, you’ll have to use the alternative handleFirebaseDynamicLink method to retrieve the referral code as before.
gameballApp.registerCustomer(
    "{customerId}", 
    customerAttributes, 
    this, 
    this.getIntent(), 
    new Callback<CustomerRegisterResponse>() {
        @Override
        public void onSuccess(CustomerRegisterResponse customerRegisterResponse) {
            // TODO Handle on success result.
        }
    
        @Override
        public void onError(Throwable e) {
            // TODO Handle on failure result.
        }
    }
);

//Overloaded with Email and Mobile Number
gameballApp.registerCustomer(
    "{customerId}", 
    "{customerEmail}",
    "{customerMobile}",
    customerAttributes,
    this, 
    this.getIntent(), 
    new Callback<CustomerRegisterResponse>() {
        @Override
        public void onSuccess(CustomerRegisterResponse customerRegisterResponse) {
            // TODO Handle on success result.
        }

        @Override
        public void onError(Throwable e) {
            // TODO Handle on failure result.
        }
    }
);

gameballApp.handleFirebaseDynamicLink(
    this, 
    this.intent, 
    new Callback<String>() {
        @Override
        public void onSuccess(String referralCode) {
            // Capture the referral code using firebase dynamic link 
            // and begin the registration flow using the newer overloads
        }
    
        @Override
        public void onError(Throwable e) {
            // TODO Handle on failure result.
        }
    }
);

​
Next Steps