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

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例

エンティティ

Deploy処理で操作の対象となるリソース

Namespace

ネームスペース

ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。

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

Request

リソースの生成・更新リクエスト

	型	必須	値の制限	説明
name	string	✓	~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
description	string		~ 1024文字	説明文
transactionSetting	TransactionSetting	✓		トランザクション設定シーズンレーティング結果の適用時に使用されるトランザクション処理の設定。
logSetting	LogSetting			ログ出力設定投票用紙の発行、投票の提出、レーティング計算などのシーズンレーティング操作のログ出力設定。設定した場合、操作ログが指定した GS2-Log ネームスペースに出力されます。

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

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

実装例

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

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/seasonRating"
)


SampleStack := core.NewStack()
seasonRating.NewNamespace(
    &SampleStack,
    "namespace-0001",
    seasonRating.NamespaceOptions{
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(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()
                        .withLogSetting(new io.gs2.cdk.core.model.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.Gs2SeasonRating.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: 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

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

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

TransactionSetting

トランザクション設定

トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。

	型	有効化条件	デフォルト	値の制限	説明
enableAtomicCommit	bool		false		トランザクションの実行をアトミックにコミットするか
transactionUseDistributor	bool	{enableAtomicCommit} == true	false		トランザクションを非同期処理で実行する ※ enableAtomicCommit が true であれば有効
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	false		スクリプトの結果コミット処理を非同期処理で実行するか ※ transactionUseDistributor が true であれば有効
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	false		入手アクションを実行する際に GS2-JobQueue を使用するか ※ enableAtomicCommit が true であれば有効
distributorNamespaceId	string		“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024文字	トランザクションの実行に使用する GS2-Distributor ネームスペース GRN
queueNamespaceId	string		“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024文字	トランザクションの実行に使用する GS2-JobQueue のネームスペース GRN

LogSetting

ログの出力設定

ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

	型	有効化条件	必須	デフォルト	値の制限	説明
loggingNamespaceId	string		✓		~ 1024文字	ログを出力する GS2-Log のネームスペース GRN 「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

CurrentSeasonModelMaster

現在アクティブなシーズンモデルのマスターデータ

現在ネームスペース内で有効な、シーズンモデルの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

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

Note

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

Request

リソースの生成・更新リクエスト

型

有効化条件

必須

デフォルト

値の制限

説明

namespaceName

string

✓

~ 128文字

ネームスペース名

ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。

mode

文字列列挙型
enum {
“direct”,
“preUpload”
}

“direct”

更新モード

定義	説明
“direct”	マスターデータを直接更新
“preUpload”	マスターデータをアップロードしてから更新

settings

string

{mode} == “direct”

✓※

~ 5242880文字

マスターデータ

※ mode が “direct” であれば必須

uploadToken

string

{mode} == “preUpload”

✓※

~ 1024文字

事前アップロードで取得したトークン

アップロードしたマスターデータを適用するために使用されます。

※ mode が “preUpload” であれば必須

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

	型	説明
Item	CurrentSeasonModelMaster	更新された現在アクティブなシーズンモデルのマスターデータ

実装例

Type: GS2::SeasonRating::CurrentSeasonModelMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  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:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
        "challengePeriodEventId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"
      }
    ]
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/seasonRating"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
seasonRating.NewNamespace(
    &SampleStack,
    "namespace-0001",
    seasonRating.NamespaceOptions{},
).MasterData(
    []seasonRating.SeasonModel{
        seasonRating.NewSeasonModel(
            "season1",
            []seasonRating.TierModel{
                seasonRating.NewTierModel(
                    0,
                    0,
                    -10,
                    20,
                    seasonRating.TierModelOptions{},
                ),
                seasonRating.NewTierModel(
                    30,
                    10,
                    -10,
                    30,
                    seasonRating.TierModelOptions{},
                ),
                seasonRating.NewTierModel(
                    60,
                    20,
                    -20,
                    50,
                    seasonRating.TierModelOptions{},
                ),
                seasonRating.NewTierModel(
                    60,
                    30,
                    -30,
                    60,
                    seasonRating.TierModelOptions{},
                ),
            },
            "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
            seasonRating.SeasonModelOptions{
                ChallengePeriodEventId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"),
            },
        ),
    },
)

println(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"
        ))->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:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    options: new \Gs2Cdk\SeasonRating\Model\Options\SeasonModelOptions(
                        challengePeriodEventId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-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"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.seasonRating.model.SeasonModel(
                    "season1",
                    Arrays.asList(
                        new io.gs2.cdk.seasonRating.model.TierModel(
                            0,
                            0,
                            -10,
                            20        
                        ),
                        new io.gs2.cdk.seasonRating.model.TierModel(
                            30,
                            10,
                            -10,
                            30        
                        ),
                        new io.gs2.cdk.seasonRating.model.TierModel(
                            60,
                            20,
                            -20,
                            50        
                        ),
                        new io.gs2.cdk.seasonRating.model.TierModel(
                            60,
                            30,
                            -30,
                            60        
                        )
                    ),
                    "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    new io.gs2.cdk.seasonRating.model.options.SeasonModelOptions()
                        .withChallengePeriodEventId("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001")
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SeasonRating.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2SeasonRating.Model.SeasonModel[] {
                new Gs2Cdk.Gs2SeasonRating.Model.SeasonModel(
                    name: "season1",
                    tiers: 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    
                        )
                    },
                    experienceModelId: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    options: new Gs2Cdk.Gs2SeasonRating.Model.Options.SeasonModelOptions
                    {
                        challengePeriodEventId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"
                    }
                )
            }
        );
    }
}

Debug.Log(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",
        ).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:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    {
                        challengePeriodEventId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"
                    }
                )
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, season_rating

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        season_rating.Namespace(
            stack=self,
            name="namespace-0001",
        ).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:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level',
                    options=season_rating.SeasonModelOptions(
                        challenge_period_event_id = 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001'
                    ),
                ),
            ],
        )

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

SeasonModel

シーズンモデル

シーズン期間中に適用されるティアー構造とポイント変動ルールを定義するマスターデータです。
各ティアーごとのポイント変動範囲・参加料・ランクアップボーナスを設定し、ポイント管理に使用する Experience モデルを指定します。
実際のポイントおよびティアーのユーザーデータは GS2-Experience によって管理されます。

	型	必須	値の制限	説明
seasonModelId	string	※	~ 1024文字	シーズンモデル GRN ※ サーバーが自動で設定
name	string	✓	~ 128文字	シーズンモデル名シーズンモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadata	string		~ 128文字	メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
tiers	List<TierModel>	✓	1 ~ 100 items	ティアーモデルのリストシーズンのランキングラダーを構成するティアー定義の順序付きリスト。各ティアーは独自のポイント変動ルール（参加料、最小/最大変動量、昇格ボーナス）を定義します。プレイヤーは GS2-Experience で管理される累積ポイントに基づいてティアーを進行します。最小1ティアー、最大100ティアー。
experienceModelId	string	✓	~ 1024文字	経験値モデルID シーズンポイントとティアー進行の管理に使用する GS2-Experience 経験値モデルの GRN。経験値モデルのランク閾値がティアー境界を決定し、経験値がプレイヤーの現在のシーズンポイントを表します。対戦結果によるポイント変動はこの経験値モデルに適用されます。
challengePeriodEventId	string		~ 1024文字	チャレンジ期間イベントID シーズンが対戦可能な期間を定義する GS2-Schedule イベントの GRN。設定した場合、参照先のイベントがアクティブな間のみプレイヤーは対戦に参加できます。未設定の場合、シーズンに期間制限はありません。

TierModel

ティアーモデル

ティアーモデルは、シーズン内の各ティアーにおけるポイント変動ルールを定義するモデルです。
順位に応じたポイント変動範囲、参加料、昇格時ボーナスを設定します。
ポイントの実データは GS2-Experience によって管理されますが、その増減ロジックは TierModel の設定に基づいて決定されます。

	型	必須	値の制限	説明
metadata	string		~ 128文字	メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
raiseRankBonus	int	✓	0 ~ 10000	ランク昇格ボーナスプレイヤーがこのティアーに昇格した際に加算されるボーナスポイントで、即座の降格を防ぐバッファとして機能します。例えば 100 に設定すると、昇格閾値より100ポイント多い状態で新ティアーを開始します。有効範囲: 0〜10000。
entryFee	int	✓	0 ~ 10000	参加料対戦開始前にプレイヤーから差し引かれる参加コストとしてのポイント。この参加料は対戦結果に関わらず常に減算され、対戦プレイにリスク要素を生み出します。有効範囲: 0〜10000。
minimumChangePoint	int	✓	-99999999 ~ -1	最小変動ポイント 1回の対戦結果で発生しうる最小（最も負の）ポイント変動量で、通常は最悪の敗北時の値を表します。負の値である必要があります。敗北プレイヤーの実際のポイント変動はこの値と0の間になります。有効範囲: -99999999〜-1。
maximumChangePoint	int	✓	1 ~ 99999999	最大変動ポイント 1回の対戦結果で発生しうる最大（最も正の）ポイント変動量で、通常は最高の勝利時の値を表します。正の値である必要があります。勝利プレイヤーの実際のポイント変動は0とこの値の間になります。有効範囲: 1〜99999999。