GS2-Schedule API Reference

Manage the schedule of in-game events.

This service is not used alone, but in conjunction with GS2-Showcase and GS2-Quest to enable products and quests to be displayed in the store only during the event period.

There are two types of event duration.

• An absolute period is shared by all players. It is used for cases like “Hosting a New Year’s event from January 1st to January 3rd,” with absoluteBegin / absoluteEnd specified in the master data.
• A relative period differs per player. It is used for cases such as “One week from game start” or “24 hours after defeating a boss for the first time.” When pulling a trigger, there are multiple ways to specify the event period if the trigger has already been pulled.

For both absolute and relative periods, by combining RepeatSetting you can express repeating schedules such as “active only on specific days of the week or hours” or “switching active/inactive on a multi-day cycle.”

For events with repeat settings, you can obtain the start and end date/times of the current and previous repeat cycles as RepeatSchedule. This allows you to aggregate how many times rewards have been received in the current cycle, or to display the remaining time until the next cycle.