Master Data Reference of GS2-SeasonRating
{
"version": "2024-02-23",
"seasonModels": [
{
"name": "[string]Season Model Name",
"metadata": "[string?]metadata",
"tiers": [
{
"metadata": "[string?]metadata",
"raiseRankBonus": "[int]The bonus points added to prevent immediate rank demotion when the rank is promoted.",
"entryFee": "[int]Points to be subtracted as an entry fee to start the game.",
"minimumChangePoint": "[int]Change point minimum value when losing",
"maximumChangePoint": "[int]Change point maximum value when winning"
}
],
"experienceModelId": "[string]Experience Model GRN",
"challengePeriodEventId": "[string?]GS2-Schedule event GRN that sets the period during which the season is open."
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2024-02-23 | Format version of master data | |||
seasonModels | List<SeasonModel> | ~ 50 items | Season Model |
SeasonModel
Season Model
GS2 uses Glicko-2 as its rating algorithm. Glicko-2 has several parameters, but GS2-Matchmaking aggregates them into a single parameter, volatility, which represents the totality of the parameters. Volatility is a parameter that expresses the magnitude of change; the larger the value, the greater the change in the rating value.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
seasonModelId | string | ✓ | ~ 1024 chars | Season Model GRN | ||
name | string | ✓ | ~ 128 chars | Season Model Name | ||
metadata | string | ~ 128 chars | metadata | |||
tiers | List<TierModel> | ✓ | 1 ~ 100 items | List of Tier | ||
experienceModelId | string | ✓ | ~ 1024 chars | Experience Model GRN | ||
challengePeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN that sets the period during which the season is open. |
TierModel
Tear model
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
metadata | string | ~ 128 chars | metadata | |||
raiseRankBonus | int | ✓ | ~ 10000 | The bonus points added to prevent immediate rank demotion when the rank is promoted. | ||
entryFee | int | ✓ | ~ 10000 | Points to be subtracted as an entry fee to start the game. | ||
minimumChangePoint | int | ✓ | ~ -1 | Change point minimum value when losing | ||
maximumChangePoint | int | ✓ | 1 ~ 99999999 | Change point maximum value when winning |
VerifyActionResult
Verify action execution result
Type | Condition | Require | Default | 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 | Condition | Require | Default | 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 | Condition | Require | Default | 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 | Condition | Require | Default | 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 |
GameResult
Match Results
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
rank | int | ✓ | ~ 2147483646 | Rank | ||
userId | string | ✓ | ~ 128 chars | User Id |
Ballot
Ballot Paper
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
userId | string | ✓ | ~ 128 chars | User Id | ||
seasonName | string | ✓ | ~ 128 chars | Rating name used for rating calculations | ||
sessionName | string | ✓ | ~ 128 chars | Name of MatchSession to be voted | ||
numberOfPlayer | int | ✓ | 2 ~ 10 | Number of participants |
SignedBallot
Ballot with signatures
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
body | string | ✓ | ~ 1024 chars | Data for ballot signature targets | ||
signature | string | ✓ | ~ 256 chars | Signature |
WrittenBallot
Ballot Paper
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
ballot | Ballot | ✓ | Ballot | |||
gameResults | List<GameResult> | ~ 10 items | List of Results |