GS2-LoginReward マスターデータリファレンス

マスターデータのフォーマット

{
  "version": "2023-07-11",
  "bonusModels": [
    {
      "name": "[string]ログインボーナスモデル名",
      "metadata": "[string?]メタデータ",
      "mode": "[string enum]モード",
      "periodEventId": "[string?]期間イベントGRN",
      "resetHour": "[int]リセット時間（UTC）",
      "repeat": "[string enum]繰り返し",
      "rewards": [
        {
          "acquireActions": [
            {
              "action": "[string]入手アクションで実行するアクションの種類",
              "request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
            }
          ]
        }
      ],
      "missedReceiveRelief": "[string enum]取り逃がし救済機能",
      "missedReceiveReliefVerifyActions": [
        {
          "action": "[string]検証アクションで実行するアクションの種類",
          "request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
        }
      ],
      "missedReceiveReliefConsumeActions": [
        {
          "action": "[string]消費アクションで実行するアクションの種類",
          "request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
        }
      ]
    }
  ]
}

モデル

BonusModel

ログインボーナスモデル

ログインボーナスモデルにはログインボーナスの配布スケジュールを設定します。
配布スケジュールには《スケジュールモード》と《ストリーミングモード》があります。

スケジュールモードでは、GS2-Schedule のイベントの指定が必須で、そのイベントの開始日からの経過日数でボーナスの配布を行います。
途中で撮り逃しが発生した場合、その分のボーナスは配布されません。

ストリーミングモードでは、毎日ボーナスに設定された報酬を先頭から順番に配布します。
ストリーミングモードでは繰り返しの設定が可能です。その場合、ストリームの終端に達した場合、先頭から再度配布を行います。

スケジュールモード・ストリーミングモード 共に、取り逃がしの救済機能があります。
一定のコストを支払うことで、取り逃がしたボーナスを受け取ることができます。
ただし、GS2-Schedule のイベントが関連づけられている場合、イベントの開始日からの経過日数より先のボーナスは受け取ることができません。
取り逃がし機能はストリーミングモードかつ繰り返しが有効な場合は使用することができません。

スケジュールモード・ストリーミングモード 共に、設定可能なボーナスの最大日数は100日です。

Reward

報酬

ログインボーナスの1日分の報酬設定を表します。
各 Reward にはユーザーが受け取るもの（アイテム、通貨、経験値など）を定義する入手アクションのリストが含まれます。
BonusModel の rewards 配列は1日あたり1つの Reward を保持し、順番に配布されます。
報酬の値はバフシステム（BonusModelBuff）を通じて実行時に変更でき、入手アクションにレート乗数を適用できます。

ConsumeAction

消費アクション

消費アクションの仕組みを通じてユーザーからリソースを消費するアクションを定義します。
取り逃がしボーナスの救済でユーザーが支払うコスト（通貨の差し引き、アイテムの消費など）を指定するために使用されます。
action フィールドは消費アクションの種類を指定し、request フィールドには対応するリクエストパラメータが含まれます。

VerifyAction

検証アクション

操作の実行前に条件を検証するアクションを定義します。
取り逃がしボーナスの救済で、救済を許可する前に前提条件（ユーザーの資格、リソースの利用可能性など）を確認するために使用されます。
action フィールドは検証アクションの種類を指定し、request フィールドには対応するリクエストパラメータが含まれます。

AcquireAction

入手アクション

入手アクションの仕組みを通じてユーザーにリソースを付与するアクションを定義します。
報酬内で使用され、ユーザーが受け取るもの（インベントリへのアイテム追加、通貨の付与、経験値の付与など）を指定します。
action フィールドは入手アクションの種類を指定し、request フィールドには対応するリクエストパラメータが含まれます。