Show Gameball Player Widget
Get started on integrating the Gameball players's profile into your website or web app
In order to show Gameball profile widget, you need to add the widget javascript code snippet to every webpage where you want the widget to appear. Paste the code snippet immediately before the closing tag. If you use templates to dynamically generate pages for your site, like PHP, ASP, or similar technology, you can paste the code snippet into its own file, then include it in your page header.
<script>
window.GbLoadInit = function(){
GbSdk.init({
APIKey: '{{Your_API_Key}}'
lang: 'en',
playerUniqueId: '',
playerAttributes:{}
});
};
</script>
<script defer src="https://assets.gameball.co/widget/js/gameball-init.min.js"></script>
The widget supports two different modes, a guest view and a player view. Each can be shown to your website visitors with the same code snippet and serve different usecase.
A guest view is normally what you want your guests (non logged-in user) to see about the programs your offering. This can be used to encourage guest to create accounts and sign in to enjoy your rewards programs. Where a player view is used to let your players (logged-in users) track their programs in your rewards program and enjoy their benifits.
For guest customers, non-logged in users, use the below snippet adding your Gameball APIKey. Please check the article How can you get your account integration details? (API Key & Transaction Key) to learn more on how to get your unique APIKey.
<script>
window.GbLoadInit = function(){
GbSdk.init({
APIKey: '{{Your_API_Key}}'
lang: 'en',
playerUniqueId: '',
playerAttributes:{}
});
};
</script>
<script defer src="https://assets.gameball.co/widget/js/gameball-init.min.js"></script>
For player view, all you need to do is to set the
playerUniqueId value to the current logged-in user. This is how your player will be identified and tracked at Gameball, hence make sure to send a permenant consistent id across a user’s lifetime. Could be database ID, random string, email or anything that uniquely identifies the player.In addition to the
playerUniqueId, optional player attributes can be sent to enrich the player's profile at Gameball. You can send non, all, or selected attributes to Gameball depending on how you would like to enrich your player's profile.Everytime the widget is initialized with player data, the player profile is created or updated at Gameball side. You may consider enriching your Gameball's player profile with attributes that are not avialable to the UI by using server side Create\Update Player API
<script>
window.GbLoadInit = function(){
GbSdk.init({
APIKey: '{{Your_API_Key}}'
lang: 'en',
playerUniqueId: '{{logged_in_player_unique_id}}',
playerAttributes: {
displayName: 'john austin',
email: '[email protected]',
custom:
{
'height': '1.8'
}
},
});
};
</script>
<script defer src="https://assets.gameball.co/widget/js/gameball-init.min.js"></script>
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 player, you risk losing all original data for that player and hence losing their points and rewards on Gameball. Accordingly, it is NOT recommended to use email address or mobile number as the unique ID as both can be changed by the user at anytime.Parameter | Type | Required | Description |
APIKey | string | Yes | Client API key |
lang | string | Yes | Your platform language preference to view Gameball Widget with. Note: 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". |
playerUniqueId | string | Yes | Unique identifier for the player in your database. Could be database ID, random string, email or anything that uniquely identifies the player. |
playerAttributes | object | No |
Parameter | Type | Description |
displayName | string | Player's display name |
firstName | string | Player's first name |
lastName | string | Player's last name |
gender | string | Player's gender. Example: M or F, Male or Female. |
email | string | Player's email |
dateOfBirth | string | Player's date of birth Example: "1980-09-19T00:00:00.000Z" |
joinDate | string | Player join date at your system. Example: "2019-09-19T21:06:29.158Z" |
tags | string | Comma separated string of tags to be attached to the player. Example: "VIP,Platinum" |
community | string | Describe which community a player belongs to. Example: ? |
custom | object | Key value pairs of any extra player attributes. {"class" : "E2022", "weight" : 78} |
For websites with multiple languages, how you can change Gameball widget language based on active website language. Gameball supports multiple languages for the player profile widget. The widget language can be changed based on your player's (customer) active language on the website.
Language | Code |
Arabic | ar |
Dutch | nl |
English | en |
French | fr |
German or Deutsch | de |
Hungarian | hu |
Italian | it |
Portuguese | pt |
Spanish | es |
Swedish | sv |
Taiwanese Mandarin | zh-TW |
In order to show the correct language of the widget based on the active language on the website, you just need to use the language code inside the
lang variable in the code snippet.
Last modified 1yr ago