Master Data Reference of GS2-Mission
{
"version": "2019-05-28",
"groups": [
{
"name": "[string]Mission Group Name",
"metadata": "[string?]metadata",
"tasks": [
{
"missionTaskId": "[string]Mission Task GRN",
"name": "[string]Task Name",
"metadata": "[string?]metadata",
"counterName": "[string]Counter Name",
"targetResetType": "[string?]Target Reset timing",
"targetValue": "[long]Target value",
"completeAcquireActions": [
{
"action": "[string]Types of actions to be performed in the stamp sheet",
"request": "[string]JSON of request"
}
],
"challengePeriodEventId": "[string?]GS2-Schedule event GRN with a set period of time during which rewards can be received",
"premiseMissionTaskName": "[string?]Name of the tasks accomplish to attempt this task"
}
],
"resetType": "[string]Reset timing",
"resetDayOfMonth": "[int]Date to reset (If the value exceeds the days of the month, it is treated as the last day.)",
"resetDayOfWeek": "[string]Day of the week to reset",
"resetHour": "[int]Hour of Reset",
"completeNotificationNamespaceId": "[string?]Namespace GRN"
}
],
"counters": [
{
"name": "[string]Counter Name",
"metadata": "[string?]metadata",
"scopes": [
{
"resetType": "[string]Reset timing",
"resetDayOfMonth": "[int]Date to reset (If the value exceeds the days of the month, it is treated as the last day.)",
"resetDayOfWeek": "[string]Day of the week to reset",
"resetHour": "[int]Hour of Reset"
}
],
"challengePeriodEventId": "[string?]GS2-Schedule event GRN that sets the period during which the counter can be operated."
}
]
}
| Type | Condition | Require | Default | Limitation | Description |
---|
version | ✓ | | 2019-05-28 | Format version of master data | | |
groups | List<MissionGroupModel> | | | | | |
counters | List<CounterModel> | | | | | |
CounterScopeModel
| Type | Condition | Require | Default | Limitation | Description |
---|
resetType | enum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’] | | ✓ | | ~ 128 chars | Reset timing |
resetDayOfMonth | int | {resetType} == “monthly” | ✓ | | 1 ~ 31 | Date to reset (If the value exceeds the days of the month, it is treated as the last day.) |
resetDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {resetType} == “weekly” | ✓ | | ~ 128 chars | Day of the week to reset |
resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ✓ | | ~ 23 | Hour of Reset |
CounterModel
Counter Model
The counter model is an entity that can be set as a condition for accomplishing mission tasks.
Since counter values can be referenced by multiple mission groups, a single counter can be set as an accomplishment condition for multiple mission groups, such as weekly and daily missions.
| Type | Condition | Require | Default | Limitation | Description |
---|
counterId | string | | ✓ | | ~ 1024 chars | Counter Model GRN |
name | string | | ✓ | | ~ 128 chars | Counter Name |
metadata | string | | | | ~ 1024 chars | metadata |
scopes | List<CounterScopeModel> | | ✓ | [] | 1 ~ 100 items | List of Counter reset timing |
challengePeriodEventId | string | | | | ~ 1024 chars | GS2-Schedule event GRN that sets the period during which the counter can be operated. |
MissionGroupModel
Mission Group Model
A mission group is an entity that groups tasks by counter reset timing.
For example, one group for daily missions. One group for Weekly Mission.
| Type | Condition | Require | Default | Limitation | Description |
---|
missionGroupId | string | | ✓ | | ~ 1024 chars | Mission Group GRN |
name | string | | ✓ | | ~ 128 chars | Mission Group Name |
metadata | string | | | | ~ 1024 chars | metadata |
tasks | List<MissionTaskModel> | | | | ~ 1000 items | List of Mission Task |
resetType | enum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’] | | ✓ | “notReset” | ~ 128 chars | Reset timing |
resetDayOfMonth | int | {resetType} == “monthly” | ✓ | | 1 ~ 31 | Date to reset (If the value exceeds the days of the month, it is treated as the last day.) |
resetDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {resetType} == “weekly” | ✓ | | ~ 128 chars | Day of the week to reset |
resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ✓ | | ~ 23 | Hour of Reset |
completeNotificationNamespaceId | string | | | | ~ 1024 chars | Namespace GRN |
MissionTaskModel
Mission Task Model Master
A mission task is an entity that defines the conditions under which a reward will be given if the value of the associated counter exceeds a certain level.
| Type | Condition | Require | Default | Limitation | Description |
---|
missionTaskId | string | | ✓ | | ~ 1024 chars | Mission Task GRN |
name | string | | ✓ | | ~ 128 chars | Task Name |
metadata | string | | | | ~ 1024 chars | metadata |
counterName | string | | ✓ | | ~ 128 chars | Counter Name |
targetResetType | enum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’] | | | | ~ 128 chars | Target Reset timing |
targetValue | long | | ✓ | | 1 ~ 9223372036854775805 | Target value |
completeAcquireActions | List<AcquireAction> | | | [] | ~ 100 items | Rewards for mission accomplishment |
challengePeriodEventId | string | | | | ~ 1024 chars | GS2-Schedule event GRN with a set period of time during which rewards can be received |
premiseMissionTaskName | string | | | | ~ 128 chars | Name of the tasks accomplish to attempt this task |
ScopedValue
| Type | Condition | Require | Default | Limitation | Description |
---|
resetType | enum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’] | | ✓ | | ~ 128 chars | Reset timing |
value | long | | ✓ | 0 | ~ 9223372036854775805 | Count value |
nextResetAt | long | | | | | Next reset timing |
updatedAt | long | | ✓ | | | Datetime of last update |
AcquireAction
| Type | Condition | Require | Default | Limitation | Description |
---|
action | enum [] | | ✓ | | ~ 128 chars | Types of actions to be performed in the stamp sheet |
request | string | | ✓ | | ~ 1048576 chars | JSON of request |