Master Data Reference of GS2-Showcase
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]Types of actions to be performed in the verify task",
"request": "[string]JSON string of the request used when executing the action"
}
],
"consumeActions": [
{
"action": "[string]Types of actions to be performed in the consume action",
"request": "[string]JSON string of the request used when executing the action"
}
],
"acquireActions": [
{
"action": "[string]Types of actions to be performed 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]Types of actions to be performed in the verify task",
"request": "[string]JSON string of the request used when executing the action"
}
],
"consumeActions": [
{
"action": "[string]Types of actions to be performed in the consume action",
"request": "[string]JSON string of the request used when executing the action"
}
],
"acquireActions": [
{
"action": "[string]Types of actions to be performed 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 Showcase"
}
]
}
],
"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]Types of actions to be performed in the verify task",
"request": "[string]JSON string of the request used when executing the action"
}
],
"consumeActions": [
{
"action": "[string]Types of actions to be performed in the consume action",
"request": "[string]JSON string of the request used when executing the action"
}
],
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON string of the request used when executing the action"
}
],
"stock": "[int]Stock",
"weight": "[int]Emission 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"
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2019-04-04 | Format version of master data | ||
| showcases | List<Showcase> | ~ 100 items | ShowcaseShowcase can be used to define products for display.Additionally, the sales period for products on Showcase can be set. | |||
| randomShowcases | List<RandomShowcase> | ~ 100 items | Random Showcase Random Showcase is display shelves where randomly selected products are displayed and rotated 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.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| showcaseId | string | ✓* | ~ 1024 chars | Showcase GRN * Automatically configured on 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 | GS2-Schedule event GRN with sales periods for Showcase | |||
| displayItems | List<DisplayItem> | ✓ | [] | 1 ~ 1000 items | List of Display Items |
DisplayItem
Displayed Item
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayItemId | string | ✓ | UUID | ~ 128 chars | Displayed Item ID Maintains a unique name for displayed products. If omitted, the system automatically assigns a name in UUID (Universally Unique Identifier) format. | |||||||
| type | String Enum enum { “salesItem”, “salesItemGroup” } | ✓ | Type
| |||||||||
| 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 Showcase |
SalesItem
Product
Set the price required to purchase the product and the reward earned for the purchase of the product.
| 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 Action | ||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 10 items | List of Consumption Action | ||
| acquireActions | List<AcquireAction> | ✓ | [] | 1 ~ 100 items | List of Acquire Action |
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.
| 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 | Products to be included in the product group |
ConsumeAction
Consume Action
VerifyAction
Verify Action
AcquireAction
Acquire Action
RandomShowcase
Random Showcase
Random Showcase is display shelves where randomly selected products are displayed and rotated 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.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| randomShowcaseId | string | ✓* | ~ 1024 chars | Random Showcase Model GRN * Automatically configured on 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 products to be selected | ||
| displayItems | List<RandomDisplayItemModel> | ✓ | [] | 1 ~ 100 items | List of Display Items subject to selection | |
| baseTimestamp | long | ✓ | Base time for re-drawing the products on display | |||
| resetIntervalHours | int | ✓ | 1 ~ 168 | Interval (hours) between re-drawing the products on display | ||
| salesPeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN with sales periods for display shelves |
RandomDisplayItemModel
Random displayable items on the Random Showcase
You can set the probability of selecting items for the display shelf.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | UUID | ~ 128 chars | Random 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. | |
| 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 Action | ||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 10 items | List of Consumption Action | ||
| acquireActions | List<AcquireAction> | ✓ | [] | 1 ~ 100 items | List of Acquire Action | |
| stock | int | ✓ | 1 ~ 2147483646 | Stock | ||
| weight | int | ✓ | 1 ~ 2147483646 | Emission Weight |