GS2-Deploy/CDK Reference of GS2-Ranking

Entities

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 of Namespace
logSetting	LogSetting			Log output settings

GetAttr

	Type	Description
Item	Namespace	Namespace created

Implementation Example

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

from gs2_cdk import Stack, core, ranking

class SampleStack(Stack):

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new ranking.model.Namespace(
            this,
            "namespace-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.Gs2Ranking.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2Ranking.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

CurrentRankingMaster

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

GetAttr

	Type	Description
Item	CurrentRankingMaster	Updated and currently available ranking settings

Implementation Example

Type: GS2::Ranking::CurrentRankingMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-09-17",
    "categories": [
      {
        "name": "category-0001",
        "orderDirection": "asc",
        "scope": "global",
        "calculateIntervalMinutes": 15,
        "uniqueByUserId": true
      },
      {
        "name": "category-0002",
        "orderDirection": "desc",
        "scope": "global",
        "calculateIntervalMinutes": 15,
        "uniqueByUserId": false
      },
      {
        "name": "category-0003",
        "orderDirection": "asc",
        "scope": "scoped",
        "minimumValue": 100,
        "maximumValue": 10000,
        "uniqueByUserId": true
      },
      {
        "name": "category-0004",
        "orderDirection": "desc",
        "scope": "scoped",
        "minimumValue": 100,
        "maximumValue": 10000,
        "uniqueByUserId": false
      },
      {
        "name": "category-0005",
        "orderDirection": "asc",
        "scope": "global",
        "calculateIntervalMinutes": 15,
        "uniqueByUserId": true
      }
    ]
  }

from gs2_cdk import Stack, core, ranking

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        ranking.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
            ],
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Ranking\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
            ],
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.ranking.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
            )
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new ranking.model.Namespace(
            this,
            // omission
        ).masterData(
            [
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Ranking.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
            }
        );
    }
}

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

Ranking

	Type	Require	Limitation	Description
rank	long	✓	1 ~ 9223372036854775805	Rank
index	long	✓	~ 9223372036854775805	Index from 1st place
categoryName	string	✓	~ 128 chars	Category Name
userId	string	✓	~ 128 chars	User Id
score	long	✓	~ 9223372036854775805	Score
metadata	string		~ 512 chars	metadata
createdAt	long	✓		Datetime of creation

Scope

	Type	Require	Default	Limitation	Description
name	string	✓		~ 128 chars	Scope Name
targetDays	long	✓		1 ~ 365	Number of days to aggregate

CalculatedAt

	Type	Require	Default	Limitation	Description
categoryName	string	✓		~ 128 chars	Category Name
calculatedAt	long	✓			Date and time of calculating

GitHubCheckoutSetting

	Type	Require	Limitation	Description
apiKeyId	string	✓	~ 1024 chars	GitHub API key GRN
repositoryName	string	✓	~ 1024 chars	Repository Name
sourcePath	string	✓	~ 1024 chars	Source code file path
referenceType	enum [‘commit_hash’, ‘branch’, ’tag’]	✓	~ 128 chars	Source of code
commitHash	string	{referenceType} == “commit_hash”	~ 1024 chars	Commit hash
branchName	string	{referenceType} == “branch”	~ 1024 chars	Branch Name
tagName	string	{referenceType} == “tag”	~ 1024 chars	Tag Name

LogSetting

	Type	Require	Default	Limitation	Description
loggingNamespaceId	string	✓		~ 1024 chars	Namespace GRN