GS2-Showcase GS2-Deploy/CDK リファレンス

エンティティ

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

型必須デフォルト値の制限説明
namestring✓~ 32文字ネームスペース名
descriptionstring~ 1024文字説明文
transactionSettingTransactionSetting✓トランザクション設定
buyScriptScriptSetting購入を実行しようとした時に実行するスクリプト
logSettingLogSettingログの出力設定

GetAttr

型説明
ItemNamespace作成したネームスペース

実装例

Type: GS2::Showcase::Namespace
Properties:
  Name: namespace1
  Description: null
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  BuyScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, showcase

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        showcase.Namespace(
            stack=self,
            name="namespace-0001",
            options=showcase.NamespaceOptions(
                transaction_setting=core.TransactionSetting(
                    enable_auto_run=False,
                    distributor_namespace_id=,
                    queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                    options=core.TransactionSettingOptions(
                        key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
                    )
                ),
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Showcase\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Showcase\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    enableAutoRun: False,
                    distributorNamespaceId: ,
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                        keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    )
                ),
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
                ),
            ),
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.showcase.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.showcase.model.options.NamespaceOptions() {
                {
                    transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(
                        false,
                        ,
                        "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                        new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                            "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                        )
                    );
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import showcase from "@/gs2cdk/showcase";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new showcase.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    false,
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    {
                        "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Showcase.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2Showcase.Model.Options.NamespaceOptions {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    false,
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                        KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

CurrentShowcaseMaster

現在有効なマスターデータ

GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

JSONファイルの形式についてはドキュメントを参照ください。

型必須デフォルト値の制限説明
namespaceNamestring✓~ 32文字ネームスペース名
settingsstring✓~ 5242880文字マスターデータ

GetAttr

型説明
ItemCurrentShowcaseMaster更新した現在有効な陳列棚マスター

実装例

Type: GS2::Showcase::CurrentShowcaseMaster
Properties:
  NamespaceName: namespace1
  Settings: {
        "version": "2019-04-04",
        "showcases": [
          {
            "name": "gem",
            "metadata": "GEM",
            "displayItems": [
              {
                "type": "salesItem",
                "salesItem": {
                  "name": "gem_3000",
                  "metadata": "GEM_3000",
                  "consumeActions": [
                    {
                      "action": "Gs2Money:InAppPurchase",
                      "request": "Gs2Money:InAppPurchase:request"
                    }
                  ],
                  "acquireActions": [
                    {
                      "action": "Gs2Money:DepositByUserId",
                      "request": "Gs2Money:DepositByUserId:request"
                    }
                  ]
                }
              },
              {
                "type": "salesItemGroup",
                "salesPeriodEventId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001",
                "salesItemGroup": {
                  "name": "step_gem",
                  "metadata": "STEP_GEM",
                  "salesItems": [
                    {
                      "name": "step1_gem_1000",
                      "metadata": "STEP1_GEM_1000",
                      "consumeActions": [
                        {
                          "action": "Gs2Money:InAppPurchase",
                          "request": "Gs2Money:InAppPurchase:request"
                        },
                        {
                          "action": "Gs2Limit:CountUpByUserId",
                          "request": "Gs2Limit:CountUpByUserId:request"
                        }
                      ],
                      "acquireActions": [
                        {
                          "action": "Gs2Money:DepositByUserId",
                          "request": "Gs2Money:DepositByUserId:request"
                        }
                      ]
                    },
                    {
                      "name": "step2_gem_2000",
                      "metadata": "STEP1_GEM_2000",
                      "consumeActions": [
                        {
                          "action": "Gs2Money:InAppPurchase",
                          "request": "Gs2Money:InAppPurchase:request"
                        },
                        {
                          "action": "Gs2Limit:CountUpByUserId",
                          "request": "Gs2Limit:CountUpByUserId:request"
                        }
                      ],
                      "acquireActions": [
                        {
                          "action": "Gs2Money:DepositByUserId",
                          "request": "Gs2Money:DepositByUserId:request"
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          },
          {
            "name": "gacha",
            "metadata": "GACHA",
            "displayItems": [
              {
                "type": "salesItem",
                "salesItem": {
                  "name": "single",
                  "metadata": "SINGLE",
                  "consumeActions": [
                    {
                      "action": "Gs2Money:WithdrawByUserId",
                      "request": "{\\"moneyName\\": \\"money-0001\\", \\"userId\\": \\"{userId}\\", \\"slot\\": \\"{slot}\\", \\"count\\": 100, \\"paidOnly\\": false}"
                    }
                  ],
                  "acquireActions": [
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "{\\"categoryName\\": \\"category-0001\\", \\"inventoryModelName\\": \\"character\\", \\"itemModelName\\": \\"ssr-0001\\", \\"userId\\": \\"{userId}\\", \\"acquireCount\\": 1}"
                    }
                  ]
                }
              },
              {
                "type": "salesItem",
                "salesItem": {
                  "name": "10times",
                  "metadata": "10TIMES",
                  "consumeActions": [
                    {
                      "action": "Gs2Money:WithdrawByUserId",
                      "request": "Gs2Money:WithdrawByUserId:request"
                    }
                  ],
                  "acquireActions": [
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    },
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    },
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    },
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    },
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    },
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    },
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    },
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    },
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    },
                    {
                      "action": "Gs2Inventory:AcquireItemSetByUserId",
                      "request": "Gs2Inventory:AcquireItemSetByUserId:request"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
from gs2_cdk import Stack, core, showcase

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        showcase.Namespace(
            stack=self,
            # 省略
        ).master_data(
            [
                showcase.Showcase(
                    name='gem',
                    display_items=[    {'type': 'salesItem', 'salesItem': {'name': 'gem_3000', 'metadata': 'GEM_3000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}},
                        {'type': 'salesItemGroup', 'salesPeriodEventId': 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001', 'salesItemGroup': {'name': 'step_gem', 'metadata': 'STEP_GEM', 'salesItems': [{'name': 'step1_gem_1000', 'metadata': 'STEP1_GEM_1000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}, {'name': 'step2_gem_2000', 'metadata': 'STEP1_GEM_2000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}]}},
                        ],
                    options=showcase.ShowcaseOptions(
                        metadata='GEM',
                    ),
                ),
                showcase.Showcase(
                    name='gacha',
                    display_items=[    {'type': 'salesItem', 'salesItem': {'name': 'single', 'metadata': 'SINGLE', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': '{"moneyName": "money-0001", "userId": "{userId}", "slot": "{slot}", "count": 100, "paidOnly": false}'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"categoryName": "category-0001", "inventoryModelName": "character", "itemModelName": "ssr-0001", "userId": "{userId}", "acquireCount": 1}'}]}},
                        {'type': 'salesItem', 'salesItem': {'name': '10times', 'metadata': '10TIMES', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': 'Gs2Money:WithdrawByUserId:request'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}]}},
                        ],
                    options=showcase.ShowcaseOptions(
                        metadata='GACHA',
                    ),
                ),
            ],
            [
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Showcase\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Showcase\Model\Showcase(
                    name:"gem",
                    displayItems:[    {'type': 'salesItem', 'salesItem': {'name': 'gem_3000', 'metadata': 'GEM_3000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}},
                    {'type': 'salesItemGroup', 'salesPeriodEventId': 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001', 'salesItemGroup': {'name': 'step_gem', 'metadata': 'STEP_GEM', 'salesItems': [{'name': 'step1_gem_1000', 'metadata': 'STEP1_GEM_1000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}, {'name': 'step2_gem_2000', 'metadata': 'STEP1_GEM_2000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}]}},
                    ],
                    options: new \Gs2Cdk\Showcase\Model\Options\ShowcaseOptions(
                        metadata:"GEM",
                    ),
                ),
                new \Gs2Cdk\Showcase\Model\Showcase(
                    name:"gacha",
                    displayItems:[    {'type': 'salesItem', 'salesItem': {'name': 'single', 'metadata': 'SINGLE', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': '{"moneyName": "money-0001", "userId": "{userId}", "slot": "{slot}", "count": 100, "paidOnly": false}'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"categoryName": "category-0001", "inventoryModelName": "character", "itemModelName": "ssr-0001", "userId": "{userId}", "acquireCount": 1}'}]}},
                    {'type': 'salesItem', 'salesItem': {'name': '10times', 'metadata': '10TIMES', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': 'Gs2Money:WithdrawByUserId:request'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}]}},
                    ],
                    options: new \Gs2Cdk\Showcase\Model\Options\ShowcaseOptions(
                        metadata:"GACHA",
                    ),
                ),
            ],
            [
            ],
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.showcase.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.showcase.model.Showcase(
                    "gem",
                    Arrays.asList(
                        {'type': 'salesItem', 'salesItem': {'name': 'gem_3000', 'metadata': 'GEM_3000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}},
                    {'type': 'salesItemGroup', 'salesPeriodEventId': 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001', 'salesItemGroup': {'name': 'step_gem', 'metadata': 'STEP_GEM', 'salesItems': [{'name': 'step1_gem_1000', 'metadata': 'STEP1_GEM_1000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}, {'name': 'step2_gem_2000', 'metadata': 'STEP1_GEM_2000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}]}}
                    ),
                    new io.gs2.cdk.showcase.model.options.ShowcaseOptions() {
                        {
                            metadata: "GEM";
                        }
                    }
                ),
                new io.gs2.cdk.showcase.model.Showcase(
                    "gacha",
                    Arrays.asList(
                        {'type': 'salesItem', 'salesItem': {'name': 'single', 'metadata': 'SINGLE', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': '{"moneyName": "money-0001", "userId": "{userId}", "slot": "{slot}", "count": 100, "paidOnly": false}'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"categoryName": "category-0001", "inventoryModelName": "character", "itemModelName": "ssr-0001", "userId": "{userId}", "acquireCount": 1}'}]}},
                    {'type': 'salesItem', 'salesItem': {'name': '10times', 'metadata': '10TIMES', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': 'Gs2Money:WithdrawByUserId:request'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}]}}
                    ),
                    new io.gs2.cdk.showcase.model.options.ShowcaseOptions() {
                        {
                            metadata: "GACHA";
                        }
                    }
                )
            ),
            Arrays.asList(
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import showcase from "@/gs2cdk/showcase";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new showcase.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new showcase.model.Showcase(
                    "gem",
                    [
                        {'type': 'salesItem', 'salesItem': {'name': 'gem_3000', 'metadata': 'GEM_3000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}},
                    {'type': 'salesItemGroup', 'salesPeriodEventId': 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001', 'salesItemGroup': {'name': 'step_gem', 'metadata': 'STEP_GEM', 'salesItems': [{'name': 'step1_gem_1000', 'metadata': 'STEP1_GEM_1000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}, {'name': 'step2_gem_2000', 'metadata': 'STEP1_GEM_2000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}]}}
                    ],
                    {
                        metadata: "GEM"
                    }
                ),
                new showcase.model.Showcase(
                    "gacha",
                    [
                        {'type': 'salesItem', 'salesItem': {'name': 'single', 'metadata': 'SINGLE', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': '{"moneyName": "money-0001", "userId": "{userId}", "slot": "{slot}", "count": 100, "paidOnly": false}'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"categoryName": "category-0001", "inventoryModelName": "character", "itemModelName": "ssr-0001", "userId": "{userId}", "acquireCount": 1}'}]}},
                    {'type': 'salesItem', 'salesItem': {'name': '10times', 'metadata': '10TIMES', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': 'Gs2Money:WithdrawByUserId:request'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}]}}
                    ],
                    {
                        metadata: "GACHA"
                    }
                )
            ],
            [
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Showcase.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Showcase.Model.Showcase(
                    "gem",
                    new Gs2Cdk.Gs2Showcase.Model.DisplayItem[] {
                        {'type': 'salesItem', 'salesItem': {'name': 'gem_3000', 'metadata': 'GEM_3000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}},
                    {'type': 'salesItemGroup', 'salesPeriodEventId': 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:schedule-0001:event:event-0001', 'salesItemGroup': {'name': 'step_gem', 'metadata': 'STEP_GEM', 'salesItems': [{'name': 'step1_gem_1000', 'metadata': 'STEP1_GEM_1000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}, {'name': 'step2_gem_2000', 'metadata': 'STEP1_GEM_2000', 'consumeActions': [{'action': 'Gs2Money:InAppPurchase', 'request': 'Gs2Money:InAppPurchase:request'}, {'action': 'Gs2Limit:CountUpByUserId', 'request': 'Gs2Limit:CountUpByUserId:request'}], 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': 'Gs2Money:DepositByUserId:request'}]}]}}
                    },
                    new Gs2Cdk.Gs2Showcase.Model.Options.ShowcaseOptions {
                        metadata = "GEM",
                    }
                ),
                new Gs2Cdk.Gs2Showcase.Model.Showcase(
                    "gacha",
                    new Gs2Cdk.Gs2Showcase.Model.DisplayItem[] {
                        {'type': 'salesItem', 'salesItem': {'name': 'single', 'metadata': 'SINGLE', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': '{"moneyName": "money-0001", "userId": "{userId}", "slot": "{slot}", "count": 100, "paidOnly": false}'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': '{"categoryName": "category-0001", "inventoryModelName": "character", "itemModelName": "ssr-0001", "userId": "{userId}", "acquireCount": 1}'}]}},
                    {'type': 'salesItem', 'salesItem': {'name': '10times', 'metadata': '10TIMES', 'consumeActions': [{'action': 'Gs2Money:WithdrawByUserId', 'request': 'Gs2Money:WithdrawByUserId:request'}], 'acquireActions': [{'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}, {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId:request'}]}}
                    },
                    new Gs2Cdk.Gs2Showcase.Model.Options.ShowcaseOptions {
                        metadata = "GACHA",
                    }
                )
            },
            new [] {
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

DisplayItemMaster

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

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

PurchaseCount

商品の購入回数

型必須デフォルト値の制限説明
namestring✓~ 128文字ランダム陳列商品名
countint✓1 ~ 2147483646購入回数

RandomDisplayItem

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

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

RandomDisplayItemModel

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

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

型必須デフォルト値の制限説明
namestring✓UUID~ 128文字ランダム陳列商品ID
metadatastring~ 2048文字メタデータ
consumeActionsList<ConsumeAction>~ 10 items消費アクションリスト
acquireActionsList<AcquireAction>✓1 ~ 100 items入手アクションリスト
stockint✓1 ~ 2147483646在庫数
weightint✓1 ~ 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",
"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",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Quest:DeleteProgressByUserId",
"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",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"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",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"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

Config

コンフィグ設定

スタンプシートの変数に適用する設定値

型必須デフォルト値の制限説明
keystring✓~ 64文字名前
valuestring~ 51200文字値

GitHubCheckoutSetting

GitHubからマスターデータをチェックアウトする設定

型必須デフォルト値の制限説明
apiKeyIdstring✓~ 1024文字GitHub のAPIキーGRN
repositoryNamestring✓~ 1024文字リポジトリ名
sourcePathstring✓~ 1024文字ソースコードのファイルパス
referenceTypeenum [
“commit_hash”,
“branch”,
“tag”
]
✓~ 128文字コードの取得元
commitHashstring{referenceType} == “commit_hash”~ 1024文字コミットハッシュ
branchNamestring{referenceType} == “branch”~ 1024文字ブランチ名
tagNamestring{referenceType} == “tag”~ 1024文字タグ名

LogSetting

ログの書き出し設定

ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子（Namespace ID）を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

型必須デフォルト値の制限説明
loggingNamespaceIdstring✓~ 1024文字ネームスペースGRN

TransactionSetting

トランザクション設定

型必須デフォルト値の制限説明
enableAutoRunbool✓false発行したスタンプシートをサーバーサイドで自動的に実行するか
distributorNamespaceIdstring✓“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字スタンプシートの実行に使用する GS2-Distributor のネームスペースGRN
keyIdstring!{enableAutoRun}“grn:gs2:{region}:{ownerId}:key:default:key:default”~ 1024文字スタンプシートの署名に使用する GS2-Key の暗号鍵
queueNamespaceIdstring✓“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字スタンプシートの実行に使用する GS2-JobQueue のネームスペースGRN

ScriptSetting

スクリプト設定

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。 このモデルは、スクリプトの実行をトリガーするための設定を保持します。

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。 同期実行は、スクリプトの実行が完了するまで処理がブロックされます。 かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることができます。

一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。 かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。 しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。 Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

型必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字スクリプトGRN
doneTriggerTargetTypeenum [
“none”,
“gs2_script”,
“aws”
]
✓“none”~ 128文字完了通知の通知先
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字スクリプトGRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字ネームスペースGRN