- Create a new reward calendar offer.
- Update an existing reward calendar offer.
- Retrieve one or more reward calendar offers.
- Retrieve all reward calendar offers.
- Delete a reward calendar offer.
Before you begin
It’s important to note the following points before starting to code:-
The
productsSequencearray must include seven objects representing the reward tiles for each configured week. You can configure one to 10 weeks, so the sequence must be a multiple of 7 and a maximum of 70 items. The main reward is every seventh index, such as 7, 14, and 21. All other indexes are sub rewards. -
If you set
rewardCollectionBehaviortoForcePlayerToCollect, players must collect the available reward when the popup opens. Because collection can’t be deferred, the collectible badge isn’t shown.
Terminology
These terms define how the Reward Calendar behaves for players:- Reset behavior: Determines how player progress resets after a missed day, either to Week 1, Day 1, or to Day 1 of the current week.
- Popup trigger: Determines whether the popup opens automatically when a reward becomes available, or only after the player clicks the badge.
- Reward collection behavior: Determines whether players must collect the reward immediately, or can close the popup and collect later that day.
- Start over: Determines whether the calendar restarts after players complete all configured weeks.