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 | ✓ | 2020-03-12 | マスターデータのフォーマットバージョン | |||
globalMessages | List<GlobalMessage> | ~ 1000 items | グローバルメッセージ |
GlobalMessage
グローバルメッセージ
グローバルメッセージはゲームプレイヤー全体にメッセージを届ける仕組みです。
グローバルメッセージには有効期間を設定でき、各ゲームプレイヤーはグローバルメッセージを受信する処理を実行することで
有効期間内のグローバルメッセージの中で未受信のメッセージを自分のメッセージボックスにコピーします。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
globalMessageId | string | ✓ | ~ 1024文字 | 全ユーザに向けたメッセージGRN | ||
name | string | ✓ | ~ 128文字 | 全ユーザに向けたメッセージ名 | ||
metadata | string | ✓ | ~ 4096文字 | 全ユーザに向けたメッセージの内容に相当するメタデータ | ||
readAcquireActions | List<AcquireAction> | [] | ~ 100 items | 開封時に実行する入手アクション | ||
expiresTimeSpan | TimeSpan | メッセージを受信したあとメッセージが削除されるまでの期間 | ||||
messageReceptionPeriodEventId | string | ~ 1024文字 | メッセージを受信可能な期間を設定した GS2-Schedule イベントGRN |
TimeSpan
時間間隔
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
days | int | ✓ | 0 | ~ 365 | 現在時刻からの日数 | |
hours | int | ✓ | 0 | ~ 24 | 現在時刻からの時間 | |
minutes | int | ✓ | 0 | ~ 60 | 現在時刻からの分 |
AcquireAction
入手アクション
VerifyActionResult
検証アクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128文字 | 検証アクションで実行するアクションの種類 | ||
verifyRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
statusCode | int | ~ 999 | ステータスコード | |||
verifyResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
定義 | 説明 |
---|
ConsumeActionResult
消費アクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128文字 | 消費アクションで実行するアクションの種類 | ||
consumeRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
statusCode | int | ~ 999 | ステータスコード | |||
consumeResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
定義 | 説明 |
---|
AcquireActionResult
入手アクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128文字 | 入手アクションで実行するアクションの種類 | ||
acquireRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
statusCode | int | ~ 999 | ステータスコード | |||
acquireResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
定義 | 説明 |
---|
TransactionResult
トランザクション実行結果
サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
transactionId | string | ✓ | 36 ~ 36文字 | トランザクションID | ||
verifyResults | List<VerifyActionResult> | ~ 10 items | 検証アクションの実行結果リスト | |||
consumeResults | List<ConsumeActionResult> | ~ 10 items | 消費アクションの実行結果リスト | |||
acquireResults | List<AcquireActionResult> | ~ 100 items | 入手アクションの実行結果リスト |