Master Data Reference of GS2-Ranking2

Reference of the format of master data and various models to be imported

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"
    }
  ]
}
TypeConditionRequiredDefaultValue LimitsDescription
versionstring
2024-05-30Format version of master data
globalRankingModelsList<GlobalRankingModel>~ 10 itemsGlobal 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.
clusterRankingModelsList<ClusterRankingModel>~ 10 itemsCluster 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.
subscribeRankingModelsList<SubscribeRankingModel>~ 10 itemsSubscribe 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.

TypeConditionRequiredDefaultValue LimitsDescription
globalRankingModelIdstring
✓*
~ 1024 charsGlobal Ranking GRN
* Automatically configured on the server
namestring
~ 128 charsGlobal Ranking Model Name
Global Ranking Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 1024 charsMetadata
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.
minimumValuelong0 ~ 9223372036854775805Minimum Score
maximumValuelong0 ~ 9223372036854775805Maximum Score
sumbool
falseAdd up the scores received and compete for the total value
orderDirectionString Enum
enum {
  “asc”,
  “desc”
}
Sort direction of scores
Enumerator String DefinitionDescription
“asc”ascending-order
“desc”descending-order
entryPeriodEventIdstring~ 1024 charsPeriod during which scores can be registered GS2-Schedule Event GRN
rankingRewardsList<RankingReward>{entryPeriodEventId} != null[]0 ~ 100 itemsList of ranking rewards
accessPeriodEventIdstring~ 1024 charsPeriod during which ranking data can be accessed GS2-Schedule Event GRN
rewardCalculationIndexString Enum
enum {
  “rank”,
  “index”
}
“rank”Reward calculation index
Enumerator String DefinitionDescription
“rank”Determine rewards based on rank
“index”Determine rewards based on 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.

TypeConditionRequiredDefaultValue LimitsDescription
thresholdRankint
1 ~ 1001Rank threshold
metadatastring~ 1024 charsMetadata
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.
acquireActionsList<AcquireAction>[]0 ~ 100 itemsList of actions to be performed when rewards are received

AcquireAction

Acquire Action

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2Schedule:ExtendTriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
Types of actions to be performed in the acquire action
requeststring
~ 524288 charsJSON string of the request used when executing the 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.

TypeConditionRequiredDefaultValue LimitsDescription
clusterRankingModelIdstring
✓*
~ 1024 charsCluster Ranking GRN
* Automatically configured on the server
namestring
~ 128 charsCluster Ranking Model name
Cluster Ranking Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 1024 charsMetadata
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.
clusterTypeString Enum
enum {
  “Raw”,
  “Gs2Guild::Guild”,
  “Gs2Matchmaking::SeasonGathering”
}
Cluster Type
Enumerator String DefinitionDescription
“Raw”No verification
“Gs2Guild::Guild”GS2-Guild Guild
“Gs2Matchmaking::SeasonGathering”GS2-Matchmaking Season Gathering
minimumValuelong0 ~ 9223372036854775805Minimum Score
maximumValuelong0 ~ 9223372036854775805Maximum Score
sumbool
falseAdd up the scores received and compete for the total value
orderDirectionString Enum
enum {
  “asc”,
  “desc”
}
Sort direction of scores
Enumerator String DefinitionDescription
“asc”ascending-order
“desc”descending-order
entryPeriodEventIdstring~ 1024 charsPeriod during which scores can be registered GS2-Schedule Event GRN
rankingRewardsList<RankingReward>{entryPeriodEventId} != null[]0 ~ 100 itemsList of ranking rewards
accessPeriodEventIdstring~ 1024 charsPeriod during which ranking data can be accessed GS2-Schedule Event GRN
rewardCalculationIndexString Enum
enum {
  “rank”,
  “index”
}
“rank”Reward calculation index
Enumerator String DefinitionDescription
“rank”Determine rewards based on rank
“index”Determine rewards based on index

SubscribeRankingModel

Subscribe Ranking Model

A model that aggregates the scores of other players who have subscribed and creates a ranking.

TypeConditionRequiredDefaultValue LimitsDescription
subscribeRankingModelIdstring
✓*
~ 1024 charsSubscribe Ranking GRN
* Automatically configured on the server
namestring
~ 128 charsSubscribe Ranking Model name
Subscribe Ranking Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 1024 charsMetadata
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.
minimumValuelong0 ~ 9223372036854775805Minimum Score
maximumValuelong0 ~ 9223372036854775805Maximum Score
sumbool
falseAdd up the scores received and compete for the total value
orderDirectionString Enum
enum {
  “asc”,
  “desc”
}
Sort direction of scores
Enumerator String DefinitionDescription
“asc”ascending-order
“desc”descending-order
entryPeriodEventIdstring~ 1024 charsPeriod during which scores can be registered GS2-Schedule Event GRN
accessPeriodEventIdstring~ 1024 charsPeriod during which ranking data can be accessed GS2-Schedule Event GRN