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?]メタデータ",
"verifyActions": [
{
"action": "[string]検証アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"consumeActions": [
{
"action": "[string]消費アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"acquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
]
},
"salesItemGroup": {
"name": "[string]商品グループ名",
"metadata": "[string?]メタデータ",
"salesItems": [
{
"name": "[string]商品名",
"metadata": "[string?]メタデータ",
"verifyActions": [
{
"action": "[string]検証アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"consumeActions": [
{
"action": "[string]消費アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"acquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
]
}
]
},
"salesPeriodEventId": "[string?]商品の販売期間を設定した GS2-Schedule のイベント"
}
]
}
],
"randomShowcases": [
{
"name": "[string]ランダム陳列棚名",
"metadata": "[string?]メタデータ",
"maximumNumberOfChoice": "[int]選出される商品の最大数",
"displayItems": [
{
"name": "[string]ランダム陳列商品ID",
"metadata": "[string?]メタデータ",
"verifyActions": [
{
"action": "[string]検証アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"consumeActions": [
{
"action": "[string]消費アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"acquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"stock": "[int]在庫数",
"weight": "[int]排出重み"
}
],
"baseTimestamp": "[long]陳列する商品を再抽選の基準時間",
"resetIntervalHours": "[int]陳列する商品を再抽選する間隔(時)",
"salesPeriodEventId": "[string?]陳列棚の販売期間を設定した GS2-Schedule のイベント"
}
]
}
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
version | ✓ | 2019-04-04 | マスターデータのフォーマットバージョン | |||
showcases | List<Showcase> | ~ 10 items | 陳列棚 | |||
randomShowcases | List<RandomShowcase> | ~ 10 items | ランダム陳列棚モデル |
SalesItem
商品
商品を購入するために必要となる対価と商品を購入したときに得られる報酬を設定します。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | 商品名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
verifyActions | List<VerifyAction> | ~ 10 items | 検証アクションリスト | |||
consumeActions | List<ConsumeAction> | ~ 10 items | 消費アクションリスト | |||
acquireActions | List<AcquireAction> | ✓ | 1 ~ 100 items | 入手アクションリスト |
SalesItemGroup
商品グループ
商品グループは陳列棚に陳列するためのエンティティです。
商品グループには複数の商品を所属させることができ、所属している商品の先頭から順番に購入可能かを判定し、一番最初に購入可能だと判定された商品が実際に陳列されます。
初回のみ割引する商品や、ステップアップガチャのように購入回数によって商品の内容が変化する仕組みに使用できます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | 商品グループ名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
salesItems | List<SalesItem> | ✓ | 2 ~ 10 items | 商品グループに含める商品 |
Showcase
陳列棚
陳列棚には販売期間を設定できます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
showcaseId | string | ✓ | ~ 1024文字 | 陳列棚GRN | ||
name | string | ✓ | ~ 128文字 | 陳列棚名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
salesPeriodEventId | string | ~ 1024文字 | 陳列棚の販売期間を設定した GS2-Schedule のイベント | |||
displayItems | List<DisplayItem> | ✓ | 1 ~ 1000 items | 陳列された商品リスト |
DisplayItem
陳列する商品
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
displayItemId | string | ✓ | UUID | ~ 128文字 | 陳列商品ID | |
type | enum { “salesItem”, “salesItemGroup” } | ✓ | ~ 128文字 | 種類 | ||
salesItem | SalesItem | {type} == “salesItem” | ✓ | 陳列する商品 | ||
salesItemGroup | SalesItemGroup | {type} == “salesItemGroup” | ✓ | 陳列する商品グループ | ||
salesPeriodEventId | string | ~ 1024文字 | 商品の販売期間を設定した GS2-Schedule のイベント |
type に指定する列挙型の定義
定義 | 説明 |
---|---|
salesItem | 商品 |
salesItemGroup | 商品グループ |
DisplayItemMaster
陳列する商品のマスターデータ
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
displayItemId | string | ✓ | UUID | ~ 128文字 | 陳列商品ID | |
type | enum { “salesItem”, “salesItemGroup” } | ✓ | ~ 128文字 | 種類 | ||
salesItemName | string | {type} == “salesItem” | ✓ | ~ 128文字 | 陳列する商品の名前 | |
salesItemGroupName | string | {type} == “salesItemGroup” | ✓ | ~ 128文字 | 陳列する商品グループの名前 | |
salesPeriodEventId | string | ~ 1024文字 | 商品の販売期間を設定した GS2-Schedule のイベント | |||
revision | long | 0 | ~ 9223372036854775805 | リビジョン |
type に指定する列挙型の定義
定義 | 説明 |
---|---|
salesItem | 商品 |
salesItemGroup | 商品グループ |
RandomShowcase
ランダム陳列棚モデル
指定した周期で入れ替わるランダムに選別された商品が陳列される陳列棚。
選別される商品は、商品プールに登録された商品から指定数量が、商品ごとに設定された重みに基づいてランダムに選択されます。
ランダム陳列棚には GS2-Schedule のイベントを関連づけることで、販売期間を設定することができます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
randomShowcaseId | string | ✓ | ~ 1024文字 | ランダム陳列棚GRN | ||
name | string | ✓ | ~ 128文字 | ランダム陳列棚名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
maximumNumberOfChoice | int | ✓ | 1 ~ 100 | 選出される商品の最大数 | ||
displayItems | List<RandomDisplayItemModel> | ✓ | 1 ~ 100 items | 選出対象の商品リスト | ||
baseTimestamp | long (UNIX時間 単位:ミリ秒) | ✓ | 陳列する商品を再抽選の基準時間 (UNIX時間 単位:ミリ秒) | |||
resetIntervalHours | int | ✓ | 1 ~ 168 | 陳列する商品を再抽選する間隔(時) | ||
salesPeriodEventId | string | ~ 1024文字 | 陳列棚の販売期間を設定した GS2-Schedule のイベント |
PurchaseCount
商品の購入回数
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | ランダム陳列商品名 | ||
count | int | ✓ | 1 ~ 2147483646 | 購入回数 |
RandomDisplayItem
ランダム陳列棚に陳列された商品
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
showcaseName | string | ✓ | ~ 128文字 | ランダム陳列棚名 | ||
name | string | ✓ | UUID | ~ 128文字 | ランダム陳列商品ID | |
metadata | string | ~ 2048文字 | メタデータ | |||
verifyActions | List<VerifyAction> | ~ 10 items | 検証アクションリスト | |||
consumeActions | List<ConsumeAction> | ~ 10 items | 消費アクションリスト | |||
acquireActions | List<AcquireAction> | ✓ | 1 ~ 100 items | 入手アクションリスト | ||
currentPurchaseCount | int | ✓ | 1 ~ 2147483646 | 現在の購入回数 | ||
maximumPurchaseCount | int | ✓ | 1 ~ 2147483646 | 最大購入回数 |
RandomDisplayItemModel
ランダム陳列棚に陳列可能な商品
weight に商品を選別する確率を設定できます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | UUID | ~ 128文字 | ランダム陳列商品ID | |
metadata | string | ~ 2048文字 | メタデータ | |||
verifyActions | List<VerifyAction> | ~ 10 items | 検証アクションリスト | |||
consumeActions | List<ConsumeAction> | ~ 10 items | 消費アクションリスト | |||
acquireActions | List<AcquireAction> | ✓ | 1 ~ 100 items | 入手アクションリスト | ||
stock | int | ✓ | 1 ~ 2147483646 | 在庫数 | ||
weight | int | ✓ | 1 ~ 2147483646 | 排出重み |
ConsumeAction
消費アクション
VerifyAction
検証アクション
AcquireAction
入手アクション