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

エンティティ

Namespace

ネームスペース

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

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

必須デフォルト値の制限説明
namestring~ 32文字ネームスペース名
descriptionstring~ 1024文字説明文
transactionSettingTransactionSettingトランザクション設定
logSettingLogSettingログの出力設定

GetAttr

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

実装例

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(
                        "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(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

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

MatchSession

セッション

必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
sessionNamestringUUID~ 128文字セッション名
ttlSecondsint6060 ~ 7200セッションの有効期限(秒)

GetAttr

説明
ItemMatchSession作成したセッション

実装例

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ファイルを書き出すことでもサービスを利用可能です。

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

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

GetAttr

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

実装例

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"}]}
from gs2_cdk import Stack, core, season_rating

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        season_rating.Namespace(
            stack=self,
            # 省略
        ).master_data(
            [
                season_rating.SeasonModel(
                    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},
                        ],
                    experience_model_id='grn:experience:level',
                ),
            ],
        )

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:[    {'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",
                ),
            ],
        );
    }
}

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(
                        {'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}
                    ),
                    "grn:experience:level"
                )
            )
        );
    }
}

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",
                    [
                        {'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}
                    ],
                    "grn:experience:level"
                )
            ]
        );
    }
}

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[] {
                        {'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}
                    },
                    "grn:experience:level"
                )
            }
        );
    }
}

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

TierModel

必須デフォルト値の制限説明
metadatastring~ 128文字メタデータ
raiseRankBonusint~ 10000ランク昇格時にすぐにランク降格を防ぐために加算するボーナスポイント
entryFeeint~ 10000ゲームを開始するための参加料として減算するポイント
minimumChangePointint~ -1負けた際に変動するレート値の最小値
maximumChangePointint1 ~ 99999999勝った際に変動するレート値の最大値

TransactionSetting

トランザクション設定

必須デフォルト値の制限説明
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字スタンプシートの実行に使用する GS2-Distributor ネームスペース
queueNamespaceIdstring“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 以外の言語で処理を記述することができます。

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

LogSetting

ログの書き出し設定

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

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

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文字タグ名

GameResult

必須デフォルト値の制限説明
rankint~ 2147483646順位
userIdstring~ 128文字ユーザーID

Ballot

必須デフォルト値の制限説明
userIdstring~ 128文字ユーザーID
seasonNamestring~ 128文字レーティング計算に使用するシーズン名
sessionNamestring~ 128文字投票対象のセッション名
numberOfPlayerint2 ~ 10参加人数

SignedBallot

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

WrittenBallot

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