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
| Type | Condition | Require | Default | Limitation | Description |
---|
action | enum { "Gs2AdReward:AcquirePointByUserId", "Gs2Dictionary:AddEntriesByUserId", "Gs2Enchant:ReDrawBalanceParameterStatusByUserId", "Gs2Enchant:SetBalanceParameterStatusByUserId", "Gs2Enchant:ReDrawRarityParameterStatusByUserId", "Gs2Enchant:AddRarityParameterStatusByUserId", "Gs2Enchant:SetRarityParameterStatusByUserId", "Gs2Enhance:DirectEnhanceByUserId", "Gs2Enhance:UnleashByUserId", "Gs2Enhance:CreateProgressByUserId", "Gs2Exchange:ExchangeByUserId", "Gs2Exchange:IncrementalExchangeByUserId", "Gs2Exchange:CreateAwaitByUserId", "Gs2Exchange:SkipByUserId", "Gs2Experience:AddExperienceByUserId", "Gs2Experience:SetExperienceByUserId", "Gs2Experience:AddRankCapByUserId", "Gs2Experience:SetRankCapByUserId", "Gs2Experience:MultiplyAcquireActionsByUserId", "Gs2Formation:AddMoldCapacityByUserId", "Gs2Formation:SetMoldCapacityByUserId", "Gs2Formation:AcquireActionsToFormProperties", "Gs2Formation:SetFormByUserId", "Gs2Formation:AcquireActionsToPropertyFormProperties", "Gs2Friend:UpdateProfileByUserId", "Gs2Grade:AddGradeByUserId", "Gs2Grade:ApplyRankCapByUserId", "Gs2Grade:MultiplyAcquireActionsByUserId", "Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName", "Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName", "Gs2Idle:IncreaseMaximumIdleMinutesByUserId", "Gs2Idle:SetMaximumIdleMinutesByUserId", "Gs2Idle:ReceiveByUserId", "Gs2Inbox:SendMessageByUserId", "Gs2Inventory:AddCapacityByUserId", "Gs2Inventory:SetCapacityByUserId", "Gs2Inventory:AcquireItemSetByUserId", "Gs2Inventory:AcquireItemSetWithGradeByUserId", "Gs2Inventory:AddReferenceOfByUserId", "Gs2Inventory:DeleteReferenceOfByUserId", "Gs2Inventory:AcquireSimpleItemsByUserId", "Gs2Inventory:SetSimpleItemsByUserId", "Gs2Inventory:AcquireBigItemByUserId", "Gs2Inventory:SetBigItemByUserId", "Gs2JobQueue:PushByUserId", "Gs2Limit:CountDownByUserId", "Gs2Limit:DeleteCounterByUserId", "Gs2LoginReward:DeleteReceiveStatusByUserId", "Gs2LoginReward:UnmarkReceivedByUserId", "Gs2Lottery:DrawByUserId", "Gs2Lottery:ResetBoxByUserId", "Gs2Mission:RevertReceiveByUserId", "Gs2Mission:IncreaseCounterByUserId", "Gs2Mission:SetCounterByUserId", "Gs2Money:DepositByUserId", "Gs2Money:RevertRecordReceipt", "Gs2Money2:DepositByUserId", "Gs2Quest:CreateProgressByUserId", "Gs2Schedule:TriggerByUserId", "Gs2Script:InvokeScript", "Gs2SerialKey:RevertUseByUserId", "Gs2Showcase:DecrementPurchaseCountByUserId", "Gs2Showcase:ForceReDrawByUserId", "Gs2SkillTree:MarkReleaseByUserId", "Gs2Stamina:RecoverStaminaByUserId", "Gs2Stamina:RaiseMaxValueByUserId", "Gs2Stamina:SetMaxValueByUserId", "Gs2Stamina:SetRecoverIntervalByUserId", "Gs2Stamina:SetRecoverValueByUserId", "Gs2StateMachine:StartStateMachineByUserId", }
| | ✓ | | ~ 128 chars | Types of actions to be performed in the acquire action |
request | string | | ✓ | | ~ 1048576 chars | JSON of request |