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

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

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




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


**JSON**
```json
{
  "version": "2023-06-06",
  "categoryModels": [
    {
      "name": "[string]カテゴリーモデル名",
      "metadata": "[string?]メタデータ",
      "rewardIntervalMinutes": "[int]報酬間隔（分）",
      "defaultMaximumIdleMinutes": "[int]デフォルト最大放置時間（分）",
      "rewardResetMode": "[string (enum)]報酬リセットモード",
      "acquireActions": [
        {
          "acquireActions": [
            {
              "action": "[string]入手アクションで実行するアクションの種類",
              "request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
            }
          ]
        }
      ],
      "idlePeriodScheduleId": "[string?]放置期間スケジュールID",
      "receivePeriodScheduleId": "[string?]受取期間スケジュールID"
    }
  ]
}
```


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2023-06-06 | | マスターデータのフォーマットバージョン |
| categoryModels | [List&lt;CategoryModel&gt;](#categorymodel) |  |  |  |  ~ 100 items | カテゴリーモデル<br>カテゴリーモデルとは、放置報酬を得られる待機カテゴリーを設定するエンティティです。<br>設定には、待機時間ごとの報酬や、最大待機時間などの情報が含まれます。 |

## モデル

### CategoryModel

カテゴリーモデル<br>

カテゴリーモデルとは、放置報酬を得られる待機カテゴリーを設定するエンティティです。<br>
設定には、待機時間ごとの報酬や、最大待機時間などの情報が含まれます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| categoryModelId | string |  | ※ |  |  ~ 1024文字 | カテゴリーモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | カテゴリーモデル名<br>カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| rewardIntervalMinutes | int |  | ✓ |  | 0 ~ 2147483646 | 報酬間隔（分）<br>各放置報酬の間の時間間隔（分）です。例えば60に設定すると、ユーザーは放置時間60分ごとに1つの報酬ユニットを獲得します。報酬の総数は（経過放置分数）/ rewardIntervalMinutes として計算され、acquireActions配列を循環します。 |
| defaultMaximumIdleMinutes | int |  | ✓ |  | 0 ~ 2147483646 | デフォルト最大放置時間（分）<br>このカテゴリーの新しいステータスに対するデフォルトの最大放置時間（分）です。この制限を超える放置時間は追加の報酬を蓄積しません。この値はステータス作成時に各ステータスの maximumIdleMinutes にコピーされ、入手アクションを通じてユーザーごとに拡張できます。 |
| rewardResetMode | 文字列列挙型<br>enum {<br>"Reset",<br>"CarryOver"<br>}<br> |  |  | "Reset" |  | 報酬リセットモード<br>ユーザーが報酬を受け取った後の放置時間の扱いを決定します。「Reset」は放置時間をゼロに戻し、部分的な間隔時間は失われます。「CarryOver」は追加の報酬を得るに足りなかった残り時間を保持し、次の報酬サイクルにカウントされます。"Reset": 待機時間を0にリセット / "CarryOver": 報酬を得るに至らなかった残り時間を持ち越す /  |
| acquireActions | [List&lt;AcquireActionList&gt;](#acquireactionlist) |  |  | [] | 1 ~ 100 items | 待機時間ごとに得られる入手アクションリスト<br>待機時間を「X分」だと仮定すると<br>「X / rewardIntervalMinutes」が報酬を受け取れる数になりますが、ここで指定した配列の要素をループすることで、待機時間ごとに異なる報酬を付与できます。 |
| idlePeriodScheduleId | string |  |  |  |  ~ 1024文字 | 放置期間スケジュールID<br>放置時間が蓄積される期間を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ放置時間がカウントされます。イベントが繰り返される場合、ステータスは繰り返し回数を追跡し、新しいサイクルの開始時に放置時間をリセットして、イベント期間ごとに報酬が計算されるようにします。 |
| receivePeriodScheduleId | string |  |  |  |  ~ 1024文字 | 受取期間スケジュールID<br>ユーザーが蓄積された放置報酬を受け取れる時間枠を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ報酬の受け取りが受け付けられます。これにより、放置蓄積期間とは別の期間限定の報酬受取期間を設定できます。 |

---

### AcquireActionList

入手アクションリスト<br>

1つの報酬間隔で一括して付与される複数の入手アクションをグループ化するラッパーです。各 AcquireActionList はカテゴリーモデルの acquireActions 配列内の1つの報酬サイクルに対応し、各間隔で異なる報酬の組み合わせを設定できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| acquireActions | [List&lt;AcquireAction&gt;](#acquireaction) |  |  | [] | 0 ~ 100 items | 入手アクションリスト<br>この報酬間隔がトリガーされた時に一括で実行される入手アクションのコレクションです。複数のアクションを組み合わせて、1つの放置報酬サイクルで異なる種類の報酬を同時に付与できます。リストあたり最大100アクションです。 |

---

### AcquireAction

入手アクション<br>

放置報酬として使用される単一の入手アクションを表します。アクションタイプ（例：アイテム追加、通貨増加）とそのリクエストパラメータで構成されます。放置報酬が受け取られると、これらのアクションがトランザクションに組み立てられ、実行されてユーザーに報酬が配布されます。

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

---