Master Data Reference of GS2-Enchant

Reference of the format of master data and various models to be imported
{
  "version": "2023-07-18",
  "balanceParameterModels": [
    {
      "name": "[string]Balance parameter model name",
      "metadata": "[string?]metadata",
      "totalValue": "[long]Total value",
      "initialValueStrategy": "[string]Initial value setting policy",
      "parameters": [
        {
          "name": "[string]Name",
          "metadata": "[string?]metadata"
        }
      ]
    }
  ],
  "rarityParameterModels": [
    {
      "name": "[string]Rarity parameter model name",
      "metadata": "[string?]metadata",
      "maximumParameterCount": "[int]Maximum number of parameters to be given",
      "parameterCounts": [
        {
          "count": "[int]Value",
          "weight": "[int]Weight"
        }
      ],
      "parameters": [
        {
          "name": "[string]Name",
          "metadata": "[string?]metadata",
          "resourceName": "[string]Parameter Resource Name for Game(Not used for GS2)",
          "resourceValue": "[long]Parameter Resource Value for Game(Not used for GS2)",
          "weight": "[int]Weight"
        }
      ]
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version
2023-07-18Format version of master data
balanceParameterModelsList<BalanceParameterModel>~ 10000 itemsBalance parameter model
rarityParameterModelsList<RarityParameterModel>~ 10000 itemsBalance parameter model

BalanceParameterModel

Balance parameter model

Defines the drawing conditions for balance parameters.

TypeConditionRequireDefaultLimitationDescription
balanceParameterModelIdstring
~ 1024 charsBalance Parameter Model GRN
namestring
~ 128 charsBalance parameter model name
metadatastring~ 2048 charsmetadata
totalValuelong
~ 9223372036854775805Total value
initialValueStrategyenum {
    “average”,
    “lottery”
}
“average”~ 128 charsInitial value setting policy
[Definition of enumeration type to be specified for initialValueStrategy](#definition-of-enumeration-type-to-be-specified-for-initialvaluestrategy
parametersList<BalanceParameterValueModel>
1 ~ 10 itemsBalance parameter value model list

Definition of enumeration type to be specified for initialValueStrategy

Enumerator String DefinitionDescription
averageAverage
lotteryLottery

RarityParameterModel

Balance parameter model

Defines the drawing conditions for balance parameters.

TypeConditionRequireDefaultLimitationDescription
rarityParameterModelIdstring
~ 1024 charsRarity Parameter Model GRN
namestring
~ 128 charsRarity parameter model name
metadatastring~ 2048 charsmetadata
maximumParameterCountint
1 ~ 10Maximum number of parameters to be given
parameterCountsList<RarityParameterCountModel>
1 ~ 10 itemsRarity parameter value model list
parametersList<RarityParameterValueModel>
1 ~ 1000 itemsRarity parameter value model list

BalanceParameterValueModel

Balance Parameter Value Model

TypeConditionRequireDefaultLimitationDescription
namestring
~ 64 charsName
metadatastring~ 512 charsmetadata

RarityParameterCountModel

Model of the number of rarity parameters granted

TypeConditionRequireDefaultLimitationDescription
countint
~ 10Value
weightint
1 ~ 2147483646Weight

RarityParameterValueModel

Balance Parameter Value Model

TypeConditionRequireDefaultLimitationDescription
namestring
~ 64 charsName
metadatastring~ 512 charsmetadata
resourceNamestring
~ 64 charsParameter Resource Name for Game(Not used for GS2)
resourceValuelong
~ 9223372036854775805Parameter Resource Value for Game(Not used for GS2)
weightint
1 ~ 2147483646Weight

BalanceParameterValue

Balance Parameter Value Model

TypeConditionRequireDefaultLimitationDescription
namestring
~ 64 charsName
valuelong
~ 9223372036854775805Value

RarityParameterValue

Rarity Parameter Value Model

TypeConditionRequireDefaultLimitationDescription
namestring
~ 64 charsName
resourceNamestring
~ 64 charsResource Name
resourceValuelong
~ 9223372036854775805Resource Value

VerifyActionResult

Verify action execution result

TypeConditionRequireDefaultLimitationDescription
actionenum {
"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",
}
~ 128 charsTypes of actions to be performed in the verify task
verifyRequeststring
~ 524288 charsJSON of request
statusCodeint~ 999Status code
verifyResultstring~ 1048576 charsResult payload

ConsumeActionResult

Consume action execution result

TypeConditionRequireDefaultLimitationDescription
actionenum {
"Gs2AdReward:ConsumePointByUserId",
"Gs2Dictionary:DeleteEntriesByUserId",
"Gs2Enhance:DeleteProgressByUserId",
"Gs2Exchange:DeleteAwaitByUserId",
"Gs2Experience:SubExperienceByUserId",
"Gs2Experience:SubRankCapByUserId",
"Gs2Formation:SubMoldCapacityByUserId",
"Gs2Grade:SubGradeByUserId",
"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
"Gs2Inbox:OpenMessageByUserId",
"Gs2Inbox:DeleteMessageByUserId",
"Gs2Inventory:ConsumeItemSetByUserId",
"Gs2Inventory:ConsumeSimpleItemsByUserId",
"Gs2Inventory:ConsumeBigItemByUserId",
"Gs2JobQueue:DeleteJobByUserId",
"Gs2Limit:CountUpByUserId",
"Gs2LoginReward:MarkReceivedByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:BatchReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Mission:ResetCounterByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Money2:WithdrawByUserId",
"Gs2Money2:VerifyReceiptByUserId",
"Gs2Quest:DeleteProgressByUserId",
"Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
"Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
"Gs2Schedule:DeleteTriggerByUserId",
"Gs2SerialKey:UseByUserId",
"Gs2Showcase:IncrementPurchaseCountByUserId",
"Gs2SkillTree:MarkRestrainByUserId",
"Gs2Stamina:DecreaseMaxValueByUserId",
"Gs2Stamina:ConsumeStaminaByUserId",
}
~ 128 charsTypes of actions to be performed in the consume action
consumeRequeststring
~ 524288 charsJSON of request
statusCodeint~ 999Status code
consumeResultstring~ 1048576 charsResult payload

AcquireActionResult

Acquire action execution result

TypeConditionRequireDefaultLimitationDescription
actionenum {
"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",
}
~ 128 charsTypes of actions to be performed in the acquire action
acquireRequeststring
~ 524288 charsJSON of request
statusCodeint~ 999Status code
acquireResultstring~ 1048576 charsResult payload

TransactionResult

Transaction execution results

Transaction execution results executed using server-side transaction auto-execution functionality

TypeConditionRequireDefaultLimitationDescription
transactionIdstring
36 ~ 36 charsTransaction ID
verifyResultsList<VerifyActionResult>~ 10 itemsList of verify action execution results
consumeResultsList<ConsumeActionResult>[]~ 10 itemsList of consume action execution results
acquireResultsList<AcquireActionResult>[]~ 100 itemsList of acquire action execution results
hasErrorbool
falseWhether an error occurred during transaction execution