GS2-Idle Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例
Tags:

エンティティ

Deploy処理で操作の対象となるリソース

Namespace

ネームスペース

ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

Request

リソースの生成・更新リクエスト

型有効化条件必須デフォルト値の制限説明
namestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
descriptionstring~ 1024文字説明文
transactionSettingTransactionSetting
✓
トランザクション設定
放置報酬の付与時のトランザクションの処理方法を制御する設定です。
receiveScriptScriptSetting報酬を受け取ったときに実行するスクリプトの設定
Script トリガーリファレンス - receive
overrideAcquireActionsScriptIdstring~ 1024文字放置報酬の入手アクションを動的に決定するスクリプト GRN
logSettingLogSettingログの出力設定
放置報酬操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。放置ステータスの作成、報酬の受け取り、タイミング問題のデバッグに役立ちます。

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemNamespace作成したネームスペース

実装例

Type: GS2::Idle::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  ReceiveScript: null
  OverrideAcquireActionsScriptId: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/idle"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
idle.NewNamespace(
    &SampleStack,
    "namespace-0001",
    idle.NamespaceOptions{
        TransactionSetting: core.NewTransactionSetting(
            core.TransactionSettingOptions{
                QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
            },
        ),
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(SampleStack.Yaml())  // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Idle\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Idle\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    new \Gs2Cdk\Core\Model\TransactionSettingOptions(
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    )
                ),
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            )
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.idle.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.idle.model.options.NamespaceOptions()
                        .withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
                            new io.gs2.cdk.core.model.options.TransactionSettingOptions()
                                .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
                        ))
                        .withLogSetting(new io.gs2.cdk.core.model.LogSetting(
                            "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                        ))
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Idle.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Idle.Model.Options.NamespaceOptions
            {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    options: new Gs2Cdk.Core.Model.TransactionSettingOptions
                    {
                        queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template
import core from "@/gs2cdk/core";
import idle from "@/gs2cdk/idle";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new idle.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    {
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
from gs2_cdk import Stack, core, idle

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        idle.Namespace(
            stack=self,
            name='namespace-0001',
            options=idle.NamespaceOptions(
                transaction_setting=core.TransactionSetting(
                    options=core.TransactionSettingOptions(
                        queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                    )
                ),
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template

TransactionSetting

トランザクション設定

トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。

型有効化条件必須デフォルト値の制限説明
enableAutoRunboolfalse発行したトランザクションをサーバーサイドで自動的に実行するか
enableAtomicCommitbool{enableAutoRun} == truefalseトランザクションの実行をアトミックにコミットするか
※ enableAutoRun が true であれば 有効
transactionUseDistributorbool{enableAtomicCommit} == truefalseトランザクションを非同期処理で実行する
※ enableAtomicCommit が true であれば 有効
commitScriptResultInUseDistributorbool{transactionUseDistributor} == truefalseスクリプトの結果コミット処理を非同期処理で実行するか
※ transactionUseDistributor が true であれば 有効
acquireActionUseJobQueuebool{enableAtomicCommit} == truefalse入手アクションを実行する際に GS2-JobQueue を使用するか
※ enableAtomicCommit が true であれば 有効
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字トランザクションの実行に使用する GS2-Distributor ネームスペース GRN
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字トランザクションの実行に使用する GS2-JobQueue のネームスペース GRN

ScriptSetting

スクリプト設定

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。

一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

型有効化条件必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字API 実行時に同期的に実行される GS2-Script のスクリプト GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。
doneTriggerTargetType文字列列挙型
enum {
  “none”,
  “gs2_script”,
  “aws”
}
“none”非同期スクリプトの実行方法
非同期実行で使用するスクリプトの種類を指定します。
「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。
定義説明
“none”なし
“gs2_script”GS2-Script
“aws”Amazon EventBridge
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字非同期実行する GS2-Script スクリプト GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。
※ doneTriggerTargetType が “gs2_script” であれば 有効
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字非同期実行スクリプトを実行する GS2-JobQueue ネームスペース GRN
非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。
GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。
※ doneTriggerTargetType が “gs2_script” であれば 有効

LogSetting

ログの出力設定

ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

型有効化条件必須デフォルト値の制限説明
loggingNamespaceIdstring
✓
~ 1024文字ログを出力する GS2-Log のネームスペース GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

CurrentCategoryMaster

現在アクティブなカテゴリーモデルのマスターデータ

現在ネームスペース内で有効な、カテゴリーモデルの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

Request

リソースの生成・更新リクエスト

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
mode文字列列挙型
enum {
  “direct”,
  “preUpload”
}
“direct”更新モード
定義説明
“direct”マスターデータを直接更新
“preUpload”マスターデータをアップロードしてから更新
settingsstring{mode} == “direct”
✓※
~ 5242880文字マスターデータ
※ mode が “direct” であれば必須
uploadTokenstring{mode} == “preUpload”
✓※
~ 1024文字事前アップロードで取得したトークン
アップロードしたマスターデータを適用するために使用されます。
※ mode が “preUpload” であれば必須

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemCurrentCategoryMaster更新された現在アクティブなカテゴリーモデルのマスターデータ

実装例

Type: GS2::Idle::CurrentCategoryMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2023-06-06",
    "categoryModels": [
      {
        "name": "category-0001",
        "rewardIntervalMinutes": 5,
        "defaultMaximumIdleMinutes": 1440,
        "rewardResetMode": "Reset",
        "acquireActions": [
          {
            "acquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": {
                  "namespaceName": "namespace-0001",
                  "experienceName": "player",
                  "userId": "#{userId}",
                  "propertyId": "player",
                  "experienceValue": 10
                }
              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": {
                  "namespaceName": "namespace-0001",
                  "experienceName": "player",
                  "userId": "#{userId}",
                  "propertyId": "player",
                  "experienceValue": 5
                }
              }
            ]
          }
        ]
      },
      {
        "name": "category-0002",
        "rewardIntervalMinutes": 5,
        "defaultMaximumIdleMinutes": 1440,
        "acquireActions": [
          {
            "acquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": {
                  "namespaceName": "namespace-0001",
                  "experienceName": "player",
                  "userId": "#{userId}",
                  "propertyId": "player",
                  "experienceValue": 10
                }
              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": {
                  "namespaceName": "namespace-0001",
                  "experienceName": "player",
                  "userId": "#{userId}",
                  "propertyId": "player",
                  "experienceValue": 5
                }
              }
            ]
          }
        ],
        "idlePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
        "receivePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
      }
    ]
  }
  UploadToken: null
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/idle"
    "github.com/gs2io/gs2-golang-cdk/experience"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
idle.NewNamespace(
    &SampleStack,
    "namespace-0001",
    idle.NamespaceOptions{},
).MasterData(
    []idle.CategoryModel{
        idle.NewCategoryModel(
            "category-0001",
            5,
            1440,
            idle.CategoryModelRewardResetModeReset,
            []idle.AcquireActionList{
                idle.NewAcquireActionList(
                    idle.AcquireActionListOptions{
                        AcquireActions: []core.AcquireAction{
                            experience.AddExperienceByUserId(
                                "namespace-0001",
                                "player",
                                "player",
                                pointy.Int64(30),
                                pointy.Bool(false),
                            ),
                        },
                    },
                ),
                idle.NewAcquireActionList(
                    idle.AcquireActionListOptions{
                        AcquireActions: []core.AcquireAction{
                            experience.AddExperienceByUserId(
                                "namespace-0001",
                                "player",
                                "player",
                                pointy.Int64(30),
                                pointy.Bool(false),
                            ),
                        },
                    },
                ),
            },
            idle.CategoryModelOptions{
            },
        ),
        idle.NewCategoryModel(
            "category-0002",
            5,
            1440,
            idle.CategoryModelRewardResetModeReset,
            []idle.AcquireActionList{
                idle.NewAcquireActionList(
                    idle.AcquireActionListOptions{
                        AcquireActions: []core.AcquireAction{
                            experience.AddExperienceByUserId(
                                "namespace-0001",
                                "player",
                                "player",
                                pointy.Int64(30),
                                pointy.Bool(false),
                            ),
                        },
                    },
                ),
                idle.NewAcquireActionList(
                    idle.AcquireActionListOptions{
                        AcquireActions: []core.AcquireAction{
                            experience.AddExperienceByUserId(
                                "namespace-0001",
                                "player",
                                "player",
                                pointy.Int64(30),
                                pointy.Bool(false),
                            ),
                        },
                    },
                ),
            },
            idle.CategoryModelOptions{
                IdlePeriodScheduleId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"),
                ReceivePeriodScheduleId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"),
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Idle\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Idle\Model\CategoryModel(
                    name:"category-0001",
                    rewardIntervalMinutes:5,
                    defaultMaximumIdleMinutes:1440,
                    rewardResetMode: \Gs2Cdk\Idle\Model\Enums\CategoryModelRewardResetMode::RESET,
                    acquireActions:[
                        new \Gs2Cdk\Idle\Model\AcquireActionList(
                            options: new \Gs2Cdk\Idle\Model\Options\AcquireActionListOptions(
                                acquireActions: [
                                    new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 10,
                                    ),
                                ],
                            ),
                        ),
                        new \Gs2Cdk\Idle\Model\AcquireActionList(
                            options: new \Gs2Cdk\Idle\Model\Options\AcquireActionListOptions(
                                acquireActions: [
                                    new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 5,
                                    ),
                                ],
                            ),
                        ),
                    ]
                ),
                new \Gs2Cdk\Idle\Model\CategoryModel(
                    name:"category-0002",
                    rewardIntervalMinutes:5,
                    defaultMaximumIdleMinutes:1440,
                    rewardResetMode: \Gs2Cdk\Idle\Model\Enums\CategoryModelRewardResetMode::RESET,
                    acquireActions:[
                        new \Gs2Cdk\Idle\Model\AcquireActionList(
                            options: new \Gs2Cdk\Idle\Model\Options\AcquireActionListOptions(
                                acquireActions: [
                                    new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 10,
                                    ),
                                ],
                            ),
                        ),
                        new \Gs2Cdk\Idle\Model\AcquireActionList(
                            options: new \Gs2Cdk\Idle\Model\Options\AcquireActionListOptions(
                                acquireActions: [
                                    new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 5,
                                    ),
                                ],
                            ),
                        ),
                    ],
                    options: new \Gs2Cdk\Idle\Model\Options\CategoryModelOptions(
                        idlePeriodScheduleId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
                        receivePeriodScheduleId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.idle.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.idle.model.CategoryModel(
                    "category-0001",
                    5,
                    1440,
                    io.gs2.cdk.idle.model.enums.CategoryModelRewardResetMode.RESET,
                    Arrays.asList(
                        new io.gs2.cdk.idle.model.AcquireActionList(
                            new io.gs2.cdk.idle.model.options.AcquireActionListOptions()
                                .withAcquireActions(Arrays.asList(
                                    new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30L,
                                        false,
                                        "#{userId}")
                                ))
                        ),
                        new io.gs2.cdk.idle.model.AcquireActionList(
                            new io.gs2.cdk.idle.model.options.AcquireActionListOptions()
                                .withAcquireActions(Arrays.asList(
                                    new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30L,
                                        false,
                                        "#{userId}")
                                ))
                        )
                    )
                ),
                new io.gs2.cdk.idle.model.CategoryModel(
                    "category-0002",
                    5,
                    1440,
                    io.gs2.cdk.idle.model.enums.CategoryModelRewardResetMode.RESET,
                    Arrays.asList(
                        new io.gs2.cdk.idle.model.AcquireActionList(
                            new io.gs2.cdk.idle.model.options.AcquireActionListOptions()
                                .withAcquireActions(Arrays.asList(
                                    new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30L,
                                        false,
                                        "#{userId}")
                                ))
                        ),
                        new io.gs2.cdk.idle.model.AcquireActionList(
                            new io.gs2.cdk.idle.model.options.AcquireActionListOptions()
                                .withAcquireActions(Arrays.asList(
                                    new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30L,
                                        false,
                                        "#{userId}")
                                ))
                        )
                    ),
                    new io.gs2.cdk.idle.model.options.CategoryModelOptions()
                        .withIdlePeriodScheduleId("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001")
                        .withReceivePeriodScheduleId("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002")
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Idle.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Idle.Model.CategoryModel[] {
                new Gs2Cdk.Gs2Idle.Model.CategoryModel(
                    name: "category-0001",
                    rewardIntervalMinutes: 5,
                    defaultMaximumIdleMinutes: 1440,
                    rewardResetMode: Gs2Cdk.Gs2Idle.Model.Enums.CategoryModelRewardResetMode.Reset,
                    acquireActions: new Gs2Cdk.Gs2Idle.Model.AcquireActionList[]
                    {
                        new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
                            options: new Gs2Cdk.Gs2Idle.Model.Options.AcquireActionListOptions
                            {
                                acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 10
                                    )
                                }
                            }
                        ),
                        new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
                            options: new Gs2Cdk.Gs2Idle.Model.Options.AcquireActionListOptions
                            {
                                acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 5
                                    )
                                }
                            }
                        )
                    }
                ),
                new Gs2Cdk.Gs2Idle.Model.CategoryModel(
                    name: "category-0002",
                    rewardIntervalMinutes: 5,
                    defaultMaximumIdleMinutes: 1440,
                    rewardResetMode: Gs2Cdk.Gs2Idle.Model.Enums.CategoryModelRewardResetMode.Reset,
                    acquireActions: new Gs2Cdk.Gs2Idle.Model.AcquireActionList[]
                    {
                        new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
                            options: new Gs2Cdk.Gs2Idle.Model.Options.AcquireActionListOptions
                            {
                                acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 10
                                    )
                                }
                            }
                        ),
                        new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
                            options: new Gs2Cdk.Gs2Idle.Model.Options.AcquireActionListOptions
                            {
                                acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 5
                                    )
                                }
                            }
                        )
                    },
                    options: new Gs2Cdk.Gs2Idle.Model.Options.CategoryModelOptions
                    {
                        idlePeriodScheduleId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
                        receivePeriodScheduleId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template
import core from "@/gs2cdk/core";
import idle from "@/gs2cdk/idle";
import experience from "@/gs2cdk/experience";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new idle.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new idle.model.CategoryModel(
                    "category-0001",
                    5,
                    1440,
                    idle.model.CategoryModelRewardResetMode.RESET,
                    [
                        new idle.model.AcquireActionList(
                            {
                                acquireActions: [
                                    new experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30,
                                        null,
                                        null,
                                        "#{userId}"
                                    ),
                                ]
                            }
                        ),
                        new idle.model.AcquireActionList(
                            {
                                acquireActions: [
                                    new experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30,
                                        null,
                                        null,
                                        "#{userId}"
                                    ),
                                ]
                            }
                        ),
                    ]
                ),
                new idle.model.CategoryModel(
                    "category-0002",
                    5,
                    1440,
                    idle.model.CategoryModelRewardResetMode.RESET,
                    [
                        new idle.model.AcquireActionList(
                            {
                                acquireActions: [
                                    new experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30,
                                        null,
                                        null,
                                        "#{userId}"
                                    ),
                                ]
                            }
                        ),
                        new idle.model.AcquireActionList(
                            {
                                acquireActions: [
                                    new experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30,
                                        null,
                                        null,
                                        "#{userId}"
                                    ),
                                ]
                            }
                        ),
                    ],
                    {
                        idlePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
                        receivePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
from gs2_cdk import Stack, core, idle, experience

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        idle.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            category_models=[
                idle.CategoryModel(
                    name='category-0001',
                    reward_interval_minutes=5,
                    default_maximum_idle_minutes=1440,
                    reward_reset_mode=idle.CategoryModelRewardResetMode.RESET,
                    acquire_actions=[
                        idle.AcquireActionList(
                            options=idle.AcquireActionListOptions(
                                acquire_actions=[
                                    experience.AddExperienceByUserId(
                                        namespace_name='namespace-0001',
                                        experience_name='player',
                                        user_id='#{userId}',
                                        property_id='player',
                                        experience_value=10
                                    ),
                                ],
                            ),
                        ),
                        idle.AcquireActionList(
                            options=idle.AcquireActionListOptions(
                                acquire_actions=[
                                    experience.AddExperienceByUserId(
                                        namespace_name='namespace-0001',
                                        experience_name='player',
                                        user_id='#{userId}',
                                        property_id='player',
                                        experience_value=5
                                    ),
                                ],
                            ),
                        ),
                    ]
                ),
                idle.CategoryModel(
                    name='category-0002',
                    reward_interval_minutes=5,
                    default_maximum_idle_minutes=1440,
                    reward_reset_mode=idle.CategoryModelRewardResetMode.RESET,
                    acquire_actions=[
                        idle.AcquireActionList(
                            options=idle.AcquireActionListOptions(
                                acquire_actions=[
                                    experience.AddExperienceByUserId(
                                        namespace_name='namespace-0001',
                                        experience_name='player',
                                        user_id='#{userId}',
                                        property_id='player',
                                        experience_value=10
                                    ),
                                ],
                            ),
                        ),
                        idle.AcquireActionList(
                            options=idle.AcquireActionListOptions(
                                acquire_actions=[
                                    experience.AddExperienceByUserId(
                                        namespace_name='namespace-0001',
                                        experience_name='player',
                                        user_id='#{userId}',
                                        property_id='player',
                                        experience_value=5
                                    ),
                                ],
                            ),
                        ),
                    ],
                    options=idle.CategoryModelOptions(
                        idle_period_schedule_id = 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001',
                        receive_period_schedule_id = 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002'
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template

CategoryModel

カテゴリーモデル

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

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

AcquireActionList

入手アクションリスト

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

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

AcquireAction

入手アクション

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

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