GS2-Deploy/CDK Reference of GS2-Exchange

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK

Entity

Resources operated in Deploy process

Namespace

A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.

Therefore, you must create a namespace before you can start using each service.

	Type	Required	Default	Value Limits	Description
namespaceId	string	✓		~ 1024 chars	Namespace GRN
name	string	✓		~ 128 chars	Namespace name
description	string			~ 1024 chars	Description
enableDirectExchange	bool	✓	true		Allow direct exchange API calls. If not allowed, exchange can only be done via transaction.
enableAwaitExchange	bool	✓	false		Use the exchange function with waiting time to receive the exchange results
transactionSetting	TransactionSetting	✓			Transaction settings
exchangeScript	ScriptSetting				Script to run when an attempt is made to perform an exchange
incrementalExchangeScript	ScriptSetting				Script to run when an attempt is made to perform an incremental exchange
acquireAwaitScript	ScriptSetting				Script to be executed when the wait is completed and the reward is about to be received in a wait-and-see type exchange process.
logSetting	LogSetting				Log output settings
createdAt	long	✓	Now		Datetime of creation Unix time, milliseconds Automatically configured on the server
updatedAt	long	✓	Now		Datetime of last update Unix time, milliseconds Automatically configured on the server
revision	long		0	0 ~ 9223372036854775805	Revision

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Exchange::Namespace
Properties:
  Name: namespace-0001
  Description: null
  EnableAwaitExchange: null
  EnableDirectExchange: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  ExchangeScript: null
  IncrementalExchangeScript: null
  AcquireAwaitScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/exchange"
    "github.com/gs2io/gs2-golang-cdk/inventory"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
exchange.NewNamespace(
    &SampleStack,
    "namespace-0001",
    exchange.NamespaceOptions{
        TransactionSetting: core.NewTransactionSetting(
            core.TransactionSettingOptions{
                QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
            },
        ),
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Exchange\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Exchange\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    new \Gs2Cdk\Core\Model\TransactionSettingOptions(
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    )
                ),
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            )
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.exchange.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.exchange.model.options.NamespaceOptions()
                        .withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
                            new io.gs2.cdk.core.model.options.TransactionSettingOptions()
                                .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
                        ))
                        .withLogSetting(new io.gs2.cdk.core.model.LogSetting(
                            "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                        ))
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Exchange.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Exchange.Model.Options.NamespaceOptions
            {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    options: new Gs2Cdk.Core.Model.TransactionSettingOptions
                    {
                        queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import exchange from "@/gs2cdk/exchange";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new exchange.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    {
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, exchange

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        exchange.Namespace(
            stack=self,
            name='namespace-0001',
            options=exchange.NamespaceOptions(
                transaction_setting=core.TransactionSetting(
                    options=core.TransactionSettingOptions(
                        queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                    )
                ),
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template

ScriptSetting

Script settings

In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.

There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API.

In contrast, asynchronous execution does not block processing until the script has finished executing. Since the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API’s response flow. For this reason, asynchronous execution is generally recommended.

There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.

Type

Condition

Required

Default

Value Limits

Description

triggerScriptId

string

~ 1024 chars

Script GRN of synchronous execution script

Must be specified in GRN format starting with “grn:gs2:”.

doneTriggerTargetType

String Enum
enum {
  “none”,
  “gs2_script”,
  “aws”
}

✓

“none”

~ 128 chars

How to execute asynchronous scripts

Specifies the type of script to use for asynchronous execution.
You can choose from “Do not use asynchronous execution scripts (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.

Enumerator String Definition	Description
“none”	None
“gs2_script”	GS2-Script
“aws”	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

Script GRN of asynchronous execution script

Must be specified in GRN format starting with “grn:gs2:”.

* Enabled if doneTriggerTargetType is “gs2_script”

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-JobQueue namespace GRN to execute asynchronous execution scripts

If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue namespace GRN.
There is little reason to use GS2-JobQueue, so you don’t need to specify it unless you have a specific reason.

* Enabled if doneTriggerTargetType is “gs2_script”

LogSetting

Log Export Settings

Manages log data export settings. This type holds the GS2-Log namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, and debugging.

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs

TransactionSetting

Transaction settings

Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, Distributor, batch application of script results, and asynchronous acquisition actions via JobQueue enables robust transaction management tailored to game logic.

	Type	Condition	Required	Default	Value Limits	Description
enableAutoRun	bool		✓	false		Whether to automatically execute issued transactions on the server side
enableAtomicCommit	bool	{enableAutoRun} == true	✓*	false		Whether to commit the execution of transactions atomically * Required if enableAutoRun is true
transactionUseDistributor	bool	{enableAtomicCommit} == true	✓*	false		Whether to execute transactions asynchronously * Required if enableAtomicCommit is true
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	✓*	false		Whether to execute the commit processing of the script result asynchronously * Required if transactionUseDistributor is true
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	✓*	false		Whether to use GS2-JobQueue to execute the acquire action * Required if enableAtomicCommit is true
distributorNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor namespace used for transaction execution
queueNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	Namespace in GS2-JobQueue used to run the transaction

CurrentRateMaster

Currently Available Master Data

GS2 uses JSON format files for managing master data. By uploading these files, the settings are applied to the server.

To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for operating your game and export JSON files in the appropriate format.

Note

Please refer to Master Data Reference of GS2-Exchange for the JSON file format.

	Type	Condition	Required	Default	Value Limits	Description
namespaceId	string		✓		~ 1024 chars	Namespace GRN
settings	string		✓		~ 5242880 bytes (5MB)	Master Data

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

	Type	Description
Item	CurrentRateMaster	Updated currently available exchange rate settings

Implementation Example

Type: GS2::Exchange::CurrentRateMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2019-08-19",
    "rateModels": [
      {
        "name": "material_n_to_r",
        "timingType": "await",
        "metadata": "N2R",
        "consumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "category-0001",
              "inventoryName": "item",
              "itemName": "item-0001",
              "userId": "#{userId}",
              "consumeCount": 10
            }
          }
        ],
        "lockTime": 50,
        "acquireActions": [
          {
            "action": "Gs2Inventory:AcquireItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "inventory-0001",
              "itemName": "item-0001",
              "acquireCount": 1,
              "expireAt": null,
              "createNewItemSet": false,
              "itemSetName": null
            }
          }
        ]
      },
      {
        "name": "material_r_to_n",
        "timingType": "await",
        "metadata": "N2R",
        "consumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "category-0001",
              "inventoryName": "item",
              "itemName": "item-0002",
              "userId": "#{userId}",
              "consumeCount": 1
            }
          }
        ],
        "lockTime": 50,
        "acquireActions": [
          {
            "action": "Gs2Inventory:AcquireItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "inventory-0001",
              "itemName": "item-0001",
              "acquireCount": 1,
              "expireAt": null,
              "createNewItemSet": false,
              "itemSetName": null
            }
          }
        ]
      }
    ],
    "incrementalRateModels": []
    
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/exchange"
    "github.com/gs2io/gs2-golang-cdk/inventory"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
exchange.NewNamespace(
    &SampleStack,
    "namespace-0001",
    exchange.NamespaceOptions{},
).MasterData(
    []exchange.RateModel{
        exchange.NewRateModel(
            "material_n_to_r",
            exchange.RateModelTimingTypeAwait,
            exchange.RateModelOptions{
                Metadata: pointy.String("N2R"),
                ConsumeActions: []core.ConsumeAction{
                    inventory.ConsumeItemSetByUserId(
                        "namespace-0001",
                        "inventory-0001",
                        "item-0001",
                        1,
                        nil,
                    ),
                },
                LockTime: pointy.Int32(50),
                AcquireActions: []core.AcquireAction{
                    inventory.AcquireItemSetByUserId(
                        "namespace-0001",
                        "inventory-0001",
                        "item-0001",
                        1,
                        nil,
                        pointy.Bool(false),
                        nil,
                    ),
                },
            },
        ),
        exchange.NewRateModel(
            "material_r_to_n",
            exchange.RateModelTimingTypeAwait,
            exchange.RateModelOptions{
                Metadata: pointy.String("N2R"),
                ConsumeActions: []core.ConsumeAction{
                    inventory.ConsumeItemSetByUserId(
                        "namespace-0001",
                        "inventory-0001",
                        "item-0001",
                        1,
                        nil,
                    ),
                },
                LockTime: pointy.Int32(50),
                AcquireActions: []core.AcquireAction{
                    inventory.AcquireItemSetByUserId(
                        "namespace-0001",
                        "inventory-0001",
                        "item-0001",
                        1,
                        nil,
                        pointy.Bool(false),
                        nil,
                    ),
                },
            },
        ),
    },
    []exchange.IncrementalRateModel{
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Exchange\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Exchange\Model\RateModel(
                    name:"material_n_to_r",
                    timingType: \Gs2Cdk\Exchange\Model\Enums\RateModelTimingType::AWAIT,
                    options: new \Gs2Cdk\Exchange\Model\Options\RateModelOptions(
                        metadata:"N2R",
                        consumeActions:[
                            new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                                namespaceName: "category-0001",
                                inventoryName: "item",
                                itemName: "item-0001",
                                userId: "#{userId}",
                                consumeCount: 10
                            ),
                        ],
                        lockTime:50,
                        acquireActions:[
                            new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
                                namespaceName: "namespace-0001",
                                inventoryName: "inventory-0001",
                                itemName: "item-0001",
                                acquireCount: 1,
                                userId: "#{userId}"
                            ),
                        ]
                    )
                ),
                new \Gs2Cdk\Exchange\Model\RateModel(
                    name:"material_r_to_n",
                    timingType: \Gs2Cdk\Exchange\Model\Enums\RateModelTimingType::AWAIT,
                    options: new \Gs2Cdk\Exchange\Model\Options\RateModelOptions(
                        metadata:"N2R",
                        consumeActions:[
                            new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                                namespaceName: "category-0001",
                                inventoryName: "item",
                                itemName: "item-0002",
                                userId: "#{userId}",
                                consumeCount: 1
                            ),
                        ],
                        lockTime:50,
                        acquireActions:[
                            new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
                                namespaceName: "namespace-0001",
                                inventoryName: "inventory-0001",
                                itemName: "item-0001",
                                acquireCount: 1,
                                userId: "#{userId}"
                            ),
                        ]
                    )
                )
            ],
            [
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.exchange.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.exchange.model.RateModel(
                    "material_n_to_r",
                    io.gs2.cdk.exchange.model.enums.RateModelTimingType.AWAIT,
                    new io.gs2.cdk.exchange.model.options.RateModelOptions()
                        .withMetadata("N2R")
                        .withConsumeActions(Arrays.asList(
                            new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1L,
                                null,
                                "#{userId}"
                            )
                        ))
                        .withLockTime(50)
                        .withAcquireActions(Arrays.asList(
                            new io.gs2.cdk.inventory.stampSheet.AcquireItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1L,
                                0L,
                                false,
                                "",
                                "#{userId}"
                            )
                        ))
                ),
                new io.gs2.cdk.exchange.model.RateModel(
                    "material_r_to_n",
                    io.gs2.cdk.exchange.model.enums.RateModelTimingType.AWAIT,
                    new io.gs2.cdk.exchange.model.options.RateModelOptions()
                        .withMetadata("N2R")
                        .withConsumeActions(Arrays.asList(
                            new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1L,
                                null,
                                "#{userId}"
                            )
                        ))
                        .withLockTime(50)
                        .withAcquireActions(Arrays.asList(
                            new io.gs2.cdk.inventory.stampSheet.AcquireItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1L,
                                0L,
                                false,
                                "",
                                "#{userId}"
                            )
                        ))
                )
            ),
            Arrays.asList(
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Exchange.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Exchange.Model.RateModel[] {
                new Gs2Cdk.Gs2Exchange.Model.RateModel(
                    name: "material_n_to_r",
                    timingType: Gs2Cdk.Gs2Exchange.Model.Enums.RateModelTimingType.Await,
                    options: new Gs2Cdk.Gs2Exchange.Model.Options.RateModelOptions
                    {
                        metadata = "N2R",
                        consumeActions = new Gs2Cdk.Core.Model.ConsumeAction[]
                        {
                            new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                                namespaceName: "category-0001",
                                inventoryName: "item",
                                itemName: "item-0001",
                                userId: "#{userId}",
                                consumeCount: 10
                            )
                        },
                        lockTime = 50,
                        acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                        {
                            new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
                                namespaceName: "namespace-0001",
                                inventoryName: "inventory-0001",
                                itemName: "item-0001",
                                acquireCount: 1,
                                userId: "#{userId}"
                            )
                        }
                    }
                ),
                new Gs2Cdk.Gs2Exchange.Model.RateModel(
                    name: "material_r_to_n",
                    timingType: Gs2Cdk.Gs2Exchange.Model.Enums.RateModelTimingType.Await,
                    options: new Gs2Cdk.Gs2Exchange.Model.Options.RateModelOptions
                    {
                        metadata = "N2R",
                        consumeActions = new Gs2Cdk.Core.Model.ConsumeAction[]
                        {
                            new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                                namespaceName: "category-0001",
                                inventoryName: "item",
                                itemName: "item-0002",
                                userId: "#{userId}",
                                consumeCount: 1
                            )
                        },
                        lockTime = 50,
                        acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                        {
                            new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
                                namespaceName: "namespace-0001",
                                inventoryName: "inventory-0001",
                                itemName: "item-0001",
                                acquireCount: 1,
                                userId: "#{userId}"
                            )
                        }
                    }
                )
            },
            new Gs2Cdk.Gs2Exchange.Model.IncrementalRateModel[] {
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import exchange from "@/gs2cdk/exchange";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new exchange.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new exchange.model.RateModel(
                    "material_n_to_r",
                    exchange.model.RateModelTimingType.AWAIT,
                    {
                        metadata: "N2R",
                        consumeActions: [
                            new inventory.stampSheet.ConsumeItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1,
                                "#{userId}"
                            ),
                        ],
                        lockTime: 50,
                        acquireActions: [
                            new inventory.stampSheet.AcquireItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1,
                                null,
                                null,
                                "#{userId}"
                            ),
                        ]
                    }
                ),
                new exchange.model.RateModel(
                    "material_r_to_n",
                    exchange.model.RateModelTimingType.AWAIT,
                    {
                        metadata: "N2R",
                        consumeActions: [
                            new inventory.stampSheet.ConsumeItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1,
                                "#{userId}"
                            ),
                        ],
                        lockTime: 50,
                        acquireActions: [
                            new inventory.stampSheet.AcquireItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1,
                                null,
                                null,
                                "#{userId}"
                            ),
                        ]
                    }
                )
            ],
            [
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, exchange

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        exchange.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            rate_models=[
                exchange.RateModel(
                    name='material_n_to_r',
                    timing_type=exchange.RateModelTimingType.AWAIT,
                    options=exchange.RateModelOptions(
                        metadata = 'N2R',
                        consume_actions = [
                            inventory.ConsumeItemSetByUserId(
                                namespace_name='namespace-0001',
                                inventory_name='inventory-0001',
                                item_name='item-0001',
                                consume_count=1,
                                user_id='#{userId}'
                            ),
                        ],
                        lock_time = 50,
                        acquire_actions = [
                            inventory.AcquireItemSetByUserId(
                                namespace_name='namespace-0001',
                                inventory_name='inventory-0001',
                                item_name='item-0001',
                                acquire_count=1,
                                user_id='#{userId}'
                            ),
                        ]
                    ),
                ),
                exchange.RateModel(
                    name='material_r_to_n',
                    timing_type=exchange.RateModelTimingType.AWAIT,
                    options=exchange.RateModelOptions(
                        metadata = 'N2R',
                        consume_actions = [
                            inventory.ConsumeItemSetByUserId(
                                namespace_name='namespace-0001',
                                inventory_name='inventory-0001',
                                item_name='item-0001',
                                consume_count=1,
                                user_id='#{userId}'
                            ),
                        ],
                        lock_time = 50,
                        acquire_actions = [
                            inventory.AcquireItemSetByUserId(
                                namespace_name='namespace-0001',
                                inventory_name='inventory-0001',
                                item_name='item-0001',
                                acquire_count=1,
                                user_id='#{userId}'
                            ),
                        ]
                    ),
                ),
            ],
            incremental_rate_models=[
            ],
        )

print(SampleStack().yaml())  # Generate Template

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.

Type

Condition

Required

Default

Value Limits

Description

rateModelId

string

✓

~ 1024 chars

Exchange rate model GRN

name

string

✓

~ 128 chars

Exchange Rate Name

metadata

string

~ 2048 chars

Metadata

verifyActions

List<VerifyAction>

[]

0 ~ 10 items

List of Verify Action

consumeActions

List<ConsumeAction>

[]

0 ~ 10 items

List of Consume Action

timingType

String Enum
enum {
“immediate”,
“await”
}

✓

“immediate”

~ 128 chars

Type of exchange

Enumerator String Definition	Description
“immediate”	Immediate
“await”	Waiting for real time to pass

lockTime

int

{timingType} == “await”

✓*

0 ~ 538214400

Waiting time (minutes) from the execution of the exchange until the reward is actually received

* Required if timingType is “await”

acquireActions

List<AcquireAction>

[]

0 ~ 100 items

List of Acquire Action

AcquireAction

Acquire Action

	Type	Condition	Required	Default	Value Limits	Description
action	String 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", }		✓		~ 128 chars	Types of actions to be performed in the acquire action
request	string		✓		~ 524288 chars	JSON string of the request used when executing the action

ConsumeAction

Consume Action

	Type	Condition	Required	Default	Value Limits	Description
action	String Enum enum { "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 chars	Types of actions to be performed in the consume action
request	string		✓		~ 524288 chars	JSON string of the request used when executing the action

VerifyAction

Verify Action

	Type	Condition	Required	Default	Value Limits	Description
action	String 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", }		✓		~ 128 chars	Types of actions to be performed in the verify task
request	string		✓		~ 524288 chars	JSON string of the request used when executing the action

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.

Type

Condition

Required

Default

Value Limits

Description

incrementalRateModelId

string

✓

~ 1024 chars

Cost increase exchange rate model GRN

name

string

✓

~ 128 chars

Cost increase type exchange rate name

metadata

string

~ 2048 chars

Metadata

consumeAction

ConsumeAction

✓

Consumption Action (Quantity/Value is overwritten so no setting is required)

calculateType

String Enum
enum {
  “linear”,
  “power”,
  “gs2_script”
}

✓

~ 128 chars

Calculation method for cost increase amount

Enumerator String Definition	Description
“linear”	Base Value + (Coefficient * Number of Exchanges)
“power”	Coefficient * (Number of Exchanges + 1) ^ 2
“gs2_script”	Any logic with GS2-Script

baseValue

long

{calculateType} == “linear”

✓*

0 ~ 9223372036854775805

Base Value

* Required if calculateType is “linear”

coefficientValue

long

{calculateType} in [“linear”, “power”]

✓*

0 ~ 9223372036854775805

Coefficient Value

calculateScriptId

string

{calculateType} == “gs2_script”

✓*

~ 1024 chars

GRN of cost calculation script

* Required if calculateType is “gs2_script”

exchangeCountId

string

✓

~ 1024 chars

GRN of GS2-Limit model that manages the number of exchanges

maximumExchangeCount

int

✓

2147483646

0 ~ 2147483646

Maximum number of exchanges

acquireActions

List<AcquireAction>

[]

0 ~ 100 items

List of Acquire Action