Master Data Reference of GS2-Exchange

{
  "version": "2019-08-19",
  "rateModels": [
    {
      "name": "[string]Exchange Rate Name",
      "metadata": "[string?]metadata",
      "verifyActions": [
        {
          "action": "[string]Types of actions to be performed in the verify task",
          "request": "[string]JSON of request"
        }
      ],
      "consumeActions": [
        {
          "action": "[string]Types of actions to be performed in the consume action",
          "request": "[string]JSON of request"
        }
      ],
      "timingType": "[string]Type of exchange",
      "lockTime": "[int]Waiting time (minutes) from the execution of the exchange until the reward is actually received",
      "acquireActions": [
        {
          "action": "[string]Types of actions to be performed in the acquire action",
          "request": "[string]JSON of request"
        }
      ]
    }
  ],
  "incrementalRateModels": [
    {
      "name": "[string]Cost Increase Type Exchange Rate Name",
      "metadata": "[string?]metadata",
      "consumeAction": {
        "action": "[string]Types of actions to be performed in the consume action",
        "request": "[string]JSON of request"
      },
      "calculateType": "[string]Calculation method for cost increase amount",
      "baseValue": "[long]Base Value",
      "coefficientValue": "[long]Coefficient Value”",
      "calculateScriptId": "[string]GRN of cost calculation script",
      "exchangeCountId": "[string]GRN of GS2-Limit model that manages the number of exchanges",
      "maximumExchangeCount": "[int]Maximum number of exchanges",
      "acquireActions": [
        {
          "action": "[string]Types of actions to be performed in the acquire action",
          "request": "[string]JSON of request"
        }
      ]
    }
  ]
}

RateModel

Exchange Rate Model

The exchange rate is an entity that defines the rate used to exchange resources for resources.

In addition to the rate at which a resource can be exchanged immediately, a rate can also be set at which a resource can be exchanged after a certain amount of time in real time has elapsed. Exchange rates that require an elapse of time in real time can further define the resources required to perform an immediate exchange.

Enumeration type definition to specify as timingType

IncrementalRateModel

Cost increase type exchange rate model

Normal exchange rates always provide exchanges at a constant rate. With incremental exchange rates, you can define a rate that increases in cost as the number of exchanges increases. For example, the first exchange can be exchanged at a rate of 1:1, but the second exchange can be exchanged at a rate of 2:1. By defining such a rate, you can increase the value of the resources obtained by the player as the game progresses.

The number of exchanges can be reset by the passage of real time. This is useful for resetting the number of exchanges on a daily or weekly basis.

Enumeration type definition to specify as calculateType

LogCost

Cost calculation result using logarithm

LogRate

Logarithmic acquisition correction

AcquireAction

Acquire Action

ConsumeAction

Consume Action

VerifyAction

Verify Action

VerifyActionResult

Verify action execution result

Enumeration type definition to specify as action

ConsumeActionResult

Consume action execution result

Enumeration type definition to specify as action

AcquireActionResult

Acquire action execution result

Enumeration type definition to specify as action

TransactionResult

Transaction execution results

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