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.
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Namespace Name | |
currencyUsagePriority | string | ✓ | ~ 128 chars | Consumption priority | |
description | string | ~ 1024 chars | Description | ||
sharedFreeCurrency | bool | ✓ | Share the free currency with different slots | ||
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 | |||
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 |
Enumeration type definition to specify as currencyUsagePriority
Enumerator String Definition | Description |
---|---|
PrioritizeFree | Prioritize the use of free currency |
PrioritizePaid | Prioritize the use of paid currency |
GetAttr
Type | Description | |
---|---|---|
Item | Namespace | Namespace created |
Implementation Example
Type: GS2::Money2::Namespace
Properties:
Name: namespace-0001
CurrencyUsagePriority: PrioritizeFree
Description: null
SharedFreeCurrency: false
PlatformSetting: null
DepositBalanceScript: null
WithdrawBalanceScript: 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"
"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 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,
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
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.
Note
Please refer to Master Data Reference of GS2-Money2 for the JSON file format.Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 128 chars | Namespace Name | |
settings | string | ✓ | ~ 5242880 chars | Master data |
GetAttr
Type | Description | |
---|---|---|
Item | CurrentModelMaster | Updated and currently available model master |
Implementation Example
Type: GS2::Money2::CurrentModelMaster
Properties:
NamespaceName: namespace-0001
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"
}
}
],
"storeSubscriptionContentModels": []
}
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.apple.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.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,
"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.apple.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.apple.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.apple.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.apple.product3',
),
)
),
),
],
store_subscription_content_models=[
],
)
print(SampleStack().yaml()) # Generate Template
Receipt
Receipt of store platform
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
Store | enum { “AppleAppStore”, “GooglePlay”, “fake” } | ✓ | ~ 128 chars | Store | |
TransactionID | string | ✓ | ~ 1024 chars | Transaction ID | |
Payload | string | ✓ | ~ 1048576 chars | Payload |
Enumeration type definition to specify as Store
Enumerator String Definition | Description |
---|---|
AppleAppStore | Apple App Store |
GooglePlay | Google Play |
fake | Fake |
PlatformSetting
Platform Setting
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
appleAppStore | AppleAppStoreSetting | Apple AppStore Setting | |||
googlePlay | GooglePlaySetting | Google Play Setting | |||
fake | FakeSetting | Fake(Unity Editor) Setting |
AppleAppStoreSetting
Apple AppStore Setting
Type | Require | Default | Limitation | 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 | Require | Default | Limitation | 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 | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
acceptFakeReceipt | enum { “Accept”, “Reject” } | ✓ | “Reject” | ~ 128 chars | Able to make a payment with a fake receipt output by UnityEditor |
Enumeration type definition to specify as acceptFakeReceipt
Enumerator String Definition | Description |
---|---|
Accept | Accept |
Reject | Reject |
WalletSummary
Wallet Status
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
paid | int | ✓ | 0 | ~ 2147483646 | Count of Paid |
free | int | ✓ | 0 | ~ 2147483646 | Count of Free |
total | int | ✓ | 0 | ~ 2147483646 | Count of Total |
DepositTransaction
Deposit Transaction
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
price | double | ✓ | ~ 100000000.0 | Purchase Price | |
currency | string | {price} > 0 | ~ 8 chars | Currency Code | |
count | int | ✓ | ~ 2147483646 | Count | |
depositedAt | long | Deposit Date (Unix time unit:milliseconds) |
VerifyReceiptEvent
Verify Receipt Event
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
contentName | string | ✓ | ~ 128 chars | Store Content Model Name | |
platform | enum { “AppleAppStore”, “GooglePlay”, “fake” } | ✓ | ~ 128 chars | Store Platform | |
appleAppStoreVerifyReceiptEvent | AppleAppStoreVerifyReceiptEvent | Apple AppStore Verify Receipt Event | |||
googlePlayVerifyReceiptEvent | GooglePlayVerifyReceiptEvent | Google Play Verify Receipt Event |
Enumeration type definition to specify as platform
Enumerator String Definition | Description |
---|---|
AppleAppStore | Apple AppStore |
GooglePlay | Google Play |
fake | Fake |
DepositEvent
Deposit Event
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
slot | int | ✓ | ~ 100000000 | Slot Number | |
depositTransactions | List<DepositTransaction> | [] | ~ 1000 items | List of deposit transactions | |
status | WalletSummary | ✓ | Wallet Status |
WithdrawEvent
Withdraw Event
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
slot | int | ✓ | ~ 100000000 | Slot Number | |
withdrawDetails | List<DepositTransaction> | [] | ~ 1000 items | List of details of the withdrawn wallet | |
status | WalletSummary | ✓ | Wallet Status |
RefundEvent
Refund Event
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
contentName | string | ✓ | ~ 128 chars | Store Content Model Name | |
platform | enum { “AppleAppStore”, “GooglePlay”, “fake” } | ✓ | ~ 128 chars | Store Platform | |
appleAppStoreRefundEvent | AppleAppStoreVerifyReceiptEvent | Apple AppStore Verify Receipt Event | |||
googlePlayRefundEvent | GooglePlayVerifyReceiptEvent | Google Play Verify Receipt Event |
Enumeration type definition to specify as platform
Enumerator String Definition | Description |
---|---|
AppleAppStore | Apple AppStore |
GooglePlay | Google Play |
fake | Fake |
AppleAppStoreVerifyReceiptEvent
Apple AppStore Receipt
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
environment | enum { “sandbox”, “production” } | ✓ | ~ 128 chars | Environment |
Enumeration type definition to specify as environment
Enumerator String Definition | Description |
---|---|
sandbox | Sandbox |
production | Production |
GooglePlayVerifyReceiptEvent
Google Play Receipt Verification Event
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
purchaseToken | string | ~ 4096 chars | Purchase Token |
AppleAppStoreContent
Content of Apple AppStore
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
productId | string | ~ 1024 chars | Product ID |
GooglePlayContent
Content of Google Play
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
productId | string | ~ 1024 chars | Product ID |
AppleAppStoreSubscriptionContent
Subscription content of Apple AppStore
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
subscriptionGroupIdentifier | string | ~ 64 chars | Subscription Group ID |
GooglePlaySubscriptionContent
Google Play Subscription Content
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
productId | string | ~ 1024 chars | Product ID |
GooglePlayRealtimeNotificationMessage
RTDN Message
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
data | string | ✓ | ~ 1048576 chars | Data | |
messageId | string | ✓ | ~ 1024 chars | Message ID | |
publishTime | string | ✓ | ~ 1024 chars | Publish Time |
GitHubCheckoutSetting
Setup to check out master data from GitHub
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
apiKeyId | string | ✓ | ~ 1024 chars | GitHub API key GRN | |
repositoryName | string | ✓ | ~ 1024 chars | Repository Name | |
sourcePath | string | ✓ | ~ 1024 chars | Source code file path | |
referenceType | enum { “commit_hash”, “branch”, “tag” } | ✓ | ~ 128 chars | Source of code | |
commitHash | string | {referenceType} == “commit_hash” | ~ 1024 chars | Commit hash | |
branchName | string | {referenceType} == “branch” | ~ 1024 chars | Branch Name | |
tagName | string | {referenceType} == “tag” | ~ 1024 chars | Tag Name |
Enumeration type definition to specify as referenceType
Enumerator String Definition | Description |
---|---|
commit_hash | Commit hash |
branch | Branch |
tag | Tag |
ScriptSetting
Script settings
In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.
There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API.
On the other hand, asynchronous execution does not block processing until the script has finished executing. Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API. However, asynchronous execution does not block processing until the script has finished executing, so it is generally recommended to use asynchronous execution.
There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
triggerScriptId | string | ~ 1024 chars | Script GRN | ||
doneTriggerTargetType | enum { “none”, “gs2_script”, “aws” } | ✓ | “none” | ~ 128 chars | Notification of Completion |
doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Script GRN | |
doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Namespace GRN |
Enumeration type definition to specify as doneTriggerTargetType
Enumerator String Definition | Description |
---|---|
none | None |
gs2_script | GS2-Script |
aws | Amazon EventBridge |
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 | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
gatewayNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:gateway:default” | ~ 1024 chars | GS2-Gateway namespace to use for push notifications |
enableTransferMobileNotification | bool? | false | Forwarding to mobile push notification | ||
sound | string | {enableTransferMobileNotification} == true | ~ 1024 chars | Sound file name to be used for mobile push notifications |
LogSetting
Log setting
This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024 chars | Namespace GRN |