> For the complete documentation index, see [llms.txt](/llms.txt)

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

マスターデータのフォーマットと インポートする各種モデルのリファレンス




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


**JSON**
```json
{
  "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文字列"
        }
      ]
    }
  ]
}
```


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2023-07-11 | | マスターデータのフォーマットバージョン |
| bonusModels | [List&lt;BonusModel&gt;](#bonusmodel) |  |  |  |  ~ 100 items | ログインボーナスモデル<br>ログインボーナスモデルにはログインボーナスの配布スケジュールを設定します。<br>配布スケジュールには《スケジュールモード》と《ストリーミングモード》があります。<br><br>スケジュールモードでは、GS2-Schedule のイベントの指定が必須で、そのイベントの開始日からの経過日数でボーナスの配布を行います。<br>途中で取り逃がしが発生した場合、その分のボーナスは配布されません。<br><br>ストリーミングモードでは、毎日ボーナスに設定された報酬を先頭から順番に配布します。<br>ストリーミングモードでは繰り返しの設定が可能です。その場合、ストリームの終端に達した場合、先頭から再度配布を行います。<br><br>スケジュールモード・ストリーミングモード 共に、取り逃がしの救済機能があります。<br>一定のコストを支払うことで、取り逃がしたボーナスを受け取ることができます。<br>ただし、GS2-Schedule のイベントが関連づけられている場合、イベントの開始日からの経過日数より先のボーナスは受け取ることができません。<br>取り逃がし救済機能はストリーミングモードかつ繰り返しが有効な場合は使用することができません。<br><br>スケジュールモード・ストリーミングモード 共に、設定可能なボーナスの最大日数は100日です。 |

## モデル

### BonusModel

ログインボーナスモデル<br>

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

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

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

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

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| bonusModelId | string |  | ※ |  |  ~ 1024文字 | ログインボーナスモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | ログインボーナスモデル名<br>ログインボーナスモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| mode | 文字列列挙型<br>enum {<br>"schedule",<br>"streaming"<br>}<br> |  | ✓ |  |  | モード<br>ログインボーナスの配布スケジュールの種類を指定します。<br>「schedule」モードでは、GS2-Schedule のイベント開始日からの経過日数に基づいて報酬が配布されます。<br>「streaming」モードでは、カレンダーの日付に関係なく、毎日先頭から順番に報酬が配布されます。"schedule": スケジュールモード / "streaming": ストリーミングモード /  |
| periodEventId | string |  |  |  |  ~ 1024文字 | 期間イベントGRN<br>ログインボーナスを有効化する期間を表す GS2-Schedule のイベントGRN。<br>スケジュールモードでは必須で、報酬配布の経過日数を計算する起点の開始日を決定します。<br>ストリーミングモードでは省略可能ですが、指定した場合はイベント開始日からの経過日数より先のボーナスは受け取れなくなります。 |
| resetHour | int | {periodEventId} == "" | ✓※ |  | 0 ~ 23 | リセット時間（UTC）<br>受け取りフラグがリセットされる時刻（0-23、UTC）。<br>ログインボーナスにおける日付の切り替わりタイミングを決定します。<br>periodEventId が未指定の場合にのみ必要です。イベントが設定されている場合、リセットタイミングはイベントのスケジュールに従います。<br>※ periodEventId が "" であれば 必須 |
| repeat | 文字列列挙型<br>enum {<br>"enabled",<br>"disabled"<br>}<br> | {mode} == "streaming" | ✓※ |  |  | 繰り返し<br>全ての報酬を配布し終えた後に、先頭から再度配布を行うかどうか。<br>ストリーミングモードでのみ有効です。有効にすると、最後の報酬を配布した後に最初の報酬に戻ってループします。<br>注意: 繰り返しが有効な場合、取り逃がし救済機能は使用できません。"enabled": 有効 / "disabled": 無効 / <br>※ mode が "streaming" であれば 必須 |
| rewards | [List&lt;Reward&gt;](#reward) |  |  |  | 0 ~ 100 items | 報酬リスト<br>日毎の報酬の順序付きリスト。各エントリは1日分のログインボーナスに対応し、インデックス 0 から順に配布されます。<br>スケジュールモードでは、インデックスはイベント開始日からの経過日数に対応します。<br>ストリーミングモードでは、インデックスはログイン日数に対応します。最大100エントリまで設定可能です。 |
| missedReceiveRelief | 文字列列挙型<br>enum {<br>"enabled",<br>"disabled"<br>}<br> |  |  | "disabled" |  | 取り逃がし救済機能<br>取り逃がしたボーナスの救済機能を有効にするかどうか。有効にすると、ユーザーは指定されたコスト（消費アクション）を支払うことで、受け取り損ねたボーナスを遡って受け取ることができます。<br>任意で、救済の許可前に条件を確認する検証アクションも設定できます。<br>ストリーミングモードかつ繰り返しが有効な場合は使用できません。デフォルトは「disabled」です。"enabled": 有効 / "disabled": 無効 /  |
| missedReceiveReliefVerifyActions | [List&lt;VerifyAction&gt;](#verifyaction) | {missedReceiveRelief} == "enabled" |  | [] | 0 ~ 10 items | 取り逃がし救済の検証アクションリスト<br>取り逃がし救済を許可する前に実行される検証アクションのリスト。<br>救済処理の前にユーザーの資格などの前提条件をチェックします。最大10個まで設定できます。<br>missedReceiveRelief が有効な場合にのみ適用されます。<br>※ missedReceiveRelief が "enabled" であれば 有効 |
| missedReceiveReliefConsumeActions | [List&lt;ConsumeAction&gt;](#consumeaction) | {missedReceiveRelief} == "enabled" |  | [] | 0 ~ 10 items | 取り逃がし救済の消費アクションリスト<br>取り逃がしたボーナスを救済するためにユーザーが支払うコストを定義する消費アクションのリスト。<br>例えば、ゲーム内通貨やアイテムを救済コストとして消費するよう設定できます。最大10個まで設定できます。<br>missedReceiveRelief が有効な場合にのみ適用されます。<br>※ missedReceiveRelief が "enabled" であれば 有効 |

---

### Reward

報酬<br>

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| acquireActions | [List&lt;AcquireAction&gt;](#acquireaction) |  | ✓ |  | 1 ~ 10 items | 入手アクションリスト<br>この日の報酬としてユーザーに付与されるリソースを定義する入手アクションのリスト。<br>各アクションは入手アクション（アイテム追加、通貨付与など）とそのリクエストパラメータを指定します。<br>報酬あたり最低1個、最大10個のアクションを設定できます。 |

---

### ConsumeAction

消費アクション<br>

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| action | 文字列列挙型<br>enum {<br>}<br> |  | ✓ |  |  | 消費アクションで実行するアクションの種類 |
| request | string |  | ✓ |  |  ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |

---

### VerifyAction

検証アクション<br>

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| action | 文字列列挙型<br>enum {<br>}<br> |  | ✓ |  |  | 検証アクションで実行するアクションの種類 |
| request | string |  | ✓ |  |  ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |

---

### AcquireAction

入手アクション<br>

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| action | 文字列列挙型<br>enum {<br>}<br> |  | ✓ |  |  | 入手アクションで実行するアクションの種類 |
| request | string |  | ✓ |  |  ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |

---