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

エンティティ

Namespace

ネームスペース

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

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

	型	必須	値の制限	説明
name	string	✓	~ 32文字	ネームスペース名
description	string		~ 1024文字	説明文
transactionSetting	TransactionSetting	✓		トランザクション設定
receiveScript	ScriptSetting			報酬を受け取ったときに実行するスクリプト
logSetting	LogSetting			ログの出力設定

GetAttr

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

実装例

Type: GS2::Idle::Namespace
Properties:
  Name: namespace1
  Description: null
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  ReceiveScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

from gs2_cdk import Stack, core, idle

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        idle.Namespace(
            stack=self,
            name="namespace-0001",
            transaction_setting=core.TransactionSetting(
                enable_auto_run=False,
                options=core.TransactionSettingOptions(
                    distributor_namespace_id=,
                    key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
                    queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                )
            ),
            options=idle.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\Idle\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                enableAutoRun: False,
                options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                    distributorNamespaceId: ,
                    keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                )
            ),
            options: new \Gs2Cdk\Idle\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.idle.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.core.model.TransactionSetting(
                false,
                new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                )
            ),
            new io.gs2.cdk.idle.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 idle from "@/gs2cdk/idle";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new idle.model.Namespace(
            this,
            "namespace-0001",
            new core.TransactionSetting(
                false,
                {
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-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.Gs2Idle.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Core.Model.TransactionSetting(
                false,
                new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                    DistributorNamespaceId = ,
                    KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    QueueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                }
            ),
            new Gs2Cdk.Gs2Idle.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

CurrentCategoryMaster

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

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

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

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

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

GetAttr

	型	説明
Item	CurrentCategoryMaster	更新した現在有効なカテゴリー設定

実装例

Type: GS2::Idle::CurrentCategoryMaster
Properties:
  NamespaceName: namespace1
  Settings: {"version": "2023-06-06", "categoryModels": [{"name": "category-0001", "rewardIntervalMinutes": 5, "defaultMaximumIdleMinutes": 1440, "acquireActions": [{"acquireActions": [{"action": "ca", "request": {"namespaceName": "namespace-0001", "experienceName": "player", "userId": "#{userId}", "propertyId": "player", "experienceValue": 10}}]}, {"acquireActions": [{"action": "Gs2Experience:AddExperienceByUserId", "request": {"namespaceName": "namespace-0001", "experienceName": "player", "userId": "#{userId}", "propertyId": "player", "experienceValue": 5}}]}]}, {"name": "category-0002", "rewardIntervalMinutes": 5, "defaultMaximumIdleMinutes": 1440, "acquireActions": [{"acquireActions": [{"action": "Gs2Experience:AddExperienceByUserId", "request": {"namespaceName": "namespace-0001", "experienceName": "player", "userId": "#{userId}", "propertyId": "player", "experienceValue": 10}}]}, {"acquireActions": [{"action": "Gs2Experience:AddExperienceByUserId", "request": {"namespaceName": "namespace-0001", "experienceName": "player", "userId": "#{userId}", "propertyId": "player", "experienceValue": 5}}]}], "idlePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace1:event:event-0001", "receivePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace1:event:event-0002"}]}

from gs2_cdk import Stack, core, idle

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        idle.Namespace(
            stack=self,
            # 省略
        ).master_data(
            [
                idle.CategoryModel(
                    name='category-0001',
                    reward_interval_minutes=5,
                    default_maximum_idle_minutes=1440,
                    acquire_actions=[    {'acquireActions': [{'action': 'ca', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                        {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]},
                        ],
                ),
                idle.CategoryModel(
                    name='category-0002',
                    reward_interval_minutes=5,
                    default_maximum_idle_minutes=1440,
                    acquire_actions=[    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                        {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]},
                        ],
                    options=idle.CategoryModelOptions(
                        idle_period_schedule_id='grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001',
                        receive_period_schedule_id='grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002',
                    ),
                ),
            ],
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Idle\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Idle\Model\CategoryModel(
                    name:"category-0001",
                    rewardIntervalMinutes:5,
                    defaultMaximumIdleMinutes:1440,
                    acquireActions:[    {'acquireActions': [{'action': 'ca', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]},
                    ],
                ),
                new \Gs2Cdk\Idle\Model\CategoryModel(
                    name:"category-0002",
                    rewardIntervalMinutes:5,
                    defaultMaximumIdleMinutes:1440,
                    acquireActions:[    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]},
                    ],
                    options: new \Gs2Cdk\Idle\Model\Options\CategoryModelOptions(
                        idlePeriodScheduleId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
                        receivePeriodScheduleId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002",
                    ),
                ),
            ],
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.idle.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.idle.model.CategoryModel(
                    "category-0001",
                    5,
                    1440,
                    Arrays.asList(
                        {'acquireActions': [{'action': 'ca', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]}
                    )
                ),
                new io.gs2.cdk.idle.model.CategoryModel(
                    "category-0002",
                    5,
                    1440,
                    Arrays.asList(
                        {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]}
                    ),
                    new io.gs2.cdk.idle.model.options.CategoryModelOptions() {
                        {
                            idlePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001";
                            receivePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002";
                        }
                    }
                )
            )
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new idle.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new idle.model.CategoryModel(
                    "category-0001",
                    5,
                    1440,
                    [
                        {'acquireActions': [{'action': 'ca', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]}
                    ]
                ),
                new idle.model.CategoryModel(
                    "category-0002",
                    5,
                    1440,
                    [
                        {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]}
                    ],
                    {
                        idlePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
                        receivePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
                    }
                )
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Idle.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Idle.Model.CategoryModel(
                    "category-0001",
                    5,
                    1440,
                    new Gs2Cdk.Gs2Idle.Model.AcquireActionList[] {
                        {'acquireActions': [{'action': 'ca', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]}
                    }
                ),
                new Gs2Cdk.Gs2Idle.Model.CategoryModel(
                    "category-0002",
                    5,
                    1440,
                    new Gs2Cdk.Gs2Idle.Model.AcquireActionList[] {
                        {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 10}}]},
                    {'acquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': {'namespaceName': 'namespace-0001', 'experienceName': 'player', 'userId': '#{userId}', 'propertyId': 'player', 'experienceValue': 5}}]}
                    },
                    new Gs2Cdk.Gs2Idle.Model.Options.CategoryModelOptions {
                        idlePeriodScheduleId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
                        receivePeriodScheduleId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002",
                    }
                )
            }
        );
    }
}

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

Config

	型	必須	デフォルト	値の制限	説明
key	string	✓		~ 64文字	名前
value	string			~ 51200文字	値

AcquireAction

	型	必須	デフォルト	値の制限	説明
action	enum []	✓		~ 128文字	スタンプシートを使用して実行するアクションの種類
request	string	✓		~ 1048576文字	リクエストのJSON

AcquireActionList

	型	必須	デフォルト	値の制限	説明
acquireActions	List<AcquireAction>				入手アクションリスト

TransactionSetting

	型	必須	デフォルト	値の制限	説明
enableAutoRun	bool	✓	false		発行したスタンプシートをサーバーサイドで自動的に実行するか
distributorNamespaceId	string	{enableAutoRun}		~ 1024文字	スタンプシートの実行に使用する GS2-Distributor ネームスペース
keyId	string	!{enableAutoRun}		~ 1024文字	スタンプシートの署名に使用する GS2-Key の暗号鍵
queueNamespaceId	string			~ 1024文字	スタンプシートの実行に使用する GS2-JobQueue のネームスペース

ScriptSetting

	型	必須	デフォルト	値の制限	説明
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

LogSetting

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

GitHubCheckoutSetting

	型	必須	値の制限	説明
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文字	タグ名