Skip to main content
The Progress Bars API lets you create and manage progress bar offers in the web store. Progress Bars are promotional offers that encourage players to make additional purchases by earning points toward configured targets. Each target has a reward and a target size. You set target size using the productsSequence.barSize property, which is the number of accumulated items (points) required to complete the target. Players earn points by purchasing eligible offers or collecting free rewards. When a target’s point requirement is met, the player receives the reward and a free order is created. After all targets are completed, the Progress Bar is removed from the web store. There are 2 types of progress bars:
  • Classic: Only one mission is displayed on the bar at a time, and the bar resets when the next mission begins.
  • Milestones: All milestones are displayed at once along the bar.
Learn more about Progress Bar offers. With the Progress Bars API, you can: You can also listen for events when a mission is started, completed, and points are granted.

​
Before you begin

Review the following before you begin:
  • Updating the productsSequence.barSize property may affect player progress. Before making changes, review updating required points.
  • Setting the active property to false marks the Progress Bar as inactive and removes it from the web store. If the Progress Bar is later reactivated, players will see the Progress Bar along with their existing progress in the web store.
  • You can schedule a Progress Bar using the schedule property. When the scheduled period ends, the Progress Bar is removed from the web store but remains active unless it is explicitly set to "active": false or deactivated in the Publisher Dashboard.