Master Data Reference of GS2-Version

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

Master Data Format

{
  "version": "2019-10-09",
  "versionModels": [
    {
      "name": "[string]Version Model Name",
      "metadata": "[string?]Metadata",
      "scope": "[string enum]Type of version value used for judgment",
      "type": "[string enum]Version Check Mode",
      "currentVersion": {
        "major": "[int]Major version",
        "minor": "[int]Minor version",
        "micro": "[int]Micro version"
      },
      "warningVersion": {
        "major": "[int]Major version",
        "minor": "[int]Minor version",
        "micro": "[int]Micro version"
      },
      "errorVersion": {
        "major": "[int]Major version",
        "minor": "[int]Minor version",
        "micro": "[int]Micro version"
      },
      "scheduleVersions": [
        {
          "currentVersion": {
            "major": "[int]Major version",
            "minor": "[int]Minor version",
            "micro": "[int]Micro version"
          },
          "warningVersion": {
            "major": "[int]Major version",
            "minor": "[int]Minor version",
            "micro": "[int]Micro version"
          },
          "errorVersion": {
            "major": "[int]Major version",
            "minor": "[int]Minor version",
            "micro": "[int]Micro version"
          },
          "scheduleEventId": "[string?]GS2-Schedule event GRN that enables version check"
        }
      ],
      "needSignature": "[bool]Whether the version value to be determined requires signature verification",
      "signatureKeyId": "[string]encryption key GRN",
      "approveRequirement": "[string enum]Requirement for approval"
    }
  ]
}

	Type	Condition	Required	Default	Value Limits	Description
version	string		✓	2019-10-09		Format version of master data
versionModels	List<VersionModel>				~ 100 items	Version Model You can set a warning version that accepts login but notifies you that you can upgrade, and an error version that does not accept login. You can specify whether or not to have the client declare the current version with or without a signature. If you select signed, the client will not be able to declare a false version.

Model

VersionModel

Version Model

You can set a warning version that accepts login but notifies you that you can upgrade, and an error version that does not accept login.

You can specify whether or not to have the client declare the current version with or without a signature. If you select signed, the client will not be able to declare a false version.

Type

Condition

Required

Default

Value Limits

Description

versionModelId

string

✓*

~ 1024 chars

Version Model GRN

* Automatically configured on the server

name

string

✓

~ 128 chars

Version Model Name

Version model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

metadata

string

~ 2048 chars

Metadata

Arbitrary values can be set in the metadata.
Since they do not affect GS2’s behavior, they can be used to store information used in the game.

scope

String Enum
enum {
“passive”,
“active”
}

✓

Type of version value used for judgment

Enumerator String Definition	Description
“passive”	Sent by Client
“active”	Version explicitly approved in the past

type

String Enum
enum {
“simple”,
“schedule”
}

✓

“simple”

Version Check Mode

Enumerator String Definition	Description
“simple”	Simple
“schedule”	Schedule Change

currentVersion

Version

{type} == “simple” and {scope} == “active”

✓*

Current Version

* Required if type is “simple” and scope is “active”

warningVersion

Version

{type} == “simple”

✓*

Version that prompts for version upgrade

* Required if type is “simple”

errorVersion

Version

{type} == “simple”

✓*

Version that is determined to be an error by the version check

* Required if type is “simple”

scheduleVersions

List<ScheduleVersion>

{type} == “schedule”

0 ~ 10 items

List of Version check content that switches over time series

* Enabled if type is “schedule”

needSignature

bool

{scope} == “passive”

✓*

Whether the version value to be determined requires signature verification

* Required if scope is “passive”

signatureKeyId

string

{needSignature}

✓*

~ 1024 chars

encryption key GRN

* Required if needSignature is “true”

approveRequirement

String Enum
enum {
“required”,
“optional”
}

{scope} == “active”

✓*

“required”

Requirement for approval

Enumerator String Definition	Description
“required”	Approval required
“optional”	Any approval

* Required if scope is “active”

Version

	Type	Required	Value Limits	Description
major	int	✓	0 ~ 2147483646	Major version
minor	int	✓	0 ~ 2147483646	Minor version
micro	int	✓	0 ~ 2147483646	Micro version

ScheduleVersion

Version that switches in chronological order

	Type	Required	Value Limits	Description
currentVersion	Version	✓		Current Version
warningVersion	Version	✓		Version that prompts for version upgrade
errorVersion	Version	✓		Version that is determined to be an error by the version check
scheduleEventId	string		~ 1024 chars	GS2-Schedule event GRN that enables version check