Master Data Reference of GS2-Ranking

Master Data Format

• JSON

{
  "version": "2019-09-17",
  "categories": [
    {
      "name": "[string]Category Name",
      "metadata": "[string?]Metadata",
      "minimumValue": "[long?]Minimum Score",
      "maximumValue": "[long?]Maximum Score",
      "sum": "[bool]Add up the scores received and compete for the total value",
      "orderDirection": "[string]Sort direction of scores",
      "scope": "[string]Type of Ranking",
      "globalRankingSetting": {
        "uniqueByUserId": "[bool]Only one score is registered per user ID",
        "calculateIntervalMinutes": "[int]Interval between score totals (minutes)",
        "calculateFixedTiming": {
          "hour": "[int?]Fixed time to start tallying scores (hour)",
          "minute": "[int?]Fixed time to start tallying scores (minutes)"
        },
        "additionalScopes": [
          {
            "name": "[string]Scope Name",
            "targetDays": "[long]Number of days to aggregate"
          }
        ],
        "ignoreUserIds": [
          "[string]User ID that are not reflected in the ranking"
        ],
        "generation": "[string?]Ranking Generation"
      },
      "entryPeriodEventId": "[string?]Period during which scores can be registered GS2-Schedule Event GRN",
      "accessPeriodEventId": "[string?]Period during which ranking data can be accessed GS2-Schedule Event GRN"
    }
  ]
}

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

Available in Global Ranking mode. Normally, the global ranking is calculated for all registered scores.

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 timing at which ranking calculations start.