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

エンティティ

Namespace

ネームスペース

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

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

	型	必須	値の制限	説明
name	string	✓	~ 128文字	ネームスペース名
description	string		~ 1024文字	説明文
transactionSetting	TransactionSetting	✓		トランザクション設定
logSetting	LogSetting			ログの出力設定

GetAttr

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

実装例

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

from gs2_cdk import Stack, core, season_rating

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        season_rating.Namespace(
            stack=self,
            name="namespace-0001",
            options=season_rating.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\SeasonRating\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\SeasonRating\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.seasonRating.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.seasonRating.model.options.NamespaceOptions() {
                {
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new seasonRating.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.Gs2SeasonRating.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2SeasonRating.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

MatchSession

セッション

	型	必須	デフォルト	値の制限	説明
namespaceName	string	✓		~ 128文字	ネームスペース名
sessionName	string		UUID	~ 128文字	セッション名
ttlSeconds	int	✓	60	60 ~ 7200	セッションの有効期限(秒)

GetAttr

	型	説明
Item	MatchSession	作成したセッション

実装例

Type: GS2::SeasonRating::MatchSession
Properties:
  NamespaceName: namespace1
  SessionName: $matchSession1.name
  TtlSeconds: null

from gs2_cdk import Stack, core, season_rating

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        season_rating.MatchSession(
            stack=self,
            namespace_name="namespace-0001",
            options=season_rating.MatchSessionOptions(
                session_name=self.match_session1.name,
            ),
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\SeasonRating\Model\MatchSession(
            stack: $this,
            namespaceName: "namespace-0001",
            options: new \Gs2Cdk\SeasonRating\Model\Options\MatchSessionOptions(
                sessionName: self::$matchSession1.name
            )
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.seasonRating.model.MatchSession(
            this,
            "namespace-0001",
            new io.gs2.cdk.seasonRating.model.options.MatchSessionOptions() {
                {
                    sessionName = "$matchSession1.name";
                }
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new seasonRating.model.MatchSession(
            this,
            "namespace-0001",
            {
                sessionName: "$matchSession1.name"
            }
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SeasonRating.Model.MatchSession(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2SeasonRating.Model.Options.MatchSessionOptions {
                sessionName = "$matchSession1.name"
            }
        );
    }
}

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

CurrentSeasonModelMaster

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

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

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

Note

JSONファイルの形式については GS2-SeasonRating マスターデータリファレンスをご参照ください。

	型	必須	デフォルト	値の制限	説明
namespaceName	string	✓		~ 128文字	ネームスペース名
settings	string	✓		~ 5242880文字	マスターデータ

GetAttr

	型	説明
Item	CurrentSeasonModelMaster	更新した現在有効なレーティングマスター

実装例

Type: GS2::SeasonRating::CurrentSeasonModelMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2024-02-23",
    "seasonModels": [
      {
        "name": "season1",
        "tiers": [
          {
            "raiseRankBonus": 0,
            "entryFee": 0,
            "minimumChangePoint": -10,
            "maximumChangePoint": 20
          },
          {
            "raiseRankBonus": 30,
            "entryFee": 10,
            "minimumChangePoint": -10,
            "maximumChangePoint": 30
          },
          {
            "raiseRankBonus": 60,
            "entryFee": 20,
            "minimumChangePoint": -20,
            "maximumChangePoint": 50
          },
          {
            "raiseRankBonus": 60,
            "entryFee": 30,
            "minimumChangePoint": -30,
            "maximumChangePoint": 60
          }
        ],
        "experienceModelId": "grn:experience:level",
        "challengePeriodEventId": "grn:schedule:event"
      }
    ]
  }

from gs2_cdk import Stack, core, season_rating

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        season_rating.Namespace(
            stack=self,
            # 省略
        ).master_data(
            season_models=[
                season_rating.SeasonModel(
                    name='season1',
                    tiers=[
                            season_rating.TierModel(
                                raise_rank_bonus=0,
                                entry_fee=0,
                                minimum_change_point=-10,
                                maximum_change_point=20
                            ),
                            season_rating.TierModel(
                                raise_rank_bonus=30,
                                entry_fee=10,
                                minimum_change_point=-10,
                                maximum_change_point=30
                            ),
                            season_rating.TierModel(
                                raise_rank_bonus=60,
                                entry_fee=20,
                                minimum_change_point=-20,
                                maximum_change_point=50
                            ),
                            season_rating.TierModel(
                                raise_rank_bonus=60,
                                entry_fee=30,
                                minimum_change_point=-30,
                                maximum_change_point=60
                            ),
                        ],
                    experience_model_id='grn:experience:level',
                    options=season_rating.SeasonModelOptions(
                        challenge_period_event_id='grn:schedule:event',
                    ),
                ),
            ],
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\SeasonRating\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\SeasonRating\Model\SeasonModel(
                    name:"season1",
                    tiers:[
                        new \Gs2Cdk\SeasonRating\Model\TierModel(
                            raiseRankBonus: 0,
                            entryFee: 0,
                            minimumChangePoint: -10,
                            maximumChangePoint: 20
                        ),
                        new \Gs2Cdk\SeasonRating\Model\TierModel(
                            raiseRankBonus: 30,
                            entryFee: 10,
                            minimumChangePoint: -10,
                            maximumChangePoint: 30
                        ),
                        new \Gs2Cdk\SeasonRating\Model\TierModel(
                            raiseRankBonus: 60,
                            entryFee: 20,
                            minimumChangePoint: -20,
                            maximumChangePoint: 50
                        ),
                        new \Gs2Cdk\SeasonRating\Model\TierModel(
                            raiseRankBonus: 60,
                            entryFee: 30,
                            minimumChangePoint: -30,
                            maximumChangePoint: 60
                        ),
                    ],
                    experienceModelId:"grn:experience:level",
                    options: new \Gs2Cdk\SeasonRating\Model\Options\SeasonModelOptions(
                        challengePeriodEventId:"grn:schedule:event"
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.seasonRating.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.seasonRating.model.SeasonModel(
                    "season1",
                    Arrays.asList(
                        new io.gs2.cdk.season_rating.model.TierModel(
                            0,
                            0,
                            -10,
                            20
                        ),
                        new io.gs2.cdk.season_rating.model.TierModel(
                            30,
                            10,
                            -10,
                            30
                        ),
                        new io.gs2.cdk.season_rating.model.TierModel(
                            60,
                            20,
                            -20,
                            50
                        ),
                        new io.gs2.cdk.season_rating.model.TierModel(
                            60,
                            30,
                            -30,
                            60
                        )
                    ),
                    "grn:experience:level",
                    new io.gs2.cdk.seasonRating.model.options.SeasonModelOptions() {
                        {
                            challengePeriodEventId: "grn:schedule:event";
                        }
                    }
                )
            )
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new seasonRating.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new seasonRating.model.SeasonModel(
                    "season1",
                    [
                        new seasonRating.model.TierModel(
                            0,
                            0,
                            -10,
                            20
                        ),
                        new seasonRating.model.TierModel(
                            30,
                            10,
                            -10,
                            30
                        ),
                        new seasonRating.model.TierModel(
                            60,
                            20,
                            -20,
                            50
                        ),
                        new seasonRating.model.TierModel(
                            60,
                            30,
                            -30,
                            60
                        ),
                    ],
                    "grn:experience:level",
                    {
                        challengePeriodEventId: "grn:schedule:event"
                    }
                )
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SeasonRating.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2SeasonRating.Model.SeasonModel(
                    "season1",
                    new Gs2Cdk.Gs2SeasonRating.Model.TierModel[] {
                        new Gs2Cdk.Gs2SeasonRating.Model.TierModel(
                            raiseRankBonus: 0,
                            entryFee: 0,
                            minimumChangePoint: -10,
                            maximumChangePoint: 20
                        ),
                        new Gs2Cdk.Gs2SeasonRating.Model.TierModel(
                            raiseRankBonus: 30,
                            entryFee: 10,
                            minimumChangePoint: -10,
                            maximumChangePoint: 30
                        ),
                        new Gs2Cdk.Gs2SeasonRating.Model.TierModel(
                            raiseRankBonus: 60,
                            entryFee: 20,
                            minimumChangePoint: -20,
                            maximumChangePoint: 50
                        ),
                        new Gs2Cdk.Gs2SeasonRating.Model.TierModel(
                            raiseRankBonus: 60,
                            entryFee: 30,
                            minimumChangePoint: -30,
                            maximumChangePoint: 60
                        ),
                    },
                    "grn:experience:level",
                    new Gs2Cdk.Gs2SeasonRating.Model.Options.SeasonModelOptions {
                        challengePeriodEventId = "grn:schedule:event"
                    }
                )
            }
        );
    }
}

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

TierModel

ティアーモデル

	型	必須	値の制限	説明
metadata	string		~ 128文字	メタデータ
raiseRankBonus	int	✓	~ 10000	ランク昇格時にすぐにランク降格を防ぐために加算するボーナスポイント
entryFee	int	✓	~ 10000	ゲームを開始するための参加料として減算するポイント
minimumChangePoint	int	✓	~ -1	負けた際に変動するレート値の最小値
maximumChangePoint	int	✓	1 ~ 99999999	勝った際に変動するレート値の最大値

TransactionSetting

トランザクション設定

	型	必須	デフォルト	値の制限	説明
distributorNamespaceId	string	✓	“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024文字	トランザクションの実行に使用する GS2-Distributor ネームスペース
queueNamespaceId	string	✓	“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024文字	トランザクションの実行に使用する GS2-JobQueue のネームスペース

ScriptSetting

スクリプト設定

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

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

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

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

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

doneTriggerTargetType に指定する列挙型の定義

定義	説明
none	なし
gs2_script	GS2-Script
aws	Amazon EventBridge

LogSetting

ログの書き出し設定

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

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

GitHubCheckoutSetting

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

	型	必須	値の制限	説明
apiKeyId	string	✓	~ 1024文字	GitHub のAPIキーGRN
repositoryName	string	✓	~ 1024文字	リポジトリ名
sourcePath	string	✓	~ 1024文字	ソースコードのファイルパス
referenceType	enum { “commit_hash”, “branch”, “tag” }	✓	~ 128文字	コードの取得元
commitHash	string	{referenceType} == “commit_hash”	~ 1024文字	コミットハッシュ
branchName	string	{referenceType} == “branch”	~ 1024文字	ブランチ名
tagName	string	{referenceType} == “tag”	~ 1024文字	タグ名

referenceType に指定する列挙型の定義

定義	説明
commit_hash	コミットハッシュ
branch	ブランチ
tag	タグ

GameResult

対戦結果

	型	必須	デフォルト	値の制限	説明
rank	int	✓		~ 2147483646	順位
userId	string	✓		~ 128文字	ユーザーID

Ballot

投票用紙

	型	必須	値の制限	説明
userId	string	✓	~ 128文字	ユーザーID
seasonName	string	✓	~ 128文字	レーティング計算に使用するシーズン名
sessionName	string	✓	~ 128文字	投票対象のセッション名
numberOfPlayer	int	✓	2 ~ 10	参加人数

SignedBallot

署名付の投票用紙

	型	必須	デフォルト	値の制限	説明
body	string	✓		~ 1024文字	投票用紙の署名対象のデータ
signature	string	✓		~ 256文字	投票用紙の署名

WrittenBallot

投票用紙

	型	必須	デフォルト	値の制限	説明
ballot	Ballot	✓			投票用紙
gameResults	List<GameResult>			~ 10 items	投票内容。対戦結果のリスト