GS2-Showcase Master Data Reference
Master Data Format
{
"version": "2019-04-04",
"showcases": [
{
"name": "[string]Showcase name",
"metadata": "[string?]Metadata",
"salesPeriodEventId": "[string?]GRN of the GS2-Schedule event that defines the sales period for the 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 display items 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 display items on display",
"resetIntervalHours": "[int]Interval (hours) between re-drawing the display items on display",
"salesPeriodEventId": "[string?]GRN of the GS2-Schedule event that defines the sales period for the Random Showcase"
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2019-04-04 | Format version of master data | ||
| showcases | List<Showcase> | ~ 100 items | Showcase A Showcase can define items for display.Additionally, the sales period for items on Showcase can be set. | |||
| randomShowcases | List<RandomShowcase> | ~ 100 items | Random Showcase Random Showcase is a display model featuring randomly selected display items that rotate at specified intervals. The display item to be selected are randomly selected from the registered display items in the display item pool according to the specified quantity and the weight set for each display item. By associating a GS2-Schedule event with the Random Showcase, you can set its sales period. |
Model
Showcase
Showcase
A Showcase can define items for display.
Additionally, the sales period for items on Showcase can be set.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| showcaseId | string | * | ~ 1024 chars | Showcase GRN * Set automatically by the server | ||
| name | string | ✓ | ~ 128 chars | Showcase name Showcase-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 2048 chars | Metadata 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. | |||
| salesPeriodEventId | string | ~ 1024 chars | GRN
of the GS2-Schedule event that defines the sales period for the 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. | |||
| displayItems | List<DisplayItem> | [] | 1 ~ 1000 items | List 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.
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayItemId | string | ✓ | UUID | ~ 128 chars | Displayed Item ID Maintains a unique name for displayed Sales Items. If omitted, the system automatically assigns a name in UUID (Universally Unique Identifier) format. | |||||||
| type | String Enum enum { “salesItem”, “salesItemGroup” } | ✓ | Type The type of item displayed. A “salesItem” is a single Sales Item with fixed price and rewards. A “salesItemGroup” contains multiple Sales Items evaluated in order, used for step-up pricing or limited purchase discounts.
| |||||||||
| salesItem | SalesItem | {type} == “salesItem” | ✓* | Sales Item * Required if type is “salesItem” | ||||||||
| salesItemGroup | SalesItemGroup | {type} == “salesItemGroup” | ✓* | Sales Item Group * Required if type is “salesItemGroup” | ||||||||
| salesPeriodEventId | string | ~ 1024 chars | GS2-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
Sales Item
Defines the price required to purchase a Sales Item and the rewards granted upon purchase.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Sales Item name Sales Item-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 2048 chars | Metadata 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. | |||
| verifyActions | List<VerifyAction> | [] | 0 ~ 10 items | List 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. | ||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 10 items | List 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. | ||
| acquireActions | List<AcquireAction> | [] | 1 ~ 100 items | List of Acquire Actions Actions that grant resources as purchase rewards. Executed after all consume actions complete successfully. |
SalesItemGroup
Sales Item Group
A Sales Item Group is an entity for display on a Showcase. Multiple Sales Items can belong to a Sales Item Group. Sales Items are evaluated in order, and the first Sales Item determined to be available for purchase is displayed on the Showcase. This can be used for Sales Items that are discounted only for the first purchase, or for systems where the contents change based on the number of purchases, such as a step-up gacha.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Sales Item Group name Sales Item Group-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 2048 chars | Metadata 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. | |||
| salesItems | List<SalesItem> | [] | 2 ~ 10 items | Sales Items included in the Sales Item 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
VerifyAction
Verify Action
AcquireAction
Acquire Action
RandomShowcase
Random Showcase
Random Showcase is a display model featuring randomly selected display items that rotate at specified intervals.
The display item to be selected are randomly selected from the registered display items in the display item pool according to the specified quantity and the weight set for each display item. By associating a GS2-Schedule event with the Random Showcase, you can set its sales period.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| randomShowcaseId | string | * | ~ 1024 chars | Random Showcase GRN * Set automatically by the server | ||
| name | string | ✓ | ~ 128 chars | Random Showcase name Random Showcase-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 2048 chars | Metadata 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. | |||
| maximumNumberOfChoice | int | ✓ | 1 ~ 100 | Maximum number of display items to be selected The number of display items 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. | ||
| displayItems | List<RandomDisplayItemModel> | [] | 1 ~ 100 items | List of Display Items subject to selection The pool of candidate display items from which items 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. | ||
| baseTimestamp | long | ✓ | Base time for re-drawing the display items on display The reference timestamp used to calculate rotation boundaries. display item re-draws occur at regular intervals (resetIntervalHours) starting from this base time. Must be set to a past timestamp. | |||
| resetIntervalHours | int | ✓ | 1 ~ 168 | Interval (hours) between re-drawing the display items on display The number of hours between each display item rotation. When the interval elapses (relative to baseTimestamp), the display items are re-drawn with a new random seed. Can be set from 1 to 168 hours (1 week). | ||
| salesPeriodEventId | string | ~ 1024 chars | GRN
of the GS2-Schedule event that defines the sales period for the Random Showcase 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 each item with weight.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | UUID | ~ 128 chars | Random Displayed Item ID Maintains a unique name for randomly displayed Sales Items. If omitted, the system automatically assigns a name in UUID (Universally Unique Identifier) format. | |
| metadata | string | ~ 2048 chars | Metadata 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. | |||
| verifyActions | List<VerifyAction> | [] | 0 ~ 10 items | List of Verify Actions Precondition checks executed before purchasing this Random Displayed Item. All verify actions must pass before consume and acquire actions are processed. | ||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 10 items | List of Consume Actions Actions that consume resources as the purchase price for this Random Displayed Item. Executed as consume actions in the transaction. | ||
| acquireActions | List<AcquireAction> | [] | 1 ~ 100 items | List of Acquire Actions Actions that grant resources as purchase rewards for this Random Displayed Item. Executed as acquire actions in the transaction. | ||
| stock | int | ✓ | 1 ~ 2147483646 | Stock 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. | ||
| weight | int | ✓ | 1 ~ 2147483646 | Draw 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. |