GS2-Inbox Master Data Reference

Master Data Format

{
  "version": "2020-03-12",
  "globalMessages": [
    {
      "name": "[string]Global Message name",
      "metadata": "[string]Metadata",
      "readAcquireActions": [
        {
          "action": "[string]Type of action to be executed in the Acquire Action",
          "request": "[string]JSON string of the request used when executing the action"
        }
      ],
      "expiresTimeSpan": {
        "days": "[int]Days",
        "hours": "[int]Hours",
        "minutes": "[int]Minutes"
      },
      "messageReceptionPeriodEventId": "[string?]Message Reception Period Event ID"
    }
  ]
}

Model

GlobalMessage

Global Message

Global Message is a mechanism for delivering messages to all game players.

Global messages can have an expiration time, 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 the player’s message box.

TimeSpan

Time Span

Represents a duration of time as a combination of days, hours, and minutes. Used to define the expiration period for messages relative to their reception time. For example, a TimeSpan of 7 days, 0 hours, 0 minutes means the message expires exactly one week after the user receives it.

AcquireAction

Acquire Action

Represents a single acquire action attached to a message as a reward. Consists of an action type (e.g., add items to inventory, increase currency) and its request parameters. When a message is opened, these actions are assembled into transactions and executed to deliver the rewards to the user.