GS2-Inbox マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
マスターデータのフォーマット
{
"version": "2020-03-12",
"globalMessages": [
{
"name": "[string]全ユーザーに向けたメッセージ名",
"metadata": "[string]全ユーザーに向けたメッセージの内容に相当するメタデータ",
"readAcquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
}
],
"expiresTimeSpan": {
"days": "[int]基準となる時刻からの日数",
"hours": "[int]基準となる時刻からの時間",
"minutes": "[int]基準となる時刻からの分"
},
"messageReceptionPeriodEventId": "[string?]メッセージを受信可能な期間を設定した GS2-Schedule イベントGRN"
}
]
}
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
|---|
| version | string | | ✓ | 2020-03-12 | | マスターデータのフォーマットバージョン |
| globalMessages | List<GlobalMessage> | | | | ~ 1000 items | グローバルメッセージ グローバルメッセージはゲームプレイヤー全体にメッセージを届ける仕組みです。
グローバルメッセージには有効期間を設定でき、各ゲームプレイヤーはグローバルメッセージを受信する処理を実行することで 有効期間内のグローバルメッセージの中で未受信のメッセージを自分のメッセージボックスにコピーします。 |
モデル
GlobalMessage
グローバルメッセージ
グローバルメッセージはゲームプレイヤー全体にメッセージを届ける仕組みです。
グローバルメッセージには有効期間を設定でき、各ゲームプレイヤーはグローバルメッセージを受信する処理を実行することで
有効期間内のグローバルメッセージの中で未受信のメッセージを自分のメッセージボックスにコピーします。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
|---|
| globalMessageId | string | | ✓* | | ~ 1024文字 | 全ユーザーに向けたメッセージ
GRN ※ サーバー側で自動的に設定 |
| name | string | | ✓ | | ~ 128文字 | 全ユーザーに向けたメッセージ名 |
| metadata | string | | ✓ | | ~ 4096文字 | 全ユーザーに向けたメッセージの内容に相当するメタデータ |
| readAcquireActions | List<AcquireAction> | | | [] | 0 ~ 100 items | 開封時に実行する入手アクション |
| expiresTimeSpan | TimeSpan | | | | | メッセージを受信したあとメッセージが削除されるまでの期間 |
| messageReceptionPeriodEventId | string | | | | ~ 1024文字 | メッセージを受信可能な期間を設定した GS2-Schedule イベント
GRN |
TimeSpan
時間間隔
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
|---|
| days | int | | ✓ | 0 | 0 ~ 365 | 基準となる時刻からの日数 |
| hours | int | | ✓ | 0 | 0 ~ 24 | 基準となる時刻からの時間 |
| minutes | int | | ✓ | 0 | 0 ~ 60 | 基準となる時刻からの分 |
AcquireAction
入手アクション
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
|---|
| 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:AcquireForceByUserId", "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", "Gs2Schedule:ExtendTriggerByUserId", "Gs2Script:InvokeScript", "Gs2SerialKey:RevertUseByUserId", "Gs2SerialKey:IssueOnce", "Gs2Showcase:DecrementPurchaseCountByUserId", "Gs2Showcase:ForceReDrawByUserId", "Gs2SkillTree:MarkReleaseByUserId", "Gs2Stamina:RecoverStaminaByUserId", "Gs2Stamina:RaiseMaxValueByUserId", "Gs2Stamina:SetMaxValueByUserId", "Gs2Stamina:SetRecoverIntervalByUserId", "Gs2Stamina:SetRecoverValueByUserId", "Gs2StateMachine:StartStateMachineByUserId", }
| | ✓ | | | 入手アクションで実行するアクションの種類 |
| request | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |