Master Data Reference of GS2-Money2

Reference of the format of master data and various models to be imported

Master Data Format

{
  "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 enum]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"
      }
    }
  ]
}
TypeConditionRequiredDefaultValue LimitsDescription
versionstring
2024-06-20Format version of master data
storeContentModelsList<StoreContentModel>~ 1000 itemsContent of the store platform
storeSubscriptionContentModelsList<StoreSubscriptionContentModel>~ 1000 itemsStore platform subscription content

Model

StoreContentModel

Content of the store platform

TypeConditionRequiredDefaultValue LimitsDescription
storeContentModelIdstring
✓*
~ 1024 charsContent Model GRN
* Automatically configured on the server
namestring
~ 128 charsStore Content Model Name
metadatastring~ 1024 charsMetadata
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.
appleAppStoreAppleAppStoreContentApple AppStore Content
googlePlayGooglePlayContentGoogle Play Content

AppleAppStoreContent

Content of Apple AppStore

TypeConditionRequiredDefaultValue LimitsDescription
productIdstring~ 1024 charsProduct ID

GooglePlayContent

Content of Google Play

TypeConditionRequiredDefaultValue LimitsDescription
productIdstring~ 1024 charsProduct ID

StoreSubscriptionContentModel

Store platform subscription content

TypeConditionRequiredDefaultValue LimitsDescription
storeSubscriptionContentModelIdstring
✓*
~ 1024 charsSubscription Content Model GRN
* Automatically configured on the server
namestring
~ 128 charsSubscription Store Content Model Name
metadatastring~ 1024 charsMetadata
scheduleNamespaceIdstring
~ 1024 charsNamespace GRN of GS2-Schedule to link the subscription period
triggerNamestring
~ 128 charsTrigger Name to reflect the subscription period
triggerExtendModeString Enum
enum {
  “just”,
  “rollupHour”
}
“just”Mode to reflect the subscription period on the trigger
Enumerator String DefinitionDescription
“just”Reflect the subscription period as it is
“rollupHour”Extend the subscription period to the next day crossing time
rollupHourint{triggerExtendMode} == “rollupHour”
✓*
00 ~ 23Hour of the day to roll up the subscription period (UTC)
* Required if triggerExtendMode is “rollupHour”
reallocateSpanDaysint
300 ~ 365Time span (days) that allows subscription contract information to be assigned to other users
appleAppStoreAppleAppStoreSubscriptionContentApple AppStore Content
googlePlayGooglePlaySubscriptionContentGoogle Play Content

AppleAppStoreSubscriptionContent

Subscription content of Apple AppStore

TypeConditionRequiredDefaultValue LimitsDescription
subscriptionGroupIdentifierstring~ 64 charsSubscription Group ID

GooglePlaySubscriptionContent

Google Play Subscription Content

TypeConditionRequiredDefaultValue LimitsDescription
productIdstring~ 1024 charsProduct ID