Master Data Reference of GS2-LoginReward

{
  "version": "2023-07-11",
  "bonusModels": [
    {
      "bonusModelId": "[string]Login Bonus Model GRN",
      "name": "[string]Bonus Model Name",
      "metadata": "[string?]metadata",
      "mode": "[string]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]Reset time of the receive flag (UTC)",
      "rewards": [
        {
          "acquireActions": [
            {
              "action": "[string]Types of actions to be performed in the stamp sheet",
              "request": "[string]JSON of request"
            }
          ]
        }
      ],
      "missedReceiveRelief": "[string]Missed Rescue Function",
      "missedReceiveReliefConsumeActions": [
        {
          "action": "[string]Types of actions to be performed in the stamp task",
          "request": "[string]JSON of the obtain request"
        }
      ]
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version2023-07-11Format version of master data
bonusModelsList<BonusModel>

BonusModel

Bonus Model Set the distribution schedule of login bonuses. There are two types of distribution schedules: “Schedule Mode” and “Streaming Mode”.

In Schedule Mode, the GS2-Schedule event is required, and the bonus is distributed based on the number of days elapsed since the start of the event. If you miss a shot in the middle, you will not receive the bonus for that shot.

In Streaming Mode, the rewards set for the bonus are distributed one by one from the beginning every day. In Streaming Mode, you can set it to repeat. In that case, if you reach the end of the stream, you will start distributing from the beginning again.

Both Schedule Mode and Streaming Mode have a rescue function for missed shots. By paying a certain cost, you can receive the bonus you missed. However, if the GS2-Schedule event is associated, you can only receive the bonus after the number of days elapsed since the start of the event. The missed capture function is not available in streaming mode and when repetition is enabled.

The maximum number of days of bonuses that can be set in both Scheduled and Streaming modes is 100 days.

TypeConditionRequireDefaultLimitationDescription
bonusModelIdstring~ 1024 charsLogin Bonus Model GRN
namestring~ 128 charsBonus Model Name
metadatastring~ 2048 charsmetadata
modeenum [‘schedule’, ‘streaming’]~ 128 charsmode
periodEventIdstring~ 1024 charsGS2-Schedule Event GRN that represents the period during which to enable login bonuses
resetHourint{periodEventId} == ""~ 23Reset time of the receive flag (UTC)
repeatenum [’enabled’, ‘disabled’]{mode} == “streaming”~ 128 charsReset time of the receive flag (UTC)
rewardsList<Reward>~ 100 itemsList of rewards
missedReceiveReliefenum [’enabled’, ‘disabled’]“disabled”~ 128 charsMissed Rescue Function
missedReceiveReliefConsumeActionsList<ConsumeAction>{missedReceiveRelief} == “enabled”~ 10 itemsList of consumption actions for missed receive relief

Reward

TypeConditionRequireDefaultLimitationDescription
acquireActionsList<AcquireAction>1 ~ 10 itemsList of Acquire Action

ConsumeAction

TypeConditionRequireDefaultLimitationDescription
actionenum []~ 128 charsTypes of actions to be performed in the stamp task
requeststring~ 1048576 charsJSON of the obtain request

AcquireAction

TypeConditionRequireDefaultLimitationDescription
actionenum []~ 128 charsTypes of actions to be performed in the stamp sheet
requeststring~ 1048576 charsJSON of request