GS2-Mission Master Data Reference

Reference for the master data format and the models to be imported

Master Data Format

{
  "version": "2019-05-28",
  "groups": [
    {
      "name": "[string]Mission Group Model name",
      "metadata": "[string?]Metadata",
      "tasks": [
        {
          "missionTaskId": "[string]Mission Task GRN",
          "name": "[string]Mission Task Model name",
          "metadata": "[string?]Metadata",
          "verifyCompleteType": "[string]Completion condition type",
          "targetCounter": {
            "counterName": "[string]Counter Model name",
            "scopeType": "[string]Scope type",
            "resetType": "[string?]Target Reset timing",
            "conditionName": "[string]Condition Name",
            "value": "[long]Target value"
          },
          "verifyCompleteConsumeActions": [
            {
              "action": "[string]Type of action to be executed in the Verify Action",
              "request": "[string]JSON string of the request used when executing the action"
            }
          ],
          "completeAcquireActions": [
            {
              "action": "[string]Type of action to be executed in the Acquire Action",
              "request": "[string]JSON string of the request used when executing the action"
            }
          ],
          "challengePeriodEventId": "[string?]GS2-Schedule event GRN with a set period of time during which rewards can be received",
          "premiseMissionTaskName": "[string?]Name of the task that must be accomplished to attempt this task",
          "counterName": "[string]Counter Model name",
          "targetResetType": "[string?]Target Reset timing",
          "targetValue": "[long]Target value"
        }
      ],
      "resetType": "[string enum]Reset timing",
      "resetDayOfMonth": "[int]Date to reset",
      "resetDayOfWeek": "[string enum]Day of the week to reset",
      "resetHour": "[int]Hour of Reset",
      "completeNotificationNamespaceId": "[string?]Push notifications when mission tasks are accomplished",
      "anchorTimestamp": "[long]Base date and time for counting elapsed days",
      "days": "[int]Number of days to reset"
    }
  ],
  "counters": [
    {
      "name": "[string]Counter Model name",
      "metadata": "[string?]Metadata",
      "scopes": [
        {
          "scopeType": "[string]Scope type",
          "resetType": "[string]Reset timing",
          "resetDayOfMonth": "[int]Date to reset",
          "resetDayOfWeek": "[string]Day of the week to reset",
          "resetHour": "[int]Hour of Reset",
          "conditionName": "[string]Condition Name",
          "condition": {
            "action": "[string]Type of action to be executed in the Verify Action",
            "request": "[string]JSON string of the request used when executing the action"
          },
          "anchorTimestamp": "[long]Base date and time for counting elapsed days",
          "days": "[int]Number of days to reset"
        }
      ],
      "challengePeriodEventId": "[string?]GS2-Schedule event GRN that sets the period during which the counter can be operated"
    }
  ]
}
TypeConditionRequiredDefaultValue LimitsDescription
versionstring
2019-05-28Format version of master data
groupsList<MissionGroupModel>~ 20 itemsMission 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.
countersList<CounterModel>~ 1000 itemsCounter Model
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.

Model

CounterModel

Counter Model

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.

TypeConditionRequiredDefaultValue LimitsDescription
counterIdstring
*
~ 1024 charsCounter Model GRN
* Set automatically by the server
namestring
~ 128 charsCounter Model name
Counter Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 1024 charsMetadata
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.
scopesList<CounterScopeModel>[]1 ~ 20 itemsList of Counter reset timing
Defines the scopes (reset timings or verify action conditions) for this counter. A single counter can have multiple scopes, allowing one counter to track values across different periods (e.g., daily, weekly, and cumulative totals simultaneously).
challengePeriodEventIdstring~ 1024 charsGS2-Schedule event GRN that sets the period during which the counter can be operated
Specifies the GS2-Schedule event that defines the time window during which this counter can be incremented or decremented. If not set, the counter can be operated at any time.

CounterScopeModel

Counter Reset Timing Model

Defines a scope for a counter, which determines how and when the counter value is reset. A scope can be either a reset timing (daily, weekly, monthly, fixed-day interval, or never) or a verify action condition. Each counter can have multiple scopes to track values across different periods.

TypeConditionRequiredDefaultValue LimitsDescription
scopeTypeString Enum
enum {
  “resetTiming”,
  “verifyAction”
}
“resetTiming”Scope type
Determines how the counter scope is defined. “resetTiming” uses a periodic reset schedule, while “verifyAction” uses a verify action to determine whether the counter value applies.
DefinitionDescription
“resetTiming”Reset timing
“verifyAction”Verify Action
resetTypeString Enum
enum {
  “notReset”,
  “daily”,
  “weekly”,
  “monthly”,
  “days”
}
“notReset”Reset timing
Determines when the counter value for this scope is reset. Choose from: not reset (permanent cumulative), daily, weekly, monthly, or every fixed number of days. Only used when scopeType is “resetTiming”.
DefinitionDescription
“notReset”Not Reset
“daily”Daily
“weekly”Weekly
“monthly”Monthly
“days”Every fixed number of days
resetDayOfMonthint{resetType} == “monthly”
✓*
1 ~ 31Date to reset
The day of the month on which the counter value resets. If the specified value exceeds the number of days in the month, it is treated as the last day of that month. Only used when resetType is “monthly”.
* Required if resetType is “monthly”
resetDayOfWeekString Enum
enum {
  “sunday”,
  “monday”,
  “tuesday”,
  “wednesday”,
  “thursday”,
  “friday”,
  “saturday”
}
{resetType} == “weekly”
✓*
Day of the week to reset
The day of the week on which the counter value resets. Only used when resetType is “weekly”.
DefinitionDescription
“sunday”Sunday
“monday”Monday
“tuesday”Tuesday
“wednesday”Wednesday
“thursday”Thursday
“friday”Friday
“saturday”Saturday
* Required if resetType is “weekly”
resetHourint{resetType} in [“monthly”, “weekly”, “daily”]
✓*
0 ~ 23Hour of Reset
The hour (0-23) at which the counter value resets. Used in combination with daily, weekly, or monthly reset types.
* Required if resetType is “monthly”,“weekly”,“daily”
conditionNamestring{scopeType} == “verifyAction”
✓*
~ 128 charsCondition Name
A unique name that identifies this verify action condition scope. Used to look up the corresponding scoped value in the counter. Only used when scopeType is “verifyAction”.
* Required if scopeType is “verifyAction”
conditionVerifyAction{scopeType} == “verifyAction”
✓*
Condition
The verify action that determines whether the counter value for this scope is applicable. Only used when scopeType is “verifyAction”.
* Required if scopeType is “verifyAction”
anchorTimestamplong{resetType} == “days”
✓*
Base date and time for counting elapsed days
Unix time, milliseconds
* Required if resetType is “days”
daysint{resetType} == “days”
✓*
1 ~ 2147483646Number of days to reset
The interval in days between counter value resets, counting from the anchor timestamp. Only used when resetType is “days”.
* Required if resetType is “days”

VerifyAction

Verify Action

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Distributor:IfExpressionByUserId",
"Gs2Distributor:AndExpressionByUserId",
"Gs2Distributor:OrExpressionByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyIncludeMemberByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
"Gs2Ranking2:VerifyClusterRankingScoreByUserId",
"Gs2Ranking2:VerifySubscribeRankingScoreByUserId",
"Gs2Schedule:VerifyTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
"Gs2SerialKey:VerifyCodeByUserId",
"Gs2Stamina:VerifyStaminaValueByUserId",
"Gs2Stamina:VerifyStaminaMaxValueByUserId",
"Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId",
"Gs2Stamina:VerifyStaminaRecoverValueByUserId",
"Gs2Stamina:VerifyStaminaOverflowValueByUserId",
}
Type of action to be executed in the Verify Action
requeststring
~ 524288 charsJSON string of the request used when executing the action

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.

TypeConditionRequiredDefaultValue LimitsDescription
missionGroupIdstring
*
~ 1024 charsMission Group GRN
* Set automatically by the server
namestring
~ 128 charsMission Group Model name
Mission Group Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 1024 charsMetadata
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.
tasksList<MissionTaskModel>[]0 ~ 1000 itemsList of Mission Task
The mission tasks belonging to this group. Each task defines a completion condition (counter threshold or verify actions) and the rewards granted upon accomplishment.
resetTypeString Enum
enum {
  “notReset”,
  “daily”,
  “weekly”,
  “monthly”,
  “days”
}
“notReset”Reset timing
Determines when the mission group’s completion status is reset. Choose from: not reset (permanent), daily, weekly, monthly, or every fixed number of days from an anchor timestamp.
DefinitionDescription
“notReset”Not Reset
“daily”Daily
“weekly”Weekly
“monthly”Monthly
“days”Every fixed number of days
resetDayOfMonthint{resetType} == “monthly”
✓*
1 ~ 31Date to reset
The day of the month on which the mission group resets. If the specified value exceeds the number of days in the month, it is treated as the last day of that month. Only used when resetType is “monthly”.
* Required if resetType is “monthly”
resetDayOfWeekString Enum
enum {
  “sunday”,
  “monday”,
  “tuesday”,
  “wednesday”,
  “thursday”,
  “friday”,
  “saturday”
}
{resetType} == “weekly”
✓*
Day of the week to reset
The day of the week on which the mission group resets. Only used when resetType is “weekly”.
DefinitionDescription
“sunday”Sunday
“monday”Monday
“tuesday”Tuesday
“wednesday”Wednesday
“thursday”Thursday
“friday”Friday
“saturday”Saturday
* Required if resetType is “weekly”
resetHourint{resetType} in [“monthly”, “weekly”, “daily”]
✓*
0 ~ 23Hour of Reset
The hour (0-23) at which the mission group resets. Used in combination with daily, weekly, or monthly reset types.
* Required if resetType is “monthly”,“weekly”,“daily”
completeNotificationNamespaceIdstring~ 1024 charsPush notifications when mission tasks are accomplished
The GS2-Gateway namespace GRN used to deliver push notifications when a mission task in this group is accomplished. Allows the game client to be notified in real-time.
anchorTimestamplong{resetType} == “days”
✓*
Base date and time for counting elapsed days
Unix time, milliseconds
* Required if resetType is “days”
daysint{resetType} == “days”
✓*
1 ~ 2147483646Number of days to reset
The interval in days between resets, counting from the anchor timestamp. Only used when resetType is “days”.
* Required if resetType is “days”

MissionTaskModel

Mission Task Model

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.

TypeConditionRequiredDefaultValue LimitsDescription
missionTaskIdstring
*
~ 1024 charsMission Task GRN
* Set automatically by the server
namestring
~ 128 charsMission Task Model name
Mission Task Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 1024 charsMetadata
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.
verifyCompleteTypeString Enum
enum {
  “counter”,
  “verifyActions”
}
“counter”Completion condition type
Specifies how mission task completion is determined. “counter” checks if the associated counter’s scoped value reaches the target threshold. “verifyActions” uses verify actions to check completion conditions.
DefinitionDescription
“counter”Counter
“verifyActions”Verify Actions
targetCounterTargetCounterModel{verifyCompleteType} == “counter”
✓*
Target Counter
Defines the counter, scope, and target value used to determine mission task completion. When the counter’s scoped value reaches or exceeds the specified target value, the task is considered accomplished.
* Required if verifyCompleteType is “counter”
verifyCompleteConsumeActionsList<VerifyAction>{verifyCompleteType} == “verifyActions”[]0 ~ 10 itemsVerify Actions when task is accomplished
A list of verify actions used to determine if the mission task is completed. All verify actions must pass for the task to be considered accomplished. Only used when verifyCompleteType is “verifyActions”.
* Applicable only if verifyCompleteType is “verifyActions”
completeAcquireActionsList<AcquireAction>[]0 ~ 100 itemsRewards for mission accomplishment
The list of acquire actions executed as rewards when the player receives the mission completion reward.
challengePeriodEventIdstring~ 1024 charsGS2-Schedule event GRN with a set period of time during which rewards can be received
Specifies the GS2-Schedule event that defines the time window during which the mission task rewards can be claimed. If not set, rewards can be received at any time after accomplishment.
premiseMissionTaskNamestring~ 128 charsName of the task that must be accomplished to attempt this task
Specifies a prerequisite mission task within the same group that must be completed before the player can receive the reward for this task. Used to create sequential mission chains.

TargetCounterModel

Target Counter

Information about the counter that serves as the achievement goal for the mission

TypeConditionRequiredDefaultValue LimitsDescription
counterNamestring
~ 128 charsCounter Model name
Counter Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
scopeTypeString Enum
enum {
  “resetTiming”,
  “verifyAction”
}
“resetTiming”Scope type
Specifies which type of counter scope to use for the mission completion check. “resetTiming” evaluates the counter value for a specific reset period, while “verifyAction” evaluates the value for a named condition.
DefinitionDescription
“resetTiming”Reset timing
“verifyAction”Verify Action
resetTypeString Enum
enum {
  “notReset”,
  “daily”,
  “weekly”,
  “monthly”,
  “days”
}
{scopeType} == “resetTiming”Target Reset timing
Specifies which reset timing scope of the counter to check against the target value. For example, selecting “daily” means the task checks the daily counter value. If omitted, the mission group’s reset timing is used.
DefinitionDescription
“notReset”Not Reset
“daily”Daily
“weekly”Weekly
“monthly”Monthly
“days”Every fixed number of days
* Applicable only if scopeType is “resetTiming”
conditionNamestring{scopeType} == “verifyAction”
✓*
~ 128 charsCondition Name
The name of the verify action condition scope to check against the target value. Must match a conditionName defined in the counter model’s scopes. Only used when scopeType is “verifyAction”.
* Required if scopeType is “verifyAction”
valuelong
0 ~ 9223372036854775805Target value
The threshold value that the counter’s scoped value must reach or exceed for the mission task to be considered accomplished.

AcquireAction

Acquire Action

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2Schedule:ExtendTriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
Type of action to be executed in the Acquire Action
requeststring
~ 524288 charsJSON string of the request used when executing the action