GS2-Deploy/CDK Reference of GS2-Money

Entities

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	✓		~ 128 chars	Namespace Name
description	string			~ 1024 chars	Description
priority	string	✓		~ 128 chars	Consumption priority
shareFree	bool	✓			Share the free currency with different slots
currency	string	✓		~ 128 chars	Currency Type
appleKey	string			~ 1024 chars	Apple AppStore Bundle ID
googleKey	string			~ 5120 chars	Google PlayStore private key
enableFakeReceipt	bool	✓	false		Able to make a payment with a fake receipt output by UnityEditor
createWalletScript	ScriptSetting				Script to run when a new wallet is created
depositScript	ScriptSetting				Script to be executed when the wallet balance is added
withdrawScript	ScriptSetting				Script to be executed when wallet balance is consumed
logSetting	LogSetting				Log output settings

Enumeration type definition to specify as priority

Enumerator String Definition	Description
free	Prioritize the use of free currency
paid	Prioritize the use of paid currency

Enumeration type definition to specify as currency

Enumerator String Definition	Description
JPY	JPY
USD	USD
TWD	TWD

GetAttr

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Money::Namespace
Properties:
  Name: namespace1
  Description: null
  Priority: paid
  ShareFree: false
  Currency: USD
  AppleKey: null
  GoogleKey: null
  EnableFakeReceipt: null
  CreateWalletScript: null
  DepositScript: null
  WithdrawScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

from gs2_cdk import Stack, core, money

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        money.Namespace(
            stack=self,
            name="namespace-0001",
            priority=money.NamespacePriority.PAID,
            share_free=False,
            currency=money.NamespaceCurrency.USD,
            options=money.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\Money\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            priority: \Gs2Cdk\Money\Model\Enum\NamespacePriority::PAID,
            shareFree: False,
            currency: \Gs2Cdk\Money\Model\Enum\NamespaceCurrency::USD,
            options: new \Gs2Cdk\Money\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.money.model.Namespace(
            this,
            "namespace-0001",
            io.gs2.cdk.money.model.enums.NamespacePriority.PAID,
            false,
            io.gs2.cdk.money.model.enums.NamespaceCurrency.USD,
            new io.gs2.cdk.money.model.options.NamespaceOptions() {
                {
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new money.model.Namespace(
            this,
            "namespace-0001",
            money.model.NamespacePriority.PAID,
            false,
            money.model.NamespaceCurrency.USD,
            {
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Money.Model.Namespace(
            this,
            "namespace-0001",
            Gs2Cdk.Gs2Money.Model.Enums.NamespacePriority.Paid,
            false,
            Gs2Cdk.Gs2Money.Model.Enums.NamespaceCurrency.Usd,
            new Gs2Cdk.Gs2Money.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

WalletDetail

Wallet Detail

	Type	Require	Default	Limitation	Description
price	float	✓		~ 100000.0	Unit Price
count	int	✓		~ 2147483646	Count

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.

On the other hand, asynchronous execution does not block 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. However, asynchronous execution does not block processing until the script has finished executing, so it is generally recommended to use asynchronous execution.

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	Require	Default	Limitation	Description
triggerScriptId	string			~ 1024 chars	Script GRN
doneTriggerTargetType	enum { “none”, “gs2_script”, “aws” }	✓	“none”	~ 128 chars	Notification of Completion
doneTriggerScriptId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024 chars	Script GRN
doneTriggerQueueNamespaceId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024 chars	Namespace GRN

Enumeration type definition to specify as doneTriggerTargetType

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

LogSetting

Log setting

This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.

	Type	Require	Default	Limitation	Description
loggingNamespaceId	string	✓		~ 1024 chars	Namespace GRN