Transaction Action on Game Server Services | Docs

Game Engine

Mon, 01 Jan 0001 00:00:00 +0000

트랜잭션이란

GS2에서의 트랜잭션 처리란, “소비 액션"과 “입수 액션"으로 정의된 리소스 교환 처리를 실행하는 덩어리를 가리킵니다. 트랜잭션을 발행하는 API에는 GS2-Exchange의 교환 실행 함수(Exchange), GS2-Showcase의 상품 구매 함수(Buy), GS2-Quest의 퀘스트 시작 함수(Start)와 같은 것들이 있습니다.

“소비 액션"은 플레이어에게 불리하게 작용하는 사용자 데이터 조작을, 반대로 “입수 액션"은 플레이어에게 이득이 되는 사용자 데이터 조작을 가리킵니다.

구체적으로 GS2-Inventory라면 아이템의 소비가 “소비 액션”, 아이템의 입수가 “입수 액션"이 됩니다. 조금 색다른 예를 들면, GS2-Inbox의 메시지 개봉 플래그를 세우는 조작이 “소비 액션”, 메시지에 첨부된 아이템을 수령하는 것이 “입수 액션"이 됩니다. GS2에서는 사용자 데이터를 다시 쓰는 트랜잭션을 발행하고 실행하는 것을 반복함으로써 게임 사이클을 실현한다고 이해하십시오.

SDK

Mon, 01 Jan 0001 00:00:00 +0000

GS2-SDK for Game Engine의 트랜잭션 처리에 대해

기본적인 개념과 처리 흐름은 for Game Engine 문서를 참조하십시오. 한편, GS2-SDK에서는 for Game Engine만큼 충실한 지원은 제공되지 않습니다.

구체적으로는 캐시 기능이나 EzTransactionDomain과 같은 구조는 마련되어 있지 않습니다.

트랜잭션 실행

자동 실행이 유효한 경우

완료 통지를 받으려면 명시적으로 GS2-Gateway에 사용자ID를 설정해야 합니다.

GS2-Gateway::setUserId

완료 통지를 핸들링해야 합니다. Gs2WebSocketSession 클래스에 통지를 핸들링하는 함수가 마련되어 있으므로 이를 이용하십시오. 프로그래밍 언어에 따라서는 WebSocket 클라이언트 구현이 없을 수도 있습니다.

스탬프 시트

Mon, 01 Jan 0001 00:00:00 +0000

GS2에서는 각 서비스 간을 연계시키는 트랜잭션 구조로서 《스탬프 시트》라는 구조를 사용합니다.

GS2 내의 API 중, 플레이어에게 불이익이 되는 조작을 《소비 액션》이라고 부르고, 반대로 플레이어에게 이익이 되는 조작을 《입수 액션》이라고 부릅니다.

게임 내 상점에서 《1000 젬을 사용》하여 《가챠를 10번 뽑는》처리가 있다고 합시다. 이 경우, 《1000 젬을 사용》이 소비 액션이고, 《가챠를 10번 뽑는》것을 입수 액션으로 볼 수 있습니다.

조금 더 예시를 나열해 보겠습니다.

《메시지를 읽음 처리》하는 소비 액션을 실행하고 《메시지에 첨부된 젬 100개를 수령》하는 입수 액션을 실행한다
《스태미나를 10 소비》하는 소비 액션을 실행하고 《퀘스트 1을 시작 상태로 만드는》 입수 액션을 실행한다
《퀘스트 1의 시작 상태를 삭제》하는 소비 액션을 실행하고 《퀘스트 1의 클리어 보상을 입수》하는 입수 액션을 실행한다
《현재 시각으로 최종 방치 보상 수령 시간을 갱신》하는 소비 액션을 실행하고 《방치 시간에 따른 보상을 입수》하는 입수 액션을 실행한다
《매일 초기화되는 횟수 제한 카운터를 1 증가》하는 소비 액션을 실행하고 《하루 1회만 받을 수 있는 아이템을 입수》하는 입수 액션을 실행한다

이처럼 GS2에서는 모든 게임 사이클이 무언가를 소비하고, 무언가를 얻는 것으로 표현됩니다.

트랜잭션 설정

Mon, 01 Jan 0001 00:00:00 +0000

GS2가 제공하는 마이크로서비스에는 대체로 네임스페이스 설정에 TransactionSetting이라는 필드가 존재합니다. TransactionSetting은 다음과 같은 구조를 가집니다.

	타입	활성화 조건	필수	기본값	값 제한	설명
enableAutoRun	bool		✓	false		발행한 트랜잭션을 서버 측에서 자동으로 실행할지 여부
enableAtomicCommit	bool	{enableAutoRun} == true	✓	false		트랜잭션 실행을 원자적(atomic)으로 커밋할지 여부 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 네임스페이스
queueNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024자	트랜잭션 실행에 사용하는 GS2-JobQueue의 네임스페이스

필드가 많고 그 용도도 복잡하므로 이 문서에서 자세히 설명합니다.

GS2-AdReward 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2AdReward:ConsumePointByUserId

사용자 ID를 지정하여 포인트 소비

지정된 사용자 ID로부터 지정된 수의 포인트를 차감하고, 갱신된 포인트 정보를 반환합니다.
요청된 소비량에 대해 포인트가 부족한 경우 오류가 반환됩니다.
네임스페이스의 소비 스크립트 설정에 GS2-Script가 설정되어 있는 경우, 포인트 차감 전에 스크립트가 실행되어 커스텀 검증이나 소비량 변경이 가능합니다.
포인트 차감 후, 네임스페이스 설정에서 변경 알림이 구성되어 있으면 알림이 전송됩니다.

수량 지정 가능한 액션: 예

반전 가능한 액션: 예

	타입	필수	값 제한	설명
namespaceName	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓	~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
point	long	✓	1 ~ 9223372036854775805	소비할 포인트
timeOffsetToken	string		~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2AdReward:ConsumePointByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "point": "[long]소비할 포인트",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2AdReward:ConsumePointByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 point: "[long]소비할 포인트"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("adReward").consume.consume_point_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 point="[long]소비할 포인트",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Dictionary 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Dictionary:VerifyEntryByUserId

사용자 ID를 지정하여 엔트리 검증

지정한 사용자가 특정 엔트리를 수집했는지 여부를 검증합니다.
검증 타입으로 조건을 지정합니다：‘have’는 사용자가 엔트리를 보유하고 있는지 확인하고, ‘havent’는 보유하고 있지 않은지 확인합니다.
검증에 실패한 경우, 오류가 반환됩니다.

수량 지정 가능한 액션: 아니오

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

entryModelName

string

✓

~ 128자

엔트리 모델 이름

엔트리 모델 고유 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다.

verifyType

문자열 열거형
enum {
“havent”,
“have”
}

✓

검증 종류

정의	설명
havent	지정한 엔트리를 보유하고 있지 않을 것
have	지정한 엔트리를 보유하고 있을 것

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Dictionary:VerifyEntryByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "entryModelName": "[string]엔트리 모델 이름",
 "verifyType": "[string]검증 종류",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Dictionary:VerifyEntryByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 entryModelName: "[string]엔트리 모델 이름"
 verifyType: "[string]검증 종류"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("dictionary").verify.verify_entry_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 entryModelName="[string]엔트리 모델 이름",
 verifyType="[string]검증 종류",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Consume Action

소비 액션

GS2-Distributor 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Distributor:IfExpressionByUserId

조건을 검증하고 소비 액션의 내용을 전환

검증 액션을 조건으로 평가하고, 결과에 따라 trueActions 또는 falseActions의 소비 액션 목록을 실행합니다.
이를 통해 트랜잭션 내에서 조건 분기가 가능해지며, 검증 결과에 따라 서로 다른 소비 액션을 실행할 수 있습니다.
multiplyValueSpecifyingQuantity가 활성화된 경우, 검증에 사용되는 값도 지정된 수량만큼 곱해집니다.

수량 지정 가능한 액션: 아니오

	타입	필수	기본값	값 제한	설명
namespaceName	string	✓		~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓		~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
condition	VerifyAction	✓			조건
trueActions	List<ConsumeAction>			0 ~ 10 items	조건이 참일 때 실행되는 소비 액션 목록
falseActions	List<ConsumeAction>			0 ~ 10 items	조건이 거짓일 때 실행되는 소비 액션 목록
multiplyValueSpecifyingQuantity	bool		true		수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부
timeOffsetToken	string			~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Distributor:IfExpressionByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "condition": {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 },
 "trueActions": [
 {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "falseActions": [
 {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Distributor:IfExpressionByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 condition: 
 action: "[string]검증 액션에서 실행할 액션의 종류"
 request: "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 trueActions: 
 - action: "[string]소비 액션에서 실행할 액션의 종류"
 request: "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 falseActions: 
 - action: "[string]소비 액션에서 실행할 액션의 종류"
 request: "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("distributor").verify.if_expression_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 condition={
 action="[string]검증 액션에서 실행할 액션의 종류",
 request="[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 },
 trueActions={
 {
 action="[string]소비 액션에서 실행할 액션의 종류",
 request="[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 },
 falseActions={
 {
 action="[string]소비 액션에서 실행할 액션의 종류",
 request="[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 },
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Distributor:AndExpressionByUserId

여러 검증 액션을 실행하여 모두 참인지 판정

GS2-Enchant 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Enchant:VerifyRarityParameterStatusByUserId

사용자 ID를 지정하여 레어리티 파라미터를 검증

지정된 사용자의 레어리티 파라미터 상태가 지정된 조건을 충족하는지 검증합니다.
3가지 검증 유형이 지원됩니다:

‘have’: 지정된 파라미터 값이 상태에 존재하는지 검증
‘havent’: 지정된 파라미터 값이 상태에 존재하지 않는지 검증
‘count’: 파라미터의 수가 지정된 수와 일치하는지 검증
다른 액션을 실행하기 전의 전제 조건 확인으로 사용할 수 있습니다.

수량 지정 가능한 액션: 예

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

parameterName

string

✓

~ 128자

레어리티 파라미터 모델명

이 상태의 추첨 조건을 정의하는 레어리티 파라미터 모델의 이름입니다. 최대 파라미터 수, 부여 수 추첨 가중치, 값 추첨 풀을 지정하는 모델을 참조합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

propertyId

string

✓

~ 1024자

파라미터의 보유 리소스의 프로퍼티 ID

이 레어리티 파라미터가 연결되어 있는 특정 게임 리소스(예: 무기나 장비 아이템)를 식별합니다. 일반적으로 GS2-Inventory의 아이템 등의 리소스를 프로퍼티 ID로 참조합니다.

verifyType

문자열 열거형
enum {
  “havent”,
  “have”,
  “count”
}

✓

검증 종류

정의	설명
havent	지정한 파라미터를 보유하고 있지 않을 것
have	지정한 파라미터를 보유하고 있을 것
count	보유하고 있는 파라미터의 수가 지정한 수와 같을 것

parameterValueName

string

{verifyType} in [“havent”, “have”]

✓※

~ 64자

이름

이 추첨 엔트리의 식별자입니다. 레어리티 파라미터 모델의 값 풀 내에서 고유해야 합니다. 추첨되었을 때, 이 이름이 결과 레어리티 파라미터 값에 저장됩니다.

※ verifyType이(가) “havent”,“have"이면 필수

parameterCount

int

{verifyType} == “count”

✓※

0 ~ 10

검증할 파라미터의 수

※ verifyType이(가) “count” 이면 필수

multiplyValueSpecifyingQuantity bool false 수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Enchant:VerifyRarityParameterStatusByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "parameterName": "[string]레어리티 파라미터 모델명",
 "userId": "[string]사용자ID",
 "propertyId": "[string]파라미터의 보유 리소스의 프로퍼티 ID",
 "verifyType": "[string]검증 종류",
 "parameterValueName": "[string]이름",
 "parameterCount": "[int]검증할 파라미터의 수",
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Enchant:VerifyRarityParameterStatusByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 parameterName: "[string]레어리티 파라미터 모델명"
 userId: "[string]사용자ID"
 propertyId: "[string]파라미터의 보유 리소스의 프로퍼티 ID"
 verifyType: "[string]검증 종류"
 parameterValueName: "[string]이름"
 parameterCount: "[int]검증할 파라미터의 수"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("enchant").verify.verify_rarity_parameter_status_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 parameterName="[string]레어리티 파라미터 모델명",
 userId="[string]사용자ID",
 propertyId="[string]파라미터의 보유 리소스의 프로퍼티 ID",
 verifyType="[string]검증 종류",
 parameterValueName="[string]이름",
 parameterCount="[int]검증할 파라미터의 수",
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Enhance 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2Enhance:DeleteProgressByUserId

사용자 ID를 지정하여 실행 중인 강화의 진행 정보를 삭제

지정된 사용자의 현재 진행 중인 강화의 진행 정보 레코드를 삭제합니다.
진행 중인 2단계 강화가 취소되며, 사전 계산된 경험치와 보너스 레이트는 폐기됩니다.
Start 단계에서 이미 소비된 소재는 자동으로 반환되지 않습니다.

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 아니오

	타입	필수	값 제한	설명
namespaceName	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓	~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
timeOffsetToken	string		~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Enhance:DeleteProgressByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Enhance:DeleteProgressByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("enhance").consume.delete_progress_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Exchange 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2Exchange:DeleteAwaitByUserId

사용자 ID를 지정하여 교환 대기 삭제

지정된 사용자의 교환 대기 레코드를 삭제합니다.
보류 중인 교환이 취소되며, 아직 취득하지 않은 보상은 포기됩니다.

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 아니오

	타입	필수	기본값	값 제한	설명
namespaceName	string	✓		~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓		~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
awaitName	string	✓	UUID	~ 36자	교환 대기의 이름 교환 대기의 고유한 이름을 보유합니다. 이름은 UUID(Universally Unique Identifier) 형식으로 자동 생성되며, 교환 대기를 식별하는 데 사용됩니다.
timeOffsetToken	string			~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Exchange:DeleteAwaitByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "awaitName": "[string]교환 대기의 이름",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Exchange:DeleteAwaitByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 awaitName: "[string]교환 대기의 이름"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("exchange").consume.delete_await_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 awaitName="[string]교환 대기의 이름",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Experience 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Experience:VerifyRankByUserId

사용자 ID를 지정하여 랭크를 검증

지정된 사용자의 현재 랭크가 지정된 값에 대한 조건을 충족하는지 검증합니다.
6가지 비교 연산자를 지원합니다: less, lessEqual, greater, greaterEqual, equal, notEqual.
검증 조건을 충족하지 않는 경우 오류(BadRequest)를 반환합니다.

수량 지정 가능한 액션: 아니오

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

experienceName

string

✓

~ 128자

경험치 모델 이름

이 스테이터스의 랭킹 규칙을 정의하는 경험치 모델의 이름입니다. 어떤 랭크업 임계값 테이블과 랭크 캡 설정이 적용되는지를 결정합니다.

verifyType

문자열 열거형
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}

✓

검증 종류

정의	설명
less	랭크가 지정값 미만일 것
lessEqual	랭크가 지정값 이하일 것
greater	랭크가 지정값 초과일 것
greaterEqual	랭크가 지정값 이상일 것
equal	랭크가 지정값과 일치할 것
notEqual	랭크가 지정값과 일치하지 않을 것

propertyId

string

✓

~ 1024자

프로퍼티ID

사용자 스코프 내에서 이 스테이터스를 고유하게 식별하는 개발자 정의 식별자입니다. 경험치를 보유한 GS2-Inventory의 아이템 세트 GRN이나 GS2-Dictionary의 엔트리 GRN 끝에 경험치 모델의 접미사를 붙인 값을 사용할 것을 권장합니다.

rankValue

long

0 ~ 9223372036854775805

현재 랭크

랭크업 임계값 테이블을 사용하여 누적 경험치로부터 산출되는 랭크(레벨)입니다. 0부터 시작하며 경험치 임계값을 초과할 때마다 증가합니다. 현재 랭크 캡 값을 초과할 수 없습니다.

multiplyValueSpecifyingQuantity bool false 수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Experience:VerifyRankByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "experienceName": "[string]경험치 모델 이름",
 "verifyType": "[string]검증 종류",
 "propertyId": "[string]프로퍼티ID",
 "rankValue": "[long]현재 랭크",
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Experience:VerifyRankByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 experienceName: "[string]경험치 모델 이름"
 verifyType: "[string]검증 종류"
 propertyId: "[string]프로퍼티ID"
 rankValue: "[long]현재 랭크"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("experience").verify.verify_rank_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 experienceName="[string]경험치 모델 이름",
 verifyType="[string]검증 종류",
 propertyId="[string]프로퍼티ID",
 rankValue="[long]현재 랭크",
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Experience:VerifyRankCapByUserId

사용자 ID를 지정하여 랭크 캡을 검증

GS2-Formation 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2Formation:SubMoldCapacityByUserId

사용자 ID를 지정하여 용량 크기 감산

지정된 사용자의 폼 저장 영역(몰드)의 용량을 감산합니다. 용량은 0 미만으로 내려가지 않습니다.

수량 지정 가능한 액션: 예

반전 가능한 액션: 예

	타입	필수	값 제한	설명
namespaceName	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓	~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
moldModelName	string	✓	~ 128자	폼 저장 영역 모델의 이름 폼 저장 영역 모델 고유의 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다.
capacity	int	✓	0 ~ 2147483646	현재 캐파시티 이 저장 영역에서 이 플레이어가 현재 이용할 수 있는 폼 저장 슬롯 수입니다. 초기값은 저장 영역 모델의 initialMaxCapacity로 설정되며, 캐파시티 증가 조작을 통해 maxCapacity까지 확장할 수 있습니다.
timeOffsetToken	string		~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Formation:SubMoldCapacityByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "moldModelName": "[string]폼 저장 영역 모델의 이름",
 "capacity": "[int]현재 캐파시티",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Formation:SubMoldCapacityByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 moldModelName: "[string]폼 저장 영역 모델의 이름"
 capacity: "[int]현재 캐파시티"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("formation").consume.sub_mold_capacity_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 moldModelName="[string]폼 저장 영역 모델의 이름",
 capacity="[int]현재 캐파시티",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Friend 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Acquire Action

입수 액션

Gs2Friend:UpdateProfileByUserId

사용자ID를 지정하여 프로필 갱신

지정된 사용자의 프로필을 3가지 서로 다른 공개 수준으로 갱신합니다(서버 사이드 조작):

publicProfile: 모든 사용자에게 공개
followerProfile: 팔로워에게만 공개
friendProfile: 친구에게만 공개

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 아니오

	타입	필수	값 제한	설명
namespaceName	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓	~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
publicProfile	string		~ 1024자	공개되는 프로필 관계와 상관없이 모든 플레이어에게 표시되는 프로필 정보입니다. 일반적으로 표시 이름, 아바타, 기타 공개 가능한 정보에 사용됩니다.
followerProfile	string		~ 1024자	팔로워에게 공개되는 프로필 이 사용자를 팔로우하고 있는 플레이어에게만 표시되는 프로필 정보입니다. 공개 프로필보다 상세한 정보(게임플레이 통계나 상태 메시지 등)를 포함할 수 있습니다.
friendProfile	string		~ 1024자	친구에게 공개되는 프로필 상호 친구 관계가 성립된 플레이어에게만 표시되는 프로필 정보입니다. 가장 프라이빗한 프로필 수준으로, 연락처나 개인 메시지 등 개인 정보를 공유하기에 적합합니다.
timeOffsetToken	string		~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Friend:UpdateProfileByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "publicProfile": "[string]공개되는 프로필",
 "followerProfile": "[string]팔로워에게 공개되는 프로필",
 "friendProfile": "[string]친구에게 공개되는 프로필",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Friend:UpdateProfileByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 publicProfile: "[string]공개되는 프로필"
 followerProfile: "[string]팔로워에게 공개되는 프로필"
 friendProfile: "[string]친구에게 공개되는 프로필"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("friend").acquire.update_profile_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 publicProfile="[string]공개되는 프로필",
 followerProfile="[string]팔로워에게 공개되는 프로필",
 friendProfile="[string]친구에게 공개되는 프로필",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

GS2-Grade 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Grade:VerifyGradeByUserId

사용자 ID를 지정하여 그레이드 검증

지정된 사용자의 그레이드 값이 지정된 조건을 만족하는지 검증합니다(서버 사이드 작업).
6가지 비교 연산자를 지원합니다: less(미만), lessEqual(이하), greater(초과), greaterEqual(이상), equal(일치), notEqual(불일치).
조건이 충족되지 않은 경우, 기대값과 실제 값을 포함한 설명적인 오류 메시지가 반환됩니다.
multiplyValueSpecifyingQuantity가 true인 경우, 검증 임계값은 지정된 수량으로 곱해집니다.

수량 지정 가능한 액션: 아니오

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

gradeName

string

✓

~ 128자

그레이드 모델 이름

이 스테이터스가 속한 그레이드 모델의 이름입니다. 그레이드 엔트리의 매핑, 연동된 경험치 모델, 보상 가산 테이블을 포함하는 그레이드 모델 정의를 참조합니다.

verifyType

문자열 열거형
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}

✓

검증 종류

정의	설명
less	그레이드가 지정한 값 미만일 것
lessEqual	그레이드가 지정한 값 이하일 것
greater	그레이드가 지정한 값을 초과할 것
greaterEqual	그레이드가 지정한 값 이상일 것
equal	그레이드가 지정한 값과 일치할 것
notEqual	그레이드가 지정한 값과 일치하지 않을 것

propertyId

string

✓

~ 1024자

프로퍼티 ID

이 그레이드 스테이터스의 개발자 정의 식별자로, 사용자와 그레이드 모델 내에서 고유합니다. 그레이드 값과 랭크 캡의 올바른 동기화를 보장하기 위해, 연동되는 GS2-Experience 스테이터스의 프로퍼티 ID와 동일한 값을 사용하는 것을 강력히 권장합니다.

gradeValue

long

1 ~ 9223372036854775805

현재 그레이드

이 스테이터스의 현재 그레이드 값입니다. 연동되는 GS2-Experience 모델의 랭크 캡을 결정하기 위해 그레이드 모델의 그레이드 엔트리 배열의 인덱스로 사용됩니다. 이 값이 변경되면 관련된 경험치 스테이터스의 랭크 캡이 해당 그레이드 엔트리에서 정의된 값으로 자동 갱신됩니다.

multiplyValueSpecifyingQuantity bool false 수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Grade:VerifyGradeByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "gradeName": "[string]그레이드 모델 이름",
 "verifyType": "[string]검증 종류",
 "propertyId": "[string]프로퍼티 ID",
 "gradeValue": "[long]현재 그레이드",
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Grade:VerifyGradeByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 gradeName: "[string]그레이드 모델 이름"
 verifyType: "[string]검증 종류"
 propertyId: "[string]프로퍼티 ID"
 gradeValue: "[long]현재 그레이드"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("grade").verify.verify_grade_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 gradeName="[string]그레이드 모델 이름",
 verifyType="[string]검증 종류",
 propertyId="[string]프로퍼티 ID",
 gradeValue="[long]현재 그레이드",
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Grade:VerifyGradeUpMaterialByUserId

사용자 ID를 지정하여 그레이드업에 사용하는 소재 검증

GS2-Guild 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName

길드 이름을 지정하여 최대 참가 가능 인원수 검증

선택된 비교 연산자를 사용하여 지정된 길드의 currentMaximumMemberCount를 지정된 값과 비교 검증합니다(서버 사이드 조작).
지원되는 연산자: less, lessEqual, greater, greaterEqual, equal, notEqual.

수량 지정 가능한 액션: 아니오

타입

활성화 조건

필수

기본값

값 제한

설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

guildModelName

string

✓

~ 128자

길드 모델 이름

길드 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

guildName

string

✓

~ 128자

길드명

verifyType

문자열 열거형
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}

✓

검증 종류

정의	설명
less	최대 참가 가능 인원수가 지정값 미만일 것
lessEqual	최대 참가 가능 인원수가 지정값 이하일 것
greater	최대 참가 가능 인원수가 지정값 초과일 것
greaterEqual	최대 참가 가능 인원수가 지정값 이상일 것
equal	최대 참가 가능 인원수가 지정값과 일치할 것
notEqual	최대 참가 가능 인원수가 지정값과 일치하지 않을 것

value

int

1 ~ 2147483646

최대 참가 가능 인원수

multiplyValueSpecifyingQuantity

bool

false

수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부

{
 "action": "Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "guildModelName": "[string]길드 모델 이름",
 "guildName": "[string]길드명",
 "verifyType": "[string]검증 종류",
 "value": "[int]최대 참가 가능 인원수",
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 }
}

action: Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName
request:
 namespaceName: "[string]네임스페이스 이름"
 guildModelName: "[string]길드 모델 이름"
 guildName: "[string]길드명"
 verifyType: "[string]검증 종류"
 value: "[int]최대 참가 가능 인원수"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"

transaction.service("guild").verify.verify_current_maximum_member_count_by_guild_name({
 namespaceName="[string]네임스페이스 이름",
 guildModelName="[string]길드 모델 이름",
 guildName="[string]길드명",
 verifyType="[string]검증 종류",
 value="[int]최대 참가 가능 인원수",
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
})

Gs2Guild:VerifyIncludeMemberByUserId

사용자 ID를 지정하여 길드 멤버에 사용자 ID가 포함되어 있는지 검증

GS2-Idle 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2Idle:DecreaseMaximumIdleMinutesByUserId

사용자 ID를 지정하여 최대 대기 시간을 감산

지정된 카테고리에서 사용자의 최대 대기 시간에서 지정된 분(分) 수를 감산합니다.
최대 대기 시간은 0 미만으로 내려갈 수 없습니다.
스테이터스가 아직 존재하지 않는 경우, 감산을 적용하기 전에 자동으로 생성됩니다.

수량 지정 가능한 액션: 예

반전 가능한 액션: 예

	타입	필수	값 제한	설명
namespaceName	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓	~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
categoryName	string	✓	~ 128자	카테고리 모델 이름 이 스테이터스가 속한 카테고리 모델의 이름입니다. 방치 보상 계산에 사용되는 보상 간격, 최대 방치 시간, 입수 액션, 스케줄 설정을 포함하는 카테고리 모델 정의를 참조합니다.
decreaseMinutes	int		1 ~ 2147483646	최대 대기 시간 감소량(분)
timeOffsetToken	string		~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "categoryName": "[string]카테고리 모델 이름",
 "decreaseMinutes": "[int]최대 대기 시간 감소량(분)",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Idle:DecreaseMaximumIdleMinutesByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 categoryName: "[string]카테고리 모델 이름"
 decreaseMinutes: "[int]최대 대기 시간 감소량(분)"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("idle").consume.decrease_maximum_idle_minutes_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 categoryName="[string]카테고리 모델 이름",
 decreaseMinutes="[int]최대 대기 시간 감소량(분)",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Inbox 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2Inbox:OpenMessageByUserId

사용자 ID를 지정하여 메시지를 개봉 완료로 표시

지정된 사용자의 수신함에 있는 지정된 메시지를 읽음(개봉 완료) 상태로 표시합니다.
이는 획득 액션을 실행하지 않고 isRead를 true로 설정하는 단순한 상태 전환입니다.
읽음 처리와 동시에 관련된 보상을 실행하려면 대신 Read API를 사용하십시오.

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 아니오

	타입	필수	기본값	값 제한	설명
namespaceName	string	✓		~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓		~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
messageName	string	✓	UUID	~ 36자	메시지 이름 메시지의 고유한 이름을 유지합니다. 이름은 UUID(Universally Unique Identifier) 형식으로 자동 생성되며, 각 메시지를 식별하는 데 사용됩니다.
timeOffsetToken	string			~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Inbox:OpenMessageByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "messageName": "[string]메시지 이름",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Inbox:OpenMessageByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 messageName: "[string]메시지 이름"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("inbox").consume.open_message_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 messageName="[string]메시지 이름",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Inbox:DeleteMessageByUserId

사용자 ID를 지정하여 메시지 삭제

GS2-Inventory 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId

사용자 ID를 지정하여 인벤토리의 최대 용량을 검증

지정된 사용자의 현재 최대 인벤토리 용량이 지정된 조건을 만족하는지 검증합니다.
6개의 비교 연산자를 지원합니다: less, lessEqual, greater, greaterEqual, equal, notEqual.
검증에는 버프 적용 후의 용량 값(GS2-Buff 의 활성 버프 효과를 반영)이 사용됩니다.

수량 지정 가능한 액션: 예

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

inventoryName

string

✓

~ 128자

인벤토리 모델 이름

이 인벤토리의 구조와 용량 설정을 정의하는 인벤토리 모델의 이름입니다. 사용자의 인벤토리 인스턴스를 모델 정의에 연결하여 사용 가능한 아이템의 종류와 용량 제한을 결정합니다.

verifyType

문자열 열거형
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}

✓

검증 종류

정의	설명
less	현재 인벤토리의 최대 용량이 지정 값 미만일 것
lessEqual	현재 인벤토리의 최대 용량이 지정 값 이하일 것
greater	현재 인벤토리의 최대 용량이 지정 값 초과일 것
greaterEqual	현재 인벤토리의 최대 용량이 지정 값 이상일 것
equal	현재 인벤토리의 최대 용량이 지정 값과 일치할 것
notEqual	현재 인벤토리의 최대 용량이 지정 값과 일치하지 않을 것

currentInventoryMaxCapacity

int

✓

0 ~ 2147483646

현재 인벤토리의 최대 용량

multiplyValueSpecifyingQuantity bool true 수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "inventoryName": "[string]인벤토리 모델 이름",
 "verifyType": "[string]검증 종류",
 "currentInventoryMaxCapacity": "[int]현재 인벤토리의 최대 용량",
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 inventoryName: "[string]인벤토리 모델 이름"
 verifyType: "[string]검증 종류"
 currentInventoryMaxCapacity: "[int]현재 인벤토리의 최대 용량"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("inventory").verify.verify_inventory_current_max_capacity_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 inventoryName="[string]인벤토리 모델 이름",
 verifyType="[string]검증 종류",
 currentInventoryMaxCapacity="[int]현재 인벤토리의 최대 용량",
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Inventory:VerifyItemSetByUserId

사용자 ID를 지정하여 아이템 세트의 소지 수량 검증

GS2-JobQueue 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2JobQueue:DeleteJobByUserId

사용자 ID를 지정하여 잡 삭제

지정한 사용자의 잡 큐에서 특정 잡을 삭제합니다.
실행 상태와 관계없이 잡이 삭제됩니다.

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 아니오

	타입	필수	기본값	값 제한	설명
namespaceName	string	✓		~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓		~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
jobName	string	✓	UUID	~ 36자	잡 이름 잡의 고유한 이름을 보유합니다. 이름은 UUID(Universally Unique Identifier) 형식으로 자동 생성되며, 각 잡을 식별하는 데 사용됩니다.
timeOffsetToken	string			~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2JobQueue:DeleteJobByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "jobName": "[string]잡 이름",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2JobQueue:DeleteJobByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 jobName: "[string]잡 이름"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("jobQueue").consume.delete_job_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 jobName="[string]잡 이름",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Limit 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Limit:VerifyCounterByUserId

사용자 ID를 지정하여 카운터 값 검증

지정된 사용자의 카운터 값이 지정된 조건을 충족하는지 검증합니다.
less, lessEqual, greater, greaterEqual, equal, notEqual의 6가지 비교 연산자를 지원합니다.

수량 지정 가능한 액션: 아니오

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

limitName

string

✓

~ 128자

사용 횟수 제한 모델 이름

이 카운터가 속한 사용 횟수 제한 모델의 이름입니다. 이 카운터 값에 적용되는 리셋 일정(매일, 매주, 매월 등)을 결정합니다.

counterName

string

✓

~ 128자

카운터 이름

사용 횟수 제한 모델 내에서 이 카운터를 고유하게 식별하는 이름입니다. 동일한 사용 횟수 제한 모델을 서로 다른 이름의 여러 카운터로 공유할 수 있어, 개별 사용 횟수 제한 모델을 만들지 않고도 별도의 사용 횟수 추적(예: 퀘스트별 또는 상품별로 카운터 1개)이 가능합니다.

verifyType

문자열 열거형
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}

✓

검증 종류

정의	설명
less	카운터 값이 지정 값 미만일 것
lessEqual	카운터 값이 지정 값 이하일 것
greater	카운터 값이 지정 값을 초과할 것
greaterEqual	카운터 값이 지정 값 이상일 것
equal	카운터 값이 지정 값과 일치할 것
notEqual	카운터 값이 지정 값과 일치하지 않을 것

count

int

0 ~ 2147483646

카운트 값

이 카운터의 현재 사용 횟수입니다. countUp 조작으로 증가하며, 이때 지정된 최대값과 비교됩니다. 사용 횟수 제한 모델의 리셋 시점에 도달하면 자동으로 0으로 리셋됩니다.

multiplyValueSpecifyingQuantity bool true 수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Limit:VerifyCounterByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "limitName": "[string]사용 횟수 제한 모델 이름",
 "counterName": "[string]카운터 이름",
 "verifyType": "[string]검증 종류",
 "count": "[int]카운트 값",
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Limit:VerifyCounterByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 limitName: "[string]사용 횟수 제한 모델 이름"
 counterName: "[string]카운터 이름"
 verifyType: "[string]검증 종류"
 count: "[int]카운트 값"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("limit").verify.verify_counter_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 limitName="[string]사용 횟수 제한 모델 이름",
 counterName="[string]카운터 이름",
 verifyType="[string]검증 종류",
 count="[int]카운트 값",
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Consume Action

소비 액션

GS2-LoginReward 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2LoginReward:MarkReceivedByUserId

사용자 ID를 지정하여 수령 완료 처리

지정된 사용자의 보너스 모델에서 특정 스텝을 수동으로 수령 완료로 표시합니다.

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 예

	타입	필수	값 제한	설명
namespaceName	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
bonusModelName	string	✓	~ 128자	보너스 모델 이름 이 수신 상태가 연결된 로그인 보너스 모델의 이름. 사용자의 수신 진행 상황을 특정 보너스 모델 정의와 연결하여, 어떤 보상 목록과 배포 규칙이 적용되는지를 결정합니다.
userId	string	✓	~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
stepNumber	int	✓	0 ~ 100	스텝 번호
timeOffsetToken	string		~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2LoginReward:MarkReceivedByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "bonusModelName": "[string]보너스 모델 이름",
 "userId": "[string]사용자ID",
 "stepNumber": "[int]스텝 번호",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2LoginReward:MarkReceivedByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 bonusModelName: "[string]보너스 모델 이름"
 userId: "[string]사용자ID"
 stepNumber: "[int]스텝 번호"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("loginReward").consume.mark_received_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 bonusModelName="[string]보너스 모델 이름",
 userId="[string]사용자ID",
 stepNumber="[int]스텝 번호",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Lottery 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Acquire Action

입수 액션

Gs2Lottery:DrawByUserId

사용자 ID를 지정하여 추첨을 실행

추첨 모델의 설정에 따라 지정한 사용자의 추첨을 실행합니다.
추첨은 두 가지 방식을 지원합니다: 배출 확률 테이블 모드(사전에 정의된 확률 테이블 사용)와 스크립트 모드(GS2-Script로 경품을 결정).
박스 추첨 모드에서는 배출된 경품이 박스에서 삭제되어 다시 배출되지 않습니다. 박스가 비어 있는 경우 Empty 오류가 반환됩니다.
배출된 경품은 트랜잭션으로 발행됩니다.

수량 지정 가능한 액션: 예

반전 가능한 액션: 아니오

	타입	필수	기본값	값 제한	설명
namespaceName	string	✓		~ 128자	네임스페이스 이름
lotteryName	string	✓		~ 128자	추첨 모델 이름 추첨 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓		~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
count	int	✓		1 ~ 1000	추첨 횟수
config	List<Config>		[]	0 ~ 1000 items	트랜잭션의 플레이스홀더에 적용하는 설정값
timeOffsetToken	string			~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Lottery:DrawByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "lotteryName": "[string]추첨 모델 이름",
 "userId": "[string]사용자ID",
 "count": "[int]추첨 횟수",
 "config": [
 {
 "key": "[string]이름",
 "value": "[string]값"
 }
 ],
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Lottery:DrawByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 lotteryName: "[string]추첨 모델 이름"
 userId: "[string]사용자ID"
 count: "[int]추첨 횟수"
 config: 
 - key: "[string]이름"
 value: "[string]값"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("lottery").acquire.draw_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 lotteryName="[string]추첨 모델 이름",
 userId="[string]사용자ID",
 count="[int]추첨 횟수",
 config={
 {
 key="[string]이름",
 value="[string]값"
 }
 },
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Lottery:ResetBoxByUserId

사용자 ID를 지정하여 박스를 리셋

GS2-Matchmaking 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Matchmaking:VerifyIncludeParticipantByUserId

사용자 ID를 지정하여 영속 개더링에 사용자 ID가 포함되어 있는지 검증

지정된 사용자가 시즌 개더링에 참가하고 있는지 여부를 검증합니다.

수량 지정 가능한 액션: 아니오

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

seasonName

string

✓

~ 128자

시즌 모델 이름

시즌 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

season

long

✓

0 ~ 9223372036854775805

시즌

tier

long

✓

0 ~ 9223372036854775805

티어

비슷한 랭크의 플레이어를 그룹화하기 위한 티어 레벨입니다.
SeasonModel에서 지정된 GS2-Experience 모델에서의 플레이어 랭크에 따라 결정됩니다.
플레이어는 동일한 티어의 플레이어와만 매칭되어 공평한 대전이 보장됩니다.

seasonGatheringName

string

✓

UUID

~ 128자

시즌 게더링명

시즌 게더링 고유의 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

verifyType

문자열 열거형
enum {
“include”,
“notInclude”
}

✓

검증 종류

정의	설명
include	시즌 개더링에 지정한 사용자가 포함되어 있음
notInclude	시즌 개더링에 지정한 사용자가 포함되지 않음

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Matchmaking:VerifyIncludeParticipantByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "seasonName": "[string]시즌 모델 이름",
 "season": "[long]시즌",
 "tier": "[long]티어",
 "seasonGatheringName": "[string]시즌 게더링명",
 "userId": "[string]사용자ID",
 "verifyType": "[string]검증 종류",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Matchmaking:VerifyIncludeParticipantByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 seasonName: "[string]시즌 모델 이름"
 season: "[long]시즌"
 tier: "[long]티어"
 seasonGatheringName: "[string]시즌 게더링명"
 userId: "[string]사용자ID"
 verifyType: "[string]검증 종류"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("matchmaking").verify.verify_include_participant_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 seasonName="[string]시즌 모델 이름",
 season="[long]시즌",
 tier="[long]티어",
 seasonGatheringName="[string]시즌 게더링명",
 userId="[string]사용자ID",
 verifyType="[string]검증 종류",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

GS2-Mission 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Mission:VerifyCompleteByUserId

사용자 ID를 지정하여 미션 달성 상황 검증

지정된 사용자의 미션 태스크의 달성 상황 또는 수령 상황을 검증합니다.

수량 지정 가능한 액션: 아니오

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

missionGroupName

string

✓

~ 128자

미션 그룹명

이 달성 상황 레코드가 속한 미션 그룹의 이름입니다. 사용자별·미션 그룹별로 하나의 달성 상황 레코드가 존재합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

verifyType

문자열 열거형
enum {
  “completed”,
  “notCompleted”,
  “received”,
  “notReceived”,
  “completedAndNotReceived”
}

✓

검증 종류

정의	설명
completed	조건이 달성 완료 상태임
notCompleted	조건이 미달성 상태임
received	보상이 수령 완료 상태임
notReceived	보상이 미수령 상태임
completedAndNotReceived	조건이 달성 완료 상태이고 보상이 미수령 상태임

missionTaskName

string

✓

~ 128자

미션 태스크 모델 이름

미션 태스크 모델 고유의 이름. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

multiplyValueSpecifyingQuantity bool false 수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Mission:VerifyCompleteByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "missionGroupName": "[string]미션 그룹명",
 "userId": "[string]사용자ID",
 "verifyType": "[string]검증 종류",
 "missionTaskName": "[string]미션 태스크 모델 이름",
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Mission:VerifyCompleteByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 missionGroupName: "[string]미션 그룹명"
 userId: "[string]사용자ID"
 verifyType: "[string]검증 종류"
 missionTaskName: "[string]미션 태스크 모델 이름"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("mission").verify.verify_complete_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 missionGroupName="[string]미션 그룹명",
 userId="[string]사용자ID",
 verifyType="[string]검증 종류",
 missionTaskName="[string]미션 태스크 모델 이름",
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Mission:VerifyCounterValueByUserId

사용자 ID를 지정하여 카운터 값 검증

GS2-Money 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2Money:WithdrawByUserId

사용자 ID를 지정하여 지갑에서 잔액 소비

지정한 사용자의 지갑에서 지정한 양의 통화를 소비합니다.
paidOnly가 false인 경우, 무료 통화가 먼저 소비되고 그다음 유료 통화가 소비됩니다.

수량 지정 가능한 액션: 예

반전 가능한 액션: 예

	타입	필수	기본값	값 제한	설명
namespaceName	string	✓		~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓		~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
slot	int	✓		0 ~ 100000000	슬롯 번호 플랫폼이나 컨텍스트별로 지갑 잔액을 분리하기 위한 식별자입니다. 슬롯을 달리하면 서로 다른 유료 통화 풀을 관리할 수 있습니다(예: iOS 구매는 슬롯 0, Android는 슬롯 1). 무료 통화는 네임스페이스의 shareFree 설정에 따라 모든 슬롯 간에 공유할 수도 있습니다.
count	int	✓		1 ~ 2147483646	소비할 유료 통화 수량
paidOnly	bool		false		유료 통화만을 대상으로 할지 여부
timeOffsetToken	string			~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Money:WithdrawByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "slot": "[int]슬롯 번호",
 "count": "[int]소비할 유료 통화 수량",
 "paidOnly": "[bool]유료 통화만을 대상으로 할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Money:WithdrawByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 slot: "[int]슬롯 번호"
 count: "[int]소비할 유료 통화 수량"
 paidOnly: "[bool]유료 통화만을 대상으로 할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("money").consume.withdraw_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 slot="[int]슬롯 번호",
 count="[int]소비할 유료 통화 수량",
 paidOnly="[bool]유료 통화만을 대상으로 할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Money:RecordReceipt

영수증 기록

GS2-Money2 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2Money2:WithdrawByUserId

사용자 ID를 지정하여 지갑에서 잔액 소비

지정된 사용자의 지갑에서 지정된 양의 통화를 소비합니다.
paidOnly가 false인 경우 무상 통화가 먼저 소비되고, 그다음 유상 통화가 소비됩니다.

수량 지정 가능한 액션: 예

반전 가능한 액션: 예

	타입	필수	기본값	값 제한	설명
namespaceName	string	✓		~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓		~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
slot	int	✓		0 ~ 100000000	슬롯 번호 지갑 슬롯을 식별합니다. 플랫폼 간 잔액 공유가 허용되지 않는 경우, 서로 다른 슬롯을 사용하여 플랫폼별로 통화를 나누어 관리할 수 있습니다(예: iOS용과 Android용).
withdrawCount	int	✓		1 ~ 2147483646	소비할 유료 통화 수량
paidOnly	bool		false		유료 통화만을 대상으로 할지 여부
timeOffsetToken	string			~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Money2:WithdrawByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "slot": "[int]슬롯 번호",
 "withdrawCount": "[int]소비할 유료 통화 수량",
 "paidOnly": "[bool]유료 통화만을 대상으로 할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Money2:WithdrawByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 slot: "[int]슬롯 번호"
 withdrawCount: "[int]소비할 유료 통화 수량"
 paidOnly: "[bool]유료 통화만을 대상으로 할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("money2").consume.withdraw_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 slot="[int]슬롯 번호",
 withdrawCount="[int]소비할 유료 통화 수량",
 paidOnly="[bool]유료 통화만을 대상으로 할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Money2:VerifyReceiptByUserId

사용자 ID를 지정하여 영수증을 사용 완료 처리

GS2-Quest 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2Quest:DeleteProgressByUserId

사용자 ID를 지정하여 퀘스트 진행 상황 삭제

지정한 사용자의 현재 퀘스트 진행 상황을 삭제합니다. 진행 중인 퀘스트를 취소하고 새로운 퀘스트를 시작할 수 있게 합니다.

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 아니오

	타입	필수	값 제한	설명
namespaceName	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓	~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
timeOffsetToken	string		~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Quest:DeleteProgressByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Quest:DeleteProgressByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("quest").consume.delete_progress_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Ranking2 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Ranking2:VerifyGlobalRankingScoreByUserId

사용자 ID를 지정하여 글로벌 랭킹의 스코어 검증

지정한 사용자의 글로벌 랭킹 스코어를 비교 연산자(less, lessEqual, greater, greaterEqual, equal, notEqual)를 사용하여 지정한 값과 비교 검증합니다.

수량 지정 가능한 액션: 예

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

rankingName

string

✓

~ 128자

글로벌 랭킹 모델 이름

글로벌 랭킹 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

verifyType

문자열 열거형
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}

✓

검증 종류

정의	설명
less	스코어가 지정값 미만일 것
lessEqual	스코어가 지정값 이하일 것
greater	스코어가 지정값 초과일 것
greaterEqual	스코어가 지정값 이상일 것
equal	스코어가 지정값과 일치할 것
notEqual	스코어가 지정값과 일치하지 않을 것

season long 0 ~ 9223372036854775805 시즌

score

long

✓

0 ~ 9223372036854775805

스코어

사용자가 등록한 스코어 값입니다. 랭킹 모델의 minimumValue와 maximumValue로 정의된 범위 내에 있어야 합니다.

multiplyValueSpecifyingQuantity bool true 수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "rankingName": "[string]글로벌 랭킹 모델 이름",
 "verifyType": "[string]검증 종류",
 "season": "[long]시즌",
 "score": "[long]스코어",
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Ranking2:VerifyGlobalRankingScoreByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 rankingName: "[string]글로벌 랭킹 모델 이름"
 verifyType: "[string]검증 종류"
 season: "[long]시즌"
 score: "[long]스코어"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("ranking2").verify.verify_global_ranking_score_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 rankingName="[string]글로벌 랭킹 모델 이름",
 verifyType="[string]검증 종류",
 season="[long]시즌",
 score="[long]스코어",
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Ranking2:VerifyClusterRankingScoreByUserId

사용자 ID를 지정하여 클러스터 랭킹의 스코어 검증

GS2-Schedule 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Schedule:VerifyTriggerByUserId

사용자 ID를 지정하여 트리거가 당겨진 후 경과 시간 검증

지정한 사용자의 트리거 상태에 관한 조건을 검증합니다. verifyType은 ’notTriggerd’, ’elapsed’, ’notElapsed’를 설정할 수 있습니다. 검증 조건이 충족되지 않으면 오류를 반환합니다.

수량 지정 가능한 액션: 아니오

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

triggerName

string

✓

~ 128자

트리거 이름

트리거 고유 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

verifyType

문자열 열거형
enum {
  “notTriggerd”,
  “elapsed”,
  “notElapsed”
}

✓

검증 종류

정의	설명
notTriggerd	트리거가 당겨지지 않음
elapsed	지정한 시간이 경과함
notElapsed	지정한 시간이 경과하지 않음

elapsedMinutes

int

{verifyType} in [“elapsed”, “notElapsed”]

✓※

0 ~ 2147483646

경과 시간(분)

※ verifyType이(가) “elapsed”,“notElapsed"이면 필수

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Schedule:VerifyTriggerByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "triggerName": "[string]트리거 이름",
 "verifyType": "[string]검증 종류",
 "elapsedMinutes": "[int]경과 시간(분)",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Schedule:VerifyTriggerByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 triggerName: "[string]트리거 이름"
 verifyType: "[string]검증 종류"
 elapsedMinutes: "[int]경과 시간(분)"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("schedule").verify.verify_trigger_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 triggerName="[string]트리거 이름",
 verifyType="[string]검증 종류",
 elapsedMinutes="[int]경과 시간(분)",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Schedule:VerifyEventByUserId

사용자 ID를 지정하여 이벤트 개최 기간인지 검증

GS2-Script 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Acquire Action

입수 액션

Gs2Script:InvokeScript

스크립트 실행

지정된 Lua 스크립트를 제공된 JSON 인수로 동기적으로 실행합니다. 스테이터스 코드, 반환값, 트랜잭션 정보, 난수 상태, 실행 시간, 표준 출력을 포함한 실행 결과를 반환합니다. GS2 서비스 간 원자적 처리를 위한 트랜잭션 처리를 지원합니다.

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 아니오

	타입	필수	기본값	값 제한	설명
scriptId	string	✓		~ 1024자	스크립트 GRN
userId	string			~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
args	string		“{}”	~ 5242880자	스크립트에 전달되는 인수 (JSON 형식)
randomStatus	RandomStatus				난수 상태
timeOffsetToken	string			~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Script:InvokeScript",
 "request": {
 "scriptId": "[string]스크립트 GRN",
 "userId": "[string]사용자ID",
 "args": "[string]스크립트에 전달되는 인수 (JSON 형식)",
 "randomStatus": {
 "seed": "[long]난수 시드",
 "used": [
 {
 "category": "[long]카테고리",
 "used": "[long]사용 횟수"
 }
 ]
 },
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Script:InvokeScript
request:
 scriptId: "[string]스크립트 GRN"
 userId: "[string]사용자ID"
 args: "[string]스크립트에 전달되는 인수 (JSON 형식)"
 randomStatus: 
 seed: "[long]난수 시드"
 used: 
 - category: "[long]카테고리"
 used: "[long]사용 횟수"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("script").acquire.invoke_script({
 scriptId="[string]스크립트 GRN",
 userId="[string]사용자ID",
 args="[string]스크립트에 전달되는 인수 (JSON 형식)",
 randomStatus={
 seed="[long]난수 시드",
 used={
 {
 category="[long]카테고리",
 used="[long]사용 횟수"
 }
 }
 },
 timeOffsetToken="[string]타임 오프셋 토큰",
})

GS2-SerialKey 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2SerialKey:VerifyCodeByUserId

사용자 ID를 지정하여 시리얼 코드의 유효성 확인

지정된 사용자의 시리얼 코드를 소비하지 않고 검증합니다. 특정 캠페인 모델 이름에 대한 검증을 지원하며, 코드가 active(미사용)인지 inactive(사용 완료)인지 확인할 수 있습니다.

수량 지정 가능한 액션: 아니오

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

code

string

✓

~ 48자

시리얼 코드

“XXXXX-XXXX-XXXXX-XXXX-XXXX” 형식의 시리얼 코드 문자열입니다. 각 코드는 고유하며 캠페인 식별 정보를 포함합니다. 코드의 형식과 데이터 길이는 고정되어 있어 변경할 수 없습니다.

campaignModelName

string

~ 128자

캠페인 이름

이 시리얼 코드가 속한 캠페인 모델의 이름입니다. 캠페인 정보는 시리얼 코드 자체에 포함되어 있으므로 코드를 사용할 때는 네임스페이스만 지정하면 됩니다.

verifyType

문자열 열거형
enum {
“active”,
“inactive”
}

✓

검증 타입

정의	설명
active	유효
inactive	비활성

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2SerialKey:VerifyCodeByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "code": "[string]시리얼 코드",
 "campaignModelName": "[string]캠페인 이름",
 "verifyType": "[string]검증 타입",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2SerialKey:VerifyCodeByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 code: "[string]시리얼 코드"
 campaignModelName: "[string]캠페인 이름"
 verifyType: "[string]검증 타입"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("serialKey").verify.verify_code_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 code="[string]시리얼 코드",
 campaignModelName="[string]캠페인 이름",
 verifyType="[string]검증 타입",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Consume Action

소비 액션

GS2-Showcase 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2Showcase:IncrementPurchaseCountByUserId

사용자 ID를 지정하여 구매 횟수 가산

지정된 사용자의 랜덤 진열대에 있는 특정 상품의 구매 횟수를 가산합니다. 로테이션 기간별 구매 제한을 추적하는 데 사용됩니다.

수량 지정 가능한 액션: 예

반전 가능한 액션: 예

	타입	필수	값 제한	설명
namespaceName	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
showcaseName	string	✓	~ 128자	랜덤 진열대 이름
displayItemName	string	✓	~ 128자	상품 구매 횟수 이름 구매 횟수를 추적하는 랜덤 진열 상품의 이름입니다. 랜덤 진열대 내 진열 상품명에 대응합니다.
userId	string	✓	~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
count	int	✓	0 ~ 100	가산할 구매 횟수
timeOffsetToken	string		~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2Showcase:IncrementPurchaseCountByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "showcaseName": "[string]랜덤 진열대 이름",
 "displayItemName": "[string]상품 구매 횟수 이름",
 "userId": "[string]사용자ID",
 "count": "[int]가산할 구매 횟수",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Showcase:IncrementPurchaseCountByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 showcaseName: "[string]랜덤 진열대 이름"
 displayItemName: "[string]상품 구매 횟수 이름"
 userId: "[string]사용자ID"
 count: "[int]가산할 구매 횟수"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("showcase").consume.increment_purchase_count_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 showcaseName="[string]랜덤 진열대 이름",
 displayItemName="[string]상품 구매 횟수 이름",
 userId="[string]사용자ID",
 count="[int]가산할 구매 횟수",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-SkillTree 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Consume Action

소비 액션

Gs2SkillTree:MarkRestrainByUserId

사용자 ID를 지정하여 노드의 해방 상태를 미해방화

지정된 노드가 구속 가능한지 검증한 후(의존하는 노드가 해방 상태가 아니어야 합니다), 미해방으로 마크합니다.

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 예

	타입	필수	값 제한	설명
namespaceName	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓	~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
propertyId	string	✓	~ 1024자	프로퍼티 ID 사용자마다 여러 개의 독립된 스킬트리 인스턴스를 가지기 위한 식별자입니다. 동일한 네임스페이스 내에서 플레이어가 서로 다른 캐릭터나 컨텍스트에 대해 별도의 스킬트리를 가지는 시나리오를 구현합니다. 최대 1024자.
nodeModelNames	List<string>	✓	1 ~ 1000 items	노드 모델 이름 목록
timeOffsetToken	string		~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2SkillTree:MarkRestrainByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "propertyId": "[string]프로퍼티 ID",
 "nodeModelNames": [
 "[string]노드 모델명"
 ],
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2SkillTree:MarkRestrainByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 propertyId: "[string]프로퍼티 ID"
 nodeModelNames: 
 - "[string]노드 모델명"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("skillTree").consume.mark_restrain_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 propertyId="[string]프로퍼티 ID",
 nodeModelNames={
 "[string]노드 모델명"
 },
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Acquire Action

입수 액션

GS2-Stamina 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Verify Action

검증 액션

Gs2Stamina:VerifyStaminaValueByUserId

사용자 ID를 지정하여 스타미나 현재값을 검증

지정된 사용자의 현재 스타미나 값이 지정된 조건을 지정된 임계값에 대해 충족하는지, 상태를 변경하지 않고 검증합니다.

수량 지정 가능한 액션: 예

타입 활성화 조건 필수 기본값 값 제한 설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.

userId

string

✓

~ 128자

사용자ID
#{userId}로 설정하면 로그인 중인 사용자ID로 치환됩니다.

staminaName

string

✓

~ 128자

스태미나 모델 이름

이 스태미나 인스턴스의 회복 파라미터, 용량, 테이블 참조를 정의하는 StaminaModel의 이름입니다.
사용자별 스태미나 상태를 대응하는 모델 정의와 연결합니다.

verifyType

문자열 열거형
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}

✓

검증 종류

정의	설명
less	현재값이 지정값 미만임
lessEqual	현재값이 지정값 이하임
greater	현재값이 지정값을 초과함
greaterEqual	현재값이 지정값 이상임
equal	현재값이 지정값과 일치함
notEqual	현재값이 지정값과 일치하지 않음

value

int

✓

0 ~ 2147483646

현재값

multiplyValueSpecifyingQuantity bool true 수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부

timeOffsetToken string ~ 1024자 타임 오프셋 토큰

{
 "action": "Gs2Stamina:VerifyStaminaValueByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "staminaName": "[string]스태미나 모델 이름",
 "verifyType": "[string]검증 종류",
 "value": "[int]현재값",
 "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2Stamina:VerifyStaminaValueByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 staminaName: "[string]스태미나 모델 이름"
 verifyType: "[string]검증 종류"
 value: "[int]현재값"
 multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("stamina").verify.verify_stamina_value_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 staminaName="[string]스태미나 모델 이름",
 verifyType="[string]검증 종류",
 value="[int]현재값",
 multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
 timeOffsetToken="[string]타임 오프셋 토큰",
})

Gs2Stamina:VerifyStaminaMaxValueByUserId

사용자 ID를 지정하여 스태미나 최댓값 검증

GS2-StateMachine 트랜잭션 액션

Mon, 01 Jan 0001 00:00:00 +0000

Acquire Action

입수 액션

Gs2StateMachine:StartStateMachineByUserId

사용자 ID를 지정하여 스테이트 머신 시작

최신 마스터 버전을 사용하여 지정한 사용자의 새로운 스테이트 머신 인스턴스를 시작합니다. 인자는 JSON으로 전달되어 스테이트 머신 변수로 파싱됩니다. 선택적으로 TTL(분 단위)을 설정할 수 있으며, 생략한 경우 스테이트 머신은 약 10년간 유효합니다.

수량 지정 가능한 액션: 아니오

반전 가능한 액션: 아니오

	타입	필수	기본값	값 제한	설명
namespaceName	string	✓		~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
userId	string	✓		~ 128자	사용자ID `#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다.
args	string		“{}”	~ 4096자	스테이트 머신에 전달할 인자
ttl	int			1 ~ 525600	유효 기간(분)
timeOffsetToken	string			~ 1024자	타임 오프셋 토큰

{
 "action": "Gs2StateMachine:StartStateMachineByUserId",
 "request": {
 "namespaceName": "[string]네임스페이스 이름",
 "userId": "[string]사용자ID",
 "args": "[string]스테이트 머신에 전달할 인자",
 "ttl": "[int]유효 기간(분)",
 "timeOffsetToken": "[string]타임 오프셋 토큰"
 }
}

action: Gs2StateMachine:StartStateMachineByUserId
request:
 namespaceName: "[string]네임스페이스 이름"
 userId: "[string]사용자ID"
 args: "[string]스테이트 머신에 전달할 인자"
 ttl: "[int]유효 기간(분)"
 timeOffsetToken: "[string]타임 오프셋 토큰"

transaction.service("stateMachine").acquire.start_state_machine_by_user_id({
 namespaceName="[string]네임스페이스 이름",
 userId="[string]사용자ID",
 args="[string]스테이트 머신에 전달할 인자",
 ttl="[int]유효 기간(분)",
 timeOffsetToken="[string]타임 오프셋 토큰",
})