GS2-Money2 Deploy/CDK Reference

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

Entities

Resources managed by the Deploy operation

Namespace

A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. 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.

Request

Resource creation and update requests

Type Condition Required Default Value Limits Description

name

string

✓

~ 128 chars

Namespace name

Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

currencyUsagePriority

string (enum)
enum {
“PrioritizeFree”,
“PrioritizePaid”
}

✓

Consumption priority

Determines the order in which paid and free currency are consumed when withdrawing from the wallet. PrioritizeFree consumes free currency first, while PrioritizePaid consumes paid currency first.

Definition	Description
PrioritizeFree	Prioritize the use of free currency
PrioritizePaid	Prioritize the use of paid currency

description string ~ 1024 chars Description

transactionSettingV2

TransactionSettingV2

Transaction Setting (V2)

Decides how the transactions this Namespace issues are executed. There are only two things to set: the GS2-Distributor Namespace that executes them, and whether the actions in a transaction run one at a time – so that a later action can build on what an earlier one wrote – or all at once for a shorter response time.
Set this on a new Namespace. transactionSetting, the obsolete setting it replaces, is used only while this is unset.

sharedFreeCurrency

bool

✓

Share the free currency with different slots

When enabled, free currency balance is shared across all wallet slots (platforms). Paid currency remains separate per slot. This setting can only be configured at Namespace creation time and cannot be changed later.

platformSetting

PlatformSetting

✓

Store platform settings

Configuration for each supported store platform (Apple App Store, Google Play, Fake for testing). Includes credentials and keys required for receipt verification on each platform.

depositBalanceScript

ScriptSetting

Script setting to be executed when depositing wallet balance

Script Trigger Reference - deposit

withdrawBalanceScript

ScriptSetting

Script setting to be executed when withdrawing wallet balance

Script Trigger Reference - withdraw

verifyReceiptScript

ScriptSetting

Script setting to be executed when verifying a receipt

Script Trigger Reference - verifyReceipt

subscribeScript

string

~ 1024 chars

GS2-Script script GRN to be executed when subscribing to a new contract (Not called when the user associated with the subscription is changed / Called when re-subscribing after contract expiration)

Script Trigger Reference - subscribe

renewScript

string

~ 1024 chars

GS2-Script script GRN to be executed when renewing a contract

Script Trigger Reference - renew

unsubscribeScript

string

~ 1024 chars

GS2-Script script GRN to be executed when unsubscribing from a contract (Not called when the user associated with the subscription is changed)

Script Trigger Reference - unsubscribe

takeOverScript

ScriptSetting

Script setting to be executed when changing the user associated with a subscription

Script Trigger Reference - takeOver

changeSubscriptionStatusNotification

NotificationSetting

Push notification when the subscription status changes

Configures push notifications delivered via GS2-Gateway when a subscription status changes (e.g., activated, renewed, canceled, expired, or revoked). Allows the game client to respond to subscription state transitions in real-time.

logSetting

LogSetting

Log Output Setting

Specifies the GS2-Log Namespace to which API request and response logs for this Namespace will be output. Useful for tracking deposits, withdrawals, receipt verifications, and subscription events.

GetAttr

Resource creation results that can be retrieved using the !GetAttr tag

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Money2::Namespace
Properties:
  Name: namespace-0001
  CurrencyUsagePriority: PrioritizeFree
  Description: null
  TransactionSettingV2: null
  SharedFreeCurrency: false
  PlatformSetting: {}
  DepositBalanceScript: null
  WithdrawBalanceScript: null
  VerifyReceiptScript: null
  SubscribeScript: null
  RenewScript: null
  UnsubscribeScript: null
  TakeOverScript: null
  ChangeSubscriptionStatusNotification: 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/money2"
)


SampleStack := core.NewStack()
money2.NewNamespace(
    &SampleStack,
    "namespace-0001",
    money2.NamespaceCurrencyUsagePriorityPrioritizeFree,
    false,
    money2.PlatformSetting{
        AppleAppStore: nil,
        GooglePlay:    nil,
        Fake:          nil,
    },
    money2.NamespaceOptions{
        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\Money2\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            currencyUsagePriority: \Gs2Cdk\Money2\Model\Enums\NamespaceCurrencyUsagePriority::PRIORITIZE_FREE,
            sharedFreeCurrency: false,
            platformSetting: new \Gs2Cdk\Money2\Model\PlatformSetting(),
            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.PlatformSetting(),
                new io.gs2.cdk.money2.model.options.NamespaceOptions()
                        .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.Gs2Money2.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            currencyUsagePriority: Gs2Cdk.Gs2Money2.Model.Enums.NamespaceCurrencyUsagePriority.PrioritizeFree,
            sharedFreeCurrency: false,
            platformSetting: new Gs2Cdk.Gs2Money2.Model.PlatformSetting(),
            options: 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

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,
            new money2.model.PlatformSetting(),
            {
                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, 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,
            platform_setting=money2.PlatformSetting(),
            options=money2.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

TransactionSettingV2

Transaction Setting (V2)

Transaction Setting (V2) decides how the transactions issued by a Namespace are executed.

There are only two things to set:

distributorNamespaceId: the GS2-Distributor Namespace used to execute the transaction
enableParallelExecution: whether the actions in a transaction run one at a time or all at once

Whichever you choose, the transaction is executed by the server the moment it is issued, and it succeeds or fails as a whole: when an action fails, the actions that already ran are undone with it and nothing is left applied. Everything else about how a transaction runs is fixed to the recommended configuration, so there is nothing else to set.

Running the actions one at a time (the default, enableParallelExecution is false) lets each action work on top of what the actions before it wrote. The actions run in verify, consume, acquire order, and this is what lets you:

update the same row from more than one action in a single transaction, which fails when they run all at once
read what an earlier action wrote, including from List and Query and from inside a nested transaction
use %{Gs2Xxx:ActionName.path[0].field} to feed the result of an earlier verify or consume action into the parameters of a later verify, consume or acquire action

In exchange, the response time is the sum of the time taken by each action, and a transaction may contain at most 20 actions. The order within each phase is decided by the action name and then by the target resource, so you cannot choose the execution order by rearranging the actions in the request, and execution stops at the first action that fails.

Running the actions all at once (enableParallelExecution is true) executes them in parallel against a single snapshot of the data, so the response time is that of the slowest single action and there is no limit on the number of actions.

In exchange, an action cannot see what the other actions wrote, and two actions that write the same row fail the transaction with database:transaction:same.resource (400), so choose this only when you can guarantee that no two actions in the same transaction write the same data. %{...} may reference only the results of an earlier phase (verify, then consume, then acquire); a reference to an action in the same phase is left unresolved, and a phase that contains %{...} waits for the earlier phases to complete, which lengthens the response time by that amount.

Transaction Setting is the obsolete setting that Transaction Setting (V2) replaces, kept for Namespaces created before Transaction Setting (V2) existed. It applies only while Transaction Setting (V2) is unset, and setting Transaction Setting (V2) supersedes it. Three behaviours it allowed are deliberately not offered here: executing a transaction as a client-run stamp sheet, running AutoRun asynchronously via GS2-Distributor, and folding acquire actions into GS2-JobQueue.

	Type	Condition	Required	Default	Value Limits	Description
distributorNamespaceId	string			“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor Namespace GRN used to execute transactions
enableParallelExecution	bool			false		Whether to execute the actions in parallel instead of sequentially

ScriptSetting

Script Setting

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. Because synchronous execution blocks processing until the script finishes executing, you can use the script result to stop the API execution or control the API response.

In contrast, asynchronous execution does not block processing until the script has finished executing. However, because the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API response flow and 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

GS2-Script script GRN executed synchronously when the API is executed

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

doneTriggerTargetType

string (enum)
enum {
  “none”,
  “gs2_script”,
  “aws”
}

“none”

Asynchronous script execution method

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

Definition	Description
none	None
gs2_script	GS2-Script
aws	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-Script script GRN for asynchronous execution

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

* Enabled only if doneTriggerTargetType is “gs2_script”

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-JobQueue Namespace GRN used to execute asynchronous scripts

If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue Namespace GRN.
GS2-JobQueue is generally not required unless you have a specific reason to use it.

* Enabled only if doneTriggerTargetType is “gs2_script”

NotificationSetting

Push Notification Setting

Configuration for sending push notifications when events occur in GS2 microservices. The push notification here refers to the processing via the WebSocket interface provided by GS2-Gateway, and is different from the push notification of a smartphone. For example, when matchmaking is completed or a friend request is received, the GS2-Gateway can send a push notification via the WebSocket interface, and the game client can detect the change of the state.

GS2-Gateway’s push notifications can be used to forward notifications to mobile push notification services when the destination device is offline. By properly utilizing mobile push notifications, you can implement a flow in which players are notified even if they exit the game during matchmaking and later return to it.

Type Condition Required Default Value Limits Description

gatewayNamespaceId

string

“grn:gs2:{region}:{ownerId}:gateway:default”

~ 1024 chars

GS2-Gateway Namespace to use for push notifications

Specify the GS2-Gateway Namespace ID in GRN format starting with “grn:gs2:”.

enableTransferMobileNotification

bool?

false

Whether to forward the notification as a mobile push notification

When an attempt is made to send this notification and the destination device is offline, specify whether it should be forwarded as a mobile push notification.

sound

string

{enableTransferMobileNotification} == true

~ 1024 chars

Sound file name to be used for mobile push notifications

The sound file name specified here is used when sending mobile push notifications, and you can send notifications with a special sound.

* Enabled only if enableTransferMobileNotification is true

mobileNotificationMessages

List<MobileNotificationMessage>

{enableTransferMobileNotification} == true

0 ~ 100 items

Localized title and body used when forwarding to mobile push notifications

The title and the body, per language, used when the notification is forwarded as a mobile push notification to an offline player.
The entry to be used is selected in the following order: the entry whose locale matches the locale registered with the device token, then the entry whose locale is default, and finally the first entry of the list.
If this is not set, the mobile array of the notification payload is used instead, and if that is not present either, the payload itself is used as the body.

* Enabled only if enableTransferMobileNotification is true

enable

string (enum)
enum {
“Enabled”,
“Disabled”
}

“Enabled”

Whether to enable push notifications

Definition	Description
Enabled	Enabled
Disabled	Disabled

LogSetting

Log Output Setting

Log Output Setting defines how log data is exported. This type holds the GS2-Log Namespace identifier (Namespace ID), which is 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, debugging, and other operational purposes.

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log Namespace GRN to output logs Must be specified in GRN format starting with “grn:gs2:”.

TransactionSetting

Transaction Setting

Transaction Setting is obsolete: Transaction Setting (V2) replaces it. It is kept for Namespaces created before Transaction Setting (V2) existed, applies only while Transaction Setting (V2) is unset, and should not be chosen for a new Namespace.

It exposes each part of transaction execution as a separate field – AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, asynchronous processing of acquire actions via GS2-JobQueue, and sequential execution – so combinations other than the recommended one can be built. Transaction Setting (V2) is that recommended combination expressed as a single setting. Keep using Transaction Setting only on a Namespace that already depends on a behaviour Transaction Setting (V2) does not offer: executing a transaction as a client-run stamp sheet, running AutoRun asynchronously via GS2-Distributor, or folding acquire actions into GS2-JobQueue.

	Type	Condition	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 transactions atomically * Enabled only if enableAutoRun is true
transactionUseDistributor	bool	{enableAtomicCommit} == true	false		Whether to execute transactions asynchronously * Enabled only if enableAtomicCommit is true
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	false		Whether to execute the commit processing of the script result asynchronously * Enabled only if transactionUseDistributor is true
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	false		Whether to use GS2-JobQueue to execute the acquire action * Enabled only if enableAtomicCommit is true
enableSequentialExecution	bool	{enableAtomicCommit} == true	false		Whether to execute the actions of an atomic commit sequentially so that multiple actions may update the same row * Enabled only if enableAtomicCommit is true
distributorNamespaceId	string		“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor Namespace GRN used to execute transactions
queueNamespaceId	string		“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	GS2-JobQueue Namespace GRN used to execute transactions

PlatformSetting

Platform Setting

Aggregates the settings for all supported store platforms. Contains configuration for Apple App Store, Google Play, and Fake (for testing in Unity Editor). Each platform setting includes the credentials and keys necessary for receipt verification.

	Type	Description
appleAppStore	AppleAppStoreSetting	Apple App Store Setting Credentials for Apple App Store receipt verification, including bundle ID, shared secret key, issuer ID, key ID, and private key.
googlePlay	GooglePlaySetting	Google Play Setting Credentials for Google Play receipt verification, including the package name and public key for signature verification.
fake	FakeSetting	Fake (Unity Editor) Setting Configuration for accepting fake receipts generated by Unity Editor during development and testing.

MobileNotificationMessage

Localized message for mobile push notification

One entry of the per-locale message list used when a notification is forwarded as a mobile push notification. Each entry holds the title and the body for one locale. The entry to be used is selected in the following order: the entry whose locale matches the locale registered with the Firebase device token, then the entry whose locale is default, and finally the first entry of the list.

	Type	Value Limits	Description
locale	string	~ 32 chars	Language of the message The language this entry is for, matched against the locale registered with the Firebase device token. The value is free-form, such as `ja` or `en`. The special value `default` marks the fallback entry used when no entry matches the device locale.
title	string	~ 256 chars	Title of the push notification The text displayed as the title of the mobile push notification when this entry is selected. If omitted, the subject of the notification is used.
message	string	~ 1024 chars	Body text of the push notification The text displayed as the body of the mobile push notification when this entry is selected.

AppleAppStoreSetting

Apple App Store Setting

Configuration for verifying Apple App Store receipts. Contains the credentials required to communicate with Apple’s receipt verification servers, including the bundle ID, shared secret, App Store Connect issuer ID, key ID, and private key.

	Type	Value Limits	Description
bundleId	string	~ 1024 chars	Apple App Store Bundle ID
sharedSecretKey	string	~ 1024 chars	Shared secret key used to encrypt the receipt issued by AppStore Connect
issuerId	string	~ 1024 chars	Issuer ID of in-app purchases registered with AppStore Connect
keyId	string	~ 1024 chars	Key ID registered with Apple
privateKeyPem	string	~ 10240 chars	Private Key received from Apple

GooglePlaySetting

Google Play Setting

Configuration for verifying Google Play receipts. Contains the package name and public key required for validating purchase signatures from Google Play.

	Type	Condition	Required	Default	Value Limits	Description
packageName	string				~ 5120 chars	Package Name to be distributed on Google Play
publicKey	string				~ 5120 chars	Public key used for signature verification

FakeSetting

Fake Setting for Debug

Configuration for handling fake receipts generated by Unity Editor during development. Controls whether fake receipts are accepted or rejected, allowing developers to test in-app purchase flows without real store platforms.

Type Condition Required Default Value Limits Description

acceptFakeReceipt

string (enum)
enum {
“Accept”,
“Reject”
}

“Reject”

Whether to allow payments using fake receipts output by Unity Editor

Controls acceptance of fake receipts. Should be set to Accept during development/testing and Reject in production to prevent unauthorized currency deposits.

Definition	Description
Accept	Accept
Reject	Reject

CurrentModelMaster

Currently active Models master data

This master data defines the Models currently active within the Namespace. GS2 uses JSON format files for managing master data. By uploading these files, you can apply the master data 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 game operations and export JSON files in the appropriate format.

Note

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

Request

Resource creation and update requests

Type

Condition

Required

Default

Value Limits

Description

namespaceName

string

✓

~ 128 chars

Namespace name

Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

mode

string (enum)
enum {
“direct”,
“preUpload”
}

“direct”

Update mode

Definition	Description
direct	Directly update master data
preUpload	Upload master data and then update

settings

string

{mode} == “direct”

✓*

~ 5242880 bytes (5MB)

Master Data

* Required if mode is “direct”

uploadToken

string

{mode} == “preUpload”

✓*

~ 1024 chars

Token obtained by pre-upload

Used to apply the uploaded master data.

* Required if mode is “preUpload”

GetAttr

Resource creation results that can be retrieved using the !GetAttr tag

	Type	Description
Item	CurrentModelMaster	Updated master data of the currently active model

Implementation Example

Type: GS2::Money2::CurrentModelMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  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.google.product3"
          }
      }
    ],
    "storeSubscriptionContentModels": []
    
  }
  UploadToken: null

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


SampleStack := core.NewStack()
money2.NewNamespace(
    &SampleStack,
    "namespace-0001",
    money2.NamespaceCurrencyUsagePriorityPrioritizeFree,
    false,
	money2.PlatformSetting{
		AppleAppStore: nil,
		GooglePlay:    nil,
		Fake:          nil,
	},
    money2.NamespaceOptions{},
).MasterData(
    []money2.StoreContentModel{
        money2.NewStoreContentModel(
            "content-0001",
            money2.StoreContentModelOptions{
                AppleAppStore: &money2.AppleAppStoreContent{
                    ProductId: pointy.String("io.gs2.sample.apple.product1"),
                },
                GooglePlay: &money2.GooglePlayContent{
                    ProductId: pointy.String("io.gs2.sample.google.product1"),
                },
            },
        ),
        money2.NewStoreContentModel(
            "content-0002",
            money2.StoreContentModelOptions{
                AppleAppStore: &money2.AppleAppStoreContent{
                    ProductId: pointy.String("io.gs2.sample.apple.product2"),
                },
                GooglePlay: &money2.GooglePlayContent{
                    ProductId: pointy.String("io.gs2.sample.google.product2"),
                },
            },
        ),
        money2.NewStoreContentModel(
            "apple-only-0001",
            money2.StoreContentModelOptions{
                AppleAppStore: &money2.AppleAppStoreContent{
                    ProductId: pointy.String("io.gs2.sample.apple.product3"),
                },
            },
        ),
        money2.NewStoreContentModel(
            "google-only-0001",
            money2.StoreContentModelOptions{
                GooglePlay: &money2.GooglePlayContent{
                    ProductId: pointy.String("io.gs2.sample.google.product3"),
                },
            },
        ),
    },
    []money2.StoreSubscriptionContentModel{
    },
)

println(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\Enums\NamespaceCurrencyUsagePriority::PRIORITIZE_FREE,
            sharedFreeCurrency: false,
            platformSetting: new \Gs2Cdk\Money2\Model\PlatformSetting(),
        ))->masterData(
            [
                new \Gs2Cdk\Money2\Model\StoreContentModel(
                    name:"content-0001",
                    options: new \Gs2Cdk\Money2\Model\Options\StoreContentModelOptions(
                        appleAppStore:new \Gs2Cdk\Money2\Model\AppleAppStoreContent(
                            options: new \Gs2Cdk\Money2\Model\Options\AppleAppStoreContentOptions(
                                productId: "io.gs2.sample.apple.product1",
                            ),
                        ),
                        googlePlay:new \Gs2Cdk\Money2\Model\GooglePlayContent(
                            options: new \Gs2Cdk\Money2\Model\Options\GooglePlayContentOptions(
                                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(
                            options: new \Gs2Cdk\Money2\Model\Options\AppleAppStoreContentOptions(
                                productId: "io.gs2.sample.apple.product2",
                            ),
                        ),
                        googlePlay:new \Gs2Cdk\Money2\Model\GooglePlayContent(
                            options: new \Gs2Cdk\Money2\Model\Options\GooglePlayContentOptions(
                                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(
                            options: new \Gs2Cdk\Money2\Model\Options\AppleAppStoreContentOptions(
                                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(
                            options: new \Gs2Cdk\Money2\Model\Options\GooglePlayContentOptions(
                                productId: "io.gs2.sample.google.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,
            "namespace-0001",
            io.gs2.cdk.money2.model.enums.NamespaceCurrencyUsagePriority.PRIORITIZE_FREE,
            false,
            null
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "content-0001",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions()
                        .withAppleAppStore(new io.gs2.cdk.money2.model.AppleAppStoreContent(
                            new io.gs2.cdk.money2.model.options.AppleAppStoreContentOptions()
                                .withProductId("io.gs2.sample.apple.product1")
                        ))
                        .withGooglePlay(new io.gs2.cdk.money2.model.GooglePlayContent(
                            new io.gs2.cdk.money2.model.options.GooglePlayContentOptions()
                                .withProductId("io.gs2.sample.google.product1")
                        ))
                ),
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "content-0002",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions()
                        .withAppleAppStore(new io.gs2.cdk.money2.model.AppleAppStoreContent(
                            new io.gs2.cdk.money2.model.options.AppleAppStoreContentOptions()
                                .withProductId("io.gs2.sample.apple.product2")
                        ))
                        .withGooglePlay(new io.gs2.cdk.money2.model.GooglePlayContent(
                            new io.gs2.cdk.money2.model.options.GooglePlayContentOptions()
                                .withProductId("io.gs2.sample.google.product2")
                        ))
                ),
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "apple-only-0001",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions()
                        .withAppleAppStore(new io.gs2.cdk.money2.model.AppleAppStoreContent(
                            new io.gs2.cdk.money2.model.options.AppleAppStoreContentOptions()
                                .withProductId("io.gs2.sample.apple.product3")
                        ))
                ),
                new io.gs2.cdk.money2.model.StoreContentModel(
                    "google-only-0001",
                    new io.gs2.cdk.money2.model.options.StoreContentModelOptions()
                        .withGooglePlay(new io.gs2.cdk.money2.model.GooglePlayContent(
                            new io.gs2.cdk.money2.model.options.GooglePlayContentOptions()
                                .withProductId("io.gs2.sample.google.product3")
                        ))
                )
            ),
            Arrays.asList(
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Money2.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            currencyUsagePriority: Gs2Cdk.Gs2Money2.Model.Enums.NamespaceCurrencyUsagePriority.PrioritizeFree,
            sharedFreeCurrency: false,
            platformSetting: null
        ).MasterData(
            new Gs2Cdk.Gs2Money2.Model.StoreContentModel[] {
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    name: "content-0001",
                    options: new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions
                    {
                        appleAppStore = new Gs2Cdk.Gs2Money2.Model.AppleAppStoreContent(
                            options: new Gs2Cdk.Gs2Money2.Model.Options.AppleAppStoreContentOptions
                            {
                                productId = "io.gs2.sample.apple.product1"
                            }
                        ),
                        googlePlay = new Gs2Cdk.Gs2Money2.Model.GooglePlayContent(
                            options: new Gs2Cdk.Gs2Money2.Model.Options.GooglePlayContentOptions
                            {
                                productId = "io.gs2.sample.google.product1"
                            }
                        )
                    }
                ),
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    name: "content-0002",
                    options: new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions
                    {
                        appleAppStore = new Gs2Cdk.Gs2Money2.Model.AppleAppStoreContent(
                            options: new Gs2Cdk.Gs2Money2.Model.Options.AppleAppStoreContentOptions
                            {
                                productId = "io.gs2.sample.apple.product2"
                            }
                        ),
                        googlePlay = new Gs2Cdk.Gs2Money2.Model.GooglePlayContent(
                            options: new Gs2Cdk.Gs2Money2.Model.Options.GooglePlayContentOptions
                            {
                                productId = "io.gs2.sample.google.product2"
                            }
                        )
                    }
                ),
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    name: "apple-only-0001",
                    options: new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions
                    {
                        appleAppStore = new Gs2Cdk.Gs2Money2.Model.AppleAppStoreContent(
                            options: new Gs2Cdk.Gs2Money2.Model.Options.AppleAppStoreContentOptions
                            {
                                productId = "io.gs2.sample.apple.product3"
                            }
                        )
                    }
                ),
                new Gs2Cdk.Gs2Money2.Model.StoreContentModel(
                    name: "google-only-0001",
                    options: new Gs2Cdk.Gs2Money2.Model.Options.StoreContentModelOptions
                    {
                        googlePlay = new Gs2Cdk.Gs2Money2.Model.GooglePlayContent(
                            options: new Gs2Cdk.Gs2Money2.Model.Options.GooglePlayContentOptions
                            {
                                productId = "io.gs2.sample.google.product3"
                            }
                        )
                    }
                )
            },
            new Gs2Cdk.Gs2Money2.Model.StoreSubscriptionContentModel[] {
            }
        );
    }
}

Debug.Log(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,
            new money2.model.PlatformSetting()
        ).masterData(
            [
                new money2.model.StoreContentModel(
                    "content-0001",
                    {
                        appleAppStore: new money2.model.AppleAppStoreContent(
                            {
                                productId: "io.gs2.sample.apple.product1"
                            }
                        ),
                        googlePlay: new money2.model.GooglePlayContent(
                            {
                                productId: "io.gs2.sample.google.product1"
                            }
                        )
                    }
                ),
                new money2.model.StoreContentModel(
                    "content-0002",
                    {
                        appleAppStore: new money2.model.AppleAppStoreContent(
                            {
                                productId: "io.gs2.sample.apple.product2"
                            }
                        ),
                        googlePlay: new money2.model.GooglePlayContent(
                            {
                                productId: "io.gs2.sample.google.product2"
                            }
                        )
                    }
                ),
                new money2.model.StoreContentModel(
                    "apple-only-0001",
                    {
                        appleAppStore: new money2.model.AppleAppStoreContent(
                            {
                                productId: "io.gs2.sample.apple.product3"
                            }
                        )
                    }
                ),
                new money2.model.StoreContentModel(
                    "google-only-0001",
                    {
                        googlePlay: new money2.model.GooglePlayContent(
                            {
                                productId: "io.gs2.sample.google.product3"
                            }
                        )
                    }
                )
            ],
            [
            ]
        );
    }
}

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

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,
            platform_setting=money2.PlatformSetting(),
        ).master_data(
            store_content_models=[
                money2.StoreContentModel(
                    name='content-0001',
                    options=money2.StoreContentModelOptions(
                        apple_app_store = money2.AppleAppStoreContent(
                            options=money2.AppleAppStoreContentOptions(
                                product_id='io.gs2.sample.apple.product1',
                            ),
                        ),
                        google_play = money2.GooglePlayContent(
                            options=money2.GooglePlayContentOptions(
                                product_id='io.gs2.sample.google.product1',
                            ),
                        )
                    ),
                ),
                money2.StoreContentModel(
                    name='content-0002',
                    options=money2.StoreContentModelOptions(
                        apple_app_store = money2.AppleAppStoreContent(
                            options=money2.AppleAppStoreContentOptions(
                                product_id='io.gs2.sample.apple.product2',
                            ),
                        ),
                        google_play = money2.GooglePlayContent(
                            options=money2.GooglePlayContentOptions(
                                product_id='io.gs2.sample.google.product2',
                            ),
                        )
                    ),
                ),
                money2.StoreContentModel(
                    name='apple-only-0001',
                    options=money2.StoreContentModelOptions(
                        apple_app_store = money2.AppleAppStoreContent(
                            options=money2.AppleAppStoreContentOptions(
                                product_id='io.gs2.sample.apple.product3',
                            ),
                        )
                    ),
                ),
                money2.StoreContentModel(
                    name='google-only-0001',
                    options=money2.StoreContentModelOptions(
                        google_play = money2.GooglePlayContent(
                            options=money2.GooglePlayContentOptions(
                                product_id='io.gs2.sample.google.product3',
                            ),
                        )
                    ),
                ),
            ],
            store_subscription_content_models=[
            ],
        )

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

StoreContentModel

Store Content Model

This is a model for storing content from various store platforms.

	Type	Required	Value Limits	Description
storeContentModelId	string	*	~ 1024 chars	Store Content Model GRN * Set automatically by the server
name	string	✓	~ 128 chars	Store Content Model name
metadata	string		~ 1024 chars	Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game.
appleAppStore	AppleAppStoreContent			Apple App Store Content The Apple App Store product information (product ID) for this store content. Used during receipt verification to match the purchased product.
googlePlay	GooglePlayContent			Google Play Content The Google Play product information (product ID) for this store content. Used during receipt verification to match the purchased product.

AppleAppStoreContent

Content of Apple App Store

Contains the Apple App Store product ID that corresponds to an in-app purchase product. Used to match receipts during verification.

	Type	Condition	Required	Default	Value Limits	Description
productId	string				~ 1024 chars	Product ID The Apple App Store product identifier registered in App Store Connect for this in-app purchase item.

GooglePlayContent

Content of Google Play

Contains the Google Play product ID that corresponds to an in-app purchase product. Used to match receipts during verification.

	Type	Condition	Required	Default	Value Limits	Description
productId	string				~ 1024 chars	Product ID The Google Play product identifier registered in Google Play Console for this in-app purchase item.

StoreSubscriptionContentModel

Store Subscription Content Model

This is a model for storing subscription-based content from various store platforms.

Type

Condition

Required

Default

Value Limits

Description

storeSubscriptionContentModelId

string

~ 1024 chars

Subscription Content Model GRN

* Set automatically by the server

name

string

✓

~ 128 chars

Store Subscription Content Model name

metadata

string

~ 1024 chars

Metadata

scheduleNamespaceId

string

✓

~ 1024 chars

Namespace GRN of GS2-Schedule to link the subscription period

triggerName

string

✓

~ 128 chars

Trigger name to reflect the subscription period

The name of the GS2-Schedule trigger that will be activated to reflect the subscription’s active period. The trigger duration is set to the subscription’s expiration time.

triggerExtendMode

string (enum)
enum {
“just”,
“rollupHour”
}

“just”

Mode to reflect the subscription period on the trigger

Controls how the subscription expiration is mapped to the trigger duration. “just” uses the exact subscription period. “rollupHour” extends the period to the next specified hour (UTC) to avoid mid-day expirations.

Definition	Description
just	Reflect the subscription period as it is
rollupHour	Extend the subscription period to the next day crossing time

rollupHour

int

{triggerExtendMode} == “rollupHour”

0 ~ 23

Hour of the day to roll up the subscription period (UTC)

When triggerExtendMode is “rollupHour”, the subscription period is extended to this hour (0-23, UTC) on the expiration day. This prevents subscriptions from expiring in the middle of a user’s play session.

* Enabled only if triggerExtendMode is “rollupHour”

reallocateSpanDays

int

0 ~ 365

Time span (days) that allows subscription contract information to be assigned to other users

The number of days after the last allocation before a subscription contract can be reassigned to a different user. This prevents abuse when users change accounts, by enforcing a waiting period before the subscription can be transferred.

appleAppStore

AppleAppStoreSubscriptionContent

Apple App Store Content

The Apple App Store subscription information (subscription group identifier) for this subscription content.

googlePlay

GooglePlaySubscriptionContent

Google Play Content

The Google Play subscription information (product ID) for this subscription content.

AppleAppStoreSubscriptionContent

Subscription content of Apple App Store

Contains the Apple App Store subscription group identifier for subscription-based products. Used to manage and verify auto-renewable subscriptions.

	Type	Condition	Required	Default	Value Limits	Description
subscriptionGroupIdentifier	string				~ 64 chars	Subscription Group ID The subscription group identifier registered in App Store Connect. Subscriptions within the same group are mutually exclusive, meaning a user can only subscribe to one at a time.

GooglePlaySubscriptionContent

Google Play Subscription Content

Contains the Google Play product ID for subscription-based products. Used to manage and verify auto-renewable subscriptions on Google Play.

	Type	Condition	Required	Default	Value Limits	Description
productId	string				~ 1024 chars	Product ID