[Gametize Tech] Feature Knowledge: Unlocking Rule Support for Reward

API Support

Show Reward Profile and List

Since reward can be unlockable, the following data point will now be returned:

• unlockable (Always returned) - true means that reward is locked and some actions may be required to unlock it.

• locked (Returned when unlockable = true) - If locked = true, reward cannot be redeemed by player yet.

Redeem Reward

Nothing changes but reward cannot be redeemed if it is unlockable = true and locked = true. As illustrated, the following error will be returned:

Complete Challenge

If user completion challenge action leads to unlocking of rewards, the unlocked rewards list will be returned in the completion success result. Look for the key rewardsUnlocked. Essential reward information such as ID, name, description and image will be returned.

CMS Development Note

For rules listing in create/update form, we can make use of the actions in achievement package as they are generic actions:

• achievement.ShowRuleScopes

• achievement.ShowAchievementRules
  
  

The parameters in DoCreateReward, DoUpdateReward and ShowRewardForAdmin are mimicking the variables used for similar achievement functions. Do note that the only exception is the rule object, which is called rewardRule and not achievementRule.

Since unlocking rule is optional, the back-end process will consider rule is not applied or rule is to be cancelled (i.e. during update) when ruleId = 0

Note:

The article's technical specifications and details are subject to potential changes based on our discretion. It is important to note that the information presented in the article might have become outdated or lost its relevance in the present context.

If you are interested to learn more about this, please drop an email to support@gametize.com with your queries regarding the article!