GS2-Chat GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | ネームスペース名 | ||
description | string | ~ 1024文字 | 説明文 | |||
allowCreateRoom | bool | ✓ | true | ゲームプレイヤーによるルームの作成を許可するか | ||
messageLifeTimeDays | int | ✓ | 1 | 1 ~ 30 | メッセージ保持期間 | |
postMessageScript | ScriptSetting | メッセージを投稿したときに実行するスクリプト | ||||
createRoomScript | ScriptSetting | ルームを作成したときに実行するスクリプト | ||||
deleteRoomScript | ScriptSetting | ルームを削除したときに実行するスクリプト | ||||
subscribeRoomScript | ScriptSetting | ルームを購読したときに実行するスクリプト | ||||
unsubscribeRoomScript | ScriptSetting | ルームの購読を解除したときに実行するスクリプト | ||||
postNotification | NotificationSetting | ✓ | 購読しているルームに新しい投稿がきたときのプッシュ通知 | |||
logSetting | LogSetting | ログの出力設定 |
GetAttr
!GetAttrタグで取得可能なリソースの生成結果
型 | 説明 | |
---|---|---|
Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Chat::Namespace
Properties:
Name: namespace-0001
Description: null
AllowCreateRoom: null
MessageLifeTimeDays: null
PostMessageScript: null
CreateRoomScript: null
DeleteRoomScript: null
SubscribeRoomScript: null
UnsubscribeRoomScript: null
PostNotification: 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/chat"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
chat.NewNamespace(
&SampleStack,
"namespace-0001",
chat.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\Chat\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Chat\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.chat.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.chat.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.Gs2Chat.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2Chat.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 chat from "@/gs2cdk/chat";
class SampleStack extends core.Stack
{
public constructor() {
super();
new chat.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, chat
class SampleStack(Stack):
def __init__(self):
super().__init__()
chat.Namespace(
stack=self,
name='namespace-0001',
options=chat.NamespaceOptions(
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Template
CurrentModelMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
Note
JSONファイルの形式については GS2-Chat マスターデータリファレンス をご参照ください。型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | ||||||||
mode | 文字列列挙型 enum { “direct”, “preUpload” } | ✓ | “direct” | ~ 128文字 | 更新モード
| |||||||
settings | string | {mode} == “direct” | ✓ | ~ 5242880文字 | マスターデータ mode が “direct” であれば 必須 | |||||||
uploadToken | string | {mode} == “preUpload” | ✓ | ~ 1024文字 | プレアップロードで取得したトークン mode が “preUpload” であれば 必須 |
GetAttr
!GetAttrタグで取得可能なリソースの生成結果
型 | 説明 | |
---|---|---|
Item | CurrentModelMaster | 更新した現在有効なマスターデータ |
実装例
Type: GS2::Chat::CurrentModelMaster
Properties:
NamespaceName: namespace-0001
Mode: null
Settings: {
"version": "2020-04-30",
"categoryModels": [
{
"category": 0,
"rejectAccessTokenPost": "Disabled"
},
{
"category": 1,
"rejectAccessTokenPost": "Disabled"
}
]
}
UploadToken: null
import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/chat"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
chat.NewNamespace(
&SampleStack,
"namespace-0001",
chat.NamespaceOptions{},
).MasterData(
[]chat.CategoryModel{
chat.NewCategoryModel(
0,
chat.CategoryModelOptions{
RejectAccessTokenPost: chat.CategoryModelRejectAccessTokenPostDisabled.Pointer(),
},
),
chat.NewCategoryModel(
1,
chat.CategoryModelOptions{
RejectAccessTokenPost: chat.CategoryModelRejectAccessTokenPostDisabled.Pointer(),
},
),
},
)
println(SampleStack.Yaml()) // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Chat\Model\Namespace_(
stack: $this,
name: "namespace-0001"
))->masterData(
[
new \Gs2Cdk\Chat\Model\CategoryModel(
category:0,
options: new \Gs2Cdk\Chat\Model\Options\CategoryModelOptions(
rejectAccessTokenPost:Gs2Cdk\Chat\Model\Enums\CategoryModelRejectAccessTokenPost::DISABLED
)
),
new \Gs2Cdk\Chat\Model\CategoryModel(
category:1,
options: new \Gs2Cdk\Chat\Model\Options\CategoryModelOptions(
rejectAccessTokenPost:Gs2Cdk\Chat\Model\Enums\CategoryModelRejectAccessTokenPost::DISABLED
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.chat.model.Namespace(
this,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.chat.model.CategoryModel(
0,
new io.gs2.cdk.chat.model.options.CategoryModelOptions()
.withRejectAccessTokenPost(io.gs2.cdk.chat.model.enums.CategoryModelRejectAccessTokenPost.DISABLED)
),
new io.gs2.cdk.chat.model.CategoryModel(
1,
new io.gs2.cdk.chat.model.options.CategoryModelOptions()
.withRejectAccessTokenPost(io.gs2.cdk.chat.model.enums.CategoryModelRejectAccessTokenPost.DISABLED)
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Chat.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Chat.Model.CategoryModel[] {
new Gs2Cdk.Gs2Chat.Model.CategoryModel(
category: 0,
options: new Gs2Cdk.Gs2Chat.Model.Options.CategoryModelOptions
{
rejectAccessTokenPost = Gs2Cdk.Gs2Chat.Model.Enums.CategoryModelRejectAccessTokenPost.Disabled
}
),
new Gs2Cdk.Gs2Chat.Model.CategoryModel(
category: 1,
options: new Gs2Cdk.Gs2Chat.Model.Options.CategoryModelOptions
{
rejectAccessTokenPost = Gs2Cdk.Gs2Chat.Model.Enums.CategoryModelRejectAccessTokenPost.Disabled
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
import core from "@/gs2cdk/core";
import chat from "@/gs2cdk/chat";
class SampleStack extends core.Stack
{
public constructor() {
super();
new chat.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new chat.model.CategoryModel(
0,
{
rejectAccessTokenPost: chat.model.CategoryModelRejectAccessTokenPost.DISABLED
}
),
new chat.model.CategoryModel(
1,
{
rejectAccessTokenPost: chat.model.CategoryModelRejectAccessTokenPost.DISABLED
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, chat
class SampleStack(Stack):
def __init__(self):
super().__init__()
chat.Namespace(
stack=self,
name="namespace-0001",
).master_data(
category_models=[
chat.CategoryModel(
category=0,
options=chat.CategoryModelOptions(
reject_access_token_post = chat.CategoryModelRejectAccessTokenPost.DISABLED
),
),
chat.CategoryModel(
category=1,
options=chat.CategoryModelOptions(
reject_access_token_post = chat.CategoryModelRejectAccessTokenPost.DISABLED
),
),
],
)
print(SampleStack().yaml()) # Generate Template
NotificationType
通知タイプ
新着メッセージ通知を受け取るカテゴリの設定
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
category | int | ✓ | 0 | ~ 2147483646 | 新着メッセージ通知を受け取るカテゴリ | |
enableTransferMobilePushNotification | bool | ✓ | false | オフラインだった時にモバイルプッシュ通知に転送するか |
ScriptSetting
スクリプト設定
GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。
スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることができます。
一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。
かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。
しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。
非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
triggerScriptId | string | ~ 1024文字 | 同期実行スクリプトの GS2-Script のスクリプトGRN | |||||||||||
doneTriggerTargetType | 文字列列挙型 enum { “none”, “gs2_script”, “aws” } | ✓ | “none” | ~ 128文字 | 非同期スクリプトの実行方法
| |||||||||
doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | 非同期実行スクリプトの GS2-Script のスクリプトGRN doneTriggerTargetType が “gs2_script” であれば有効 | ||||||||||
doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | 非同期実行スクリプトを実行する GS2-JobQueue ネームスペース doneTriggerTargetType が “gs2_script” であれば有効 |
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文字 | モバイルプッシュ通知で使用するサウンドファイル名 enableTransferMobileNotification が true であれば有効 |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子(Namespace ID)を保持します。
ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。
この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。
GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
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文字 | コミットハッシュ referenceType が “commit_hash” であれば必須 | |||||||||
branchName | string | {referenceType} == “branch” | ✓ | ~ 1024文字 | ブランチ名 referenceType が “branch” であれば必須 | |||||||||
tagName | string | {referenceType} == “tag” | ✓ | ~ 1024文字 | タグ名 referenceType が “tag” であれば必須 |