GS2-Showcase マスターデータリファレンス
{
"version": "2019-04-04",
"showcases": [
{
"name": "[string]商品名",
"metadata": "[string?]メタデータ",
"salesPeriodEventId": "[string?]陳列棚の販売期間を設定した GS2-Schedule のイベント",
"displayItems": [
{
"displayItemId": "[string]陳列商品ID",
"type": "[string]種類",
"salesItem": {
"name": "[string]商品名",
"metadata": "[string?]メタデータ",
"consumeActions": [
{
"action": "[string]スタンプタスクで実行するアクションの種類",
"request": "[string]入手リクエストのJSON"
}
],
"acquireActions": [
{
"action": "[string]スタンプシートを使用して実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
]
},
"salesItemGroup": {
"name": "[string]商品グループ名",
"metadata": "[string?]メタデータ",
"salesItems": [
{
"name": "[string]商品名",
"metadata": "[string?]メタデータ",
"consumeActions": [
{
"action": "[string]スタンプタスクで実行するアクションの種類",
"request": "[string]入手リクエストのJSON"
}
],
"acquireActions": [
{
"action": "[string]スタンプシートを使用して実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
]
}
]
},
"salesPeriodEventId": "[string?]商品の販売期間を設定した GS2-Schedule のイベント"
}
]
}
]
}
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
version | ✓ | | 2019-04-04 | マスターデータのフォーマットバージョン | |
showcases | List<Showcase> | | | | |
SalesItem
陳列棚
商品を購入するために必要となる対価と商品を購入したときに得られる報酬を設定します。
SalesItemGroup
商品グループ
商品グループは陳列棚に陳列するためのエンティティです。
商品グループには複数の商品を所属させることができ、所属している商品の先頭から順番に購入可能かを判定し、一番最初に購入可能だと判定された商品が実際に陳列されます。
初回のみ割引する商品や、ステップアップガチャのように購入回数によって商品の内容が変化する仕組みに使用できます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
name | string | ✓ | | ~ 128文字 | 商品グループ名 |
metadata | string | | | ~ 2048文字 | メタデータ |
salesItems | List<SalesItem> | ✓ | | | 商品グループに含める商品 |
Showcase
陳列棚
陳列棚には販売期間を設定できます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
showcaseId | string | ✓ | | ~ 1024文字 | 陳列棚GRN |
name | string | ✓ | | ~ 128文字 | 商品名 |
metadata | string | | | ~ 2048文字 | メタデータ |
salesPeriodEventId | string | | | ~ 1024文字 | 陳列棚の販売期間を設定した GS2-Schedule のイベント |
displayItems | List<DisplayItem> | ✓ | | | 陳列された商品リスト |
DisplayItem
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
displayItemId | string | ✓ | UUID | ~ 36文字 | 陳列商品ID |
type | enum [‘salesItem’, ‘salesItemGroup’] | ✓ | | ~ 128文字 | 種類 |
salesItem | SalesItem | {type} == “salesItem” | | | 陳列する商品 |
salesItemGroup | SalesItemGroup | {type} == “salesItemGroup” | | | 陳列する商品グループ |
salesPeriodEventId | string | | | ~ 1024文字 | 商品の販売期間を設定した GS2-Schedule のイベント |
DisplayItemMaster
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
displayItemId | string | ✓ | UUID | ~ 36文字 | 陳列商品ID |
type | enum [‘salesItem’, ‘salesItemGroup’] | ✓ | | ~ 128文字 | 種類 |
salesItemName | string | {type} == “salesItem” | | ~ 128文字 | 陳列する商品の名前 |
salesItemGroupName | string | {type} == “salesItemGroup” | | ~ 128文字 | 陳列する商品グループの名前 |
salesPeriodEventId | string | | | ~ 1024文字 | 商品の販売期間を設定した GS2-Schedule のイベント |
ConsumeAction
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
action | enum [] | ✓ | | ~ 128文字 | スタンプタスクで実行するアクションの種類 |
request | string | ✓ | | ~ 1048576文字 | 入手リクエストのJSON |
AcquireAction
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
action | enum [] | ✓ | | ~ 128文字 | スタンプシートを使用して実行するアクションの種類 |
request | string | ✓ | | ~ 1048576文字 | リクエストのJSON |