GS2-Inbox GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
GetAttr
実装例
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,
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',
)
),
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,
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",
)
),
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,
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"
)
);
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: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.Gs2Inbox.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Inbox.Model.Options.NamespaceOptions {
transactionSetting = 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"
}
),
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
実装例
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 | ✓ | 0 | ~ 365 | 現在時刻からの日数 |
hours | int | ✓ | 0 | ~ 24 | 現在時刻からの時間 |
minutes | int | ✓ | 0 | ~ 60 | 現在時刻からの分 |
AcquireAction
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
action | enum [] | ✓ | | ~ 128文字 | スタンプシートを使用して実行するアクションの種類 |
request | string | ✓ | | ~ 1048576文字 | リクエストのJSON |
Config
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
key | string | ✓ | | ~ 64文字 | 名前 |
value | string | | | ~ 51200文字 | 値 |
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 |
NotificationSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
gatewayNamespaceId | string | ✓ | | ~ 1024文字 | ネームスペースGRN |
enableTransferMobileNotification | bool? | | | | モバイルプッシュ通知へ転送するか |
sound | string | | | ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名 |
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文字 | タグ名 |
LogSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
loggingNamespaceId | string | ✓ | | ~ 1024文字 | ネームスペースGRN |
TransactionSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
enableAutoRun | bool | ✓ | false | | 発行したスタンプシートをサーバーサイドで自動的に実行するか |
distributorNamespaceId | string | {enableAutoRun} | | ~ 1024文字 | スタンプシートの実行に使用する GS2-Distributor ネームスペース |
keyId | string | !{enableAutoRun} | | ~ 1024文字 | スタンプシートの署名に使用する GS2-Key の暗号鍵 |
queueNamespaceId | string | | | ~ 1024文字 | スタンプシートの実行に使用する GS2-JobQueue のネームスペース |