Profile Web Component

Note: For the APIs used to create this web component, see Create a Custom Web Component or Block.

Displays the user's name, role, level, and point balance. You can customize the profile by showing or hiding different elements.

If your program is integrated with the Global Rewards Marketplace, a user's enrollment and verification status determines if they can view their available balance and/or access the Marketplace.

Configure a Web Component  

1. Open Nitro Studio > Integrate > Web Components.
2. Click New > Profile.
3. Enter the web component settings.
   Parameters are used when working directly with a web component embed tag (HTML) or editing the config.json file for Bunchball Go.

Studio Field	Description	Parameters
		Web Component Embed HTML	Bunchball Go config.json	Valid Values	Required (web component)	Required (iframe)
Name	The web component name. web component - set the component tag as bunchball-profile. iframe - must match exactly with the name of the web component created in Nitro Studio.	name	name		No	Yes
Width	The web component's width.	width	width	relative (%) or absolute value (px)	No	Yes
Height	The web component's height.	height	height	relative (%) or absolute value (px)	No	Yes
Custom Styles	The link to your custom stylesheet(s). Accepts a comma delimited list of URLs.
Embed Type	Specifies the type of embed code to generate. web component - Recommended. Web components improve performance due to faster loading. Height and width settings are not required as the web component will fill space on the page like any other HTML element. iframe - The source code is a div tag and the rendered web component will be inside an iframe.	data-embed-type	embed-type	iframe	No	Yes
Web Component
User ID	The ID of the user to get information for.	data-user-id	user-id		Yes	Yes
Title	The title to display as the web component's header. Defaults to My Profile.	data-title	title		No	No
Subtitle	The subtitle to display below the web component header.	data-subtitle	subtitle		No	No
Point Category	The point category to display.	data-point-category	point-category		No	No
Point Category Title	The title to display for the user's lifetime points balance. Defaults to the name of the selected point category.	data-point-category-title	point-category-title		No	No
Catalog Navigation	Defines if the Global Rewards Marketplace catalog should open inline or in a new tab. Defaults to new tab. Most programs, particularly Bunchball Go, will want to set this to new tab.	data-navigation	navigation	inline, new tab	No	No
Balance Display Type	The type of points balance to display in the balance section. None - Shows the user's lifetime points balance for the point category selected in the Point Category field. Current Balance - Shows the user's lifetime and current points balances for the point category selected in the Point Category field. Award Balance - Shows the user's lifetime point balance for the point category selected in the Point Category field, the current points balance for the point category tied to your award account, and a Redeem Points button to access the Global Rewards Marketplace.	data-balance-display-type	balance-display-type	None, Current, Award Balance	No	No
Balance Title	The title to display when showing the user's current points balance. Defaults to Award Account.	data-balance-title	balance-title		No	No
Award account exclusion group class	Defines the groups that will not see their award balance or the redemption button. Allows you to hide the award account section for specific groups.	data-award-account-exclusion-group-class-id	award-account-exclusion-group-class-id		No	No
Hide Level Progress Bar	Specifies if the level progress bar section should be hidden. Bunchball recommends hiding this section when using custom levels.	data-hide-level-progress	hide-level-progress	true, false	No	No
Max Level Achieved Message	The message to display in place of the next level when the highest level is reached. By default, the icon displays if no message is set.	data-max-level-achieved-message	max-level-achieved-message		No	No
Unenrolled Message	The message to display when a user is not enrolled in an award account. See Award Account Enrollment and Verification Examples for more details.	data-unenrolled-message	unenrolled-message		No	No
Unverified Message	The message to display when a user is unverified. Only applies to programs with an award account.	data-unverified-message	unverified-message		No	No
Unverified URL	The URL you want to use for the unverified button. This can take the user to the location where they can verify their status or link to a browse only version of the catalog. Only applies to programs with an award account.	data-unverified-url	unverified-url		No	No
Editable Items	The items you want to allow users to edit within their profile. These edits update the user's preferences (firstName, lastName, and userPhotoUrl). Note: If users remove their profile image, it clears the userPhotoUrl preference.	data-editable-items	editable-items	name, image	No	No
Language	Add a language code to preview the web component in a Nitro supported default language. Default languages are: en, de, hi, zh, it, es, and fr.				No	No
Custom Language Reference	Add a language code and then add a custom translation key to the browser console to preview the web component in a non-default language.				No	No
	Marks the root body element inside the web component with a given class(es) name. This makes it easier to style web components sharing the same custom CSS file with theme differences.	data-theme	theme		No	No

4. Click Save & Finish and reopen the web component.
5. Click Get Web Component Embed Code. Copy the code to the clipboard or a file.
6. Include the code to generate an OAuth token in your app.
7. Insert the embed code into the page/div where you want to display the web component in your app or web page, and update the variable for the OAuth token.

Sample Embed Code

See Embed an OAuth Web Component for more information and the Web Components view for the most up-to-date embed code. The following is an example embed for a Profile web component.

<bunchball-profile style="display:block; width:350px;"
  data-user-id="AutoTest"
  data-token="abcdefg1234567"
  data-balance-display-type='Award Balance'
  data-balance-title='Award Account'
  data-connection-params='
  {
    u'apiKey': u'76f4ad5f7xxxxxxxxxx',
    u'timeStamp': 1534956874,
    u'userId': u'AutoTest',
    u'autoLogin': True,
    u'server': u'https%3A%2F%2Fnitro.bunchball.com/nitro/json',
    u'sessionKey': None,
    u'signature': u'39b1cddfxxxxxxx151f5',
    u'debug': False
  }'
  data-hide-level-progress='false'
  data-editable-items='name,image'
  data-navigation='new tab'
  data-point-category='Points'
  data-unverified-message='You are not verified for the Award Account'
  data-custom-css=''>
</bunchball-profile>

<div name="Profile"
  class="nitro-widget"
  width="350"
  height="500"
  data-user-id="AutoTest"
  data-name='Profile'
  data-balance-display-type='Award Balance'
  data-balance-title='Award Account'
  data-connection-params='
  {
    u'apiKey': u'76f4ad5f7xxxxxxxxxx',
    u'timeStamp': 1534956874,
    u'userId': u'AutoTest',
    u'autoLogin': True,
    u'server': u'https%3A%2F%2Fnitro.bunchball.com/nitro/json',
    u'sessionKey': None,
    u'signature': u'39b1cddfxxxxxxx151f5',
    u'debug': False
  }'
  data-embed-type='iframe'
  data-height='500'
  data-hide-level-progress='false'
  data-unverified-message='You are not verified for the Award Account'
  data-editable-items='name,image'  
  data-navigation='new tab'
  data-point-category='Points'
  data-width='350'>                                
</div>

See also

Web components

Styling web components