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

# GS2-Dictionary API リファレンス

図鑑機能




アイテム図鑑やキャラクター図鑑のようなプレイヤー・エントリー毎に「手に入れた」「手に入れない」の二値を持つデータベースを実現します。

- GS2-Dictionary は1回のAPIリクエストで最大100個のエントリーを登録できます。
- GS2-Dictionary では、一度記録したエントリーを削除したり、特定のエントリーを入手済みか（または未入手か）を検証することができます。
- 期間限定のイベントアイテムの所持状態をリセットしたり、特定のアイテムを入手している場合のみクエストを開始できるといった制限を設けるといった運用が可能です。
- GS2-Dictionary では記録済みエントリーに「お気に入り」を付与できます。`AddLikes` や `DeleteLikes` でお気に入りリストを管理し、`Likes` API で一覧取得や変更通知の購読が可能です。お気に入り情報を利用することで図鑑画面のフィルタリングやUIでの優先表示を実現できます。
- お気に入りエントリーは内部的に `LikeToc` という単位でまとめて保存されており、1ユーザーが大量のお気に入りを登録しても効率的に取得できます。

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



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