Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Contest Rewards let you trigger a Reward for players based on their leaderboard rank. Rewards can only be created within a Contest. Setting a Reward is optional. You can create multiple rewards in a Contest. 

To create a Reward, click Add and fill out the rewards information as in the screen example above. 

To create a reward that will be issued to the player you need to fill out the details. Information like Name and Description is for the player to see when he or she receives the reward. Other information like Rank, Value, expires in, etc. configures the Reward.

REWARDS

EXAMPLES


Name

Required

String

The Name of the Reward. This is intended to be exposed to the player via the front end.
Rank

Required

Double

A specific position or a list of positions that will be used to award players based on their position in the leaderboard.
Value

Required

Double

A Reward value. For example, if the Reward is intended to be 5 free spins, then you would enter 5 for the value. 
Type

Required

String

Select a reward type that you pre created.

Note
titleNote!

Reward types can be created in Settings → Reward Types. How to create Reward types you can read about it here.


Description

Optional

String

The description of the Reward. This is intended to be exposed via the front end to the player. 
Expires in

Optional

Integer

The numerical value in how many minutes the reward notification will expire. You can use this to configure time-limited Rewards that are displayed to the player. 
Expires on a specific date

Optional

DateTime

Date and time that indicates when the reward will not be issued anymore.
Acknowledgement to 
issue required

Required

Boolean

Specify if the Reward is issued immediately, or if the Reward must be claimed. 

Note
titleNote!

You can build a front end experience for customers to claim Rewards using the Public API. See Claim Member Award by Reference ID POST api/v1/:space/members/reference/:memberRefId/award/:awardId/award


Delay

Optional

Integer(NOT IMPLEMENTED)
Delay the Reward by the specified minutes. You might use this for a game where the Reward could be issued before the game animation has completed. 
Metadata

Optional

Array [Object]

Optional information for your backend systems. 


APP Example:

Name
Free spin!
Rank
1
Value

1

Type
Badge
Description
You get 1 free spin if you win!
Expires in
N/A
Expires on a specific date
N/A
Acknowledgement to 
issue required
No
Delay
0
Metadata
Key
Win
Value
1

API Example:

{
"rewards": [
{
"jsonClass": "Reward",
"entityId": "IucyuWwBNwtlnqmJLNbJ",
"rewardRank": [
1
],
"rewardName": "Free spin!",
"value": 1.0,
"rewardType": "FsjwdGsBmxo4zyGh_nsK",
"description": "You get 1 free spin if you win!",
"delay": 0,
"memberAcknowledgmentRequired": false,
"metadata": [
{
"jsonClass": "Metadata",
"key": "Win",
"value": "1"
}
],
"accountId": "E8jwdGsBmxo4zyGh9Hs7",
"pointInTime": "2019-08-22T11:59:29.581+00:00",
"period": 0,
"created": "2019-08-22T11:59:29.586+00:00",
"id": "YwsyuWwBCyJvIjn8L7Yy",
"translations": {},
"translatableFields": [
"rewardName",
"description"
],
"rewardTypeObject": {
"jsonClass": "RewardType",
"name": "Badge",
"key": "badge",
"description": "",
"accountId": "E8jwdGsBmxo4zyGh9Hs7",
"system": true,
"metadata": [],
"created": "2019-06-20T12:51:19.178+00:00",
"id": "FsjwdGsBmxo4zyGh_nsK"
}
...
)
A full example of POST Contest can be found in the Contest APP API documentation here

Status
subtletrue
colourGreen
titleContinue
 Click Save to create the Reward in the Contest.

Status
subtletrue
colourRed
titleMissing entries
 If any required information is missing, the field is shown in red as in the example below.

Expand
titleEXAMPLE

You can then use the action buttons for the created reward:

  •  - Reward details lets you preview what kind of reward is created.
  •  - Edit lets you edit the Reward.
  •  - Delete lets you delete a Reward. 

Status
subtletrue
colourGreen
titleContinue
 Click Next and continue to the next step.