Master Data Reference of GS2-Money2
Reference of the format of master data and various models to be imported
{
"version": "2024-06-20",
"storeContentModels": [
{
"name": "[string]Store Content Model Name",
"metadata": "[string?]Metadata",
"appleAppStore": {
"productId": "[string?]Product ID"
},
"googlePlay": {
"productId": "[string?]Product ID"
}
}
],
"storeSubscriptionContentModels": [
{
"name": "[string]Subscription Store Content Model Name",
"metadata": "[string?]Metadata",
"scheduleNamespaceId": "[string]Namespace GRN of GS2-Schedule to link the subscription period",
"triggerName": "[string]Trigger Name to reflect the subscription period",
"triggerExtendMode": "[string]Mode to reflect the subscription period on the trigger",
"rollupHour": "[int]Hour of the day to roll up the subscription period (UTC)",
"reallocateSpanDays": "[int]Time span (days) that allows subscription contract information to be assigned to other users",
"appleAppStore": {
"subscriptionGroupIdentifier": "[string?]Subscription Group ID"
},
"googlePlay": {
"productId": "[string?]Product ID"
}
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2024-06-20 | Format version of master data | |||
storeContentModels | List<StoreContentModel> | ~ 1000 items | Content of the store platform | |||
storeSubscriptionContentModels | List<StoreSubscriptionContentModel> | ~ 1000 items | Store platform subscription content |
StoreContentModel
Content of the store platform
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
storeContentModelId | string | ✓ | ~ 1024 chars | Content Model GRN | ||
name | string | ✓ | ~ 128 chars | Store Content Model Name | ||
metadata | string | ~ 1024 chars | Metadata | |||
appleAppStore | AppleAppStoreContent | Apple AppStore Content | ||||
googlePlay | GooglePlayContent | Google Play Content |
StoreSubscriptionContentModel
Store platform subscription content
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
storeSubscriptionContentModelId | string | ✓ | ~ 1024 chars | Subscription Content Model GRN | ||
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 | enum { “just”, “rollupHour” } | ✓ | “just” | ~ 128 chars | Mode to reflect the subscription period on the trigger | |
rollupHour | int | {triggerExtendMode} == “rollupHour” | ✓ | 0 | ~ 23 | Hour of the day to roll up the subscription period (UTC) |
reallocateSpanDays | int | ✓ | 30 | ~ 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 |
Enumeration type definition to specify as triggerExtendMode
Enumerator String Definition | Description |
---|---|
just | Reflect the subscription period as it is |
rollupHour | Extend the subscription period to the next day crossing time |
Receipt
Receipt of store platform
Type | Condition | 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 | Condition | 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 | Condition | 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 | Condition | 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 | Condition | 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 | Condition | 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 | Condition | 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 | Condition | 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 | Condition | 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 | Condition | 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 | Condition | 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 | Condition | 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 | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
purchaseToken | string | ~ 4096 chars | Purchase Token |
AppleAppStoreContent
Content of Apple AppStore
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
productId | string | ~ 1024 chars | Product ID |
GooglePlayContent
Content of Google Play
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
productId | string | ~ 1024 chars | Product ID |
AppleAppStoreSubscriptionContent
Subscription content of Apple AppStore
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
subscriptionGroupIdentifier | string | ~ 64 chars | Subscription Group ID |
GooglePlaySubscriptionContent
Google Play Subscription Content
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
productId | string | ~ 1024 chars | Product ID |
GooglePlayRealtimeNotificationMessage
RTDN Message
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
data | string | ✓ | ~ 1048576 chars | Data | ||
messageId | string | ✓ | ~ 1024 chars | Message ID | ||
publishTime | string | ✓ | ~ 1024 chars | Publish Time |