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 のイベント"
        }
      ]
    }
  ],
  "randomShowcases": [
    {
      "name": "[string]ランダム陳列棚名",
      "metadata": "[string?]メタデータ",
      "maximumNumberOfChoice": "[int]選出される商品の最大数",
      "displayItems": [
        {
          "name": "[string]ランダム陳列商品ID",
          "metadata": "[string?]メタデータ",
          "consumeActions": [
            {
              "action": "[string]スタンプタスクで実行するアクションの種類",
              "request": "[string]リクエストのJSON"
            }
          ],
          "acquireActions": [
            {
              "action": "[string]スタンプシートを使用して実行するアクションの種類",
              "request": "[string]リクエストのJSON"
            }
          ],
          "stock": "[int]在庫数",
          "weight": "[int]排出重み"
        }
      ],
      "baseTimestamp": "[long]陳列する商品を再抽選の基準時間",
      "resetIntervalHours": "[int]陳列する商品を再抽選する間隔(時)",
      "salesPeriodEventId": "[string?]陳列棚の販売期間を設定した GS2-Schedule のイベント"
    }
  ]
}
有効化条件必須デフォルト値の制限説明
version2019-04-04マスターデータのフォーマットバージョン
showcasesList<Showcase>~ 10 items陳列棚
randomShowcasesList<RandomShowcase>~ 10 itemsランダム陳列棚モデル

SalesItem

商品

商品を購入するために必要となる対価と商品を購入したときに得られる報酬を設定します。

有効化条件必須デフォルト値の制限説明
namestring~ 128文字商品名
metadatastring~ 2048文字メタデータ
consumeActionsList<ConsumeAction>~ 10 items消費アクションリスト
acquireActionsList<AcquireAction>1 ~ 100 items入手アクションリスト

SalesItemGroup

商品グループ

商品グループは陳列棚に陳列するためのエンティティです。 商品グループには複数の商品を所属させることができ、所属している商品の先頭から順番に購入可能かを判定し、一番最初に購入可能だと判定された商品が実際に陳列されます。 初回のみ割引する商品や、ステップアップガチャのように購入回数によって商品の内容が変化する仕組みに使用できます。

有効化条件必須デフォルト値の制限説明
namestring~ 128文字商品グループ名
metadatastring~ 2048文字メタデータ
salesItemsList<SalesItem>2 ~ 10 items商品グループに含める商品

Showcase

陳列棚

陳列棚には販売期間を設定できます。

有効化条件必須デフォルト値の制限説明
showcaseIdstring~ 1024文字陳列棚GRN
namestring~ 128文字陳列棚名
metadatastring~ 2048文字メタデータ
salesPeriodEventIdstring~ 1024文字陳列棚の販売期間を設定した GS2-Schedule のイベント
displayItemsList<DisplayItem>1 ~ 1000 items陳列された商品リスト

DisplayItem

陳列する商品

有効化条件必須デフォルト値の制限説明
displayItemIdstringUUID~ 128文字陳列商品ID
typeenum [
“salesItem”,
“salesItemGroup”
]
~ 128文字種類
salesItemSalesItem{type} == “salesItem”陳列する商品
salesItemGroupSalesItemGroup{type} == “salesItemGroup”陳列する商品グループ
salesPeriodEventIdstring~ 1024文字商品の販売期間を設定した GS2-Schedule のイベント

DisplayItemMaster

陳列する商品のマスターデータ

有効化条件必須デフォルト値の制限説明
displayItemIdstringUUID~ 128文字陳列商品ID
typeenum [
“salesItem”,
“salesItemGroup”
]
~ 128文字種類
salesItemNamestring{type} == “salesItem”~ 128文字陳列する商品の名前
salesItemGroupNamestring{type} == “salesItemGroup”~ 128文字陳列する商品グループの名前
salesPeriodEventIdstring~ 1024文字商品の販売期間を設定した GS2-Schedule のイベント
revisionlong0~ 9223372036854775805リビジョン

RandomShowcase

ランダム陳列棚モデル

指定した周期で入れ替わるランダムに選別された商品が陳列される陳列棚。

選別される商品は、商品プールに登録された商品から指定数量が、商品ごとに設定された重みに基づいてランダムに選択されます。 ランダム陳列棚には GS2-Schedule のイベントを関連づけることで、販売期間を設定することができます。

有効化条件必須デフォルト値の制限説明
randomShowcaseIdstring~ 1024文字ランダム陳列棚GRN
namestring~ 128文字ランダム陳列棚名
metadatastring~ 2048文字メタデータ
maximumNumberOfChoiceint1 ~ 100選出される商品の最大数
displayItemsList<RandomDisplayItemModel>1 ~ 100 items選出対象の商品リスト
baseTimestamplong陳列する商品を再抽選の基準時間
resetIntervalHoursint1 ~ 168陳列する商品を再抽選する間隔(時)
salesPeriodEventIdstring~ 1024文字陳列棚の販売期間を設定した GS2-Schedule のイベント

PurchaseCount

商品の購入回数

有効化条件必須デフォルト値の制限説明
namestring~ 128文字ランダム陳列商品名
countint1 ~ 2147483646購入回数

RandomDisplayItem

ランダム陳列棚に陳列された商品

有効化条件必須デフォルト値の制限説明
showcaseNamestring~ 128文字ランダム陳列棚名
namestringUUID~ 128文字ランダム陳列商品ID
metadatastring~ 2048文字メタデータ
consumeActionsList<ConsumeAction>~ 10 items消費アクションリスト
acquireActionsList<AcquireAction>1 ~ 100 items入手アクションリスト
currentPurchaseCountint1 ~ 2147483646現在の購入回数
maximumPurchaseCountint1 ~ 2147483646最大購入回数

RandomDisplayItemModel

ランダム陳列棚に陳列可能な商品

weight に商品を選別する確率を設定できます。

有効化条件必須デフォルト値の制限説明
namestringUUID~ 128文字ランダム陳列商品ID
metadatastring~ 2048文字メタデータ
consumeActionsList<ConsumeAction>~ 10 items消費アクションリスト
acquireActionsList<AcquireAction>1 ~ 100 items入手アクションリスト
stockint1 ~ 2147483646在庫数
weightint1 ~ 2147483646排出重み

ConsumeAction

消費アクション

有効化条件必須デフォルト値の制限説明
actionenum [
"Gs2AdReward:ConsumePointByUserId",
"Gs2Dictionary:DeleteEntriesByUserId",
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Enhance:DeleteProgressByUserId",
"Gs2Exchange:DeleteAwaitByUserId",
"Gs2Experience:SubExperienceByUserId",
"Gs2Experience:SubRankCapByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Formation:SubMoldCapacityByUserId",
"Gs2Grade:SubGradeByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyIncludeMemberByUserId",
"Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
"Gs2Inbox:OpenMessageByUserId",
"Gs2Inbox:DeleteMessageByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:ConsumeItemSetByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:ConsumeSimpleItemsByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:ConsumeBigItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2JobQueue:DeleteJobByUserId",
"Gs2Limit:CountUpByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2LoginReward:MarkReceivedByUserId",
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Money2:WithdrawByUserId",
"Gs2Money2:VerifyReceiptByUserId",
"Gs2Quest:DeleteProgressByUserId",
"Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
"Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
"Gs2Schedule:DeleteTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
"Gs2SerialKey:UseByUserId",
"Gs2Showcase:IncrementPurchaseCountByUserId",
"Gs2SkillTree:MarkRestrainByUserId",
"Gs2Stamina:DecreaseMaxValueByUserId",
"Gs2Stamina:ConsumeStaminaByUserId",
]
~ 128文字スタンプタスクで実行するアクションの種類
requeststring~ 1048576文字リクエストのJSON

AcquireAction

入手アクション

有効化条件必須デフォルト値の制限説明
actionenum [
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:UnlockIncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2SerialKey:RevertUseByUserId",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
]
~ 128文字スタンプシートを使用して実行するアクションの種類
requeststring~ 1048576文字リクエストのJSON