GS2-Deploy/CDK Reference of GS2-Money2
Entity
Resources operated in Deploy process
Namespace
Namespace
A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Each GS2 service is managed on a per namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.
Therefore, you must create a namespace before you can start using each service.
Request
Resource generation request
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace Name | ||||||||
| currencyUsagePriority | String Enum enum { “PrioritizeFree”, “PrioritizePaid” } | ✓ | Consumption priority
| |||||||||
| description | string | ~ 1024 chars | Description | |||||||||
| transactionSetting | TransactionSetting | Transaction settings | ||||||||||
| platformSetting | PlatformSetting | ✓ | Store platform settings | |||||||||
| depositBalanceScript | ScriptSetting | Script to be executed when depositing wallet balance | ||||||||||
| withdrawBalanceScript | ScriptSetting | Script to be executed when withdrawing wallet balance | ||||||||||
| verifyReceiptScript | ScriptSetting | Script to be executed when verifying a receipt | ||||||||||
| subscribeScript | string | ~ 1024 chars | Script to be executed when subscribing to a new contract(Not called when changing user association / Called when re-subscribing after contract expiration) | |||||||||
| renewScript | string | ~ 1024 chars | Script to be executed when renewing a contract | |||||||||
| unsubscribeScript | string | ~ 1024 chars | Script to be executed when unsubscribing from a contract(Not called when changing user association) | |||||||||
| takeOverScript | ScriptSetting | Script to be executed when taking over a contract | ||||||||||
| changeSubscriptionStatusNotification | NotificationSetting | Notification when the subscription status of the period changes | ||||||||||
| logSetting | LogSetting | Log output settings |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | Namespace | Namespace created |
Implementation Example
Type: GS2::Money2::Namespace
Properties:
Name: namespace-0001
CurrencyUsagePriority: PrioritizeFree
Description: null
TransactionSetting: null
SharedFreeCurrency: false
PlatformSetting: null
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-0001import (
"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{
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,
null,
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 Templatepublic 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,
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 Templateimport 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 TemplateTransactionSetting
Transaction settings
Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, Distributor, batch application of script results, and asynchronous acquisition actions via JobQueue enables robust transaction management tailored to game logic.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | Whether to automatically execute issued transactions on the server side | ||
| enableAtomicCommit | bool | {enableAutoRun} == true | ✓* | false | Whether to commit the execution of transactions atomically * Required if enableAutoRun is true | |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | ✓* | false | Whether to execute transactions asynchronously * Required if enableAtomicCommit is true | |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | ✓* | false | Whether to execute the commit processing of the script result asynchronously * Required if transactionUseDistributor is true | |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | ✓* | false | Whether to use GS2-JobQueue to execute the acquire action * Required if enableAtomicCommit is true | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor namespace GRN used for transaction execution | |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | Namespace GRN in GS2-JobQueue used to run the transaction |
ScriptSetting
Script settings
In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.
There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API.
In contrast, asynchronous execution does not block processing until the script has finished executing. Since the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API’s response flow. For this reason, asynchronous execution is generally recommended.
There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024 chars | Script GRN
of synchronous execution script Must be specified in GRN format starting with “grn:gs2:”. | |||||||||||
| doneTriggerTargetType | String Enum enum { “none”, “gs2_script”, “aws” } | ✓ | “none” | How to execute asynchronous scripts Specifies the type of script to use for asynchronous execution. You can choose from “Do not use asynchronous execution scripts (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.
| ||||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Script GRN
of asynchronous execution script Must be specified in GRN format starting with “grn:gs2:”. * Enabled if doneTriggerTargetType is “gs2_script” | ||||||||||
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-JobQueue namespace GRN
to execute asynchronous execution scripts If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue namespace GRN. There is little reason to use GS2-JobQueue, so you don’t need to specify it unless you have a specific reason. * Enabled if doneTriggerTargetType is “gs2_script” |
NotificationSetting
Push notification settings
This is a setting for sending push notifications when an event occurs in a GS2 microservice. 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 a 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 send additional processing to mobile push notifications when the destination device is offline. If you use mobile push notifications well, you may be able to realize a flow in which you can notify the player by using mobile push notifications even if you end the game during matchmaking and return to the game.
| 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 | Forwarding to mobile push notification When this notification is sent, if the destination device is offline, specify whether to forward it to 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 if enableTransferMobileNotification is true | ||||||||
| enable | String Enum enum { “Enabled”, “Disabled” } | ✓ | “Enabled” | Whether to enable push notifications
|
LogSetting
Log Export Settings
Manages log data export settings. This type holds the GS2-Log namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, and debugging.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | GS2-Log namespace GRN
to output logs Must be specified in GRN format starting with “grn:gs2:”. |
PlatformSetting
Platform Setting
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| appleAppStore | AppleAppStoreSetting | Apple AppStore Setting | ||||
| googlePlay | GooglePlaySetting | Google Play Setting | ||||
| fake | FakeSetting | Fake(Unity Editor) Setting |
AppleAppStoreSetting
Apple AppStore Setting
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| bundleId | string | ~ 1024 chars | Apple AppStore 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
| 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
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| acceptFakeReceipt | String Enum enum { “Accept”, “Reject” } | ✓ | “Reject” | Able to make a payment with a fake receipt output by UnityEditor
|
CurrentModelMaster
Currently Active Master Data
Currently active master data describing the model definitions within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data settings are updated on the server.
To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for operating your game and export JSON files in the appropriate format.
Note
Please refer to Master Data Reference of GS2-Money2 for the JSON file format.Request
Resource generation request
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace Name | ||||||||
| mode | String Enum enum { “direct”, “preUpload” } | ✓ | “direct” | Update mode
| ||||||||
| settings | string | {mode} == “direct” | ✓* | ~ 5242880 chars | Master Data * Required if mode is “direct” | |||||||
| uploadToken | string | {mode} == “preUpload” | ✓* | ~ 1024 chars | Token used to reflect results after upload * Required if mode is “preUpload” |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentModelMaster | Updated Currently Active Model Master Data |
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: nullimport (
"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 Templatepublic 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 Templateimport 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 TemplateStoreContentModel
Content of the store platform
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| storeContentModelId | string | ✓* | ~ 1024 chars | Content Model GRN * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Store Content Model Name | ||
| metadata | string | ~ 1024 chars | Metadata | |||
| appleAppStore | AppleAppStoreContent | Apple AppStore Content | ||||
| googlePlay | GooglePlayContent | Google Play Content |
AppleAppStoreContent
Content of Apple AppStore
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| productId | string | ~ 1024 chars | Product ID |
GooglePlayContent
Content of Google Play
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| productId | string | ~ 1024 chars | Product ID |
StoreSubscriptionContentModel
Store platform subscription content
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| storeSubscriptionContentModelId | string | ✓* | ~ 1024 chars | Subscription Content Model GRN * Automatically configured on the server | ||||||||
| name | string | ✓ | ~ 128 chars | Subscription Store 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 | ||||||||
| triggerExtendMode | String Enum enum { “just”, “rollupHour” } | ✓ | “just” | Mode to reflect the subscription period on the trigger
| ||||||||
| rollupHour | int | {triggerExtendMode} == “rollupHour” | ✓* | 0 | 0 ~ 23 | Hour of the day to roll up the subscription period (UTC) * Required if triggerExtendMode is “rollupHour” | ||||||
| reallocateSpanDays | int | ✓ | 30 | 0 ~ 365 | Time span (days) that allows subscription contract information to be assigned to other users | |||||||
| appleAppStore | AppleAppStoreSubscriptionContent | Apple AppStore Content | ||||||||||
| googlePlay | GooglePlaySubscriptionContent | Google Play Content |
AppleAppStoreSubscriptionContent
Subscription content of Apple AppStore
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| subscriptionGroupIdentifier | string | ~ 64 chars | Subscription Group ID |
GooglePlaySubscriptionContent
Google Play Subscription Content
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| productId | string | ~ 1024 chars | Product ID |