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

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

エンティティ

Deploy処理で操作する対象リソース

Namespace

ネームスペース

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

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

型有効化条件必須デフォルト値の制限説明
namespaceIdstring
✓
~ 1024文字ネームスペース GRN
namestring
✓
~ 128文字ネームスペース名
descriptionstring~ 1024文字説明文
transactionSettingTransactionSetting
✓
トランザクション設定
receiveScriptScriptSetting報酬を受け取る時に実行するスクリプト
logSettingLogSettingログの出力設定
createdAtlong
✓
現在時刻作成日時
UNIX 時間・ミリ秒
サーバー側で自動的に設定
updatedAtlong
✓
現在時刻最終更新日時
UNIX 時間・ミリ秒
サーバー側で自動的に設定
revisionlong00 ~ 9223372036854775805リビジョン

GetAttr

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

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

実装例

Type: GS2::LoginReward::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  ReceiveScript: 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/loginReward"
    "github.com/gs2io/gs2-golang-cdk/money"
    "github.com/gs2io/gs2-golang-cdk/stamina"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
loginReward.NewNamespace(
    &SampleStack,
    "namespace-0001",
    loginReward.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\LoginReward\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\LoginReward\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.loginReward.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.loginReward.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.Gs2LoginReward.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2LoginReward.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 loginReward from "@/gs2cdk/loginReward";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new loginReward.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, login_reward

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        login_reward.Namespace(
            stack=self,
            name='namespace-0001',
            options=login_reward.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）、非同期実行（Distributor）、スクリプト結果の一括適用、JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。

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

ScriptSetting

スクリプト設定

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

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

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

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

型有効化条件必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字同期実行スクリプトの 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

CurrentBonusMaster

現在有効なマスターデータ

GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

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

型有効化条件必須デフォルト値の制限説明
namespaceIdstring
✓
~ 1024文字ネームスペース GRN
settingsstring
✓
~ 5242880 バイト (5MB)マスターデータ

GetAttr

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

型説明
ItemCurrentBonusMaster更新した現在有効なボーナスモデルマスター

実装例

Type: GS2::LoginReward::CurrentBonusMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2023-07-11",
    "bonusModels": [
      {
        "name": "schedule",
        "mode": "schedule",
        "missedReceiveRelief": "disabled",
        "periodEventId": "grn:gs2:schedule:grn-0001",
        "rewards": [
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": {
                  "namespaceName": "stamina-0001",
                  "staminaName": "quest",
                  "userId": "#{userId}",
                  "recoverValue": 100
                }
              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": {
                  "namespaceName": "stamina-0001",
                  "staminaName": "quest",
                  "userId": "#{userId}",
                  "recoverValue": 100
                }
              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": {
                  "namespaceName": "stamina-0001",
                  "staminaName": "quest",
                  "userId": "#{userId}",
                  "recoverValue": 100
                }
              }
            ]
          }
        ]
      },
      {
        "name": "streaming",
        "mode": "streaming",
        "missedReceiveRelief": "enabled",
        "resetHour": 15,
        "repeat": "enabled",
        "rewards": [
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": {
                  "namespaceName": "stamina-0001",
                  "staminaName": "quest",
                  "userId": "#{userId}",
                  "recoverValue": 100
                }
              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": {
                  "namespaceName": "stamina-0001",
                  "staminaName": "quest",
                  "userId": "#{userId}",
                  "recoverValue": 100
                }
              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Stamina:RecoverStaminaByUserId",
                "request": {
                  "namespaceName": "stamina-0001",
                  "staminaName": "quest",
                  "userId": "#{userId}",
                  "recoverValue": 100
                }
              }
            ]
          }
        ],
        "missedReceiveReliefConsumeActions": [
          {
            "action": "Gs2Money:WithdrawByUserId",
            "request": {
              "namespaceName": "money-0001",
              "userId": "#{userId}",
              "slot": 0,
              "count": 200,
              "paidOnly": false
            }
          }
        ]
      }
    ]
  }
  UploadToken: null
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/loginReward"
    "github.com/gs2io/gs2-golang-cdk/money"
    "github.com/gs2io/gs2-golang-cdk/stamina"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
loginReward.NewNamespace(
    &SampleStack,
    "namespace-0001",
    loginReward.NamespaceOptions{},
).MasterData(
    []loginReward.BonusModel{
        loginReward.NewBonusModel(
            "schedule",
            loginReward.BonusModelModeSchedule,
            loginReward.BonusModelMissedReceiveReliefDisabled,
            loginReward.BonusModelOptions{
                PeriodEventId: pointy.String("grn:gs2:schedule:grn-0001"),
                Rewards: []loginReward.Reward{
                    loginReward.NewReward(
                        []core.AcquireAction{
                            stamina.RecoverStaminaByUserId(
                                "namespace-0001",
                                "quest",
                                5,
                            ),
                        },
                        loginReward.RewardOptions{},
                    ),
                    loginReward.NewReward(
                        []core.AcquireAction{
                            stamina.RecoverStaminaByUserId(
                                "namespace-0001",
                                "quest",
                                5,
                            ),
                        },
                        loginReward.RewardOptions{},
                    ),
                    loginReward.NewReward(
                        []core.AcquireAction{
                            stamina.RecoverStaminaByUserId(
                                "namespace-0001",
                                "quest",
                                5,
                            ),
                        },
                        loginReward.RewardOptions{},
                    ),
                },
            },
        ),
        loginReward.NewBonusModel(
            "streaming",
            loginReward.BonusModelModeStreaming,
            loginReward.BonusModelMissedReceiveReliefEnabled,
            loginReward.BonusModelOptions{
                ResetHour: pointy.Int32(15),
                Repeat: loginReward.BonusModelRepeatEnabled.Pointer(),
                Rewards: []loginReward.Reward{
                    loginReward.NewReward(
                        []core.AcquireAction{
                            stamina.RecoverStaminaByUserId(
                                "namespace-0001",
                                "quest",
                                5,
                            ),
                        },
                        loginReward.RewardOptions{},
                    ),
                    loginReward.NewReward(
                        []core.AcquireAction{
                            stamina.RecoverStaminaByUserId(
                                "namespace-0001",
                                "quest",
                                5,
                            ),
                        },
                        loginReward.RewardOptions{},
                    ),
                    loginReward.NewReward(
                        []core.AcquireAction{
                            stamina.RecoverStaminaByUserId(
                                "namespace-0001",
                                "quest",
                                5,
                            ),
                        },
                        loginReward.RewardOptions{},
                    ),
                },
                MissedReceiveReliefConsumeActions: []core.ConsumeAction{
                    money.WithdrawByUserId(
                        "namespace-0001",
                        0,
                        1,
                        pointy.Bool(false),
                    ),
                },
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\LoginReward\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\LoginReward\Model\BonusModel(
                    name:"schedule",
                    mode: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMode::SCHEDULE,
                    missedReceiveRelief: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMissedReceiveRelief::DISABLED,
                    options: new \Gs2Cdk\LoginReward\Model\Options\BonusModelOptions(
                        periodEventId:"grn:gs2:schedule:grn-0001",
                        rewards:[
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100,
                                    ),
                                ],    
                            ),
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100,
                                    ),
                                ],    
                            ),
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100,
                                    ),
                                ],    
                            ),
                        ]
                    )
                ),
                new \Gs2Cdk\LoginReward\Model\BonusModel(
                    name:"streaming",
                    mode: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMode::STREAMING,
                    missedReceiveRelief: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMissedReceiveRelief::ENABLED,
                    options: new \Gs2Cdk\LoginReward\Model\Options\BonusModelOptions(
                        resetHour:15,
                        repeat:Gs2Cdk\LoginReward\Model\Enums\BonusModelRepeat::ENABLED,
                        rewards:[
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100,
                                    ),
                                ],    
                            ),
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100,
                                    ),
                                ],    
                            ),
                            new \Gs2Cdk\LoginReward\Model\Reward(
                                acquireActions: [
                                    new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100,
                                    ),
                                ],    
                            ),
                        ],
                        missedReceiveReliefConsumeActions:[
                            new \Gs2Cdk\Money\StampSheet\WithdrawByUserId(
                                namespaceName: "money-0001",
                                userId: "#{userId}",
                                slot: 0,
                                count: 200,
                                paidOnly: False,
                            ),
                        ]
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.loginReward.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.loginReward.model.BonusModel(
                    "schedule",
                    io.gs2.cdk.loginReward.model.enums.BonusModelMode.SCHEDULE,
                    io.gs2.cdk.loginReward.model.enums.BonusModelMissedReceiveRelief.DISABLED,
                    new io.gs2.cdk.loginReward.model.options.BonusModelOptions()
                        .withPeriodEventId("grn:gs2:schedule:grn-0001")
                        .withRewards(Arrays.asList(
                            new io.gs2.cdk.loginReward.model.Reward(
                                Arrays.asList(
                                    new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        "#{userId}")
                                )        
                            ),
                            new io.gs2.cdk.loginReward.model.Reward(
                                Arrays.asList(
                                    new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        "#{userId}")
                                )        
                            ),
                            new io.gs2.cdk.loginReward.model.Reward(
                                Arrays.asList(
                                    new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        "#{userId}")
                                )        
                            )
                        ))
                ),
                new io.gs2.cdk.loginReward.model.BonusModel(
                    "streaming",
                    io.gs2.cdk.loginReward.model.enums.BonusModelMode.STREAMING,
                    io.gs2.cdk.loginReward.model.enums.BonusModelMissedReceiveRelief.ENABLED,
                    new io.gs2.cdk.loginReward.model.options.BonusModelOptions()
                        .withResetHour(15)
                        .withRepeat(io.gs2.cdk.loginReward.model.enums.BonusModelRepeat.ENABLED)
                        .withRewards(Arrays.asList(
                            new io.gs2.cdk.loginReward.model.Reward(
                                Arrays.asList(
                                    new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        "#{userId}")
                                )        
                            ),
                            new io.gs2.cdk.loginReward.model.Reward(
                                Arrays.asList(
                                    new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        "#{userId}")
                                )        
                            ),
                            new io.gs2.cdk.loginReward.model.Reward(
                                Arrays.asList(
                                    new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        "#{userId}")
                                )        
                            )
                        ))
                        .withMissedReceiveReliefConsumeActions(Arrays.asList(
                            new io.gs2.cdk.money.stampSheet.WithdrawByUserId(
                                "namespace-0001",
                                0,
                                1,
                                false,
                                "#{userId}")
                        ))
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2LoginReward.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2LoginReward.Model.BonusModel[] {
                new Gs2Cdk.Gs2LoginReward.Model.BonusModel(
                    name: "schedule",
                    mode: Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMode.Schedule,
                    missedReceiveRelief: Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMissedReceiveRelief.Disabled,
                    options: new Gs2Cdk.Gs2LoginReward.Model.Options.BonusModelOptions
                    {
                        periodEventId = "grn:gs2:schedule:grn-0001",
                        rewards = new Gs2Cdk.Gs2LoginReward.Model.Reward[]
                        {
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100
                                    )
                                }    
                            ),
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100
                                    )
                                }    
                            ),
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100
                                    )
                                }    
                            )
                        }
                    }
                ),
                new Gs2Cdk.Gs2LoginReward.Model.BonusModel(
                    name: "streaming",
                    mode: Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMode.Streaming,
                    missedReceiveRelief: Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMissedReceiveRelief.Enabled,
                    options: new Gs2Cdk.Gs2LoginReward.Model.Options.BonusModelOptions
                    {
                        resetHour = 15,
                        repeat = Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelRepeat.Enabled,
                        rewards = new Gs2Cdk.Gs2LoginReward.Model.Reward[]
                        {
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100
                                    )
                                }    
                            ),
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100
                                    )
                                }    
                            ),
                            new Gs2Cdk.Gs2LoginReward.Model.Reward(
                                acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
                                        namespaceName: "stamina-0001",
                                        staminaName: "quest",
                                        userId: "#{userId}",
                                        recoverValue: 100
                                    )
                                }    
                            )
                        },
                        missedReceiveReliefConsumeActions = new Gs2Cdk.Core.Model.ConsumeAction[]
                        {
                            new Gs2Cdk.Gs2Money.StampSheet.WithdrawByUserId(
                                namespaceName: "money-0001",
                                userId: "#{userId}",
                                slot: 0,
                                count: 200,
                                paidOnly: false
                            )
                        }
                    }
                )
            }
        );
    }
}

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new loginReward.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new loginReward.model.BonusModel(
                    "schedule",
                    loginReward.model.BonusModelMode.SCHEDULE,
                    loginReward.model.BonusModelMissedReceiveRelief.DISABLED,
                    {
                        periodEventId: "grn:gs2:schedule:grn-0001",
                        rewards: [
                            new loginReward.model.Reward(
                                [
                                    new stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        null,
                                        "#{userId}"
                                    ),
                                ]        
                            ),
                            new loginReward.model.Reward(
                                [
                                    new stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        null,
                                        "#{userId}"
                                    ),
                                ]        
                            ),
                            new loginReward.model.Reward(
                                [
                                    new stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        null,
                                        "#{userId}"
                                    ),
                                ]        
                            ),
                        ]
                    }
                ),
                new loginReward.model.BonusModel(
                    "streaming",
                    loginReward.model.BonusModelMode.STREAMING,
                    loginReward.model.BonusModelMissedReceiveRelief.ENABLED,
                    {
                        resetHour: 15,
                        repeat: loginReward.model.BonusModelRepeat.ENABLED,
                        rewards: [
                            new loginReward.model.Reward(
                                [
                                    new stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        null,
                                        "#{userId}"
                                    ),
                                ]        
                            ),
                            new loginReward.model.Reward(
                                [
                                    new stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        null,
                                        "#{userId}"
                                    ),
                                ]        
                            ),
                            new loginReward.model.Reward(
                                [
                                    new stamina.stampSheet.RecoverStaminaByUserId(
                                        "namespace-0001",
                                        "quest",
                                        5,
                                        null,
                                        "#{userId}"
                                    ),
                                ]        
                            ),
                        ],
                        missedReceiveReliefConsumeActions: [
                            new money.stampSheet.WithdrawByUserId(
                                "namespace-0001",
                                0,
                                1,
                                false,
                                "#{userId}"
                            ),
                        ]
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, login_reward

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        login_reward.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            bonus_models=[
                login_reward.BonusModel(
                    name='schedule',
                    mode=login_reward.BonusModelMode.SCHEDULE,
                    missed_receive_relief=login_reward.BonusModelMissedReceiveRelief.DISABLED,
                    options=login_reward.BonusModelOptions(
                        period_event_id = 'grn:gs2:schedule:grn-0001',
                        rewards = [
                            login_reward.Reward(
                                acquire_actions=[
                                    stamina.RecoverStaminaByUserId(
                                        namespace_name='stamina-0001',
                                        stamina_name='quest',
                                        user_id='#{userId}',
                                        recover_value=100
                                    ),
                                ],        
                            ),
                            login_reward.Reward(
                                acquire_actions=[
                                    stamina.RecoverStaminaByUserId(
                                        namespace_name='stamina-0001',
                                        stamina_name='quest',
                                        user_id='#{userId}',
                                        recover_value=100
                                    ),
                                ],        
                            ),
                            login_reward.Reward(
                                acquire_actions=[
                                    stamina.RecoverStaminaByUserId(
                                        namespace_name='stamina-0001',
                                        stamina_name='quest',
                                        user_id='#{userId}',
                                        recover_value=100
                                    ),
                                ],        
                            ),
                        ]
                    ),
                ),
                login_reward.BonusModel(
                    name='streaming',
                    mode=login_reward.BonusModelMode.STREAMING,
                    missed_receive_relief=login_reward.BonusModelMissedReceiveRelief.ENABLED,
                    options=login_reward.BonusModelOptions(
                        reset_hour = 15,
                        repeat = login_reward.BonusModelRepeat.ENABLED,
                        rewards = [
                            login_reward.Reward(
                                acquire_actions=[
                                    stamina.RecoverStaminaByUserId(
                                        namespace_name='stamina-0001',
                                        stamina_name='quest',
                                        user_id='#{userId}',
                                        recover_value=100
                                    ),
                                ],        
                            ),
                            login_reward.Reward(
                                acquire_actions=[
                                    stamina.RecoverStaminaByUserId(
                                        namespace_name='stamina-0001',
                                        stamina_name='quest',
                                        user_id='#{userId}',
                                        recover_value=100
                                    ),
                                ],        
                            ),
                            login_reward.Reward(
                                acquire_actions=[
                                    stamina.RecoverStaminaByUserId(
                                        namespace_name='stamina-0001',
                                        stamina_name='quest',
                                        user_id='#{userId}',
                                        recover_value=100
                                    ),
                                ],        
                            ),
                        ],
                        missed_receive_relief_consume_actions = [
                            money.WithdrawByUserId(
                                namespace_name='money-0001',
                                user_id='#{userId}',
                                slot=0,
                                count=200,
                                paid_only=False
                            ),
                        ]
                    ),
                ),
            ],
        )

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

BonusModel

ボーナスモデル

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

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

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

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

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

型有効化条件必須デフォルト値の制限説明
bonusModelIdstring
✓
~ 1024文字ログインボーナスモデル GRN
namestring
✓
~ 128文字ボーナスモデル名
metadatastring~ 2048文字メタデータ
mode文字列列挙型
enum {
  “schedule”,
  “streaming”
}
✓
モード
定義説明
“schedule”スケジュールモード
“streaming”ストリーミングモード
periodEventIdstring~ 1024文字ログインボーナスを有効化する期間を表す GS2-Schedule のイベント GRN
resetHourint{periodEventId} == ""
✓*
0 ~ 23受け取りフラグのリセット時間(UTC)
※ periodEventId が "" であれば必須
repeat文字列列挙型
enum {
  “enabled”,
  “disabled”
}
{mode} == “streaming”
✓*
終端に達した後に繰り返すかどうか
※ mode が “streaming” であれば必須
rewardsList<Reward>0 ~ 100 items報酬リスト
missedReceiveRelief文字列列挙型
enum {
  “enabled”,
  “disabled”
}
✓
“disabled”取り逃がし救済機能
定義説明
“enabled”有効
“disabled”無効
missedReceiveReliefVerifyActionsList<VerifyAction>{missedReceiveRelief} == “enabled”[]0 ~ 10 items取り逃がし救済の検証アクションリスト
※ missedReceiveRelief が “enabled” であれば有効
missedReceiveReliefConsumeActionsList<ConsumeAction>{missedReceiveRelief} == “enabled”[]0 ~ 10 items取り逃がし救済の消費アクションリスト
※ missedReceiveRelief が “enabled” であれば有効

Reward

報酬

型有効化条件必須デフォルト値の制限説明
acquireActionsList<AcquireAction>
✓
1 ~ 10 items入手アクションリスト

ConsumeAction

消費アクション

型有効化条件必須デフォルト値の制限説明
action文字列列挙型
enum {
"Gs2AdReward:ConsumePointByUserId",
"Gs2Dictionary:DeleteEntriesByUserId",
"Gs2Enhance:DeleteProgressByUserId",
"Gs2Exchange:DeleteAwaitByUserId",
"Gs2Experience:SubExperienceByUserId",
"Gs2Experience:SubRankCapByUserId",
"Gs2Formation:SubMoldCapacityByUserId",
"Gs2Grade:SubGradeByUserId",
"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
"Gs2Inbox:OpenMessageByUserId",
"Gs2Inbox:DeleteMessageByUserId",
"Gs2Inventory:ConsumeItemSetByUserId",
"Gs2Inventory:ConsumeSimpleItemsByUserId",
"Gs2Inventory:ConsumeBigItemByUserId",
"Gs2JobQueue:DeleteJobByUserId",
"Gs2Limit:CountUpByUserId",
"Gs2LoginReward:MarkReceivedByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:BatchReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Mission:ResetCounterByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Money2:WithdrawByUserId",
"Gs2Money2:VerifyReceiptByUserId",
"Gs2Quest:DeleteProgressByUserId",
"Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
"Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
"Gs2Schedule:DeleteTriggerByUserId",
"Gs2SerialKey:UseByUserId",
"Gs2Showcase:IncrementPurchaseCountByUserId",
"Gs2SkillTree:MarkRestrainByUserId",
"Gs2Stamina:DecreaseMaxValueByUserId",
"Gs2Stamina:ConsumeStaminaByUserId",
}
✓
消費アクションで実行するアクションの種類
requeststring
✓
~ 524288文字アクション実行時に使用されるリクエストのJSON文字列

VerifyAction

検証アクション

型有効化条件必須デフォルト値の制限説明
action文字列列挙型
enum {
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Distributor:IfExpressionByUserId",
"Gs2Distributor:AndExpressionByUserId",
"Gs2Distributor:OrExpressionByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyIncludeMemberByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
"Gs2Ranking2:VerifyClusterRankingScoreByUserId",
"Gs2Ranking2:VerifySubscribeRankingScoreByUserId",
"Gs2Schedule:VerifyTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
"Gs2SerialKey:VerifyCodeByUserId",
"Gs2Stamina:VerifyStaminaValueByUserId",
"Gs2Stamina:VerifyStaminaMaxValueByUserId",
"Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId",
"Gs2Stamina:VerifyStaminaRecoverValueByUserId",
"Gs2Stamina:VerifyStaminaOverflowValueByUserId",
}
✓
検証アクションで実行するアクションの種類
requeststring
✓
~ 524288文字アクション実行時に使用されるリクエストのJSON文字列

AcquireAction

入手アクション

型有効化条件必須デフォルト値の制限説明
action文字列列挙型
enum {
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2Schedule:ExtendTriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
✓
入手アクションで実行するアクションの種類
requeststring
✓
~ 524288文字アクション実行時に使用されるリクエストのJSON文字列