GS2-Money Deploy/CDK 레퍼런스
엔티티
Deploy 처리에서 조작 대상이 되는 리소스
Namespace
네임스페이스
네임스페이스는 하나의 프로젝트 내에서 동일한 서비스를 서로 다른 용도로 여러 개 이용하기 위한 엔티티입니다.
GS2의 각 서비스는 네임스페이스 단위로 관리됩니다. 네임스페이스가 다르면 동일한 서비스라도 완전히 독립된 데이터 공간으로 취급됩니다.
따라서 각 서비스의 이용을 시작하려면 먼저 네임스페이스를 생성해야 합니다.
Request
리소스 생성・갱신 요청
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128자 | 네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. | ||||||||||
| description | string | ~ 1024자 | 설명문 | |||||||||||
| transactionSetting | TransactionSetting | 트랜잭션 설정 머니 조작 시 트랜잭션의 처리 방법을 제어하는 설정입니다. | ||||||||||||
| priority | 문자열 열거형 enum { “free”, “paid” } | ✓ | 소비 우선순위 지갑에서 통화를 소비할 때, 유료 통화와 무료 통화 중 어느 쪽을 먼저 소비할지를 결정합니다. “free"로 설정하면 무료 통화(단가=0)가 먼저 소비되고, 그 다음 단가가 높은 유료 통화가 소비됩니다. “paid"로 설정하면 단가가 높은 유료 통화가 먼저 소비되고, 그 다음 무료 통화가 소비됩니다.
| |||||||||||
| shareFree | bool | ✓ | 무료 통화 공유 무료 통화를 모든 지갑 슬롯 간에 공유할지 여부입니다. 활성화하면 무료 통화 잔액이 슬롯 0에서 다른 모든 슬롯으로 동기화되어, 서로 다른 플랫폼의 플레이어가 동일한 무료 통화 풀을 공유할 수 있습니다. 유료 통화는 이 설정과 관계없이 항상 슬롯별로 별도로 관리됩니다. | |||||||||||
| currency | 문자열 열거형 enum { “JPY”, “USD”, “TWD” } | ✓ | 통화 종류 가격 설정과 자금결제법 준수 계산에 사용되는 실제 통화입니다. 유료 통화 가치 추적과 환불 의무 계산 시의 측정 단위를 결정합니다. 네임스페이스 생성 후에는 변경할 수 없습니다.
| |||||||||||
| appleKey | string | ~ 1024자 | Apple App Store 번들 ID Apple App Store의 구매 영수증을 검증하는 데 사용되는 iOS 앱의 Bundle ID입니다. iOS 기기로부터의 인앱 구매를 받으려면 필요합니다. | |||||||||||
| googleKey | string | ~ 5120자 | Google PlayStore 비밀 키 Google Play의 구매 영수증을 검증하는 데 사용되는 서비스 계정의 비밀 키입니다. Android 기기로부터의 인앱 구매를 받으려면 필요합니다. | |||||||||||
| enableFakeReceipt | bool | false | 가짜 영수증 활성화 테스트 목적으로 Unity Editor가 생성하는 가짜 구매 영수증을 허용할지 여부입니다. 개발/테스트 환경에서만 활성화해야 하며, 부정한 통화 지급을 방지하기 위해 운영 환경에서는 반드시 비활성화해야 합니다. 기본값은 false입니다. | |||||||||||
| createWalletScript | ScriptSetting | 지갑 생성 시 스크립트 새로운 지갑이 처음 생성될 때 실행되는 스크립트입니다. 지갑은 최초 접근 시 자동으로 생성되므로, 플레이어가 통화 시스템에 처음 접근했을 때 이 스크립트가 트리거됩니다. | ||||||||||||
| depositScript | ScriptSetting | 잔액 충전 시 스크립트 지갑에 통화가 충전될 때 실행되는 스크립트입니다. 유료 통화 충전(스토어 구매)과 무료 통화 지급 양쪽에서 트리거됩니다. | ||||||||||||
| withdrawScript | ScriptSetting | 잔액 소비 시 스크립트 지갑에서 통화가 소비될 때 실행되는 스크립트입니다. 소비 우선순위 설정에 따라 유료 통화 또는 무료 통화가 차감될 때 트리거됩니다. | ||||||||||||
| logSetting | LogSetting | 로그 출력 설정 API 요청/응답 로그를 GS2-Log에 출력하기 위한 설정입니다. 설정하면 지갑 조작(충전, 소비, 구매)이 모니터링, 감사, 분석을 위해 로그로 출력됩니다. |
GetAttr
!GetAttr 태그로 취득 가능한 리소스 생성 결과
| 타입 | 설명 | |
|---|---|---|
| Item | Namespace | 생성한 네임스페이스 |
구현 예제
Type: GS2::Money::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting: null
Priority: paid
ShareFree: false
Currency: USD
AppleKey: null
GoogleKey: null
EnableFakeReceipt: null
CreateWalletScript: null
DepositScript: null
WithdrawScript: 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/money"
)
SampleStack := core.NewStack()
money.NewNamespace(
&SampleStack,
"namespace-0001",
money.NamespacePriorityPaid,
false,
money.NamespaceCurrencyUsd,
money.NamespaceOptions{
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\Money\Model\Namespace_(
stack: $this,
name: "namespace-0001",
priority: \Gs2Cdk\Money\Model\Enums\NamespacePriority::PAID,
shareFree: false,
currency: \Gs2Cdk\Money\Model\Enums\NamespaceCurrency::USD,
options: new \Gs2Cdk\Money\Model\Options\NamespaceOptions(
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.money.model.Namespace(
this,
"namespace-0001",
io.gs2.cdk.money.model.enums.NamespacePriority.PAID,
false,
io.gs2.cdk.money.model.enums.NamespaceCurrency.USD,
new io.gs2.cdk.money.model.options.NamespaceOptions()
.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.Gs2Money.Model.Namespace(
stack: this,
name: "namespace-0001",
priority: Gs2Cdk.Gs2Money.Model.Enums.NamespacePriority.Paid,
shareFree: false,
currency: Gs2Cdk.Gs2Money.Model.Enums.NamespaceCurrency.Usd,
options: new Gs2Cdk.Gs2Money.Model.Options.NamespaceOptions
{
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 money from "@/gs2cdk/money";
class SampleStack extends core.Stack
{
public constructor() {
super();
new money.model.Namespace(
this,
"namespace-0001",
money.model.NamespacePriority.PAID,
false,
money.model.NamespaceCurrency.USD,
{
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, money
class SampleStack(Stack):
def __init__(self):
super().__init__()
money.Namespace(
stack=self,
name='namespace-0001',
priority=money.NamespacePriority.PAID,
share_free=False,
currency=money.NamespaceCurrency.USD,
options=money.NamespaceOptions(
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로 지정해야 합니다. |