NAV
YAML TypeScript (CDK) Python (CDK) PHP (CDK) Java (CDK) C# (CDK)

GS2-Exchange

Reference to resource definitions available in GS2-Deploy templates

GS2-Deploy Reference

Entities

Namespace

Namespace

Type: GS2::Exchange::Namespace
Properties:
  Name: namespace1
  Description: null
  EnableAwaitExchange: null
  EnableDirectExchange: null
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  ExchangeScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, exchange

class SampleStack(Stack):

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

print(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",
            transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                enableAutoRun: False,
                options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                    distributorNamespaceId: ,
                    keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                )
            ),
            options: new \Gs2Cdk\Exchange\Model\Options\NamespaceOptions(
                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.core.model.TransactionSetting(
                false,
                new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                )
            ),
            new io.gs2.cdk.exchange.model.options.NamespaceOptions() {
                {
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(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",
            new core.TransactionSetting(
                false,
                {
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                }
            ),
            {
                logSetting: new core.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(
            this,
            "namespace-0001",
            new Gs2Cdk.Core.Model.TransactionSetting(
                false,
                new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                    DistributorNamespaceId = ,
                    KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    QueueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                }
            ),
            new Gs2Cdk.Gs2Exchange.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

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

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project.
Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

Type Require Default Limitation Description
name string ~ 32 chars Namespace name
description string ~ 1024 chars description of Namespace
enableAwaitExchange bool false Use the exchange function with waiting time to receive the exchange results
enableDirectExchange bool true Allow direct exchange API calls. If not allowed, exchange can only be done via stamp sheet.
transactionSetting TransactionSetting Transaction settings
exchangeScript ScriptSetting Script to run when an attempt is made to perform an exchange
logSetting LogSetting Log output settings

CurrentRateMaster

CurrentRateMaster

Type: GS2::Exchange::CurrentRateMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-08-19",
    "rateModels": [
      {
        "name": "material_n_to_r",
        "metadata": "N2R",
        "timingType": "await",
        "enableSkip": false,
        "lockTime": 50,
        "consumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": "{\\"namespaceName\\": \\"category-0001\\", \\"inventoryName\\": \\"item\\", \\"itemName\\": \\"item-0001\\", \\"userId\\": \\"#{userId}\\", \\"consumeCount\\": 10}"
          }
        ],
        "acquireActions": [
          {
            "action": "Gs2Inventory:AcquireItemSetByUserId",
            "request": "{\\"namespaceName\\": \\"category-0001\\", \\"inventoryName\\": \\"item\\", \\"itemName\\": \\"item-0002\\", \\"userId\\": \\"#{userId}\\", \\"acquireCount\\": 1}"
          }
        ]
      },
      {
        "name": "material_r_to_n",
        "metadata": "N2R",
        "timingType": "await",
        "enableSkip": false,
        "lockTime": 50,
        "consumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": "{\\"namespaceName\\": \\"category-0001\\", \\"inventoryName\\": \\"item\\", \\"itemName\\": \\"item-0002\\", \\"userId\\": \\"#{userId}\\", \\"consumeCount\\": 1}"
          }
        ],
        "acquireActions": [
          {
            "action": "Gs2Inventory:AcquireItemSetByUserId",
            "request": "{\\"namespaceName\\": \\"category-0001\\", \\"inventoryName\\": \\"item\\", \\"itemName\\": \\"item-0001\\", \\"userId\\": \\"#{userId}\\", \\"acquireCount\\": 10}"
          }
        ]
      }
    ]
  }
from gs2_cdk import Stack, core, exchange

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        exchange.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
                exchange.RateModel(
                    name='material_n_to_r',
                    timing_type='await',
                    options=exchange.RateModelOptions(
                        metadata='N2R',
                        consume_actions=[    {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 10}'},
                            ],
                        lock_time=50,
                        acquire_actions=[    {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'},
                            ],
                    ),
                ),
                exchange.RateModel(
                    name='material_r_to_n',
                    timing_type='await',
                    options=exchange.RateModelOptions(
                        metadata='N2R',
                        consume_actions=[    {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "consumeCount": 1}'},
                            ],
                        lock_time=50,
                        acquire_actions=[    {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'},
                            ],
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Exchange\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Exchange\Model\RateModel(
                    name:"material_n_to_r",
                    timingType:"await",
                    options: new \Gs2Cdk\Exchange\Model\Options\RateModelOptions(
                        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": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'},
                        ],
                    ),
                ),
                new \Gs2Cdk\Exchange\Model\RateModel(
                    name:"material_r_to_n",
                    timingType:"await",
                    options: new \Gs2Cdk\Exchange\Model\Options\RateModelOptions(
                        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": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'},
                        ],
                    ),
                ),
            ],
        );
    }
}

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,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.exchange.model.RateModel(
                    "material_n_to_r",
                    "await",
                    new io.gs2.cdk.exchange.model.options.RateModelOptions() {
                        {
                            metadata: "N2R";
                            consumeActions: Arrays.asList(
                                {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 10}'}
                            );
                            lockTime: 50;
                            acquireActions: Arrays.asList(
                                {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'}
                            );
                        }
                    }
                ),
                new io.gs2.cdk.exchange.model.RateModel(
                    "material_r_to_n",
                    "await",
                    new io.gs2.cdk.exchange.model.options.RateModelOptions() {
                        {
                            metadata: "N2R";
                            consumeActions: Arrays.asList(
                                {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "consumeCount": 1}'}
                            );
                            lockTime: 50;
                            acquireActions: Arrays.asList(
                                {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'}
                            );
                        }
                    }
                )
            )
        );
    }
}

System.out.println(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,
            // omission
        ).masterData(
            [
                new exchange.model.RateModel(
                    "material_n_to_r",
                    "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": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'}
                            ]
                    }
                ),
                new exchange.model.RateModel(
                    "material_r_to_n",
                    "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": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'}
                            ]
                    }
                )
            ]
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Exchange.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Exchange.Model.RateModel(
                    "material_n_to_r",
                    "await",
                    new Gs2Cdk.Gs2Exchange.Model.Options.RateModelOptions {
                        metadata = "N2R",
                        consumeActions = new Gs2Cdk.Gs2Exchange.Model.ConsumeAction[] {
                            {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 10}'}
                        },
                        lockTime = 50,
                        acquireActions = new Gs2Cdk.Gs2Exchange.Model.AcquireAction[] {
                            {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "acquireCount": 1}'}
                        },
                    }
                ),
                new Gs2Cdk.Gs2Exchange.Model.RateModel(
                    "material_r_to_n",
                    "await",
                    new Gs2Cdk.Gs2Exchange.Model.Options.RateModelOptions {
                        metadata = "N2R",
                        consumeActions = new Gs2Cdk.Gs2Exchange.Model.ConsumeAction[] {
                            {'action': 'Gs2Inventory:ConsumeItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "consumeCount": 1}'}
                        },
                        lockTime = 50,
                        acquireActions = new Gs2Cdk.Gs2Exchange.Model.AcquireAction[] {
                            {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"namespaceName": "category-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "acquireCount": 10}'}
                        },
                    }
                )
            }
        );
    }
}

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

Currently available master data

GS2 uses JSON format files for master data management.
By uploading the file, you can actually reflect the settings on the server.

We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the
The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.

Please refer to the documentation for the format of the JSON file.

Type Require Default Limitation Description
namespaceName string ~ 32 chars Namespace name
settings string ~ 5242880 chars Master data