Master Data Reference of GS2-Showcase
{
"version": "2019-04-04",
"showcases": [
{
"name": "[string]Showcase Name",
"metadata": "[string?]metadata",
"salesPeriodEventId": "[string?]GS2-Schedule events with sales periods for display shelves",
"displayItems": [
{
"displayItemId": "[string]Displayed Item ID",
"type": "[string]Type",
"salesItem": {
"name": "[string]Product Name",
"metadata": "[string?]metadata",
"verifyActions": [
{
"action": "[string]Types of actions to be performed in the verify task",
"request": "[string]JSON of request"
}
],
"consumeActions": [
{
"action": "[string]Types of actions to be performed in the consume action",
"request": "[string]JSON of request"
}
],
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON of request"
}
]
},
"salesItemGroup": {
"name": "[string]Product Group Name",
"metadata": "[string?]metadata",
"salesItems": [
{
"name": "[string]Product Name",
"metadata": "[string?]metadata",
"verifyActions": [
{
"action": "[string]Types of actions to be performed in the verify task",
"request": "[string]JSON of request"
}
],
"consumeActions": [
{
"action": "[string]Types of actions to be performed in the consume action",
"request": "[string]JSON of request"
}
],
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON of request"
}
]
}
]
},
"salesPeriodEventId": "[string?]GS2-Schedule events with product sales periods"
}
]
}
],
"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 of request"
}
],
"consumeActions": [
{
"action": "[string]Types of actions to be performed in the consume action",
"request": "[string]JSON of request"
}
],
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON of request"
}
],
"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 events with sales periods for display shelves"
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2019-04-04 | Format version of master data | |||
showcases | List<Showcase> | ~ 10 items | Showcase | |||
randomShowcases | List<RandomShowcase> | ~ 10 items | Random Showcase |
SalesItem
Product
Set the price required to purchase the product and the reward earned for the purchase of the product.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Product Name | ||
metadata | string | ~ 2048 chars | metadata | |||
verifyActions | List<VerifyAction> | ~ 10 items | List of Verify Action | |||
consumeActions | List<ConsumeAction> | ~ 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 | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Product Group Name | ||
metadata | string | ~ 2048 chars | metadata | |||
salesItems | List<SalesItem> | ✓ | 2 ~ 10 items | Products to be included in the product group |
Showcase
Showcase
The sales period can be set for the display shelf.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
showcaseId | string | ✓ | ~ 1024 chars | Showcase GRN | ||
name | string | ✓ | ~ 128 chars | Showcase Name | ||
metadata | string | ~ 2048 chars | metadata | |||
salesPeriodEventId | string | ~ 1024 chars | GS2-Schedule events with sales periods for display shelves | |||
displayItems | List<DisplayItem> | ✓ | 1 ~ 1000 items | List of Products on display |
DisplayItem
Displayed Item
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
displayItemId | string | ✓ | UUID | ~ 128 chars | Displayed Item ID | |
type | enum { “salesItem”, “salesItemGroup” } | ✓ | ~ 128 chars | Type | ||
salesItem | SalesItem | {type} == “salesItem” | ✓ | Products to be displayed | ||
salesItemGroup | SalesItemGroup | {type} == “salesItemGroup” | ✓ | Product group to be displayed | ||
salesPeriodEventId | string | ~ 1024 chars | GS2-Schedule events with product sales periods |
Enumeration type definition to specify as type
Enumerator String Definition | Description |
---|---|
salesItem | Product |
salesItemGroup | Product Group |
DisplayItemMaster
Displayed Item Master Data
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
displayItemId | string | ✓ | UUID | ~ 128 chars | Displayed Item ID | |
type | enum { “salesItem”, “salesItemGroup” } | ✓ | ~ 128 chars | Type | ||
salesItemName | string | {type} == “salesItem” | ✓ | ~ 128 chars | Name of the product to be displayed | |
salesItemGroupName | string | {type} == “salesItemGroup” | ✓ | ~ 128 chars | Name of the product group to be displayed | |
salesPeriodEventId | string | ~ 1024 chars | Product group to be displayed | |||
revision | long | 0 | ~ 9223372036854775805 | Revision |
Enumeration type definition to specify as type
Enumerator String Definition | Description |
---|---|
salesItem | Product |
salesItemGroup | Product Group |
RandomShowcase
Random Showcase
A display shelf where randomly selected products are displayed 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 | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
randomShowcaseId | string | ✓ | ~ 1024 chars | Random Showcase Model GRN | ||
name | string | ✓ | ~ 128 chars | Random Showcase Name | ||
metadata | string | ~ 2048 chars | metadata | |||
maximumNumberOfChoice | int | ✓ | 1 ~ 100 | Maximum number of products to be selected | ||
displayItems | List<RandomDisplayItemModel> | ✓ | 1 ~ 100 items | List of Products on display | ||
baseTimestamp | long | ✓ | Base time for re-drawing the products on display (Unix time unit:milliseconds) | |||
resetIntervalHours | int | ✓ | 1 ~ 168 | Interval (hours) between re-drawing the products on display | ||
salesPeriodEventId | string | ~ 1024 chars | GS2-Schedule events with sales periods for display shelves |
PurchaseCount
Number of product purchases
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Random Displayed Item Name | ||
count | int | ✓ | 1 ~ 2147483646 | Purchase count |
RandomDisplayItem
Random displayable items on the Random Showcase
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
showcaseName | string | ✓ | ~ 128 chars | Random Displayed Item Name | ||
name | string | ✓ | UUID | ~ 128 chars | Random Displayed Item ID | |
metadata | string | ~ 2048 chars | metadata | |||
verifyActions | List<VerifyAction> | ~ 10 items | List of Verify Action | |||
consumeActions | List<ConsumeAction> | ~ 10 items | List of Consume Action | |||
acquireActions | List<AcquireAction> | ✓ | 1 ~ 100 items | List of Acquire Action | ||
currentPurchaseCount | int | ✓ | 1 ~ 2147483646 | Current purchase count | ||
maximumPurchaseCount | int | ✓ | 1 ~ 2147483646 | Maximum purchase count |
RandomDisplayItemModel
Random displayable items on the Random Showcase
You can set the probability of selecting items for the display shelf.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | UUID | ~ 128 chars | Random Displayed Item ID | |
metadata | string | ~ 2048 chars | metadata | |||
verifyActions | List<VerifyAction> | ~ 10 items | List of Verify Action | |||
consumeActions | List<ConsumeAction> | ~ 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 |
ConsumeAction
Consume Action
VerifyAction
Verify Action
AcquireAction
Acquire Action
VerifyActionResult
Verify action execution result
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the verify task | ||
verifyRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
statusCode | int | ~ 999 | Status code | |||
verifyResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
Enumerator String Definition | Description |
---|
ConsumeActionResult
Consume action execution result
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the consume action | ||
consumeRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
statusCode | int | ~ 999 | Status code | |||
consumeResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
Enumerator String Definition | Description |
---|
AcquireActionResult
Acquire action execution result
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the acquire action | ||
acquireRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
statusCode | int | ~ 999 | Status code | |||
acquireResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
Enumerator String Definition | Description |
---|
TransactionResult
Transaction execution results
Transaction execution results executed using server-side transaction auto-execution functionality
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
transactionId | string | ✓ | 36 ~ 36 chars | Transaction ID | ||
verifyResults | List<VerifyActionResult> | ~ 10 items | List of verify action execution results | |||
consumeResults | List<ConsumeActionResult> | ~ 10 items | List of consume action execution results | |||
acquireResults | List<AcquireActionResult> | ~ 100 items | List of acquire action execution results |