Master Data Reference of GS2-Ranking2

{
  "version": "2024-05-30",
  "globalRankingModels": [
    {
      "name": "[string]Ranking Name",
      "metadata": "[string?]metadata",
      "minimumValue": "[long?]Minimum Score",
      "maximumValue": "[long?]Maximum Score",
      "sum": "[bool]Add up the scores of put and compete for the total value.",
      "orderDirection": "[string]Sort direction of scores",
      "entryPeriodEventId": "[string?]GS2-Schedule Event GRN",
      "rankingRewards": [
        {
          "thresholdRank": "[int]Rank threshold",
          "metadata": "[string?]metadata",
          "acquireActions": [
            {
              "action": "[string]Types of actions to be performed in the stamp sheet",
              "request": "[string]JSON of request"
            }
          ]
        }
      ],
      "accessPeriodEventId": "[string?]GS2-Schedule Event GRN"
    }
  ],
  "clusterRankingModels": [
    {
      "name": "[string]Ranking Name",
      "metadata": "[string?]metadata",
      "clusterType": "[string]Cluster Type",
      "minimumValue": "[long?]Minimum Score",
      "maximumValue": "[long?]Maximum Score",
      "sum": "[bool]Add up the scores of put and compete for the total value.",
      "orderDirection": "[string]Sort direction of scores",
      "entryPeriodEventId": "[string?]GS2-Schedule Event GRN",
      "rankingRewards": [
        {
          "thresholdRank": "[int]Rank threshold",
          "metadata": "[string?]metadata",
          "acquireActions": [
            {
              "action": "[string]Types of actions to be performed in the stamp sheet",
              "request": "[string]JSON of request"
            }
          ]
        }
      ],
      "accessPeriodEventId": "[string?]GS2-Schedule Event GRN"
    }
  ],
  "subscribeRankingModels": [
    {
      "name": "[string]Ranking Name",
      "metadata": "[string?]metadata",
      "minimumValue": "[long?]Minimum Score",
      "maximumValue": "[long?]Maximum Score",
      "sum": "[bool]Add up the scores of put and compete for the total value.",
      "orderDirection": "[string]Sort direction of scores",
      "entryPeriodEventId": "[string?]GS2-Schedule Event GRN",
      "accessPeriodEventId": "[string?]GS2-Schedule Event GRN"
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version2024-05-30Format version of master data
globalRankingModelsList<GlobalRankingModel>~ 10 itemsGlobal Ranking Model
clusterRankingModelsList<ClusterRankingModel>~ 10 itemsCluster Ranking Model
subscribeRankingModelsList<SubscribeRankingModel>~ 10 itemsSubscribe Ranking Model

GlobalRankingModel

Global Ranking Model

The global ranking is a mode 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.

TypeConditionRequireDefaultLimitationDescription
globalRankingModelIdstring~ 1024 charsGlobal Ranking GRN
namestring~ 128 charsRanking Name
metadatastring~ 1024 charsmetadata
minimumValuelong~ 9223372036854775805Minimum Score
maximumValuelong~ 9223372036854775805Maximum Score
sumboolfalseAdd up the scores of put and compete for the total value.
orderDirectionenum [
“asc”,
“desc”
]
~ 128 charsSort direction of scores
entryPeriodEventIdstring~ 1024 charsGS2-Schedule Event GRN
rankingRewardsList<RankingReward>{entryPeriodEventId} != null~ 100 itemsList of ranking rewards
accessPeriodEventIdstring~ 1024 charsGS2-Schedule Event GRN

ClusterRankingModel

Cluster Ranking Model

The cluster ranking mode is a mode for realizing rankings targeting players in 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.

TypeConditionRequireDefaultLimitationDescription
clusterRankingModelIdstring~ 1024 charsCluster Ranking GRN
namestring~ 128 charsRanking Name
metadatastring~ 1024 charsmetadata
clusterTypeenum [
“Raw”,
“Gs2Guild::Guild”,
“Gs2Matchmaking::SeasonGathering”
]
~ 128 charsCluster Type
minimumValuelong~ 9223372036854775805Minimum Score
maximumValuelong~ 9223372036854775805Maximum Score
sumboolfalseAdd up the scores of put and compete for the total value.
orderDirectionenum [
“asc”,
“desc”
]
~ 128 charsSort direction of scores
entryPeriodEventIdstring~ 1024 charsGS2-Schedule Event GRN
rankingRewardsList<RankingReward>{entryPeriodEventId} != null~ 100 itemsList of ranking rewards
accessPeriodEventIdstring~ 1024 charsGS2-Schedule Event GRN

SubscribeRankingModel

Subscribe Ranking Model

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

TypeConditionRequireDefaultLimitationDescription
subscribeRankingModelIdstring~ 1024 charsSubscribe Ranking GRN
namestring~ 128 charsRanking Name
metadatastring~ 1024 charsmetadata
minimumValuelong~ 9223372036854775805Minimum Score
maximumValuelong~ 9223372036854775805Maximum Score
sumboolfalseAdd up the scores of put and compete for the total value.
orderDirectionenum [
“asc”,
“desc”
]
~ 128 charsSort direction of scores
entryPeriodEventIdstring~ 1024 charsGS2-Schedule Event GRN
accessPeriodEventIdstring~ 1024 charsGS2-Schedule Event GRN

SubscribeUser

Subscribe Information

TypeConditionRequireDefaultLimitationDescription
rankingNamestring~ 128 charsRanking Name
userIdstring~ 128 charsUser Id
targetUserIdstring~ 128 charsSubscribe Target User ID

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.

TypeConditionRequireDefaultLimitationDescription
thresholdRankint1 ~ 1001Rank threshold
metadatastring~ 1024 charsmetadata
acquireActionsList<AcquireAction>[]~ 100 itemsList of actions to be performed when rewards are received

AcquireAction

Acquire Action

TypeConditionRequireDefaultLimitationDescription
actionenum [
"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:UnlockIncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"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",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2SerialKey:RevertUseByUserId",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
]
~ 128 charsTypes of actions to be performed in the stamp sheet
requeststring~ 1048576 charsJSON of request