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. Each Progress Bar contains one or more missions, but only one mission is visible to players at any given time. Each Progress Bar has a current mission. A mission is defined by the total number of points a player must earn to receive a reward. Players earn points by purchasing eligible offers or by collecting free rewards such as Daily Bonuses. As points are earned, the Progress Bar fills to visually represent the player’s progress. When the required number of points is reached, the mission is completed, the player receives the reward, and a free order is created. If another mission is available, the Progress Bar resets automatically and the player progresses to the next mission. If no additional missions remain, the Progress Bar is removed from the web store. When all missions are completed, the Progress Bar is considered complete. Learn more about Progress Bar offers. With the Progress Bars API, you can:

​
Before you begin

Review the following before you begin:
  • Updating the productsSequence.barSize property value may affect player progress. Before making changes, review updating a mission size.
  • 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.