Master Data Reference of GS2-Idle
{
"version": "2023-06-06",
"categoryModels": [
{
"name": "[string]Category Model Name",
"metadata": "[string?]metadata",
"rewardIntervalMinutes": "[int]Interval at which idle rewards can be obtained (minutes)",
"defaultMaximumIdleMinutes": "[int]Maximum time to get idle rewards (minutes)",
"acquireActions": [
{
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON of request"
}
]
}
],
"idlePeriodScheduleId": "[string?]GS2-Schedule event GRN with time period used for idle rewards calculation",
"receivePeriodScheduleId": "[string?]GS2-Schedule EventGRN that sets the period during which idle rewards can be obtained"
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2023-06-06 | Format version of master data | |||
categoryModels | List<CategoryModel> | ~ 100 items | Category Model Master |
CategoryModel
Category Model Master
A category model is an entity that sets the idle category that can be obtained as a reward for leaving. The settings include information such as the reward for each waiting time and the maximum idle time.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
categoryModelId | string | ✓ | ~ 1024 chars | Category Model GRN | ||
name | string | ✓ | ~ 128 chars | Category Model Name | ||
metadata | string | ~ 2048 chars | metadata | |||
rewardIntervalMinutes | int | ✓ | ~ 2147483646 | Interval at which idle rewards can be obtained (minutes) | ||
defaultMaximumIdleMinutes | int | ✓ | ~ 2147483646 | Maximum time to get idle rewards (minutes) | ||
acquireActions | List<AcquireActionList> | ✓ | 1 ~ 100 items | List of acquire actions for each waiting time | ||
idlePeriodScheduleId | string | ~ 1024 chars | GS2-Schedule event GRN with time period used for idle rewards calculation | |||
receivePeriodScheduleId | string | ~ 1024 chars | GS2-Schedule EventGRN that sets the period during which idle rewards can be obtained |
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 |
AcquireAction
Acquire Action
AcquireActionList
Acquisition Action List
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
acquireActions | List<AcquireAction> | ~ 100 items | List of Acquire Action |