Master Data Reference of GS2-Grade
{
"version": "2023-12-25",
"gradeModels": [
{
"name": "[string]Grade Model Name",
"metadata": "[string?]metadata",
"defaultGrades": [
{
"propertyIdRegex": "[string]Regular expression for property ID to which default value is applied",
"defaultGradeValue": "[long]Default grade value"
}
],
"experienceModelId": "[string]Experience model GRN to link grade and rank cap",
"gradeEntries": [
{
"metadata": "[string?]metadata",
"rankCapValue": "[long]Rank cap value to be set in GS2-Experience",
"propertyIdRegex": "[string]Regular expression for property ID that can be used for grade up",
"gradeUpPropertyIdRegex": "[string]Regular expression for property ID that can be used for grade up"
}
],
"acquireActionRates": [
{
"name": "[string]Remuneration addition table name",
"mode": "[string]Remuneration addition table type",
"rates": [
"[double]Addition amount (multiplier)"
],
"bigRates": [
"[string]Addition amount (multiplier)"
]
}
]
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2023-12-25 | Format version of master data | |||
gradeModels | List<GradeModel> | ~ 100 items | Grade Model |
GradeModel
Grade Model
An grade model is an entity that sets the threshold of grade required for rank advancement and for each default and maximum rank cap.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
gradeModelId | string | ✓ | ~ 1024 chars | Grade Model GRN | ||
name | string | ✓ | ~ 128 chars | Grade Model Name | ||
metadata | string | ~ 2048 chars | metadata | |||
defaultGrades | List<DefaultGradeModel> | ~ 100 items | List of Default grade model | |||
experienceModelId | string | ✓ | ~ 1024 chars | Experience model GRN to link grade and rank cap | ||
gradeEntries | List<GradeEntryModel> | ✓ | 1 ~ 100 items | List of Grade entry | ||
acquireActionRates | List<AcquireActionRate> | ~ 100 items | List of Remuneration addition table |
DefaultGradeModel
Default grade model
You can set the default grade value according to the match of the property ID regular expression when creating a new grade.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
propertyIdRegex | string | ✓ | ~ 1024 chars | Regular expression for property ID to which default value is applied | ||
defaultGradeValue | long | ✓ | ~ 9223372036854775805 | Default grade value |
GradeEntryModel
Grade Entry
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
metadata | string | ~ 2048 chars | metadata | |||
rankCapValue | long | ✓ | ~ 9223372036854775805 | Rank cap value to be set in GS2-Experience | ||
propertyIdRegex | string | ✓ | ~ 1024 chars | Regular expression for property ID that can be used for grade up | ||
gradeUpPropertyIdRegex | string | ✓ | ~ 1024 chars | Regular expression for property ID that can be used for grade up |
AcquireActionRate
Remuneration addition table master
You can adjust the amount of rewards according to the rank.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Remuneration addition table name | ||
mode | enum { “double”, “big” } | ✓ | “double” | ~ 128 chars | Remuneration addition table type | |
rates | List<double> | {mode} == “double” | ✓ | 1 ~ 1000 items | Amount added per grade (multiplier) | |
bigRates | List<string> | {mode} == “big” | ✓ | 1 ~ 1000 items | Amount added per grade (multiplier) |
Enumeration type definition to specify as mode
Enumerator String Definition | Description |
---|---|
double | Floating point number less than 2^48 |
big | Floating point number less than 1024 digits |
AcquireAction
Acquire Action
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 |