Initialize Gameball Customer Profile

Show your customers' profile including all details and progress on your Flutter 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 Flutter SDK.

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.

Showing Gameball Customer Profile

To show the Gameball customer profile that contains their details, available reward campaigns, and the leaderboard use showProfile() SDK method.

Gameball’s views are accessible through the code below. You just need to use it on any button action.

gameballApp.showProfile(context, "{CUST_ID}", "{openDetail}", "{hideNavigation}");

The below is description of show customer profile parameters

context BuildContext Required

BuildContext instance which will be

---

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 Optional

Specify if you want the widget to open on a specific view.

Open Details Values

Value	View
details_referral	Navigates to the referral page directly.
details_redeem_coupons	Navigates to the coupons tab directly in the redeem page.
details_reward_campaign	Navigates to the reward campaigns page directly listing all the available reward campaigns.
details_reward_campaign_{CampaignId}	Navigates to a specific reward campaign details showing its progress.
details_wheels_list	Navigates to Wheels' list page directly.
details_wheel	Navigates to the first wheel details available from the wheels' list.
details_wheel_{WheelId}	Navigates to a specific Wheel Campaign with the given Id.
details_slot_list	Displays the list of available Slot Machines.
details_slot	Navigates to the first Slot Machine details available from the slots' list.
details_slot_{SlotId}	Opens a specific Slot Machine by its ID.
details_calendar_list	Displays the list of available Calendar campaigns.
details_calendar	Navigates to the first Calendar campaign details available.
details_calendar_{CalendarId}	Opens a specific Calendar campaign by its ID
details_scratch	Navigates to the first Scratch and Win available.
details_scratch_{scratchId}	Opens a specific Scratch and Win by its ID.
details_match	Navigates to the first Match game available.
details_match_{matchId}	Opens a specific Match game by its ID.

---

hideNavigation Boolean Optional

Set to true to stop widget navigation otherwise leave as null

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.

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 Optional

Customer's unique Email address.

---

customerMobile string Optional

Customer's unique Mobile number.

---

customerAttributes object Optional

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

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

---

registerCallBack function Optional

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's side. You may consider enriching your Gameball's customer profile with attributes that are not available to the UI by using server side Create\Update Customer API

Choose an Unchangeable CustomerId

Gameball customer gets created using thecustomerId. 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, hence losing their points and rewards on Gameball. Accordingly, it is NOT recommended to use email address

Note that if you set a Preferred Language, it will override the language value provided in the init method.

An example to create CustomerAttributes object

      CustomerAttributes customerAttributes = CustomerAttributes(
        displayName: "John Doe",
        firstName: "John",
        lastName: "Doe",
        mobileNumber: "0123456789",
        preferredLanguage: "en",
        customAttributes: {
          "{key}": "{value}"
        }
      );

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

 // RegisterCallback
 customerRegistrationCallback(response, error) {
        if(error == null && response != null){
          // TODO Handle on success result.
        }
        else{
          // TODO Handle on failure result.
        }
    }
      
 gameballApp.registerCustomer(
          "{CUST_ID}",
          "{customerEmail}",
          "{customerMobile}",
          customerAttributes, 
          customerRegistrationCallback
  );