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

# GS2-Guild API リファレンス

ギルド機能




複数プレイヤーで構成されるギルドを管理するマイクロサービスです。<br>
ギルドメンバー管理や、メンバーごとの権限制御を提供します。

GS2-Guild では、ギルド自体を「ギルドユーザー」という1つのユーザーとして扱う点が特徴です。<br>
そのため、通常のプレイヤーと同様に、ギルドにも経験値・レベル・スタミナ・スキルツリーなど、GS2 の各種ユーザーデータを持たせることができます。

また、ギルドメンバーはフェデレーション機能を通じてギルドユーザーとして API を操作でき、役職ごとのアクセス権限も設定可能です。<br>
例えば、ギルドマスターのみがギルド共有資産の購入や管理操作を行う、といった制御を実現できます。

ギルド単位の設定は GuildModel で管理します。`defaultMaximumMemberCount` と `maximumMemberCount` でメンバーの初期値と上限を定め、`inactivityPeriodDays` にギルドマスターの無活動期間を指定すると自動的に後継者を選出できます。`rejoinCoolTimeMinutes` で脱退後の再参加クールタイム、`maxConcurrentJoinGuilds` や `maxConcurrentGuildMasterCount` で同時参加ギルド数やギルドマスターの人数制限も設定可能です。

ロールは、ギルドに所属しているプレイヤーの役職に相当するエンティティで、実行可能なAPIの種類を定義します。<br>
1つのギルドモデルに最大10種類のロールを定義できます。

ロールには GS2-Identifier のポリシードキュメントを定義できます。<br>
ギルドユーザーに切り替わる前の権限と、ロールの権限の両方が許可している範囲で API を呼び出すことができます。

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



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