Master Data Reference of GS2-Inbox
{
"version": "2020-03-12",
"globalMessages": [
{
"name": "[string]Name of message for all users",
"metadata": "[string]Metadata corresponding to the content of the message to all users",
"readAcquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON of request"
}
],
"expiresTimeSpan": {
"days": "[int]Number of days from current time",
"hours": "[int]Hours from current time",
"minutes": "[int]Minutes from current time"
},
"messageReceptionPeriodEventId": "[string?]GS2-Schedule event GRN that sets the time period during which the message can be received"
}
]
}
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| version | ✓ | 2020-03-12 | Format version of master data | |||
| globalMessages | List<GlobalMessage> | ~ 1000 items | Global Messages |
GlobalMessage
Global Messages
Global messages are a mechanism for delivering messages to all game players.
Global messages can have an expiration date, and each game player can receive a global message by executing the process of receiving a global message. Unreceived global messages within the validity period are copied to your message box.
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| globalMessageId | string | ✓ | ~ 1024 chars | Message GRN to all users | ||
| name | string | ✓ | ~ 128 chars | Name of message for all users | ||
| metadata | string | ✓ | ~ 4096 chars | Metadata corresponding to the content of the message to all users | ||
| readAcquireActions | List<AcquireAction> | [] | ~ 100 items | Acquisition actions to be performed upon opening | ||
| expiresTimeSpan | TimeSpan | The period of time between receipt of a message and deletion of the message | ||||
| messageReceptionPeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN that sets the time period during which the message can be received |
TimeSpan
Time Interval
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| days | int | ✓ | 0 | ~ 365 | Number of days from current time | |
| hours | int | ✓ | 0 | ~ 24 | Hours from current time | |
| minutes | int | ✓ | 0 | ~ 60 | Minutes from current time |
AcquireAction
Acquire Action
VerifyActionResult
Verify action execution result
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the verify task | ||
| verifyRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
| statusCode | int | ~ 999 | Status code | |||
| verifyResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
| Enumerator String Definition | Description |
|---|
ConsumeActionResult
Consume action execution result
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the consume action | ||
| consumeRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
| statusCode | int | ~ 999 | Status code | |||
| consumeResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
| Enumerator String Definition | Description |
|---|
AcquireActionResult
Acquire action execution result
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the acquire action | ||
| acquireRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
| statusCode | int | ~ 999 | Status code | |||
| acquireResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
| Enumerator String Definition | Description |
|---|
TransactionResult
Transaction execution results
Transaction execution results executed using server-side transaction auto-execution functionality
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| transactionId | string | ✓ | 36 ~ 36 chars | Transaction ID | ||
| verifyResults | List<VerifyActionResult> | ~ 10 items | List of verify action execution results | |||
| consumeResults | List<ConsumeActionResult> | ~ 10 items | List of consume action execution results | |||
| acquireResults | List<AcquireActionResult> | ~ 100 items | List of acquire action execution results |