GS2-LoginReward Deploy/CDK リファレンス
GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例
エンティティ
Deploy処理で操作の対象となるリソース
Namespace
ネームスペース
ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
Request
リソースの生成・更新リクエスト
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| description | string | ~ 1024文字 | 説明文 | |||
| transactionSetting | TransactionSetting | ✓ | トランザクション設定 このネームスペース内で報酬トランザクションがどのように実行されるかの設定。 | |||
| receiveScript | ScriptSetting | 報酬を受け取るときに実行するスクリプトの設定 Script トリガーリファレンス - receive | ||||
| logSetting | LogSetting | ログの出力設定 APIリクエスト・レスポンスのログを GS2-Log に出力するための設定。 設定すると、ログインボーナスの操作（受け取り、取り逃がし救済など）がモニタリングと分析のためにログ出力されます。 |
GetAttr
!GetAttrタグで取得可能なリソースの生成結果
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース |
実装例
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-0001import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/loginReward"
"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 Templateclass 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 Templateclass 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 Templatepublic 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 Templateimport 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 Templatefrom 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 TemplateTransactionSetting
トランザクション設定
トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | false | 発行したトランザクションをサーバーサイドで自動的に実行するか | |||
| enableAtomicCommit | bool | {enableAutoRun} == true | false | トランザクションの実行をアトミックにコミットするか ※ enableAutoRun が true であれば 有効 | ||
| transactionUseDistributor | bool | {enableAtomicCommit} == true | false | トランザクションを非同期処理で実行する ※ enableAtomicCommit が true であれば 有効 | ||
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | false | スクリプトの結果コミット処理を非同期処理で実行するか ※ transactionUseDistributor が true であれば 有効 | ||
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | false | 入手アクションを実行する際に GS2-JobQueue を使用するか ※ enableAtomicCommit が true であれば 有効 | ||
| distributorNamespaceId | string | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペース GRN | ||
| queueNamespaceId | string | “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 以外の言語で処理を記述することができます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024文字 | API 実行時に同期的に実行される GS2-Script のスクリプト
GRN 「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 | |||||||||||
| doneTriggerTargetType | 文字列列挙型 enum { “none”, “gs2_script”, “aws” } | “none” | 非同期スクリプトの実行方法 非同期実行で使用するスクリプトの種類を指定します。 「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。
| |||||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | 非同期実行する GS2-Script スクリプト
GRN 「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 ※ doneTriggerTargetType が “gs2_script” であれば 有効 | ||||||||||
| doneTriggerQueueNamespaceId | string | {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 ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024文字 | ログを出力する GS2-Log のネームスペース
GRN 「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |
CurrentBonusMaster
現在アクティブなログインボーナスモデルのマスターデータ
現在ネームスペース内で有効な、ログインボーナスモデルの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
Note
JSONファイルの形式については GS2-LoginReward マスターデータリファレンス をご参照ください。Request
リソースの生成・更新リクエスト
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||||||||
| mode | 文字列列挙型 enum { “direct”, “preUpload” } | “direct” | 更新モード
| |||||||||
| settings | string | {mode} == “direct” | ✓※ | ~ 5242880文字 | マスターデータ ※ mode が “direct” であれば必須 | |||||||
| uploadToken | string | {mode} == “preUpload” | ✓※ | ~ 1024文字 | 事前アップロードで取得したトークン アップロードしたマスターデータを適用するために使用されます。 ※ mode が “preUpload” であれば必須 |
GetAttr
!GetAttrタグで取得可能なリソースの生成結果
| 型 | 説明 | |
|---|---|---|
| Item | CurrentBonusMaster | 更新された現在アクティブなログインボーナスモデルのマスターデータ |
実装例
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: nullimport (
"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 Templateclass 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 Templateclass 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 Templatepublic 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 Templateimport core from "@/gs2cdk/core";
import loginReward from "@/gs2cdk/loginReward";
import money from "@/gs2cdk/money";
import stamina from "@/gs2cdk/stamina";
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 Templatefrom gs2_cdk import Stack, core, login_reward, money, stamina
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 TemplateBonusModel
ログインボーナスモデル
ログインボーナスモデルにはログインボーナスの配布スケジュールを設定します。
配布スケジュールには《スケジュールモード》と《ストリーミングモード》があります。
スケジュールモードでは、GS2-Schedule のイベントの指定が必須で、そのイベントの開始日からの経過日数でボーナスの配布を行います。
途中で撮り逃しが発生した場合、その分のボーナスは配布されません。
ストリーミングモードでは、毎日ボーナスに設定された報酬を先頭から順番に配布します。
ストリーミングモードでは繰り返しの設定が可能です。その場合、ストリームの終端に達した場合、先頭から再度配布を行います。
スケジュールモード・ストリーミングモード 共に、取り逃がしの救済機能があります。
一定のコストを支払うことで、取り逃がしたボーナスを受け取ることができます。
ただし、GS2-Schedule のイベントが関連づけられている場合、イベントの開始日からの経過日数より先のボーナスは受け取ることができません。
取り逃がし機能はストリーミングモードかつ繰り返しが有効な場合は使用することができません。
スケジュールモード・ストリーミングモード 共に、設定可能なボーナスの最大日数は100日です。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bonusModelId | string | ※ | ~ 1024文字 | ログインボーナスモデル
GRN ※ サーバーが自動で設定 | ||||||||
| name | string | ✓ | ~ 128文字 | ログインボーナスモデル名 ログインボーナスモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||||||||
| metadata | string | ~ 2048文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||||||||
| mode | 文字列列挙型 enum { “schedule”, “streaming” } | ✓ | モード ログインボーナスの配布スケジュールの種類を指定します。 「schedule」モードでは、GS2-Schedule のイベント開始日からの経過日数に基づいて報酬が配布されます。 「streaming」モードでは、カレンダーの日付に関係なく、毎日先頭から順番に報酬が配布されます。
| |||||||||
| periodEventId | string | ~ 1024文字 | 期間イベント
GRN ログインボーナスを有効化する期間を表す GS2-Schedule のイベントGRN。 スケジュールモードでは必須で、報酬配布の経過日数を計算する起点の開始日を決定します。 ストリーミングモードでは省略可能ですが、指定した場合はイベント開始日からの経過日数より先のボーナスは受け取れなくなります。 | |||||||||
| resetHour | int | {periodEventId} == "" | ✓※ | 0 ~ 23 | リセット時間（UTC） 受け取りフラグがリセットされる時刻（0-23、UTC）。 ログインボーナスにおける日付の切り替わりタイミングを決定します。 periodEventId が未指定の場合にのみ必要です。イベントが設定されている場合、リセットタイミングはイベントのスケジュールに従います。 ※ periodEventId が "" であれば 必須 | |||||||
| repeat | 文字列列挙型 enum { “enabled”, “disabled” } | {mode} == “streaming” | ✓※ | 繰り返し 全ての報酬を配布し終えた後に、先頭から再度配布を行うかどうか。 ストリーミングモードでのみ有効です。有効にすると、最後の報酬を配布した後に最初の報酬に戻ってループします。 注意: 繰り返しが有効な場合、取り逃がし救済機能は使用できません。
※ mode が “streaming” であれば 必須 | ||||||||
| rewards | List<Reward> | 0 ~ 100 items | 報酬リスト 日毎の報酬の順序付きリスト。各エントリは1日分のログインボーナスに対応し、インデックス 0 から順に配布されます。 スケジュールモードでは、インデックスはイベント開始日からの経過日数に対応します。 ストリーミングモードでは、インデックスはログイン日数に対応します。最大100エントリまで設定可能です。 | |||||||||
| missedReceiveRelief | 文字列列挙型 enum { “enabled”, “disabled” } | “disabled” | 取り逃がし救済機能 取り逃がしたボーナスの救済機能を有効にするかどうか。有効にすると、ユーザーは指定されたコスト（消費アクション）を支払うことで、受け取り損ねたボーナスを遡って受け取ることができます。 任意で、救済の許可前に条件を確認する検証アクションも設定できます。 ストリーミングモードかつ繰り返しが有効な場合は使用できません。デフォルトは「disabled」です。
| |||||||||
| missedReceiveReliefVerifyActions | List<VerifyAction> | {missedReceiveRelief} == “enabled” | [] | 0 ~ 10 items | 取り逃がし救済の検証アクションリスト 取り逃がし救済を許可する前に実行される検証アクションのリスト。 救済処理の前にユーザーの資格などの前提条件をチェックします。最大10個まで設定できます。 missedReceiveRelief が有効な場合にのみ適用されます。 ※ missedReceiveRelief が “enabled” であれば 有効 | |||||||
| missedReceiveReliefConsumeActions | List<ConsumeAction> | {missedReceiveRelief} == “enabled” | [] | 0 ~ 10 items | 取り逃がし救済の消費アクションリスト 取り逃がしたボーナスを救済するためにユーザーが支払うコストを定義する消費アクションのリスト。 例えば、ゲーム内通貨やアイテムを救済コストとして消費するよう設定できます。最大10個まで設定できます。 missedReceiveRelief が有効な場合にのみ適用されます。 ※ missedReceiveRelief が “enabled” であれば 有効 |
Reward
報酬
ログインボーナスの1日分の報酬設定を表します。
各 Reward にはユーザーが受け取るもの（アイテム、通貨、経験値など）を定義する入手アクションのリストが含まれます。
BonusModel の rewards 配列は1日あたり1つの Reward を保持し、順番に配布されます。
報酬の値はバフシステム（BonusModelBuff）を通じて実行時に変更でき、入手アクションにレート乗数を適用できます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| acquireActions | List<AcquireAction> | ✓ | 1 ~ 10 items | 入手アクションリスト この日の報酬としてユーザーに付与されるリソースを定義する入手アクションのリスト。 各アクションは入手アクション（アイテム追加、通貨付与など）とそのリクエストパラメータを指定します。 報酬あたり最低1個、最大10個のアクションを設定できます。 |
ConsumeAction
消費アクション
消費アクションの仕組みを通じてユーザーからリソースを消費するアクションを定義します。
取り逃がしボーナスの救済でユーザーが支払うコスト（通貨の差し引き、アイテムの消費など）を指定するために使用されます。
action フィールドは消費アクションの種類を指定し、request フィールドには対応するリクエストパラメータが含まれます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| action | 文字列列挙型 enum { } | ✓ | 消費アクションで実行するアクションの種類 | |||
| request | string | ✓ | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |
VerifyAction
検証アクション
操作の実行前に条件を検証するアクションを定義します。
取り逃がしボーナスの救済で、救済を許可する前に前提条件（ユーザーの資格、リソースの利用可能性など）を確認するために使用されます。
action フィールドは検証アクションの種類を指定し、request フィールドには対応するリクエストパラメータが含まれます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| action | 文字列列挙型 enum { } | ✓ | 検証アクションで実行するアクションの種類 | |||
| request | string | ✓ | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |
AcquireAction
入手アクション
入手アクションの仕組みを通じてユーザーにリソースを付与するアクションを定義します。
報酬内で使用され、ユーザーが受け取るもの（インベントリへのアイテム追加、通貨の付与、経験値の付与など）を指定します。
action フィールドは入手アクションの種類を指定し、request フィールドには対応するリクエストパラメータが含まれます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| action | 文字列列挙型 enum { } | ✓ | 入手アクションで実行するアクションの種類 | |||
| request | string | ✓ | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |