GS2-Guild API 레퍼런스

여러 플레이어로 구성되는 길드를 관리하는 마이크로서비스입니다.
길드 멤버 관리와 멤버별 권한 제어를 제공합니다.

GS2-Guild에서는 길드 자체를 “길드 사용자"라는 하나의 사용자로 취급하는 점이 특징입니다.
이를 통해 일반 플레이어와 마찬가지로 길드에도 경험치·레벨·스태미나·스킬 트리 등 GS2의 다양한 사용자 데이터를 갖게 할 수 있습니다.

또한 길드 멤버는 페더레이션 기능을 통해 길드 사용자로서 API를 조작할 수 있으며, 역할별 액세스 권한도 설정할 수 있습니다.
예를 들어 길드 마스터만 길드 공유 자산의 구매나 관리 조작을 수행하도록 하는 등의 제어를 실현할 수 있습니다.

길드 단위의 설정은 GuildModel로 관리합니다. defaultMaximumMemberCount와 maximumMemberCount로 멤버의 초기값과 상한을 정하고, inactivityPeriodDays에 길드 마스터의 비활동 기간을 지정하면 자동으로 후계자를 선출할 수 있습니다. rejoinCoolTimeMinutes로 탈퇴 후 재참가 쿨타임을, maxConcurrentJoinGuilds나 maxConcurrentGuildMasterCount로 동시 참가 길드 수나 길드 마스터 인원 제한도 설정할 수 있습니다.

역할은, 길드에 소속된 플레이어의 직책에 해당하는 엔티티로, 실행 가능한 API의 종류를 정의합니다.
하나의 길드 모델에 최대 10종류의 역할을 정의할 수 있습니다.

역할에는 GS2-Identifier의 정책 문서를 정의할 수 있습니다.
길드 사용자로 전환하기 전의 권한과 역할의 권한이 모두 허용하는 범위 내에서 API를 호출할 수 있습니다.