Master Data Reference of GS2-LoginReward

Master Data Format

• JSON

{
  "version": "2023-07-11",
  "bonusModels": [
    {
      "name": "[string]Login Bonus Model Name",
      "metadata": "[string?]Metadata",
      "mode": "[string enum]mode",
      "periodEventId": "[string?]GS2-Schedule Event GRN that represents the period during which to enable login bonuses",
      "resetHour": "[int]Reset time of the receive flag (UTC)",
      "repeat": "[string enum]Whether to repeat after reaching the end",
      "rewards": [
        {
          "acquireActions": [
            {
              "action": "[string]Types of actions to be performed in the acquire action",
              "request": "[string]JSON string of the request used when executing the action"
            }
          ]
        }
      ],
      "missedReceiveRelief": "[string enum]Missed Rescue Function",
      "missedReceiveReliefVerifyActions": [
        {
          "action": "[string]Types of actions to be performed in the verify task",
          "request": "[string]JSON string of the request used when executing the action"
        }
      ],
      "missedReceiveReliefConsumeActions": [
        {
          "action": "[string]Types of actions to be performed in the consume action",
          "request": "[string]JSON string of the request used when executing the action"
        }
      ]
    }
  ]
}

Model

BonusModel

Login Bonus Model

Login Bonus Model defines the distribution schedule for login bonuses. There are two schedule types: 《Schedule Mode》 and 《Streaming Mode》.

In Schedule Mode, a GS2-Schedule event must be specified, and bonuses are distributed based on the number of days elapsed since the event’s start date. If the user misses a day partway through, the bonus for that day will not be granted.

In Streaming Mode, the rewards configured for the bonus are distributed sequentially from the beginning each day. Streaming Mode also supports repetition; when enabled, the distribution restarts from the first reward after reaching the end of the stream.

Both Schedule Mode and Streaming Mode provide a missed-bonus recovery feature. By paying a certain cost, users can receive bonuses they previously missed. However, if a GS2-Schedule event is associated, users cannot receive bonuses beyond the number of days elapsed since the event’s start date. Additionally, the recovery feature cannot be used when using Streaming Mode with repetition enabled.

In both Schedule Mode and Streaming Mode, the maximum number of days that can be configured for bonuses is 100 days.

Reward

Reward

ConsumeAction

Consume Action

VerifyAction

Verify Action

AcquireAction

Acquire Action