GS2-Showcase Master Data Reference

Reference for the master data format and the models to be imported

Master Data Format

{
  "version": "2019-04-04",
  "showcases": [
    {
      "name": "[string]Showcase name",
      "metadata": "[string?]Metadata",
      "salesPeriodEventId": "[string?]GS2-Schedule event GRN with sales periods for Showcase",
      "displayItems": [
        {
          "displayItemId": "[string]Displayed Item ID",
          "type": "[string]Type",
          "salesItem": {
            "name": "[string]Sales Item name",
            "metadata": "[string?]Metadata",
            "verifyActions": [
              {
                "action": "[string]Type of action to be executed in the Verify Action",
                "request": "[string]JSON string of the request used when executing the action"
              }
            ],
            "consumeActions": [
              {
                "action": "[string]Type of action to be executed in the Consume Action",
                "request": "[string]JSON string of the request used when executing the action"
              }
            ],
            "acquireActions": [
              {
                "action": "[string]Type of action to be executed in the Acquire Action",
                "request": "[string]JSON string of the request used when executing the action"
              }
            ]
          },
          "salesItemGroup": {
            "name": "[string]Sales Item Group name",
            "metadata": "[string?]Metadata",
            "salesItems": [
              {
                "name": "[string]Sales Item name",
                "metadata": "[string?]Metadata",
                "verifyActions": [
                  {
                    "action": "[string]Type of action to be executed in the Verify Action",
                    "request": "[string]JSON string of the request used when executing the action"
                  }
                ],
                "consumeActions": [
                  {
                    "action": "[string]Type of action to be executed in the Consume Action",
                    "request": "[string]JSON string of the request used when executing the action"
                  }
                ],
                "acquireActions": [
                  {
                    "action": "[string]Type of action to be executed in the Acquire Action",
                    "request": "[string]JSON string of the request used when executing the action"
                  }
                ]
              }
            ]
          },
          "salesPeriodEventId": "[string?]GS2-Schedule event GRN with sales periods for this display item"
        }
      ]
    }
  ],
  "randomShowcases": [
    {
      "name": "[string]Random Showcase name",
      "metadata": "[string?]Metadata",
      "maximumNumberOfChoice": "[int]Maximum number of products to be selected",
      "displayItems": [
        {
          "name": "[string]Random Displayed Item ID",
          "metadata": "[string?]Metadata",
          "verifyActions": [
            {
              "action": "[string]Type of action to be executed in the Verify Action",
              "request": "[string]JSON string of the request used when executing the action"
            }
          ],
          "consumeActions": [
            {
              "action": "[string]Type of action to be executed in the Consume Action",
              "request": "[string]JSON string of the request used when executing the action"
            }
          ],
          "acquireActions": [
            {
              "action": "[string]Type of action to be executed in the Acquire Action",
              "request": "[string]JSON string of the request used when executing the action"
            }
          ],
          "stock": "[int]Stock",
          "weight": "[int]Draw Weight"
        }
      ],
      "baseTimestamp": "[long]Base time for re-drawing the products on display",
      "resetIntervalHours": "[int]Interval (hours) between re-drawing the products on display",
      "salesPeriodEventId": "[string?]GS2-Schedule event GRN with sales periods for display shelves"
    }
  ]
}
TypeConditionRequiredDefaultValue LimitsDescription
versionstring
2019-04-04Format version of master data
showcasesList<Showcase>~ 100 itemsShowcase
Showcase can be used to define products for display.
Additionally, the sales period for products on Showcase can be set.
randomShowcasesList<RandomShowcase>~ 100 itemsRandom Showcase
Random Showcase is a display model featuring randomly selected products that rotate at specified intervals.

The products to be selected are randomly selected from the registered products in the product pool according to the specified quantity and the weight set for each product.
By associating an event of GS2-Schedule with the random display shelf, you can set the sales period.

Model

Showcase

Showcase

Showcase can be used to define products for display. Additionally, the sales period for products on Showcase can be set.

TypeConditionRequiredDefaultValue LimitsDescription
showcaseIdstring
*
~ 1024 charsShowcase GRN
* Set automatically by the server
namestring
~ 128 charsShowcase name
Showcase-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 2048 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.
salesPeriodEventIdstring~ 1024 charsGS2-Schedule event GRN with sales periods for Showcase
Controls the overall sales period of this showcase. When specified, the entire showcase is only available during the associated GS2-Schedule event period. If the event is not active, the showcase returns empty.
displayItemsList<DisplayItem>[]1 ~ 1000 itemsList of Display Items
The list of items displayed on this showcase. Each display item can be either a single sales item or a sales item group. Items with an expired or inactive sales period event are automatically filtered out when the showcase is retrieved.

DisplayItem

Displayed Item

An item displayed on a showcase. Can reference either a single sales item or a sales item group. Each display item can have its own sales period controlled by a GS2-Schedule event, independently of the showcase-level sales period.

TypeConditionRequiredDefaultValue LimitsDescription
displayItemIdstring
UUID~ 128 charsDisplayed Item ID
Maintains a unique name for displayed products.
If omitted, the system automatically assigns a name in UUID (Universally Unique Identifier) format.
typeString Enum
enum {
  “salesItem”,
  “salesItemGroup”
}
Type
The type of item displayed. A “salesItem” is a single product with fixed price and rewards. A “salesItemGroup” contains multiple sales items evaluated in order, used for step-up pricing or limited purchase discounts.
DefinitionDescription
“salesItem”Sales Item
“salesItemGroup”Sales Item Group
salesItemSalesItem{type} == “salesItem”
✓*
Sales Item
* Required if type is “salesItem”
salesItemGroupSalesItemGroup{type} == “salesItemGroup”
✓*
Sales Item Group
* Required if type is “salesItemGroup”
salesPeriodEventIdstring~ 1024 charsGS2-Schedule event GRN with sales periods for this display item
Controls the sales period of this individual display item. When specified, the item is only shown on the showcase during the associated GS2-Schedule event period. This is independent of the showcase-level sales period.

SalesItem

Product

Set the price required to purchase the product and the reward earned for the purchase of the product.

TypeConditionRequiredDefaultValue LimitsDescription
namestring
~ 128 charsSales Item name
Sales Item-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 2048 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.
verifyActionsList<VerifyAction>[]0 ~ 10 itemsList of Verify Actions
Precondition checks executed before the purchase. All verify actions must pass before consume and acquire actions are processed. Can be used to check purchase eligibility conditions.
consumeActionsList<ConsumeAction>[]0 ~ 10 itemsList of Consume Actions
Actions that consume resources as the purchase price. Can include GS2-Limit CountUp actions to control purchase limits for sales item groups.
acquireActionsList<AcquireAction>[]1 ~ 100 itemsList of Acquire Actions
Actions that grant resources as purchase rewards. Executed after all consume actions complete successfully.

SalesItemGroup

Product Group

A product group is an entity for display on a showcase. The first product that is determined to be available for purchase is actually displayed on the shelves. This can be used for products that are discounted only for the first time, or for a system in which the contents of products change depending on the number of times they are purchased, such as a step-up gacha.

TypeConditionRequiredDefaultValue LimitsDescription
namestring
~ 128 charsSales Item Group name
Sales Item Group-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 2048 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.
salesItemsList<SalesItem>[]2 ~ 10 itemsProducts to be included in the product group
Ordered list of sales items in this group. The system evaluates each item from first to last using GS2-Limit counters to determine purchase availability. The first purchasable item is displayed; if none qualify, the last item in the list is used as a fallback.

ConsumeAction

Consume Action

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"Gs2AdReward:ConsumePointByUserId",
"Gs2Dictionary:DeleteEntriesByUserId",
"Gs2Enhance:DeleteProgressByUserId",
"Gs2Exchange:DeleteAwaitByUserId",
"Gs2Experience:SubExperienceByUserId",
"Gs2Experience:SubRankCapByUserId",
"Gs2Formation:SubMoldCapacityByUserId",
"Gs2Grade:SubGradeByUserId",
"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
"Gs2Inbox:OpenMessageByUserId",
"Gs2Inbox:DeleteMessageByUserId",
"Gs2Inventory:ConsumeItemSetByUserId",
"Gs2Inventory:ConsumeSimpleItemsByUserId",
"Gs2Inventory:ConsumeBigItemByUserId",
"Gs2JobQueue:DeleteJobByUserId",
"Gs2Limit:CountUpByUserId",
"Gs2LoginReward:MarkReceivedByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:BatchReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Mission:ResetCounterByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Money2:WithdrawByUserId",
"Gs2Money2:VerifyReceiptByUserId",
"Gs2Quest:DeleteProgressByUserId",
"Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
"Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
"Gs2Schedule:DeleteTriggerByUserId",
"Gs2SerialKey:UseByUserId",
"Gs2Showcase:IncrementPurchaseCountByUserId",
"Gs2SkillTree:MarkRestrainByUserId",
"Gs2Stamina:DecreaseMaxValueByUserId",
"Gs2Stamina:ConsumeStaminaByUserId",
}
Type of action to be executed in the Consume Action
requeststring
~ 524288 charsJSON string of the request used when executing the action

VerifyAction

Verify Action

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Distributor:IfExpressionByUserId",
"Gs2Distributor:AndExpressionByUserId",
"Gs2Distributor:OrExpressionByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyIncludeMemberByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
"Gs2Ranking2:VerifyClusterRankingScoreByUserId",
"Gs2Ranking2:VerifySubscribeRankingScoreByUserId",
"Gs2Schedule:VerifyTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
"Gs2SerialKey:VerifyCodeByUserId",
"Gs2Stamina:VerifyStaminaValueByUserId",
"Gs2Stamina:VerifyStaminaMaxValueByUserId",
"Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId",
"Gs2Stamina:VerifyStaminaRecoverValueByUserId",
"Gs2Stamina:VerifyStaminaOverflowValueByUserId",
}
Type of action to be executed in the Verify Action
requeststring
~ 524288 charsJSON string of the request used when executing the action

AcquireAction

Acquire Action

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2Schedule:ExtendTriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
Type of action to be executed in the Acquire Action
requeststring
~ 524288 charsJSON string of the request used when executing the action

RandomShowcase

Random Showcase

Random Showcase is a display model featuring randomly selected products that rotate at specified intervals.

The products to be selected are randomly selected from the registered products in the product pool according to the specified quantity and the weight set for each product. By associating an event of GS2-Schedule with the random display shelf, you can set the sales period.

TypeConditionRequiredDefaultValue LimitsDescription
randomShowcaseIdstring
*
~ 1024 charsRandom Showcase Model GRN
* Set automatically by the server
namestring
~ 128 charsRandom Showcase name
Random Showcase-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 2048 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.
maximumNumberOfChoiceint
1 ~ 100Maximum number of products to be selected
The number of products randomly drawn from the display item pool each rotation period. Items are drawn without replacement using weighted random selection, so the same item will not appear twice in one rotation.
displayItemsList<RandomDisplayItemModel>[]1 ~ 100 itemsList of Display Items subject to selection
The pool of candidate items from which products are randomly drawn. Each item has a weight that determines its relative selection probability and a stock count that limits how many times it can appear across rotations.
baseTimestamplong
Base time for re-drawing the products on display
The reference timestamp used to calculate rotation boundaries. Product re-draws occur at regular intervals (resetIntervalHours) starting from this base time. Must be set to a past timestamp.
resetIntervalHoursint
1 ~ 168Interval (hours) between re-drawing the products on display
The number of hours between each product rotation. When the interval elapses (relative to baseTimestamp), the displayed products are re-drawn with a new random seed. Can be set from 1 to 168 hours (1 week).
salesPeriodEventIdstring~ 1024 charsGS2-Schedule event GRN with sales periods for display shelves
Controls the overall sales period of this random showcase. When specified, the showcase is only available during the associated GS2-Schedule event period.

RandomDisplayItemModel

Items that can be displayed in a Random Showcase

You can set the probability of selecting items for the display shelf.

TypeConditionRequiredDefaultValue LimitsDescription
namestring
UUID~ 128 charsRandom Displayed Item ID
Maintains a unique name for randomly displayed products.
If omitted, the system automatically assigns a name in UUID (Universally Unique Identifier) format.
metadatastring~ 2048 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.
verifyActionsList<VerifyAction>[]0 ~ 10 itemsList of Verify Actions
Precondition checks executed before purchasing this random display item. All verify actions must pass before consume and acquire actions are processed.
consumeActionsList<ConsumeAction>[]0 ~ 10 itemsList of Consume Actions
Actions that consume resources as the purchase price for this random display item. Executed as consume actions in the transaction.
acquireActionsList<AcquireAction>[]1 ~ 100 itemsList of Acquire Actions
Actions that grant resources as purchase rewards for this random display item. Executed as acquire actions in the transaction.
stockint
1 ~ 2147483646Stock
The maximum number of times this item can be drawn across all rotations. Once stock reaches zero, the item is excluded from future draws. Stock is consumed when the item is selected during a rotation draw.
weightint
1 ~ 2147483646Draw Weight
The relative probability weight for this item in the random selection. Higher weights increase the chance of being drawn. The actual selection probability is calculated as this item’s weight divided by the sum of all eligible items’ weights.