GS2-Ranking Master Data Reference

Master Data Format

{
  "version": "2019-09-17",
  "categories": [
    {
      "name": "[string]Category Model name",
      "metadata": "[string?]Metadata",
      "minimumValue": "[long?]Minimum Value",
      "maximumValue": "[long?]Maximum Value",
      "sum": "[bool]Sum Mode",
      "orderDirection": "[string enum]Order Direction",
      "scope": "[string enum]Scope",
      "globalRankingSetting": {
        "uniqueByUserId": "[bool]Unique By User ID",
        "calculateIntervalMinutes": "[int]Calculate Interval Minutes",
        "calculateFixedTiming": {
          "hour": "[int?]Hour",
          "minute": "[int?]Minute"
        },
        "additionalScopes": [
          {
            "name": "[string]Scope Name",
            "targetDays": "[long]Target Days"
          }
        ],
        "ignoreUserIds": [
          "[string]User ID that are not reflected in the ranking"
        ],
        "generation": "[string?]Generation"
      },
      "entryPeriodEventId": "[string?]Entry Period Event ID",
      "accessPeriodEventId": "[string?]Access Period Event ID"
    }
  ]
}

Model

CategoryModel

Category Model

Different rankings can be created for different categories.

Categories can have a minimum and maximum score that can be registered, and scores outside of that range are discarded. When calculating rankings, it is possible to set whether the scores are to be ranked in ascending or descending order, with the smallest scores being ranked higher (ascending order) or the largest scores being ranked lower (descending order).

You can select global or scope as the type of ranking. Global is a ranking where all players see the same results, and Scope is a ranking where each game player has a different result, such as a ranking among friends or a ranking in a guild.

For global ranking, you can set the ranking interval from 15 minutes to 24 hours for each category. Scope rankings reflect the calculate results in real time.

The ranking data has a setting called “generation,” and the registered scores can be reset by changing the generation.

Scope

Aggregation Scope

Defines an additional time-windowed aggregation scope for Global Ranking mode. Normally, global ranking is calculated for all registered scores regardless of when they were submitted. By adding scopes, you can create separate rankings that only consider scores registered within a specified number of days, enabling daily, weekly, or monthly leaderboards alongside the all-time ranking.

GlobalRankingSetting

Global Ranking Setting

Global is a ranking where all players see the same results. The ranking interval can be set from 15 minutes to 24 hours.

The ranking data has a setting called “generation,” and the registered scores can be reset by changing the generation.

FixedTiming

Fixed Timing

Specifies the fixed time of day at which global ranking calculations start. Without this setting, ranking calculation occurs at regular intervals from an unspecified base time. By specifying a fixed hour and minute, you can ensure that ranking recalculation always begins at a predictable time (in UTC), such as midnight or a specific hour.