GS2-Ranking Deploy/CDK 레퍼런스

GS2-Deploy의 스택을 생성할 때 사용하는 템플릿 포맷과, CDK를 이용한 각종 언어의 템플릿 출력 구현 예제

엔티티

Deploy 처리에서 조작 대상이 되는 리소스

Namespace

네임스페이스

네임스페이스는 하나의 프로젝트 내에서 동일한 서비스를 서로 다른 용도로 여러 개 이용하기 위한 엔티티입니다.
GS2의 각 서비스는 네임스페이스 단위로 관리됩니다. 네임스페이스가 다르면 동일한 서비스라도 완전히 독립된 데이터 공간으로 취급됩니다.

따라서 각 서비스의 이용을 시작하려면 먼저 네임스페이스를 생성해야 합니다.

Request

리소스 생성・갱신 요청

	타입	필수	값 제한	설명
name	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
description	string		~ 1024자	설명문
transactionSetting	TransactionSetting			트랜잭션 설정 랭킹 조작 시 트랜잭션의 처리 방법을 제어하는 설정입니다.
logSetting	LogSetting			로그 출력 설정 랭킹 관련 조작 로그를 GS2-Log에 출력하기 위한 설정입니다. 설정하면 스코어 등록, 랭킹 취득, 구독 변경 등의 작업이 분석 및 감사를 위해 기록됩니다.

GetAttr

!GetAttr 태그로 취득 가능한 리소스 생성 결과

	타입	설명
Item	Namespace	생성한 네임스페이스

구현 예제

Type: GS2::Ranking::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/ranking"
)


SampleStack := core.NewStack()
ranking.NewNamespace(
    &SampleStack,
    "namespace-0001",
    ranking.NamespaceOptions{
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Ranking\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Ranking\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.ranking.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.ranking.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 Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Ranking.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Ranking.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 Template

import core from "@/gs2cdk/core";
import ranking from "@/gs2cdk/ranking";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new ranking.model.Namespace(
            this,
            "namespace-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, ranking

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        ranking.Namespace(
            stack=self,
            name='namespace-0001',
            options=ranking.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

TransactionSetting

트랜잭션 설정

트랜잭션 설정은 트랜잭션의 실행 방법·정합성·비동기 처리·충돌 회피 메커니즘을 제어하는 설정입니다.
자동 실행(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

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로 지정해야 합니다.

CurrentRankingMaster

현재 활성화된 랭킹 모델 마스터 데이터

현재 네임스페이스 내에서 유효한 랭킹 모델의 정의를 기술한 마스터 데이터입니다.
GS2는 마스터 데이터 관리에 JSON 형식의 파일을 사용합니다.
파일을 업로드함으로써 실제로 서버에 설정을 반영할 수 있습니다.

JSON 파일을 작성하는 방법으로, 매니지먼트 콘솔 내에 마스터 데이터 에디터를 제공하고 있습니다.
또한 게임 운영에 더 적합한 도구를 직접 제작하여 적절한 형식의 JSON 파일을 출력하는 방식으로도 서비스를 이용할 수 있습니다.

Note

JSON 파일 형식에 대해서는 GS2-Ranking 마스터 데이터 레퍼런스를 참조해 주세요.

Request

리소스 생성・갱신 요청

타입

활성화 조건

필수

기본값

값 제한

설명

namespaceName

string

✓

~ 128자

네임스페이스 이름

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

mode

문자열 열거형
enum {
“direct”,
“preUpload”
}

“direct”

업데이트 모드

정의	설명
direct	마스터 데이터를 직접 업데이트
preUpload	마스터 데이터를 업로드한 후 업데이트

settings

string

{mode} == “direct”

✓※

~ 5242880 바이트 (5MB)

마스터 데이터

※ mode이(가) “direct” 이면 필수

uploadToken

string

{mode} == “preUpload”

✓※

~ 1024자

사전 업로드로 획득한 토큰

업로드한 마스터 데이터를 적용하기 위해 사용됩니다.

※ mode이(가) “preUpload” 이면 필수

GetAttr

!GetAttr 태그로 취득 가능한 리소스 생성 결과

	타입	설명
Item	CurrentRankingMaster	업데이트된 현재 활성화된 랭킹 모델의 마스터 데이터

구현 예제

Type: GS2::Ranking::CurrentRankingMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2019-09-17",
    "categories": []
    
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/ranking"
)


SampleStack := core.NewStack()
ranking.NewNamespace(
    &SampleStack,
    "namespace-0001",
    ranking.NamespaceOptions{},
).MasterData(
    []ranking.CategoryModel{
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Ranking\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.ranking.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Ranking.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Ranking.Model.CategoryModel[] {
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import ranking from "@/gs2cdk/ranking";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new ranking.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, ranking

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        ranking.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            categories=[
            ],
        )

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

CategoryModel

카테고리 모델

카테고리마다 서로 다른 랭킹을 생성할 수 있습니다.

카테고리에는 등록 가능한 스코어의 최소값·최대값을 설정할 수 있으며, 해당 범위를 벗어나는 스코어는 폐기됩니다.
랭킹을 집계할 때 스코어가 작은 것을 상위(오름차순)로 할지, 큰 것을 상위(내림차순)로 할지를 설정할 수 있습니다.

랭킹의 종류로 글로벌과 스코프를 선택할 수 있습니다.
글로벌은 모든 플레이어가 동일한 결과를 참조하는 것이며, 스코프는 친구 내 랭킹이나 길드 내 랭킹처럼 게임 플레이어마다 결과가 다른 랭킹입니다.

글로벌 랭킹은 카테고리별로 랭킹 집계 간격을 15분~24시간으로 설정할 수 있습니다.
스코프 랭킹은 실시간으로 집계 결과가 반영됩니다.

랭킹 데이터에는 세대라는 설정이 있으며, 세대를 변경함으로써 등록된 스코어를 리셋할 수 있습니다.

타입

활성화 조건

필수

기본값

값 제한

설명

categoryModelId

string

※

~ 1024자

카테고리 모델 GRN

※ 서버가 자동으로 설정

name

string

✓

~ 128자

카테고리 모델 이름

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

metadata

string

~ 1024자

메타데이터

메타데이터에는 임의의 값을 설정할 수 있습니다.
이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다.

minimumValue

long

0 ~ 9223372036854775805

점수 최솟값

이 카테고리에 등록할 수 있는 점수의 최솟값입니다.
이 임곗값보다 낮은 점수는 등록 시 거부됩니다. 설정하지 않으면 하한이 없습니다.

maximumValue

long

0 ~ 9223372036854775805

점수 최댓값

이 카테고리에 등록할 수 있는 점수의 최댓값입니다.
이 임곗값보다 높은 점수는 등록 시 거부됩니다. 설정하지 않으면 상한이 없습니다.

sum

bool

false

합산 모드

활성화하면 새로 등록된 점수가 기존 점수를 대체하는 것이 아니라 합계에 더해집니다.
랭킹은 누적된 합계값을 기준으로 계산됩니다. 비활성화된 경우 각 점수 등록은 독립된 항목으로 처리됩니다.

orderDirection

문자열 열거형
enum {
“asc”,
“desc”
}

✓

정렬 방향

랭킹 집계의 정렬 순서를 결정합니다.
“asc”(오름차순)는 낮은 점수를 상위로 하며, 시간 기반이나 골프식 랭킹에 적합합니다.
“desc”(내림차순)는 높은 점수를 상위로 하며, 포인트 기반이나 하이스코어 랭킹에 적합합니다.

정의	설명
asc	오름차순
desc	내림차순

scope

문자열 열거형
enum {
“global”,
“scoped”
}

✓

랭킹 종류

이 카테고리의 랭킹 타입입니다.
“global” 은 모든 플레이어가 공유하는 단일 리더보드를 만들며, 설정된 간격으로 배치 집계됩니다.
“scoped” 는 구독한 플레이어(친구나 길드 멤버 등)를 기반으로 한 사용자별 리더보드를 만들며, 점수가 실시간으로 반영됩니다.

정의	설명
global	글로벌
scoped	스코프

globalRankingSetting

GlobalRankingSetting

{scope} == “global”

✓※

글로벌 랭킹 설정

글로벌 랭킹 모드 전용 설정입니다. 집계 간격, 고정 시각, 점수의 유니크 여부, 세대 관리, 추가 기간 한정 스코프를 포함합니다.
scope 가 “global” 로 설정된 경우에만 적용됩니다.

※ scope이(가) “global” 이면 필수

entryPeriodEventId

string

~ 1024자

점수 등록 기간 이벤트 ID

점수 등록을 받는 기간을 정의하는 GS2-Schedule 이벤트의 GRN입니다.
이 기간 외의 점수 등록 요청은 거부됩니다. 설정하지 않으면 점수는 언제든지 등록할 수 있습니다.

accessPeriodEventId

string

~ 1024자

접근 기간 이벤트 ID

랭킹 데이터를 열람할 수 있는 기간을 정의하는 GS2-Schedule 이벤트의 GRN입니다.
이 기간 외의 랭킹 조회 요청은 거부됩니다. 설정하지 않으면 랭킹은 언제든지 접근할 수 있습니다.

Scope

집계 스코프

글로벌 랭킹 모드에서의 추가적인 기간 한정 집계 스코프를 정의합니다.
일반적으로 글로벌 랭킹은 등록된 모든 스코어를 대상으로 집계됩니다.
스코프를 추가하면 지정한 일수 이내에 등록된 스코어만을 대상으로 하는 별도의 랭킹을 생성할 수 있으며, 전체 기간 랭킹과 함께 데일리·위클리·먼슬리 등의 리더보드를 구현할 수 있습니다.

	타입	활성화 조건	필수	기본값	값 제한	설명
name	string		✓		~ 128자	스코프 이름 카테고리 내에서 이 집계 스코프를 고유하게 식별하는 이름입니다. 여러 개의 기간 한정 랭킹 보드를 구분하기 위해 사용됩니다(예: “daily”, “weekly”). 최대 128자.
targetDays	long		✓		1 ~ 365	집계 대상 일수 집계 윈도우에 포함할 일수입니다. 현재 시각으로부터 이 일수 이내에 등록된 스코어만 스코프 랭킹의 대상이 됩니다. 범위: 1~365일.

GlobalRankingSetting

글로벌 랭킹 설정

글로벌은 모든 플레이어가 동일한 결과를 참조하는 방식입니다.
랭킹 집계 간격은 15분~24시간으로 설정할 수 있습니다.

랭킹 데이터에는 세대라는 설정이 있으며, 세대를 변경함으로써 등록된 점수를 초기화할 수 있습니다.

	타입	필수	기본값	값 제한	설명
uniqueByUserId	bool		true		사용자 ID별 유니크 활성화하면 랭킹 내에서 사용자 ID별로 하나의 점수만 유지됩니다. 사용자가 새로운 점수를 등록하면 정렬 방향에 따라 더 나은 점수로 교체됩니다. 비활성화하면 동일 사용자로부터 여러 점수 항목이 허용되어 합산 모드나 다중 항목 경쟁이 가능해집니다.
calculateIntervalMinutes	int	✓		15 ~ 1440	집계 간격(분) 연속되는 랭킹 재집계 사이의 간격(분)입니다. 시스템은 이 간격으로 등록된 모든 점수를 기반으로 글로벌 랭킹을 정기적으로 재집계합니다. 범위: 15~~1440분(15분~~24시간).
calculateFixedTiming	FixedTiming				집계 시각 고정 설정 랭킹 재집계가 시작되는 하루 중 고정 시각(UTC)을 지정합니다. 설정하지 않으면 재집계는 정해지지 않은 기준 시각부터 일정 간격으로 실행됩니다. 이를 설정하면 매일 예측 가능하고 일관된 시각에 재집계가 이루어지도록 할 수 있습니다.
additionalScopes	List<Scope>			0 ~ 10 items	추가 스코프 목록 추가적인 기간 한정 집계 스코프 목록입니다. 각 스코프는 지정한 일수 이내에 등록된 점수만을 대상으로 하는 별도의 랭킹을 정의합니다. 전체 기간의 글로벌 랭킹과 함께 데일리·위클리·먼슬리 등의 리더보드를 만들 수 있습니다. 최대 10건.
ignoreUserIds	List<string>			0 ~ 10000 items	제외 사용자 ID 목록 랭킹 집계에서 점수를 제외할 사용자 ID 목록입니다. 테스트 계정, 관리자 계정 또는 알려진 부정 사용자를 리더보드에서 제외하는 데 사용합니다. 최대 10,000건.
generation	string			~ 256자	세대 현재 랭킹 세대를 나타내는 임의의 문자열입니다. 이 값을 변경하면 이전 세대의 점수는 랭킹 집계에 포함되지 않으므로 사실상 점수가 초기화됩니다. 시즌제 초기화나 정기적인 랭킹 초기화를 구현하는 데 사용합니다. 최대 256자.

FixedTiming

집계 시각 고정 설정

글로벌 랭킹의 집계가 시작되는 고정 시각을 지정합니다.
이 설정이 없으면 랭킹 집계는 정해지지 않은 기준 시각부터 일정 간격으로 실행됩니다.
고정된 시·분을 지정함으로써 매일의 집계 시작 시각(UTC)을 예측 가능하게 할 수 있으며, 자정이나 특정 시각에 집계를 시작하도록 제어할 수 있습니다.

	타입	활성화 조건	필수	기본값	값 제한	설명
hour	int				0 ~ 23	시 랭킹 집계가 시작되는 시각의 시(UTC)입니다. 0~23 사이의 정수로 지정합니다.
minute	int				0 ~ 59	분 지정한 시각의 분입니다. 0~59 사이의 정수로 지정합니다.