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

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

エンティティ

Deploy処理で操作する対象リソース

Namespace

ネームスペース

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

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

Request

リソースの生成リクエスト

型有効化条件必須デフォルト値の制限説明
namestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
descriptionstring~ 1024文字説明文
transactionSettingTransactionSettingトランザクション設定
countUpScriptScriptSettingカウントアップするときに実行するスクリプトの設定
logSettingLogSettingログの出力設定

GetAttr

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

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

実装例

Type: GS2::Limit::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  CountUpScript: 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/limit"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
limit.NewNamespace(
    &SampleStack,
    "namespace-0001",
    limit.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\Limit\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Limit\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.limit.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.limit.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.Gs2Limit.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Limit.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 limit from "@/gs2cdk/limit";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new limit.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, limit

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        limit.Namespace(
            stack=self,
            name='namespace-0001',
            options=limit.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

TransactionSetting

トランザクション設定

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

型有効化条件必須デフォルト値の制限説明
enableAutoRunbool
✓
false発行したトランザクションをサーバーサイドで自動的に実行するか
enableAtomicCommitbool{enableAutoRun} == true
✓*
falseトランザクションの実行をアトミックにコミットするか
※ enableAutoRun が true であれば 必須
transactionUseDistributorbool{enableAtomicCommit} == true
✓*
falseトランザクションを非同期処理で実行する
※ enableAtomicCommit が true であれば 必須
commitScriptResultInUseDistributorbool{transactionUseDistributor} == true
✓*
falseスクリプトの結果コミット処理を非同期処理で実行するか
※ transactionUseDistributor が true であれば 必須
acquireActionUseJobQueuebool{enableAtomicCommit} == true
✓*
false入手アクションを実行する際に GS2-JobQueue を使用するか
※ enableAtomicCommit が true であれば 必須
distributorNamespaceIdstring
✓
“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字トランザクションの実行に使用する GS2-Distributor ネームスペース GRN
queueNamespaceIdstring
✓
“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字トランザクションの実行に使用する GS2-JobQueue のネームスペース GRN

ScriptSetting

スクリプト設定

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

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

一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。

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

型有効化条件必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字同期実行する GS2-Script のスクリプト GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。
doneTriggerTargetType文字列列挙型
enum {
  “none”,
  “gs2_script”,
  “aws”
}
✓
“none”非同期スクリプトの実行方法
非同期実行で使用するスクリプトの種類を指定します。
「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。
定義説明
“none”なし
“gs2_script”GS2-Script
“aws”Amazon EventBridge
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字非同期実行する GS2-Script スクリプト GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

※ doneTriggerTargetType が “gs2_script” であれば 有効
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字非同期実行スクリプトを実行する GS2-JobQueue ネームスペース GRN
非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。
GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。

※ doneTriggerTargetType が “gs2_script” であれば 有効

LogSetting

ログの書き出し設定

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

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

CurrentLimitMaster

引き継ぎ情報モデルマスターデータ

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

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

Request

リソースの生成リクエスト

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
mode文字列列挙型
enum {
  “direct”,
  “preUpload”
}
✓
“direct”更新モード
定義説明
“direct”マスターデータを直接更新
“preUpload”マスターデータをアップロードしてから更新
settingsstring{mode} == “direct”
✓*
~ 5242880文字マスターデータ
※ mode が “direct” であれば必須
uploadTokenstring{mode} == “preUpload”
✓*
~ 1024文字事前アップロードで取得したトークン
アップロードしたマスターデータを適用するために使用されます。

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

GetAttr

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

型説明
ItemCurrentLimitMaster更新した現在アクティブな回数制限モデルのマスターデータ

実装例

Type: GS2::Limit::CurrentLimitMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2019-04-05",
    "limitModels": [
      {
        "name": "daily",
        "resetType": "daily",
        "metadata": "DAILY",
        "resetHour": 9
      },
      {
        "name": "weekly",
        "resetType": "weekly",
        "metadata": "WEEKLY",
        "resetDayOfWeek": "sunday",
        "resetHour": 18
      }
    ]
  }
  UploadToken: null
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/limit"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
limit.NewNamespace(
    &SampleStack,
    "namespace-0001",
    limit.NamespaceOptions{},
).MasterData(
    []limit.LimitModel{
        limit.NewLimitModel(
            "daily",
            limit.LimitModelResetTypeDaily,
            limit.LimitModelOptions{
                Metadata: pointy.String("DAILY"),
                ResetHour: pointy.Int32(9),
            },
        ),
        limit.NewLimitModel(
            "weekly",
            limit.LimitModelResetTypeWeekly,
            limit.LimitModelOptions{
                Metadata: pointy.String("WEEKLY"),
                ResetDayOfWeek: limit.LimitModelResetDayOfWeekSunday.Pointer(),
                ResetHour: pointy.Int32(18),
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Limit\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"daily",
                    resetType: \Gs2Cdk\Limit\Model\Enums\LimitModelResetType::DAILY,
                    options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
                        metadata:"DAILY",
                        resetHour:9
                    )
                ),
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"weekly",
                    resetType: \Gs2Cdk\Limit\Model\Enums\LimitModelResetType::WEEKLY,
                    options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
                        metadata:"WEEKLY",
                        resetDayOfWeek:Gs2Cdk\Limit\Model\Enums\LimitModelResetDayOfWeek::SUNDAY,
                        resetHour:18
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.limit.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.limit.model.LimitModel(
                    "daily",
                    io.gs2.cdk.limit.model.enums.LimitModelResetType.DAILY,
                    new io.gs2.cdk.limit.model.options.LimitModelOptions()
                        .withMetadata("DAILY")
                        .withResetHour(9)
                ),
                new io.gs2.cdk.limit.model.LimitModel(
                    "weekly",
                    io.gs2.cdk.limit.model.enums.LimitModelResetType.WEEKLY,
                    new io.gs2.cdk.limit.model.options.LimitModelOptions()
                        .withMetadata("WEEKLY")
                        .withResetDayOfWeek(io.gs2.cdk.limit.model.enums.LimitModelResetDayOfWeek.SUNDAY)
                        .withResetHour(18)
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Limit.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Limit.Model.LimitModel[] {
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    name: "daily",
                    resetType: Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetType.Daily,
                    options: new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions
                    {
                        metadata = "DAILY",
                        resetHour = 9
                    }
                ),
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    name: "weekly",
                    resetType: Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetType.Weekly,
                    options: new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions
                    {
                        metadata = "WEEKLY",
                        resetDayOfWeek = Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetDayOfWeek.Sunday,
                        resetHour = 18
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template
import core from "@/gs2cdk/core";
import limit from "@/gs2cdk/limit";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new limit.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new limit.model.LimitModel(
                    "daily",
                    limit.model.LimitModelResetType.DAILY,
                    {
                        metadata: "DAILY",
                        resetHour: 9
                    }
                ),
                new limit.model.LimitModel(
                    "weekly",
                    limit.model.LimitModelResetType.WEEKLY,
                    {
                        metadata: "WEEKLY",
                        resetDayOfWeek: limit.model.LimitModelResetDayOfWeek.SUNDAY,
                        resetHour: 18
                    }
                )
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, limit

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        limit.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            limit_models=[
                limit.LimitModel(
                    name='daily',
                    reset_type=limit.LimitModelResetType.DAILY,
                    options=limit.LimitModelOptions(
                        metadata = 'DAILY',
                        reset_hour = 9
                    ),
                ),
                limit.LimitModel(
                    name='weekly',
                    reset_type=limit.LimitModelResetType.WEEKLY,
                    options=limit.LimitModelOptions(
                        metadata = 'WEEKLY',
                        reset_day_of_week = limit.LimitModelResetDayOfWeek.SUNDAY,
                        reset_hour = 18
                    ),
                ),
            ],
        )

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

LimitModel

回数制限モデル

回数制限には、使用回数をリセットするタイミングを設定できます。
リセット間隔は 「毎日」「毎週」「毎月」「リセットしない」「一定日数」の 5 種類から選択できます。

また、回数制限の最大値はマスターデータ側では固定しません。
これは、ゲーム内のコンテキストに応じて、許可される最大回数を動的に変化させるためです。
たとえばステップアップガチャのように、

  • 購入回数カウンターが 3 回未満 の場合に購入できる商品
  • 上記の商品が購入できない場合に、購入回数カウンターが 5 回未満 なら購入できる別の商品

といったように、状況に応じて「最大回数」を切り替えられる設計を想定しています。

型有効化条件必須デフォルト値の制限説明
limitModelIdstring
✓*
~ 1024文字回数制限モデル GRN
※ サーバー側で自動的に設定
namestring
✓
~ 128文字回数制限モデル名
回数制限モデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadatastring~ 2048文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
resetType文字列列挙型
enum {
  “notReset”,
  “daily”,
  “weekly”,
  “monthly”,
  “days”
}
✓
リセットタイミング
定義説明
“notReset”リセットしない
“daily”毎日
“weekly”毎週
“monthly”毎月
“days”一定日数
resetDayOfMonthint{resetType} == “monthly”
✓*
1 ~ 31リセットをする日にち（月の日数を超える場合は、最終日として扱われます）
※ resetType が “monthly” であれば 必須
resetDayOfWeek文字列列挙型
enum {
  “sunday”,
  “monday”,
  “tuesday”,
  “wednesday”,
  “thursday”,
  “friday”,
  “saturday”
}
{resetType} == “weekly”
✓*
リセットする曜日
定義説明
“sunday”日曜日
“monday”月曜日
“tuesday”火曜日
“wednesday”水曜日
“thursday”木曜日
“friday”金曜日
“saturday”土曜日

※ resetType が “weekly” であれば 必須
resetHourint{resetType} in [“monthly”, “weekly”, “daily”]
✓*
0 ~ 23リセット時刻
※ resetType が “monthly”,“weekly”,“daily"であれば 必須
anchorTimestamplong{resetType} == “days”
✓*
経過日数のカウントをする基準日時
UNIX 時間・ミリ秒

※ resetType が “days” であれば 必須
daysint{resetType} == “days”
✓*
1 ~ 2147483646リセットする日数
※ resetType が “days” であれば 必須