GS2-Inbox API リファレンス

プレゼントボックス機能

プレゼントつきのメッセージ機能を提供するサービスです。

メッセージは既読状態をもちます。
既読状態のメッセージをリストに残すか、リストから削除するかを設定できます。

メッセージには報酬を添付することが可能です。
既読フラグを立てる代わりに、メッセージに添付された報酬を受け取ることができます。

メッセージには有効期限(expiresAt)を設定できます。
有効期限を迎えたメッセージは、未読状態、開封後の既読状態にかかわらず、自動的に削除されます。

特定のプレイヤーではなく、全プレイヤーに対して同一のメッセージを配布したい場合は「グローバルメッセージ」を使用します。
グローバルメッセージはマスターデータとして定義し、各プレイヤーが ReceiveGlobalMessage を呼び出した際に、まだ受け取っていないメッセージをそのプレイヤーの受信ボックスにコピーします。

マスターデータの登録はマネージメントコンソールから登録する他、GitHubからデータを反映したり、GS2-Deployを使ってCIから登録するようなワークフローを組むことが可能です。


GS2-Inbox SDK for Game Engine API リファレンス

ゲームエンジン向け GS2-Inbox SDK の モデルの仕様 と API のリファレンス

GS2-Inbox SDK API リファレンス

各種プログラミング言語向け GS2-Inbox SDK の モデルの仕様 と API のリファレンス

GS2-Inbox スクリプト トリガー リファレンス

拡張スクリプトを呼び出すイベントトリガーのリファレンス

GS2-Inbox Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例

GS2-Inbox マスターデータリファレンス

マスターデータのフォーマットと インポートする各種モデルのリファレンス

GS2-Inbox トランザクションアクション

検証/消費/入手の各トランザクションアクションの仕様