Master Data Reference of GS2-Showcase
{
"version": "2019-04-04",
"showcases": [
{
"name": "[string]Showcase Name",
"metadata": "[string?]Metadata",
"salesPeriodEventId": "[string?]GS2-Schedule event GRN 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 event GRN 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 event GRN with sales periods for display shelves"
}
]
}
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | ✓ | 2019-04-04 | Format version of master data | |||
| showcases | List<Showcase> | ~ 100 items | Showcase The sales period can be set for the display shelf. | |||
| randomShowcases | List<RandomShowcase> | ~ 100 items | 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. |
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 | Product Name | ||
| metadata | string | ~ 2048 chars | Metadata | |||
| 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 | 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 | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| showcaseId | string | ✓ | ~ 1024 chars | Showcase GRN | ||
| name | string | ✓ | ~ 128 chars | Showcase Name | ||
| metadata | string | ~ 2048 chars | Metadata | |||
| salesPeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN with sales periods for display shelves | |||
| displayItems | List<DisplayItem> | ✓ | [] | 1 ~ 1000 items | List of Products on display |
DisplayItem
Displayed Item
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayItemId | string | ✓ | UUID | ~ 128 chars | Displayed Item ID | |||||||
| type | String Enum enum { “salesItem”, “salesItemGroup” } | ✓ | ~ 128 chars | Type
| ||||||||
| salesItem | SalesItem | {type} == “salesItem” | ✓* | Products to be displayed * Enabled if type is “salesItem” | ||||||||
| salesItemGroup | SalesItemGroup | {type} == “salesItemGroup” | ✓* | Product group to be displayed * Enabled if type is “salesItemGroup” | ||||||||
| salesPeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN with product sales periods |
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 | Required | Default | Value Limits | 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 | |||
| 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 |
PurchaseCount
Number of product purchases
| Type | Condition | Required | Default | Value Limits | 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 | Required | Default | Value Limits | 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> | [] | 0 ~ 10 items | List of Verify Action | ||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 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 |
ConsumeAction
Consume Action
VerifyAction
Verify Action
AcquireAction
Acquire Action
VerifyActionResult
Verify action execution result
ConsumeActionResult
Consume action execution result
AcquireActionResult
Acquire action execution result
TransactionResult
Transaction execution results
Transaction execution results executed using server-side transaction auto-execution functionality
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| transactionId | string | ✓ | 36 ~ 36 chars | Transaction ID | ||
| verifyResults | List<VerifyActionResult> | 0 ~ 10 items | List of verify action execution results | |||
| consumeResults | List<ConsumeActionResult> | [] | 0 ~ 10 items | List of consume action execution results | ||
| acquireResults | List<AcquireActionResult> | [] | 0 ~ 100 items | List of acquire action execution results | ||
| hasError | bool | ✓ | false | Whether an error occurred during transaction execution |
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 | |
| metadata | string | ~ 2048 chars | Metadata | |||
| 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 |
DisplayItemMaster
Displayed Item Master Data
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayItemId | string | ✓ | UUID | ~ 128 chars | Displayed Item ID | |||||||
| type | String Enum enum { “salesItem”, “salesItemGroup” } | ✓ | ~ 128 chars | Type
| ||||||||
| salesItemName | string | {type} == “salesItem” | ✓* | ~ 128 chars | Name of the product to be displayed * Enabled if type is “salesItem” | |||||||
| salesItemGroupName | string | {type} == “salesItemGroup” | ✓* | ~ 128 chars | Name of the product group to be displayed * Enabled if type is “salesItemGroup” | |||||||
| salesPeriodEventId | string | ~ 1024 chars | Product group to be displayed | |||||||||
| revision | long | 0 | 0 ~ 9223372036854775805 | Revision |