GS2-Idle マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
{
  "version": "2023-06-06",
  "categoryModels": [
    {
      "name": "[string]カテゴリーモデル名",
      "metadata": "[string?]メタデータ",
      "rewardIntervalMinutes": "[int]待機報酬が得られる間隔(分)",
      "defaultMaximumIdleMinutes": "[int]待機報酬が得られる最大時間(分)",
      "rewardResetMode": "[string]報酬受け取り後の待機時間のリセット方針",
      "acquireActions": [
        {
          "acquireActions": [
            {
              "action": "[string]入手アクションで実行するアクションの種類",
              "request": "[string]リクエストのJSON"
            }
          ]
        }
      ],
      "idlePeriodScheduleId": "[string?]放置報酬計算に使用される期間を設定した GS2-Schedule イベントGRN",
      "receivePeriodScheduleId": "[string?]放置報酬を受け取れる期間を設定した GS2-Schedule イベントGRN"
    }
  ]
}
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| version | ✓ | 2023-06-06 | マスターデータのフォーマットバージョン | |||
| categoryModels | List<CategoryModel> | ~ 100 items | カテゴリーモデルマスター | 
CategoryModel
カテゴリーモデルマスター
カテゴリーモデルとは、放置報酬を得られる待機カテゴリーの設定するエンティティです。
設定には、待機時間ごとの報酬や、最大待機時間などの情報が含まれます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| categoryModelId | string | ✓ | ~ 1024文字 | カテゴリーモデルGRN | ||||||||
| name | string | ✓ | ~ 128文字 | カテゴリーモデル名 | ||||||||
| metadata | string | ~ 2048文字 | メタデータ | |||||||||
| rewardIntervalMinutes | int | ✓ | 0 ~ 2147483646 | 待機報酬が得られる間隔(分) | ||||||||
| defaultMaximumIdleMinutes | int | ✓ | 0 ~ 2147483646 | 待機報酬が得られる最大時間(分) | ||||||||
| rewardResetMode | 文字列列挙型 enum { “Reset”, “CarryOver” } | ✓ | “Reset” | ~ 128文字 | 報酬受け取り後の待機時間のリセット方針 
 | |||||||
| acquireActions | List<AcquireActionList> | ✓ | [] | 1 ~ 100 items | 待機時間ごとに得られる入手アクションリスト | |||||||
| idlePeriodScheduleId | string | ~ 1024文字 | 放置報酬計算に使用される期間を設定した GS2-Schedule イベントGRN | |||||||||
| receivePeriodScheduleId | string | ~ 1024文字 | 放置報酬を受け取れる期間を設定した GS2-Schedule イベントGRN | 
VerifyActionResult
検証アクションの実行結果
ConsumeActionResult
消費アクションの実行結果
AcquireActionResult
入手アクションの実行結果
TransactionResult
トランザクション実行結果
サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| transactionId | string | ✓ | 36 ~ 36文字 | トランザクションID | ||
| verifyResults | List<VerifyActionResult> | 0 ~ 10 items | 検証アクションの実行結果リスト | |||
| consumeResults | List<ConsumeActionResult> | [] | 0 ~ 10 items | 消費アクションの実行結果リスト | ||
| acquireResults | List<AcquireActionResult> | [] | 0 ~ 100 items | 入手アクションの実行結果リスト | ||
| hasError | bool | ✓ | false | トランザクション実行中にエラーが発生したかどうか | 
AcquireAction
入手アクション
AcquireActionList
入手アクションリスト
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| acquireActions | List<AcquireAction> | [] | 0 ~ 100 items | 入手アクションリスト |