GS2-Showcase マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
マスターデータのフォーマット
{
"version": "2019-04-04",
"showcases": [
{
"name": "[string]陳列棚名",
"metadata": "[string?]メタデータ",
"salesPeriodEventId": "[string?]陳列棚の販売期間を設定した GS2-Schedule のイベントGRN",
"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 のイベントGRN"
}
]
}
],
"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 のイベントGRN"
}
]
}| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2019-04-04 | マスターデータのフォーマットバージョン | ||
| showcases | List<Showcase> | ~ 100 items | 陳列棚陳列棚には陳列する商品を定義できます。また、 陳列棚の商品の販売期間を設定することができます。 | |||
| randomShowcases | List<RandomShowcase> | ~ 100 items | ランダム陳列棚 ランダム陳列棚は、指定した周期で入れ替わるランダムに選別された商品が陳列される陳列棚のモデルです。 選別される商品は、商品プールに登録された商品から指定数量が、商品ごとに設定された重みに基づいてランダムに選択されます。 ランダム陳列棚には GS2-Schedule のイベントを関連づけることで、販売期間を設定することができます。 |
モデル
Showcase
陳列棚
陳列棚には陳列する商品を定義できます。
また、陳列棚の商品の販売期間を設定することができます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| showcaseId | string | ✓* | ~ 1024文字 | 陳列棚
GRN ※ サーバー側で自動的に設定 | ||
| name | string | ✓ | ~ 128文字 | 陳列棚名 陳列棚固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| metadata | string | ~ 2048文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||
| salesPeriodEventId | string | ~ 1024文字 | 陳列棚の販売期間を設定した GS2-Schedule のイベント GRN | |||
| displayItems | List<DisplayItem> | ✓ | [] | 1 ~ 1000 items | 陳列する商品リスト |
DisplayItem
陳列する商品
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayItemId | string | ✓ | UUID | ~ 128文字 | 陳列商品ID 陳列商品の一意な名前を保持します。 省略するとシステムによって UUID(Universally Unique Identifier)フォーマットで自動的に割り当てられます。 | |||||||
| type | 文字列列挙型 enum { “salesItem”, “salesItemGroup” } | ✓ | 種類
| |||||||||
| salesItem | SalesItem | {type} == “salesItem” | ✓* | 商品 ※ type が “salesItem” であれば 必須 | ||||||||
| salesItemGroup | SalesItemGroup | {type} == “salesItemGroup” | ✓* | 商品グループ ※ type が “salesItemGroup” であれば 必須 | ||||||||
| salesPeriodEventId | string | ~ 1024文字 | 陳列棚の販売期間を設定した GS2-Schedule のイベント GRN |
SalesItem
商品
商品を購入するために必要となる対価と、商品を購入したときに得られる報酬を設定します。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | 商品名 商品固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| metadata | string | ~ 2048文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||
| verifyActions | List<VerifyAction> | [] | 0 ~ 10 items | 検証アクションリスト | ||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 10 items | 消費アクションリスト | ||
| acquireActions | List<AcquireAction> | ✓ | [] | 1 ~ 100 items | 入手アクションリスト |
SalesItemGroup
商品グループ
商品グループは陳列棚に陳列するためのエンティティです。
商品グループには複数の商品を所属させることができ、所属している商品の先頭から順番に購入可能かを判定し、一番最初に購入可能だと判定された商品が実際に陳列されます。
初回のみ割引する商品や、ステップアップガチャのように購入回数によって商品の内容が変化する仕組みに使用できます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | 商品グループ名 商品グループ固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| metadata | string | ~ 2048文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||
| salesItems | List<SalesItem> | ✓ | [] | 2 ~ 10 items | 商品グループに含める商品 |
ConsumeAction
消費アクション
VerifyAction
検証アクション
AcquireAction
入手アクション
RandomShowcase
ランダム陳列棚
ランダム陳列棚は、指定した周期で入れ替わるランダムに選別された商品が陳列される陳列棚のモデルです。
選別される商品は、商品プールに登録された商品から指定数量が、商品ごとに設定された重みに基づいてランダムに選択されます。
ランダム陳列棚には GS2-Schedule のイベントを関連づけることで、販売期間を設定することができます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| randomShowcaseId | string | ✓* | ~ 1024文字 | ランダム陳列棚
GRN ※ サーバー側で自動的に設定 | ||
| name | string | ✓ | ~ 128文字 | ランダム陳列棚名 ランダム陳列棚固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| metadata | string | ~ 2048文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||
| maximumNumberOfChoice | int | ✓ | 1 ~ 100 | 選出される商品の最大数 | ||
| displayItems | List<RandomDisplayItemModel> | ✓ | [] | 1 ~ 100 items | 選出対象の陳列商品リスト | |
| baseTimestamp | long | ✓ | 陳列する商品を再抽選の基準時間 | |||
| resetIntervalHours | int | ✓ | 1 ~ 168 | 陳列する商品を再抽選する間隔(時) | ||
| salesPeriodEventId | string | ~ 1024文字 | 陳列棚の販売期間を設定した GS2-Schedule のイベント GRN |
RandomDisplayItemModel
ランダム陳列棚に陳列可能な商品
weight に商品を選別する確率を設定できます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | UUID | ~ 128文字 | ランダム陳列商品ID ランダム陳列商品の一意な名前を保持します。 省略するとシステムによって UUID(Universally Unique Identifier)フォーマットで自動的に割り当てられます。 | |
| metadata | string | ~ 2048文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||
| verifyActions | List<VerifyAction> | [] | 0 ~ 10 items | 検証アクションリスト | ||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 10 items | 消費アクションリスト | ||
| acquireActions | List<AcquireAction> | ✓ | [] | 1 ~ 100 items | 入手アクションリスト | |
| stock | int | ✓ | 1 ~ 2147483646 | 在庫数 | ||
| weight | int | ✓ | 1 ~ 2147483646 | 排出重み |