GS2-LoginReward Master Data Reference

Master Data Format

{
  "version": "2023-07-11",
  "bonusModels": [
    {
      "name": "[string]Login Bonus Model name",
      "metadata": "[string?]Metadata",
      "mode": "[string enum]Mode",
      "periodEventId": "[string?]Period Event GRN",
      "resetHour": "[int]Reset Hour (UTC)",
      "repeat": "[string enum]Repeat",
      "rewards": [
        {
          "acquireActions": [
            {
              "action": "[string]Type of action to be executed in the Acquire Action",
              "request": "[string]JSON string of the request used when executing the action"
            }
          ]
        }
      ],
      "missedReceiveRelief": "[string enum]Missed Receive Relief",
      "missedReceiveReliefVerifyActions": [
        {
          "action": "[string]Type of action to be executed in the Verify Action",
          "request": "[string]JSON string of the request used when executing the action"
        }
      ],
      "missedReceiveReliefConsumeActions": [
        {
          "action": "[string]Type of action to be executed 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

Represents a single day’s reward configuration for a login bonus. Each Reward contains a list of acquire actions that define what the user receives (e.g., items, currency, experience). The rewards array in BonusModel holds one Reward per day, distributed in order. Reward values can be modified at runtime through the buff system (BonusModelBuff) to apply rate multipliers to acquire actions.

ConsumeAction

Consume Action

Defines an action for consuming resources from a user via the transaction mechanism. Used in missed-bonus recovery to specify the cost users must pay (e.g., deducting currency, consuming items). The action field specifies the type of consume action, and the request field contains the corresponding request parameters.

VerifyAction

Verify Action

Defines an action for verifying conditions before proceeding with an operation. Used in missed-bonus recovery to check preconditions (e.g., user eligibility, resource availability) before allowing the recovery. The action field specifies the type of verify action, and the request field contains the corresponding request parameters.

AcquireAction

Acquire Action

Defines an action for granting resources to a user via the transaction mechanism. Used within rewards to specify what the user receives (e.g., adding items to inventory, granting currency, awarding experience points). The action field specifies the type of acquire action, and the request field contains the corresponding request parameters.