Master Data Reference of GS2-Ranking2
Master Data Format
{
"version": "2024-05-30",
"globalRankingModels": [
{
"name": "[string]Global Ranking Model 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 enum]Sort direction of scores",
"entryPeriodEventId": "[string?]Period during which scores can be registered GS2-Schedule EventGRN",
"rankingRewards": [
{
"thresholdRank": "[int]Rank threshold",
"metadata": "[string?]Metadata",
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON string of the request used when executing the action"
}
]
}
],
"accessPeriodEventId": "[string?]Period during which ranking data can be accessed GS2-Schedule EventGRN",
"rewardCalculationIndex": "[string enum]Reward calculation index"
}
],
"clusterRankingModels": [
{
"name": "[string]Cluster Ranking Model name",
"metadata": "[string?]Metadata",
"clusterType": "[string enum]Cluster Type",
"minimumValue": "[long?]Minimum Score",
"maximumValue": "[long?]Maximum Score",
"sum": "[bool]Add up the scores received and compete for the total value",
"orderDirection": "[string enum]Sort direction of scores",
"entryPeriodEventId": "[string?]Period during which scores can be registered GS2-Schedule EventGRN",
"rankingRewards": [
{
"thresholdRank": "[int]Rank threshold",
"metadata": "[string?]Metadata",
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON string of the request used when executing the action"
}
]
}
],
"accessPeriodEventId": "[string?]Period during which ranking data can be accessed GS2-Schedule EventGRN",
"rewardCalculationIndex": "[string enum]Reward calculation index"
}
],
"subscribeRankingModels": [
{
"name": "[string]Subscribe Ranking Model 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 enum]Sort direction of scores",
"entryPeriodEventId": "[string?]Period during which scores can be registered GS2-Schedule EventGRN",
"accessPeriodEventId": "[string?]Period during which ranking data can be accessed GS2-Schedule EventGRN"
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2024-05-30 | Format version of master data | ||
| globalRankingModels | List<GlobalRankingModel> | ~ 10 items | Global Ranking Model The global ranking is a model that allows you to create a ranking that targets all players. You can display the top 1000 rankings. By associating it with the repeat event of GS2-Schedule, you can reset the ranking according to the number of repetitions. | |||
| clusterRankingModels | List<ClusterRankingModel> | ~ 10 items | Cluster Ranking Model The cluster ranking model enables rankings for players within guilds or gatherings. You can display the top 1000 rankings. By associating it with the repeat event of GS2-Schedule, you can reset the ranking according to the number of repetitions. | |||
| subscribeRankingModels | List<SubscribeRankingModel> | ~ 10 items | Subscribe Ranking Model A model that aggregates the scores of other players who have subscribed and creates a ranking. |
Model
GlobalRankingModel
Global Ranking Model
The global ranking is a model that allows you to create a ranking that targets all players. You can display the top 1000 rankings.
By associating it with the repeat event of GS2-Schedule, you can reset the ranking according to the number of repetitions.
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| globalRankingModelId | string | ✓* | ~ 1024 chars | Global Ranking GRN * Automatically configured on the server | ||||||||
| name | string | ✓ | ~ 128 chars | Global Ranking Model Name Global Ranking Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||
| metadata | string | ~ 1024 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||||||||
| minimumValue | long | 0 ~ 9223372036854775805 | Minimum Score | |||||||||
| maximumValue | long | 0 ~ 9223372036854775805 | Maximum Score | |||||||||
| sum | bool | ✓ | false | Add up the scores received and compete for the total value | ||||||||
| orderDirection | String Enum enum { “asc”, “desc” } | ✓ | Sort direction of scores
| |||||||||
| entryPeriodEventId | string | ~ 1024 chars | Period during which scores can be registered GS2-Schedule Event GRN | |||||||||
| rankingRewards | List<RankingReward> | {entryPeriodEventId} != null | [] | 0 ~ 100 items | List of ranking rewards | |||||||
| accessPeriodEventId | string | ~ 1024 chars | Period during which ranking data can be accessed GS2-Schedule Event GRN | |||||||||
| rewardCalculationIndex | String Enum enum { “rank”, “index” } | ✓ | “rank” | Reward calculation index
|
RankingReward
Ranking Reward Model
Set the rewards that can be received during the reference period when the score registration period is set in the ranking. If the repeat setting is enabled, the most recently ended period ranking will be the target for receiving rewards.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| thresholdRank | int | ✓ | 1 ~ 1001 | Rank threshold | ||
| metadata | string | ~ 1024 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||
| acquireActions | List<AcquireAction> | [] | 0 ~ 100 items | List of actions to be performed when rewards are received |
AcquireAction
Acquire Action
ClusterRankingModel
Cluster Ranking Model
The cluster ranking model enables rankings for players within guilds or gatherings. You can display the top 1000 rankings.
By associating it with the repeat event of GS2-Schedule, you can reset the ranking according to the number of repetitions.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| clusterRankingModelId | string | ✓* | ~ 1024 chars | Cluster Ranking GRN * Automatically configured on the server | ||||||||||
| name | string | ✓ | ~ 128 chars | Cluster Ranking Model name Cluster Ranking Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||
| metadata | string | ~ 1024 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||||||||||
| clusterType | String Enum enum { “Raw”, “Gs2Guild::Guild”, “Gs2Matchmaking::SeasonGathering” } | ✓ | Cluster Type
| |||||||||||
| minimumValue | long | 0 ~ 9223372036854775805 | Minimum Score | |||||||||||
| maximumValue | long | 0 ~ 9223372036854775805 | Maximum Score | |||||||||||
| sum | bool | ✓ | false | Add up the scores received and compete for the total value | ||||||||||
| orderDirection | String Enum enum { “asc”, “desc” } | ✓ | Sort direction of scores
| |||||||||||
| entryPeriodEventId | string | ~ 1024 chars | Period during which scores can be registered GS2-Schedule Event GRN | |||||||||||
| rankingRewards | List<RankingReward> | {entryPeriodEventId} != null | [] | 0 ~ 100 items | List of ranking rewards | |||||||||
| accessPeriodEventId | string | ~ 1024 chars | Period during which ranking data can be accessed GS2-Schedule Event GRN | |||||||||||
| rewardCalculationIndex | String Enum enum { “rank”, “index” } | ✓ | “rank” | Reward calculation index
|
SubscribeRankingModel
Subscribe Ranking Model
A model that aggregates the scores of other players who have subscribed and creates a ranking.
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| subscribeRankingModelId | string | ✓* | ~ 1024 chars | Subscribe Ranking GRN * Automatically configured on the server | ||||||||
| name | string | ✓ | ~ 128 chars | Subscribe Ranking Model name Subscribe Ranking Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||
| metadata | string | ~ 1024 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||||||||
| minimumValue | long | 0 ~ 9223372036854775805 | Minimum Score | |||||||||
| maximumValue | long | 0 ~ 9223372036854775805 | Maximum Score | |||||||||
| sum | bool | ✓ | false | Add up the scores received and compete for the total value | ||||||||
| orderDirection | String Enum enum { “asc”, “desc” } | ✓ | Sort direction of scores
| |||||||||
| entryPeriodEventId | string | ~ 1024 chars | Period during which scores can be registered GS2-Schedule Event GRN | |||||||||
| accessPeriodEventId | string | ~ 1024 chars | Period during which ranking data can be accessed GS2-Schedule Event GRN |