GS2-Inbox
Reference to resource definitions available in GS2-Deploy templates
GS2-Deploy Reference
Entities
Namespace
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,
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"
)
}
);
}
}
System.out.println(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
Namespace
Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project.
Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.
Therefore, it is necessary to create a namespace before starting to use each service.
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 32 chars | Namespace name | |
| description | string | ~ 1024 chars | description of Namespace | ||
| isAutomaticDeletingEnabled | bool | Automatically delete opened messages | |||
| transactionSetting | TransactionSetting | Transaction settings | |||
| receiveMessageScript | ScriptSetting | Script to run when a message is received | |||
| readMessageScript | ScriptSetting | Script to run when a message is opened | |||
| deleteMessageScript | ScriptSetting | Script to run when a message is deleted | |||
| receiveNotification | NotificationSetting | Push notifications when messages are received | |||
| logSetting | LogSetting | Log output settings |
CurrentMessageMaster
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,
# omission
).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,
// omission
))->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,
// omission
).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,
// omission
).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
}
)
]
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Inbox.Model.Namespace(
this,
// omission
).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
Currently available master data
GS2 uses JSON format files for master data management.
By uploading the file, you can actually reflect the settings on the server.
We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the
The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.
Please refer to the documentation for the format of the JSON file.
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 32 chars | Namespace name | |
| settings | string | ✓ | ~ 5242880 chars | Master data |