GS2-Deploy/CDK Reference of GS2-Money2

Entities

Namespace

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.

TypeRequireDefaultLimitationDescription
namestring~ 128 charsNamespace Name
currencyUsagePrioritystring~ 128 charsConsumption priority
descriptionstring~ 1024 charsDescription
sharedFreeCurrencyboolShare the free currency with different slots
platformSettingPlatformSettingStore platform settings
changeBalanceScriptScriptSettingScript to be executed when wallet balance changes
logSettingLogSettingLog output settings

GetAttr

TypeDescription
ItemNamespaceNamespace created

Implementation Example

Type: GS2::Money2::Namespace
Properties:
  Name: namespace1
  CurrencyUsagePriority: PrioritizeFree
  Description: null
  SharedFreeCurrency: false
  PlatformSetting: null
  ChangeBalanceScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, money2

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        money2.Namespace(
            stack=self,
            name="namespace-0001",
            currency_usage_priority=money2.NamespaceCurrencyUsagePriority.PRIORITIZE_FREE,
            shared_free_currency=False,
            options=money2.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\Money2\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            currencyUsagePriority: \Gs2Cdk\Money2\Model\Enum\NamespaceCurrencyUsagePriority::PRIORITIZE_FREE,
            sharedFreeCurrency: False,
            options: new \Gs2Cdk\Money2\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.money2.model.Namespace(
            this,
            "namespace-0001",
            io.gs2.cdk.money2.model.enums.NamespaceCurrencyUsagePriority.PRIORITIZE_FREE,
            false,
            new io.gs2.cdk.money2.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 money2 from "@/gs2cdk/money2";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new money2.model.Namespace(
            this,
            "namespace-0001",
            money2.model.NamespaceCurrencyUsagePriority.PRIORITIZE_FREE,
            false,
            {
                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.Gs2Money2.Model.Namespace(
            this,
            "namespace-0001",
            Gs2Cdk.Gs2Money2.Model.Enums.NamespaceCurrencyUsagePriority.PrioritizeFree,
            false,
            new Gs2Cdk.Gs2Money2.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

CurrentModelMaster

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.

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 128 charsNamespace Name
settingsstring~ 5242880 charsMaster data

GetAttr

TypeDescription
ItemCurrentModelMasterUpdated and currently available model master

Implementation Example

Type: GS2::Money2::CurrentModelMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2024-06-20",
    "storeContentModels": [
      {
        "name": "content-0001",
        "appleAppStore":
          {
            "productId": "io.gs2.sample.apple.product1"
          },
        "googlePlay":
          {
            "productId": "io.gs2.sample.google.product1"
          }
      },
      {
        "name": "content-0002",
        "appleAppStore":
          {
            "productId": "io.gs2.sample.apple.product2"
          },
        "googlePlay":
          {
            "productId": "io.gs2.sample.google.product2"
          }
      },
      {
        "name": "apple-only-0001",
        "appleAppStore":
          {
            "productId": "io.gs2.sample.apple.product3"
          }
      },
      {
        "name": "google-only-0001",
        "googlePlay":
          {
            "productId": "io.gs2.sample.apple.product3"
          }
      }
    ]
  }
from gs2_cdk import Stack, core, money2

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        money2.Namespace(
            stack=self,
            # omission
        ).master_data(
            store_content_models=[
                money2.StoreContentModel(
                    name='content-0001',
                    options=money2.StoreContentModelOptions(
                        apple_app_store=money2.AppleAppStoreContent(
                            product_id='io.gs2.sample.apple.product1'
                        ),
                        google_play=money2.GooglePlayContent(
                            product_id='io.gs2.sample.google.product1'
                        ),
                    ),
                ),
                money2.StoreContentModel(
                    name='content-0002',
                    options=money2.StoreContentModelOptions(
                        apple_app_store=money2.AppleAppStoreContent(
                            product_id='io.gs2.sample.apple.product2'
                        ),
                        google_play=money2.GooglePlayContent(
                            product_id='io.gs2.sample.google.product2'
                        ),
                    ),
                ),
                money2.StoreContentModel(
                    name='apple-only-0001',
                    options=money2.StoreContentModelOptions(
                        apple_app_store=money2.AppleAppStoreContent(
                            product_id='io.gs2.sample.apple.product3'
                        ),
                    ),
                ),
                money2.StoreContentModel(
                    name='google-only-0001',
                    options=money2.StoreContentModelOptions(
                        google_play=money2.GooglePlayContent(
                            product_id='io.gs2.sample.apple.product3'
                        ),
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Money2\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Money2\Model\StoreContentModel(
                    name:"content-0001",
                    options: new \Gs2Cdk\Money2\Model\Options\StoreContentModelOptions(
                        appleAppStore:new \Gs2Cdk\Money2\Model\AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product1"
                        ),
                        googlePlay:new \Gs2Cdk\Money2\Model\GooglePlayContent(
                            productId: "io.gs2.sample.google.product1"
                        )
                    )
                ),
                new \Gs2Cdk\Money2\Model\StoreContentModel(
                    name:"content-0002",
                    options: new \Gs2Cdk\Money2\Model\Options\StoreContentModelOptions(
                        appleAppStore:new \Gs2Cdk\Money2\Model\AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product2"
                        ),
                        googlePlay:new \Gs2Cdk\Money2\Model\GooglePlayContent(
                            productId: "io.gs2.sample.google.product2"
                        )
                    )
                ),
                new \Gs2Cdk\Money2\Model\StoreContentModel(
                    name:"apple-only-0001",
                    options: new \Gs2Cdk\Money2\Model\Options\StoreContentModelOptions(
                        appleAppStore:new \Gs2Cdk\Money2\Model\AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product3"
                        )
                    )
                ),
                new \Gs2Cdk\Money2\Model\StoreContentModel(
                    name:"google-only-0001",
                    options: new \Gs2Cdk\Money2\Model\Options\StoreContentModelOptions(
                        googlePlay:new \Gs2Cdk\Money2\Model\GooglePlayContent(
                            productId: "io.gs2.sample.apple.product3"
                        )
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.money2.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "content-0001",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions() {
                        {
                            appleAppStore: new io.gs2.cdk.money2.model.AppleAppStoreContent(
                                "io.gs2.sample.apple.product1"
                            );
                            googlePlay: new io.gs2.cdk.money2.model.GooglePlayContent(
                                "io.gs2.sample.google.product1"
                            );
                        }
                    }
                ),
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "content-0002",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions() {
                        {
                            appleAppStore: new io.gs2.cdk.money2.model.AppleAppStoreContent(
                                "io.gs2.sample.apple.product2"
                            );
                            googlePlay: new io.gs2.cdk.money2.model.GooglePlayContent(
                                "io.gs2.sample.google.product2"
                            );
                        }
                    }
                ),
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "apple-only-0001",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions() {
                        {
                            appleAppStore: new io.gs2.cdk.money2.model.AppleAppStoreContent(
                                "io.gs2.sample.apple.product3"
                            );
                        }
                    }
                ),
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "google-only-0001",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions() {
                        {
                            googlePlay: new io.gs2.cdk.money2.model.GooglePlayContent(
                                "io.gs2.sample.apple.product3"
                            );
                        }
                    }
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import money2 from "@/gs2cdk/money2";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new money2.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new money2.model.StoreContentModel(
                    "content-0001",
                    {
                        appleAppStore: new money2.model.AppleAppStoreContent(
                            "io.gs2.sample.apple.product1"
                        ),
                        googlePlay: new money2.model.GooglePlayContent(
                            "io.gs2.sample.google.product1"
                        )
                    }
                ),
                new money2.model.StoreContentModel(
                    "content-0002",
                    {
                        appleAppStore: new money2.model.AppleAppStoreContent(
                            "io.gs2.sample.apple.product2"
                        ),
                        googlePlay: new money2.model.GooglePlayContent(
                            "io.gs2.sample.google.product2"
                        )
                    }
                ),
                new money2.model.StoreContentModel(
                    "apple-only-0001",
                    {
                        appleAppStore: new money2.model.AppleAppStoreContent(
                            "io.gs2.sample.apple.product3"
                        )
                    }
                ),
                new money2.model.StoreContentModel(
                    "google-only-0001",
                    {
                        googlePlay: new money2.model.GooglePlayContent(
                            "io.gs2.sample.apple.product3"
                        )
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Money2.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    "content-0001",
                    new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions {
                        appleAppStore = new Gs2Cdk.Gs2Money2.Model.AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product1"
                        ),
                        googlePlay = new Gs2Cdk.Gs2Money2.Model.GooglePlayContent(
                            productId: "io.gs2.sample.google.product1"
                        )
                    }
                ),
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    "content-0002",
                    new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions {
                        appleAppStore = new Gs2Cdk.Gs2Money2.Model.AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product2"
                        ),
                        googlePlay = new Gs2Cdk.Gs2Money2.Model.GooglePlayContent(
                            productId: "io.gs2.sample.google.product2"
                        )
                    }
                ),
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    "apple-only-0001",
                    new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions {
                        appleAppStore = new Gs2Cdk.Gs2Money2.Model.AppleAppStoreContent(
                            productId: "io.gs2.sample.apple.product3"
                        )
                    }
                ),
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    "google-only-0001",
                    new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions {
                        googlePlay = new Gs2Cdk.Gs2Money2.Model.GooglePlayContent(
                            productId: "io.gs2.sample.apple.product3"
                        )
                    }
                )
            }
        );
    }
}

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

Receipt

Receipt of store platform

TypeRequireDefaultLimitationDescription
Storeenum [
“AppleAppStore”,
“GooglePlay”,
“fake”
]
~ 128 charsStore
TransactionIDstring~ 128 charsTransaction ID
Payloadstring~ 1048576 charsPayload

PlatformSetting

Platform Setting

TypeRequireDefaultLimitationDescription
appleAppStoreAppleAppStoreSettingApple AppStore Setting
googlePlayGooglePlaySettingGoogle Play Setting
fakeFakeSettingFake(Unity Editor) Setting

AppleAppStoreSetting

Apple AppStore Setting

TypeRequireDefaultLimitationDescription
bundleIdstring~ 1024 charsApple AppStore Bundle ID

GooglePlaySetting

Google Play Setting

TypeRequireDefaultLimitationDescription
packageNamestring~ 5120 charsPackage Name to be distributed on Google Play
publicKeystring~ 5120 charsPublic key used for signature verification

FakeSetting

Fake Setting for Debug

TypeRequireDefaultLimitationDescription
acceptFakeReceiptenum [
“Accept”,
“Reject”
]
“Reject”~ 128 charsAble to make a payment with a fake receipt output by UnityEditor

WalletSummary

Wallet Status

TypeRequireDefaultLimitationDescription
paidint0~ 2147483646Count of Paid
freeint0~ 2147483646Count of Free
totalint0~ 2147483646Count of Total

DepositTransaction

Deposit Transaction

TypeRequireDefaultLimitationDescription
pricefloat~ 100000.0Purchase Price
currencystring{price} > 0~ 8 charsCurrency Code
countint~ 2147483646Count
depositedAtlongDeposit Date

VerifyReceiptEvent

Deposit Event

TypeRequireDefaultLimitationDescription
contentNamestring~ 128 charsStore Content Model Name
platformenum [
“AppleAppStore”,
“GooglePlay”,
“fake”
]
~ 128 charsStore Platform
appleAppStoreVerifyReceiptEventAppleAppStoreVerifyReceiptEventApple AppStore Verify Receipt Event
googlePlayVerifyReceiptEventGooglePlayVerifyReceiptEventGoogle Play Verify Receipt Event

DepositEvent

Deposit Event

TypeRequireDefaultLimitationDescription
slotint~ 100000000Slot Number
depositTransactionsList<DepositTransaction>[]~ 1000 itemsList of deposit transactions
statusWalletSummaryWallet Status

WithdrawEvent

Withdraw Event

TypeRequireDefaultLimitationDescription
slotint~ 100000000Slot Number
withdrawDetailsList<DepositTransaction>[]~ 1000 itemsList of details of the withdrawn wallet
statusWalletSummaryWallet Status

AppleAppStoreVerifyReceiptEvent

Apple AppStore Receipt

TypeRequireDefaultLimitationDescription
environmentenum [
“sandbox”,
“production”
]
~ 128 charsEnvironment

GooglePlayVerifyReceiptEvent

Google Play Receipt Verification Event

TypeRequireDefaultLimitationDescription
purchaseTokenstring~ 4096 charsPurchase Token

AppleAppStoreContent

Content of Apple AppStore

TypeRequireDefaultLimitationDescription
productIdstring~ 1024 charsProduct ID

GooglePlayContent

Content of Google Play

TypeRequireDefaultLimitationDescription
productIdstring~ 1024 charsProduct ID

GitHubCheckoutSetting

Setup to check out master data from GitHub

TypeRequireDefaultLimitationDescription
apiKeyIdstring~ 1024 charsGitHub API key GRN
repositoryNamestring~ 1024 charsRepository Name
sourcePathstring~ 1024 charsSource code file path
referenceTypeenum [
“commit_hash”,
“branch”,
“tag”
]
~ 128 charsSource of code
commitHashstring{referenceType} == “commit_hash”~ 1024 charsCommit hash
branchNamestring{referenceType} == “branch”~ 1024 charsBranch Name
tagNamestring{referenceType} == “tag”~ 1024 charsTag Name

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.

TypeRequireDefaultLimitationDescription
triggerScriptIdstring~ 1024 charsScript GRN
doneTriggerTargetTypeenum [
“none”,
“gs2_script”,
“aws”
]
“none”~ 128 charsNotification of Completion
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsScript GRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsNamespace GRN

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.

TypeRequireDefaultLimitationDescription
loggingNamespaceIdstring~ 1024 charsNamespace GRN