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 のイベント"
        }
      ]
    }
  ]
}
必須デフォルト値の制限説明
version2019-04-04マスターデータのフォーマットバージョン
showcasesList<Showcase>

SalesItem

陳列棚

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

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

SalesItemGroup

商品グループ

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

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

Showcase

陳列棚

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

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

DisplayItem

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

DisplayItemMaster

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

ConsumeAction

必須デフォルト値の制限説明
actionenum []~ 128文字スタンプタスクで実行するアクションの種類
requeststring~ 1048576文字入手リクエストのJSON

AcquireAction

必須デフォルト値の制限説明
actionenum []~ 128文字スタンプシートを使用して実行するアクションの種類
requeststring~ 1048576文字リクエストのJSON