Initialize Gameball Customer Profile

Show your customer's profile including all details, customer reward campaigns, and the leaderboard on React-native 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 elaborates, is through using our react native SDK.

Using the SDK, you can open the Gameball customer profile from a button in your app, programmatically when someone does something, or from a persistent button that sits over your app’s UI.

When you trigger the Gameball customer profile, your customer is presented with a home screen. This is configurable inside Gameball to change how it looks and what’s presented.

From there, your customer can check his progress across different Gameball programs as per your configurations.

To show the Gameball customer profile that contains the customer details, customer reward campaigns, and the leaderboard use the below steps.

import {GameballWidget} from 'react-native-gameball';

There are two ways to view the widget.

Show as Standalone Screen

<GameballWidget />

<GameballWidget 
  modal={true}
/>

and then to open the widget you need to call the showProfile function on the ref property of the widget

The below is description of show customer profile parameters.

modal boolean Optional

Boolean value used to Indicates if you want to show the widget in modal view

openDetail string Optional

Specify if you want the widget to open on a specific view. Possible values are:

details_referral
details_reward_campaign
details_reward_campaign_{RewardID}
details_wheels_list
details_wheel

hideNavigation boolean Optional

Set to true to stop widget navigation otherwise leave as null

Usage

Class component

return (
      <View style={{ flex: 1 }}>
        <Button
          title={'open widget'}
          onPress={() => this.widget.showProfile()}
        />
        <GameballWidget
          ref={(ref) => this.widget = ref}
          modal={true}
        />
      </View>
)

Functional component

const ref = createRef();
return (
  <View>
    <Button title="Open modal" onPress={() => ref.current.showProfile()} />
    <GameballWidget modal={true} ref={ref} />
  </View>
)

Advanced Techniques: Deep Links

In certain scenarios, where you offer a product as a free reward, you might want to showcase this product within the Gameball widget along with a deep link. When customers click on the deep link, they will be seamlessly redirected to the product page within your app, where they can obtain more information and take further action. To enable this functionality, you need to follow the steps outlined below.

Create a custom Gameball widget that is based on the default widget and implemented as a ForwardRefRenderFunction.
Override the WebView's 'onShouldStartLoadWithRequest' event with a customized implementation.
- In this implementation, detect URLs that begin with '{your_app_deep_link_prefix}://' to identify deep links specific to your app.
- Handle these deep links using the main app's action to process and dispatch them, instead of relying on the WebView."

Register Customer

Register player method is used to create or update customers at Gameball. It is called when your login network call is successful.

First, import Gameball SDK as follows:

import {GameballSDK} from 'react-native-gameball';

then

GameballSDK.registerPlayer({
  "playerUniqueId": "{CUST_ID}",
  "deviceToken": "{deviceToken}",
  "playerAttributes": {
    "displayName": "{displayName}",
    "email": "{email}",
    "gender": "{gender}",
    "mobileNumber": "{mobile}",
    "dateOfBirth": "{dateOfBirth}",
    "joinDate": "{joinDate}"
  }
}).then(res => res.json()).then(jsonResponse => {...}) // on success

Once the APIKey and playerUniqueId have been registered, Gameball views can be made visible to the user.

playerUniqueId 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.

email string Optional

Customer's unique Email address.

mobile string Optional

Customer's unique Mobile number.

deviceToken string Optional

Token used to identify the device.

referrerCode string Optional

The referral code of an existing customer who is referring the customer being created. This is required in the create customer request to process the referral. Check Track Referrals for more details

playerAttributes object Optional

Additional customer-specific attributes. Includes attributes such as the customer’s name, contact details, and purchase history.

playerAttributes Object

displayName string Optional

The display name of the customer.

firstName string Optional

The first name of the customer.

lastName string Optional

The last name of the customer.

email string Optional

Customer's unique Email address.

mobileNumber string Optional

Customer's unique Mobile number.

gender string Optional

The gender of the customer. Use "M" for male, "F" for female, or other identifiers as needed.

dateOfBirth string Optional

The customer's date of birth in the format YYYY-MM-DD.

joinDate string Optional

The date the customer joined your system, in the format YYYY-MM-DD.

preferredLanguage string Optional

The language the customer prefers for receiving notifications.

customAttributes Object Optional

Custom attributes related to the customer, defined by specific key-value pairs.rs.

Choose an Unchangeable Player Unique ID

Gameball user profile gets created using the playerUniqueId. 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.

PreviousGetting Started NextTrack Customer Events

Last updated 1 month ago