Master Data Reference of GS2-Inbox
Reference of the format of master data and various models to be imported
Master Data Format
{
"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 string of the request used when executing the action"
}
],
"expiresTimeSpan": {
"days": "[int]Number of days from the reference time",
"hours": "[int]Hours from the reference time",
"minutes": "[int]Minutes from the reference time"
},
"messageReceptionPeriodEventId": "[string?]GS2-Schedule event GRN that sets the time period during which the message can be received"
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2020-03-12 | Format version of master data | ||
| globalMessages | List<GlobalMessage> | ~ 1000 items | Global Message Global message is 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. |
Model
GlobalMessage
Global Message
Global message is 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 | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| globalMessageId | string | ✓* | ~ 1024 chars | Message GRN
to all users * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Name of message for all users Message-specific name for all users. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ✓ | ~ 4096 chars | Metadata corresponding to the content of the message to all users | ||
| readAcquireActions | List<AcquireAction> | [] | 0 ~ 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 | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| days | int | ✓ | 0 | 0 ~ 365 | Number of days from the reference time | |
| hours | int | ✓ | 0 | 0 ~ 24 | Hours from the reference time | |
| minutes | int | ✓ | 0 | 0 ~ 60 | Minutes from the reference time |
AcquireAction
Acquire Action