> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Inbox API リファレンス

プレゼントボックス機能




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

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

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

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

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

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

[マイクロサービス紹介 / GS2-Inbox](../../microservices/inbox)



- [GS2-Inbox Deploy/CDK リファレンス](/ja/api_reference/inbox/deploy/)
  
- [GS2-Inbox SDK API リファレンス](/ja/api_reference/inbox/sdk/)
  
- [GS2-Inbox SDK for Game Engine API リファレンス](/ja/api_reference/inbox/game_engine/)
  
- [GS2-Inbox スクリプト トリガー リファレンス](/ja/api_reference/inbox/script/)
  
- [GS2-Inbox トランザクションアクション](/ja/api_reference/inbox/stamp_sheet/)
  
- [GS2-Inbox マスターデータリファレンス](/ja/api_reference/inbox/master_data/)