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

# GS2-Dictionary API 레퍼런스

도감 기능




아이템 도감이나 캐릭터 도감처럼 플레이어·엔트리마다 "입수함"/"입수하지 않음"의 이진값을 갖는 데이터베이스를 구현합니다.

- GS2-Dictionary 는 한 번의 API 요청으로 최대 100개의 엔트리를 등록할 수 있습니다.
- GS2-Dictionary 에서는 한 번 기록한 엔트리를 삭제하거나, 특정 엔트리를 입수했는지(또는 미입수인지) 검증할 수 있습니다. 기간 한정 이벤트 아이템의 소지 상태를 초기화하거나, 특정 아이템을 입수한 경우에만 퀘스트를 시작할 수 있도록 제한하는 등의 운영이 가능합니다.
- 마스터 데이터 등록은 관리 콘솔에서 등록하는 방법 외에도, GitHub 에서 데이터를 반영하거나 GS2-Deploy 를 사용하여 CI 에서 등록하는 워크플로우를 구성할 수 있습니다.
- GS2-Dictionary 에서는 기록된 엔트리에 "즐겨찾기"를 지정할 수 있습니다. `AddLikes` 나 `DeleteLikes` 로 즐겨찾기 목록을 관리하고, `Likes` API 로 목록 조회나 변경 알림 구독이 가능합니다. 즐겨찾기 정보를 활용하면 도감 화면의 필터링이나 UI 에서의 우선 표시를 구현할 수 있습니다.
- 즐겨찾기 엔트리는 내부적으로 `LikeToc` 라는 단위로 정리되어 저장되므로, 한 사용자가 대량의 즐겨찾기를 등록하더라도 효율적으로 조회할 수 있습니다.

[마이크로서비스 소개 / GS2-Dictionary](../../microservices/dictionary)



- [GS2-Dictionary Deploy/CDK 레퍼런스](/ko/api_reference/dictionary/deploy/)
  
- [GS2-Dictionary SDK API 레퍼런스](/ko/api_reference/dictionary/sdk/)
  
- [GS2-Dictionary SDK for Game Engine API 레퍼런스](/ko/api_reference/dictionary/game_engine/)
  
- [GS2-Dictionary 마스터 데이터 레퍼런스](/ko/api_reference/dictionary/master_data/)
  
- [GS2-Dictionary 스크립트 트리거 레퍼런스](/ko/api_reference/dictionary/script/)
  
- [GS2-Dictionary 트랜잭션 액션](/ko/api_reference/dictionary/stamp_sheet/)