GS2-Deploy/CDK Reference of GS2-Showcase

Entities

Namespace

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

TypeRequireDefaultLimitationDescription
namestring✓~ 32 charsNamespace name
descriptionstring~ 1024 charsdescription of Namespace
transactionSettingTransactionSetting✓Transaction settings
buyScriptScriptSettingScript to run when attempting to execute a purchase
logSettingLogSettingLog output settings

GetAttr

TypeDescription
ItemNamespaceNamespace created

Implementation Example

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",
            transaction_setting=core.TransactionSetting(
                enable_auto_run=False,
                options=core.TransactionSettingOptions(
                    distributor_namespace_id=,
                    key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
                    queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                )
            ),
            options=showcase.NamespaceOptions(
                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",
            transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                enableAutoRun: False,
                options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                    distributorNamespaceId: ,
                    keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                )
            ),
            options: new \Gs2Cdk\Showcase\Model\Options\NamespaceOptions(
                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.core.model.TransactionSetting(
                false,
                new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                )
            ),
            new io.gs2.cdk.showcase.model.options.NamespaceOptions() {
                {
                    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",
            new core.TransactionSetting(
                false,
                {
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-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.Core.Model.TransactionSetting(
                false,
                new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                    DistributorNamespaceId = ,
                    KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    QueueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                }
            ),
            new Gs2Cdk.Gs2Showcase.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

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

CurrentShowcaseMaster

Currently available master data

GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.

We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.

Please refer to the documentation for the format of the JSON file.

TypeRequireDefaultLimitationDescription
namespaceNamestring✓~ 32 charsNamespace name
settingsstring✓~ 5242880 charsMaster data

GetAttr

TypeDescription
ItemCurrentShowcaseMasterUpdated and currently available showcase master

Implementation Example

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,
            # omission
        ).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,
            // omission
        ))->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,
            // omission
        ).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,
            // omission
        ).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,
            // omission
        ).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

Displayed Item

TypeRequireDefaultLimitationDescription
displayItemIdstring✓UUID~ 128 charsDisplayed Item ID
typeenum [‘salesItem’, ‘salesItemGroup’]✓~ 128 charsType
salesItemNamestring{type} == “salesItem”~ 128 charsName of the product to be displayed
salesItemGroupNamestring{type} == “salesItemGroup”~ 128 charsName of the product group to be displayed
salesPeriodEventIdstring~ 1024 charsProduct group to be displayed
revisionlong0~ 9223372036854775805Revision

PurchaseCount

Number of product purchases

TypeRequireDefaultLimitationDescription
namestring✓~ 128 charsRandom Displayed Item Name
countint✓1 ~ 2147483646Purchase count

RandomDisplayItem

Random displayable items on the Random Showcase

TypeRequireDefaultLimitationDescription
showcaseNamestring✓~ 128 charsRandom Displayed Item Name
namestring✓UUID~ 128 charsRandom Displayed Item ID
metadatastring~ 2048 charsmetadata
consumeActionsList<ConsumeAction>~ 10 itemsList of Consumption Action
acquireActionsList<AcquireAction>✓1 ~ 100 itemsList of Acquire Action
currentPurchaseCountint✓1 ~ 2147483646Current purchase count
maximumPurchaseCountint✓1 ~ 2147483646Maximum purchase count

RandomDisplayItemModel

Random displayable items on the Random Showcase

You can set the probability of selecting items for the display shelf.

TypeRequireDefaultLimitationDescription
namestring✓UUID~ 128 charsRandom Displayed Item ID
metadatastring~ 2048 charsmetadata
consumeActionsList<ConsumeAction>~ 10 itemsList of Consumption Action
acquireActionsList<AcquireAction>✓1 ~ 100 itemsList of Acquire Action
stockint✓1 ~ 2147483646Stock
weightint✓1 ~ 2147483646Emission Weight

ConsumeAction

TypeRequireDefaultLimitationDescription
actionenum []✓~ 128 charsTypes of actions to be performed in the stamp task
requeststring✓~ 1048576 charsJSON of the obtain request

AcquireAction

TypeRequireDefaultLimitationDescription
actionenum []✓~ 128 charsTypes of actions to be performed in the stamp sheet
requeststring✓~ 1048576 charsJSON of request

Config

TypeRequireDefaultLimitationDescription
keystring✓~ 64 charsName
valuestring~ 51200 charsValue

GitHubCheckoutSetting

TypeRequireDefaultLimitationDescription
apiKeyIdstring✓~ 1024 charsGitHub API key GRN
repositoryNamestring✓~ 1024 charsRepository Name
sourcePathstring✓~ 1024 charsSource code file path
referenceTypeenum [‘commit_hash’, ‘branch’, ’tag’]✓~ 128 charsSource of code
commitHashstring{referenceType} == “commit_hash”~ 1024 charsCommit hash
branchNamestring{referenceType} == “branch”~ 1024 charsBranch Name
tagNamestring{referenceType} == “tag”~ 1024 charsTag Name

LogSetting

TypeRequireDefaultLimitationDescription
loggingNamespaceIdstring✓~ 1024 charsNamespace GRN

TransactionSetting

TypeRequireDefaultLimitationDescription
enableAutoRunbool✓falseAutomatically run issued stamp sheets on the server side, or
distributorNamespaceIdstring{enableAutoRun}~ 1024 charsGS2-Distributor namespace used for stamp sheet execution
keyIdstring!{enableAutoRun}~ 1024 charsGS2-Key encryption key used to sign the stamp sheet
queueNamespaceIdstring~ 1024 charsNamespace in GS2-JobQueue used to run the stamp sheet

ScriptSetting

TypeRequireDefaultLimitationDescription
triggerScriptIdstring~ 1024 charsScript GRN
doneTriggerTargetTypeenum [’none’, ‘gs2_script’, ‘aws’]✓“none”~ 128 charsNotification of Completion
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsScript GRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsNamespace GRN