GS2-Ranking 마스터 데이터 레퍼런스

마스터 데이터 포맷

• JSON

{
  "version": "2019-09-17",
  "categories": [
    {
      "name": "[string]카테고리 모델 이름",
      "metadata": "[string?]메타데이터",
      "minimumValue": "[long?]점수 최솟값",
      "maximumValue": "[long?]점수 최댓값",
      "sum": "[bool]합산 모드",
      "orderDirection": "[문자열 열거형]정렬 방향",
      "scope": "[문자열 열거형]랭킹 종류",
      "globalRankingSetting": {
        "uniqueByUserId": "[bool]사용자 ID별 유니크",
        "calculateIntervalMinutes": "[int]집계 간격(분)",
        "calculateFixedTiming": {
          "hour": "[int?]시",
          "minute": "[int?]분"
        },
        "additionalScopes": [
          {
            "name": "[string]스코프 이름",
            "targetDays": "[long]집계 대상 일수"
          }
        ],
        "ignoreUserIds": [
          "[string]랭킹에 반영하지 않을 사용자 ID"
        ],
        "generation": "[string?]세대"
      },
      "entryPeriodEventId": "[string?]점수 등록 기간 이벤트 ID",
      "accessPeriodEventId": "[string?]접근 기간 이벤트 ID"
    }
  ]
}

모델

CategoryModel

카테고리 모델

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

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

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

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

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

Scope

집계 스코프

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

GlobalRankingSetting

글로벌 랭킹 설정

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

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

FixedTiming

집계 시각 고정 설정

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