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

エンティティ

Namespace

ネームスペース

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

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

	型	必須	値の制限	説明
name	string	✓	~ 32文字	ネームスペース名
description	string		~ 1024文字	説明文
isAutomaticDeletingEnabled	bool			開封したメッセージを自動的に削除するか
transactionSetting	TransactionSetting			トランザクション設定
receiveMessageScript	ScriptSetting			メッセージ受信したときに実行するスクリプト
readMessageScript	ScriptSetting			メッセージ開封したときに実行するスクリプト
deleteMessageScript	ScriptSetting			メッセージ削除したときに実行するスクリプト
receiveNotification	NotificationSetting			メッセージを受信したときのプッシュ通知
logSetting	LogSetting			ログの出力設定

GetAttr

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

実装例

Type: GS2::Inbox::Namespace
Properties:
  Name: namespace1
  Description: null
  IsAutomaticDeletingEnabled: 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
  ReceiveMessageScript: null
  ReadMessageScript: null
  DeleteMessageScript: null
  ReceiveNotification: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

from gs2_cdk import Stack, core, inbox

class SampleStack(Stack):

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

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

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

CurrentMessageMaster

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

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

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

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

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

GetAttr

	型	説明
Item	CurrentMessageMaster	更新した現在有効なグローバルメッセージ設定

実装例

Type: GS2::Inbox::CurrentMessageMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2020-03-12",
    "globalMessages": [
      {
        "name": "message-0001",
        "metadata": "hoge"
      },
      {
        "name": "message-0002",
        "metadata": "fuga",
        "readAcquireActions": [
          {
            "action": "Gs2Inventory:AcquireItemSetByUserId",
            "request": "Gs2Inventory:AcquireItemSetByUserId-request"
          }
        ],
        "expiresTimeSpan": {
          "days": 1,
          "hours": 2,
          "minutes": 3
        }
      },
      {
        "name": "message-0003",
        "metadata": "piyo",
        "expiresAt": 1000
      }
    ]
  }

from gs2_cdk import Stack, core, inbox

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        inbox.Namespace(
            stack=self,
            # 省略
        ).master_data(
            [
                inbox.GlobalMessage(
                    name='message-0001',
                    metadata='hoge',
                ),
                inbox.GlobalMessage(
                    name='message-0002',
                    metadata='fuga',
                    options=inbox.GlobalMessageOptions(
                        read_acquire_actions=[    {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId-request'},
                            ],
                        expires_time_span={'days': 1, 'hours': 2, 'minutes': 3},
                    ),
                ),
                inbox.GlobalMessage(
                    name='message-0003',
                    metadata='piyo',
                    options=inbox.GlobalMessageOptions(
                        expires_at=1000,
                    ),
                ),
            ],
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Inbox\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Inbox\Model\GlobalMessage(
                    name:"message-0001",
                    metadata:"hoge",
                ),
                new \Gs2Cdk\Inbox\Model\GlobalMessage(
                    name:"message-0002",
                    metadata:"fuga",
                    options: new \Gs2Cdk\Inbox\Model\Options\GlobalMessageOptions(
                        readAcquireActions:[    {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId-request'},
                        ],
                        expiresTimeSpan:{'days': 1, 'hours': 2, 'minutes': 3},
                    ),
                ),
                new \Gs2Cdk\Inbox\Model\GlobalMessage(
                    name:"message-0003",
                    metadata:"piyo",
                    options: new \Gs2Cdk\Inbox\Model\Options\GlobalMessageOptions(
                        expiresAt:1000,
                    ),
                ),
            ],
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.inbox.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.inbox.model.GlobalMessage(
                    "message-0001",
                    "hoge"
                ),
                new io.gs2.cdk.inbox.model.GlobalMessage(
                    "message-0002",
                    "fuga",
                    new io.gs2.cdk.inbox.model.options.GlobalMessageOptions() {
                        {
                            readAcquireActions: Arrays.asList(
                                {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId-request'}
                            );
                            expiresTimeSpan: {'days': 1, 'hours': 2, 'minutes': 3};
                        }
                    }
                ),
                new io.gs2.cdk.inbox.model.GlobalMessage(
                    "message-0003",
                    "piyo",
                    new io.gs2.cdk.inbox.model.options.GlobalMessageOptions() {
                        {
                            expiresAt: 1000L;
                        }
                    }
                )
            )
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new inbox.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new inbox.model.GlobalMessage(
                    "message-0001",
                    "hoge"
                ),
                new inbox.model.GlobalMessage(
                    "message-0002",
                    "fuga",
                    {
                        readAcquireActions: [
                                {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId-request'}
                            ],
                        expiresTimeSpan: {'days': 1, 'hours': 2, 'minutes': 3}
                    }
                ),
                new inbox.model.GlobalMessage(
                    "message-0003",
                    "piyo",
                    {
                        expiresAt: 1000
                    }
                )
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Inbox.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
                    "message-0001",
                    "hoge"
                ),
                new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
                    "message-0002",
                    "fuga",
                    new Gs2Cdk.Gs2Inbox.Model.Options.GlobalMessageOptions {
                        readAcquireActions = new Gs2Cdk.Gs2Inbox.Model.AcquireAction[] {
                            {'action': 'Gs2Inventory:AcquireItemSetByUserId', 'request': 'Gs2Inventory:AcquireItemSetByUserId-request'}
                        },
                        expiresTimeSpan = {'days': 1, 'hours': 2, 'minutes': 3},
                    }
                ),
                new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
                    "message-0003",
                    "piyo",
                    new Gs2Cdk.Gs2Inbox.Model.Options.GlobalMessageOptions {
                        expiresAt = 1000L,
                    }
                )
            }
        );
    }
}

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

TimeSpan

時間間隔

	型	必須	値の制限	説明
days	int	✓	~ 365	現在時刻からの日数
hours	int	✓	~ 24	現在時刻からの時間
minutes	int	✓	~ 60	現在時刻からの分

AcquireAction

入手アクション

	型	必須	デフォルト	値の制限	説明
action	enum [ "Gs2AdReward:AcquirePointByUserId", "Gs2Dictionary:AddEntriesByUserId", "Gs2Enchant:ReDrawBalanceParameterStatusByUserId", "Gs2Enchant:SetBalanceParameterStatusByUserId", "Gs2Enchant:ReDrawRarityParameterStatusByUserId", "Gs2Enchant:AddRarityParameterStatusByUserId", "Gs2Enchant:SetRarityParameterStatusByUserId", "Gs2Enhance:DirectEnhanceByUserId", "Gs2Enhance:UnleashByUserId", "Gs2Enhance:CreateProgressByUserId", "Gs2Exchange:ExchangeByUserId", "Gs2Exchange:IncrementalExchangeByUserId", "Gs2Exchange:UnlockIncrementalExchangeByUserId", "Gs2Exchange:CreateAwaitByUserId", "Gs2Exchange:SkipByUserId", "Gs2Experience:AddExperienceByUserId", "Gs2Experience:SetExperienceByUserId", "Gs2Experience:AddRankCapByUserId", "Gs2Experience:SetRankCapByUserId", "Gs2Experience:MultiplyAcquireActionsByUserId", "Gs2Formation:AddMoldCapacityByUserId", "Gs2Formation:SetMoldCapacityByUserId", "Gs2Formation:AcquireActionsToFormProperties", "Gs2Formation:SetFormByUserId", "Gs2Formation:AcquireActionsToPropertyFormProperties", "Gs2Grade:AddGradeByUserId", "Gs2Grade:ApplyRankCapByUserId", "Gs2Grade:MultiplyAcquireActionsByUserId", "Gs2Idle:IncreaseMaximumIdleMinutesByUserId", "Gs2Idle:SetMaximumIdleMinutesByUserId", "Gs2Inbox:SendMessageByUserId", "Gs2Inventory:AddCapacityByUserId", "Gs2Inventory:SetCapacityByUserId", "Gs2Inventory:AcquireItemSetByUserId", "Gs2Inventory:AcquireItemSetWithGradeByUserId", "Gs2Inventory:AddReferenceOfByUserId", "Gs2Inventory:DeleteReferenceOfByUserId", "Gs2Inventory:AcquireSimpleItemsByUserId", "Gs2Inventory:SetSimpleItemsByUserId", "Gs2Inventory:AcquireBigItemByUserId", "Gs2Inventory:SetBigItemByUserId", "Gs2JobQueue:PushByUserId", "Gs2Limit:CountDownByUserId", "Gs2Limit:DeleteCounterByUserId", "Gs2LoginReward:DeleteReceiveStatusByUserId", "Gs2LoginReward:UnmarkReceivedByUserId", "Gs2Lottery:DrawByUserId", "Gs2Lottery:ResetBoxByUserId", "Gs2Mission:RevertReceiveByUserId", "Gs2Mission:IncreaseCounterByUserId", "Gs2Money:DepositByUserId", "Gs2Money:RevertRecordReceipt", "Gs2Quest:CreateProgressByUserId", "Gs2Schedule:TriggerByUserId", "Gs2SerialKey:RevertUseByUserId", "Gs2Showcase:DecrementPurchaseCountByUserId", "Gs2Showcase:ForceReDrawByUserId", "Gs2SkillTree:MarkReleaseByUserId", "Gs2Stamina:RecoverStaminaByUserId", "Gs2Stamina:RaiseMaxValueByUserId", "Gs2Stamina:SetMaxValueByUserId", "Gs2Stamina:SetRecoverIntervalByUserId", "Gs2Stamina:SetRecoverValueByUserId", "Gs2StateMachine:StartStateMachineByUserId", ]	✓		~ 128文字	スタンプシートを使用して実行するアクションの種類
request	string	✓		~ 1048576文字	リクエストのJSON

Config

コンフィグ設定

スタンプシートの変数に適用する設定値

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

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

NotificationSetting

プッシュ通知に関する設定

GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。

GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。

	型	必須	デフォルト	値の制限	説明
gatewayNamespaceId	string	✓	“grn:gs2:{region}:{ownerId}:gateway:default”	~ 1024文字	プッシュ通知に使用する GS2-Gateway のネームスペース
enableTransferMobileNotification	bool?		false		モバイルプッシュ通知へ転送するか
sound	string	{enableTransferMobileNotification} == true		~ 1024文字	モバイルプッシュ通知で使用するサウンドファイル名

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

LogSetting

ログの書き出し設定

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

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

TransactionSetting

トランザクション設定

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