Master Data Reference of GS2-Matchmaking

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

Tags:

Master Data

{
  "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."
    }
  ]
}

	Type	Require	Default	Limitation	Description
version		✓	2020-06-24		Format version of master data
ratingModels	List<RatingModel>			~ 50 items	Rating Model
seasonModels	List<SeasonModel>			~ 50 items	Season 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.

	Type	Require	Default	Limitation	Description
ratingModelId	string	✓		~ 1024 chars	Rating Model GRN
name	string	✓		~ 128 chars	Rating Model Name
metadata	string			~ 128 chars	metadata
initialValue	int	✓	1500	100 ~ 10000	Initial value of rate value
volatility	int	✓	100	1 ~ 20000	Magnitude of rate value fluctuation

SeasonModel

Season Model

	Type	Require	Limitation	Description
seasonModelId	string	✓	~ 1024 chars	Season Model GRN
name	string	✓	~ 128 chars	Season Model Name
metadata	string		~ 128 chars	metadata
maximumParticipants	int	✓	2 ~ 1000	Maximum number of participants
experienceModelId	string		~ 1024 chars	Experience model that holds the tier
challengePeriodEventId	string	✓	~ 1024 chars	GS2-Schedule event GRN that sets the period during which the season is open.

AttributeRange

Terms and Conditions

	Type	Require	Default	Limitation	Description
name	string	✓		~ 128 chars	Attribute Name
min	int	✓	0	0 ~ 2147483646	Minimum attribute values that can participate in the Gathering
max	int	✓	0	0 ~ 2147483646	Maximum value of attributes that can participate in the Gathering

CapacityOfRole

Application Limit

	Type	Require	Default	Limitation	Description
roleName	string	✓	“default”	~ 128 chars	Role Name
roleAliases	List<string>		[]	0 ~ 9 items	List of Role Name Aliases
capacity	int	✓		1 ~ 256	Number of applicants
participants	List<Player>		[]	0 ~ 1000 items	List of Participant Players

Attribute

Attribute Value

	Type	Condition	Require	Default	Limitation	Description
name	string		✓		~ 128 chars	Attribute Name
value	int		✓	0	0 ~ 2147483646	Attribute value

Player

Participant Player Information

	Type	Require	Default	Limitation	Description
userId	string	✓		~ 128 chars	User Id
attributes	List<Attribute>		[]	0 ~ 5 items	List of Attributes
roleName	string	✓	“default”	~ 128 chars	Role Name
denyUserIds	List<string>		[]	0 ~ 100 items	List of user IDs that are denied participation
createdAt	long	✓	Now		Datetime of creation (Unix time unit:milliseconds)

GameResult

Match Results

	Type	Condition	Require	Default	Limitation	Description
rank	int		✓		0 ~ 2147483646	Rank
userId	string		✓		~ 128 chars	User Id

Ballot

Ballot Paper

	Type	Require	Limitation	Description
userId	string	✓	~ 128 chars	User Id
ratingName	string	✓	~ 128 chars	Rating name used for rating calculations
gatheringName	string	✓	~ 128 chars	Name of Gathering 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>				0 ~ 10 items	List of Results

TimeSpan

Time Interval

	Type	Require	Limitation	Description
days	int	✓	0 ~ 365	Number of days from current time
hours	int	✓	0 ~ 24	Hours from current time
minutes	int	✓	0 ~ 60	Minutes from current time