Master Data Reference of GS2-Ranking2

Tags:

Master Data

{
  "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?]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 of request"
            }
          ]
        }
      ],
      "accessPeriodEventId": "[string?]Period during which ranking data can be accessed GS2-Schedule EventGRN",
      "rewardCalculationIndex": "[string]Reward calculation index"
    }
  ],
  "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?]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 of request"
            }
          ]
        }
      ],
      "accessPeriodEventId": "[string?]Period during which ranking data can be accessed GS2-Schedule EventGRN",
      "rewardCalculationIndex": "[string]Reward calculation index"
    }
  ],
  "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?]Period during which scores can be registered GS2-Schedule EventGRN",
      "accessPeriodEventId": "[string?]Period during which ranking data can be accessed GS2-Schedule EventGRN"
    }
  ]
}

	Type	Require	Default	Limitation	Description
version		✓	2024-05-30		Format version of master data
globalRankingModels	List<GlobalRankingModel>			~ 10 items	Global Ranking Model
clusterRankingModels	List<ClusterRankingModel>			~ 10 items	Cluster Ranking Model
subscribeRankingModels	List<SubscribeRankingModel>			~ 10 items	Subscribe 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	Require	Default	Limitation	Description
globalRankingModelId	string		✓		~ 1024 chars	Global Ranking GRN
name	string		✓		~ 128 chars	Ranking Name
metadata	string				~ 1024 chars	metadata
minimumValue	long				~ 9223372036854775805	Minimum Score
maximumValue	long				~ 9223372036854775805	Maximum Score
sum	bool		✓	false		Add up the scores of put and compete for the total value.
orderDirection	enum { “asc”, “desc” }		✓		~ 128 chars	Sort direction of scores
entryPeriodEventId	string				~ 1024 chars	Period during which scores can be registered GS2-Schedule EventGRN
rankingRewards	List<RankingReward>	{entryPeriodEventId} != null			~ 100 items	List of ranking rewards
accessPeriodEventId	string				~ 1024 chars	Period during which ranking data can be accessed GS2-Schedule EventGRN
rewardCalculationIndex	enum { “rank”, “index” }		✓	“rank”	~ 128 chars	Reward calculation index

Enumeration type definition to specify as orderDirection

Enumerator String Definition	Description
asc	ascending-order
desc	descending-order

Enumeration type definition to specify as rewardCalculationIndex

Enumerator String Definition	Description
rank	Determine rewards based on rank
index	Determine rewards based on index

ClusterRankingModel

Cluster Ranking Model

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

	Type	Condition	Require	Default	Limitation	Description
clusterRankingModelId	string		✓		~ 1024 chars	Cluster Ranking GRN
name	string		✓		~ 128 chars	Ranking Name
metadata	string				~ 1024 chars	metadata
clusterType	enum { “Raw”, “Gs2Guild::Guild”, “Gs2Matchmaking::SeasonGathering” }		✓		~ 128 chars	Cluster Type
minimumValue	long				~ 9223372036854775805	Minimum Score
maximumValue	long				~ 9223372036854775805	Maximum Score
sum	bool		✓	false		Add up the scores of put and compete for the total value.
orderDirection	enum { “asc”, “desc” }		✓		~ 128 chars	Sort direction of scores
entryPeriodEventId	string				~ 1024 chars	Period during which scores can be registered GS2-Schedule EventGRN
rankingRewards	List<RankingReward>	{entryPeriodEventId} != null			~ 100 items	List of ranking rewards
accessPeriodEventId	string				~ 1024 chars	Period during which ranking data can be accessed GS2-Schedule EventGRN
rewardCalculationIndex	enum { “rank”, “index” }		✓	“rank”	~ 128 chars	Reward calculation index

Enumeration type definition to specify as clusterType

Enumerator String Definition	Description
Raw	No verification
Gs2Guild::Guild	GS2-Guild Guild
Gs2Matchmaking::SeasonGathering	GS2-Matchmaking Season Gathering

Enumeration type definition to specify as orderDirection

Enumerator String Definition	Description
asc	ascending-order
desc	descending-order

Enumeration type definition to specify as rewardCalculationIndex

Enumerator String Definition	Description
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.

	Type	Require	Default	Limitation	Description
subscribeRankingModelId	string	✓		~ 1024 chars	Subscribe Ranking GRN
name	string	✓		~ 128 chars	Ranking Name
metadata	string			~ 1024 chars	metadata
minimumValue	long			~ 9223372036854775805	Minimum Score
maximumValue	long			~ 9223372036854775805	Maximum Score
sum	bool	✓	false		Add up the scores of put and compete for the total value.
orderDirection	enum { “asc”, “desc” }	✓		~ 128 chars	Sort direction of scores
entryPeriodEventId	string			~ 1024 chars	Period during which scores can be registered GS2-Schedule EventGRN
accessPeriodEventId	string			~ 1024 chars	Period during which ranking data can be accessed GS2-Schedule EventGRN

Enumeration type definition to specify as orderDirection

Enumerator String Definition	Description
asc	ascending-order
desc	descending-order

SubscribeUser

Subscribe Information

	Type	Require	Limitation	Description
rankingName	string	✓	~ 128 chars	Ranking Name
userId	string	✓	~ 128 chars	User Id
targetUserId	string	✓	~ 128 chars	Subscribe 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.

	Type	Require	Default	Limitation	Description
thresholdRank	int	✓		1 ~ 1001	Rank threshold
metadata	string			~ 1024 chars	metadata
acquireActions	List<AcquireAction>		[]	~ 100 items	List of actions to be performed when rewards are received

VerifyActionResult

Verify action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the verify task
verifyRequest	string	✓	~ 1048576 chars	JSON of request
statusCode	int		~ 999	Status code
verifyResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

ConsumeActionResult

Consume action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the consume action
consumeRequest	string	✓	~ 1048576 chars	JSON of request
statusCode	int		~ 999	Status code
consumeResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

AcquireActionResult

Acquire action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the acquire action
acquireRequest	string	✓	~ 1048576 chars	JSON of request
statusCode	int		~ 999	Status code
acquireResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

TransactionResult

Transaction execution results

Transaction execution results executed using server-side transaction auto-execution functionality

	Type	Require	Limitation	Description
transactionId	string	✓	36 ~ 36 chars	Transaction ID
verifyResults	List<VerifyActionResult>		~ 10 items	List of verify action execution results
consumeResults	List<ConsumeActionResult>		~ 10 items	List of consume action execution results
acquireResults	List<AcquireActionResult>		~ 100 items	List of acquire action execution results

AcquireAction

Acquire Action

	Type	Condition	Require	Default	Limitation	Description
action	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", "Gs2Script:InvokeScript", "Gs2SerialKey:RevertUseByUserId", "Gs2SerialKey:IssueOnce", "Gs2Showcase:DecrementPurchaseCountByUserId", "Gs2Showcase:ForceReDrawByUserId", "Gs2SkillTree:MarkReleaseByUserId", "Gs2Stamina:RecoverStaminaByUserId", "Gs2Stamina:RaiseMaxValueByUserId", "Gs2Stamina:SetMaxValueByUserId", "Gs2Stamina:SetRecoverIntervalByUserId", "Gs2Stamina:SetRecoverValueByUserId", "Gs2StateMachine:StartStateMachineByUserId", }		✓		~ 128 chars	Types of actions to be performed in the acquire action
request	string		✓		~ 1048576 chars	JSON of request