Master Data Reference of GS2-Matchmaking

Reference of the format of master data and various models to be imported
{
  "version": "2020-06-24",
  "ratingModels": [
    {
      "name": "[string]Rating Model Name",
      "metadata": "[string?]metadata",
      "initialValue": "[int]Initial value of rate value",
      "volatility": "[int]Magnitude of rate value fluctuation"
    }
  ],
  "seasonModels": [
    {
      "name": "[string]Season Model Name",
      "metadata": "[string?]metadata",
      "maximumParticipants": "[int]Maximum number of participants",
      "experienceModelId": "[string?]Experience model that holds the tier",
      "challengePeriodEventId": "[string]GS2-Schedule event GRN that sets the period during which the season is open."
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version
2020-06-24Format version of master data
ratingModelsList<RatingModel>~ 50 itemsRating Model
seasonModelsList<SeasonModel>~ 50 itemsSeason Model

RatingModel

Rating 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.

TypeConditionRequireDefaultLimitationDescription
ratingModelIdstring
~ 1024 charsRating Model GRN
namestring
~ 128 charsRating Model Name
metadatastring~ 128 charsmetadata
initialValueint
1500100 ~ 10000Initial value of rate value
volatilityint
1001 ~ 20000Magnitude of rate value fluctuation

SeasonModel

Season Model

TypeConditionRequireDefaultLimitationDescription
seasonModelIdstring
~ 1024 charsSeason Model GRN
namestring
~ 128 charsSeason Model Name
metadatastring~ 128 charsmetadata
maximumParticipantsint
2 ~ 1000Maximum number of participants
experienceModelIdstring~ 1024 charsExperience model that holds the tier
challengePeriodEventIdstring
~ 1024 charsGS2-Schedule event GRN that sets the period during which the season is open.

AttributeRange

Terms and Conditions

TypeConditionRequireDefaultLimitationDescription
namestring
~ 128 charsAttribute Name
minint
0~ 2147483646Minimum attribute values that can participate in the Gathering
maxint
0~ 2147483646Maximum value of attributes that can participate in the Gathering

CapacityOfRole

Application Limit

TypeConditionRequireDefaultLimitationDescription
roleNamestring
“default”~ 128 charsRole Name
roleAliasesList<string>[]~ 9 itemsList of Role Name Aliases
capacityint
1 ~ 256Number of applicants
participantsList<Player>[]~ 1000 itemsList of Participant Players

Attribute

Attribute Value

TypeConditionRequireDefaultLimitationDescription
namestring
~ 128 charsAttribute Name
valueint
0~ 2147483646Attribute value

Player

Participant Player Information

TypeConditionRequireDefaultLimitationDescription
userIdstring
~ 128 charsUser Id
attributesList<Attribute>[]~ 5 itemsList of Attributes
roleNamestring
“default”~ 128 charsRole Name
denyUserIdsList<string>[]~ 100 itemsList of user IDs that are denied participation
createdAtlong
NowDatetime of creation (Unix time unit:milliseconds)

GameResult

Match Results

TypeConditionRequireDefaultLimitationDescription
rankint
~ 2147483646Rank
userIdstring
~ 128 charsUser Id

Ballot

Ballot Paper

TypeConditionRequireDefaultLimitationDescription
userIdstring
~ 128 charsUser Id
ratingNamestring
~ 128 charsRating name used for rating calculations
gatheringNamestring
~ 128 charsName of Gathering to be voted
numberOfPlayerint
2 ~ 10Number of participants

SignedBallot

Ballot with signatures

TypeConditionRequireDefaultLimitationDescription
bodystring
~ 1024 charsData for ballot signature targets
signaturestring
~ 256 charsSignature

WrittenBallot

Ballot Paper

TypeConditionRequireDefaultLimitationDescription
ballotBallot
Ballot
gameResultsList<GameResult>~ 10 itemsList of Results

TimeSpan

Time Interval

TypeConditionRequireDefaultLimitationDescription
daysint
0~ 365Number of days from current time
hoursint
0~ 24Hours from current time
minutesint
0~ 60Minutes from current time