GS2-LoginReward 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 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 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 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 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에서는 마이크로서비스의 이벤트에 연결하여 커스텀 스크립트를 실행할 수 있습니다.
이 모델은 스크립트 실행을 트리거하기 위한 설정을 보유합니다.
스크립트 실행 방식은 크게 두 가지로, 바로 “동기 실행"과 “비동기 실행"입니다.
동기 실행은 스크립트 실행이 완료될 때까지 처리가 블록됩니다.
대신 스크립트 실행 결과를 이용하여 API 실행을 중단시키거나 API 응답 내용을 제어할 수 있습니다.
한편, 비동기 실행에서는 스크립트 완료를 기다리기 위해 처리가 블록되는 일이 없습니다.
다만 스크립트 실행 결과를 이용하여 API 실행을 중단하거나 API 응답 내용을 변경할 수는 없습니다.
비동기 실행은 API의 응답 흐름에 영향을 주지 않으므로 원칙적으로 비동기 실행을 권장합니다.
비동기 실행에는 실행 방식이 두 가지 있으며, 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 파일을 출력함으로써도 서비스를 이용할 수 있습니다.
JSON 파일 형식에 대해서는 GS2-LoginReward 마스터 데이터 레퍼런스를 참조해 주세요.
Request
리소스 생성・갱신 요청
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128자 | 네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. | ||||||||
| mode | 문자열 열거형 enum { “direct”, “preUpload” } | “direct” | 업데이트 모드
| |||||||||
| settings | string | {mode} == “direct” | ✓※ | ~ 5242880 바이트 (5MB) | 마스터 데이터 ※ 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 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 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 Template
from 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 | 보상 목록 날짜별 보상의 순서가 지정된 목록입니다. 각 항목은 하루치 로그인 보너스에 대응하며, 인덱스 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
보상
로그인 보너스의 하루치 보상 설정을 나타냅니다.
각 Reward에는 사용자가 수신할 항목(아이템, 화폐, 경험치 등)을 정의하는 입수 액션 목록이 포함됩니다.
BonusModel의 rewards 배열은 하루당 하나의 Reward를 보유하며, 순서대로 배포됩니다.
보상 값은 버프 시스템(BonusModelBuff)을 통해 실행 시점에 변경할 수 있으며, 입수 액션에 배율을 적용할 수 있습니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| acquireActions | List<AcquireAction> | ✓ | 1 ~ 10 items | 입수 액션 목록 이 날짜의 보상으로 사용자에게 부여되는 리소스를 정의하는 입수 액션 목록. 각 액션은 입수 액션(아이템 추가, 화폐 부여 등)과 그 요청 파라미터를 지정합니다. 보상당 최소 1개, 최대 10개의 액션을 설정할 수 있습니다. |
ConsumeAction
소비 액션
소비 액션의 구조를 통해 사용자로부터 리소스를 소비하는 액션을 정의합니다.
미수령 보너스 구제에서 사용자가 지불해야 하는 비용(화폐 차감, 아이템 소비 등)을 지정하는 데 사용됩니다.
action 필드는 소비 액션의 종류를 지정하고, request 필드에는 그에 대응하는 요청 매개변수가 포함됩니다.
VerifyAction
검증 액션
작업을 실행하기 전에 조건을 검증하는 액션을 정의합니다.
미수령 보너스 구제에서 구제를 허용하기 전에 전제 조건(사용자 자격, 리소스 이용 가능 여부 등)을 확인하는 데 사용됩니다.
action 필드는 검증 액션의 종류를 지정하고, request 필드에는 그에 대응하는 요청 매개변수가 포함됩니다.
AcquireAction
획득 액션
획득 액션의 구조를 통해 사용자에게 리소스를 부여하는 액션을 정의합니다.
보상 내에서 사용되며, 사용자가 받는 것(인벤토리에 아이템 추가, 화폐 부여, 경험치 부여 등)을 지정합니다.
action 필드는 획득 액션의 종류를 지정하고, request 필드에는 그에 대응하는 요청 매개변수가 포함됩니다.