GS2-SerialKey

Reference to resource definitions available in GS2-Deploy templates

GS2-Deploy Reference

Entities

Namespace

Namespace

Type: GS2::SerialKey::Namespace
Properties:
  Name: namespace1
  Description: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

from gs2_cdk import Stack, core, serial_key

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        serial_key.Namespace(
            stack=self,
            name="namespace-0001",
            options=serial_key.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\SerialKey\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\SerialKey\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.serialKey.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.serialKey.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 serialKey from "@/gs2cdk/serialKey";

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

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SerialKey.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2SerialKey.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

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.

	Type	Require	Limitation	Description
name	string	✓	~ 32 chars	Namespace name
description	string		~ 1024 chars	Description
logSetting	LogSetting			Log output settings

CurrentCampaignMaster

CurrentCampaignMaster

Type: GS2::SerialKey::CurrentCampaignMaster
Properties:
  NamespaceName: namespace1
  Settings: {"version": "2022-09-13", "campaignModels": [{"name": "campaign-0001", "metadata": "CAMPAIGN_0001", "enableCampaignCode": true, "enableLimit": false}]}

from gs2_cdk import Stack, core, serial_key

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        serial_key.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
                serial_key.CampaignModel(
                    name='campaign-0001',
                    enable_campaign_code=True,
                    options=serial_key.CampaignModelOptions(
                        metadata='CAMPAIGN_0001',
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\SerialKey\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\SerialKey\Model\CampaignModel(
                    name:"campaign-0001",
                    enableCampaignCode:True,
                    options: new \Gs2Cdk\SerialKey\Model\Options\CampaignModelOptions(
                        metadata:"CAMPAIGN_0001",
                    ),
                ),
            ],
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.serialKey.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.serialKey.model.CampaignModel(
                    "campaign-0001",
                    true,
                    new io.gs2.cdk.serialKey.model.options.CampaignModelOptions() {
                        {
                            metadata: "CAMPAIGN_0001";
                        }
                    }
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

import core from "@/gs2cdk/core";
import serialKey from "@/gs2cdk/serialKey";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new serialKey.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new serialKey.model.CampaignModel(
                    "campaign-0001",
                    true,
                    {
                        metadata: "CAMPAIGN_0001"
                    }
                )
            ]
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SerialKey.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2SerialKey.Model.CampaignModel(
                    "campaign-0001",
                    true,
                    new Gs2Cdk.Gs2SerialKey.Model.Options.CampaignModelOptions {
                        metadata = "CAMPAIGN_0001",
                    }
                )
            }
        );
    }
}

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

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.

	Type	Require	Default	Limitation	Description
namespaceName	string	✓		~ 32 chars	Namespace name
settings	string	✓		~ 5242880 chars	Master data