GS2-Guild マスターデータリファレンス

{
  "version": "2024-04-25",
  "guildModels": [
    {
      "name": "[string]ギルドモデル名",
      "metadata": "[string?]メタデータ",
      "defaultMaximumMemberCount": "[int]ギルド作成時に適用されるギルドメンバーの最大数",
      "maximumMemberCount": "[int]ギルドメンバーの引き上げを行える最大値",
      "roles": [
        {
          "name": "[string]ロールモデル名",
          "metadata": "[string?]メタデータ",
          "policyDocument": "[string]ロールに適用する権限のポリシードキュメント"
        }
      ],
      "guildMasterRole": "[string]ギルドマスターが持つ権限",
      "guildMemberDefaultRole": "[string]ギルドメンバーが初期状態に持つロール",
      "rejoinCoolTimeMinutes": "[int]ギルド離脱後に再度参加できるまでのクールタイム(分)"
    }
  ]
}
有効化条件必須デフォルト値の制限説明
version2024-04-25マスターデータのフォーマットバージョン
guildModelsList<GuildModel>~ 100 itemsギルドモデルマスター

GuildModel

ギルドモデルマスター

ギルドモデルとは、ギルドの加入可能最大人数の設定や、ギルド内での役職ごとの権限設定を持つエンティティです。

有効化条件必須デフォルト値の制限説明
guildModelIdstring~ 1024文字ギルドモデルGRN
namestring~ 128文字ギルドモデル名
metadatastring~ 2048文字メタデータ
defaultMaximumMemberCountint1 ~ 2147483646ギルド作成時に適用されるギルドメンバーの最大数
maximumMemberCountint1 ~ 2147483646ギルドメンバーの引き上げを行える最大値
rolesList<RoleModel>1 ~ 10 itemsギルド内の各役職ごとの権限設定リスト
guildMasterRolestring~ 128文字ギルドマスターが持つ権限
guildMemberDefaultRolestring~ 128文字ギルドメンバーが初期状態に持つロール
rejoinCoolTimeMinutesint0~ 2147483646ギルド離脱後に再度参加できるまでのクールタイム(分)

RoleModel

ロールモデル

ロールモデルはギルド内での役割を定義し、その役割ごと実行できる処理に関する権限を設定します。

有効化条件必須デフォルト値の制限説明
namestring~ 128文字ロールモデル名
metadatastring~ 2048文字メタデータ
policyDocumentstring~ 10240文字ロールに適用する権限のポリシードキュメント

Member

メンバー

ギルドメンバーの一覧を管理するエンティティ

有効化条件必須デフォルト値の制限説明
userIdstring~ 128文字ユーザーID
roleNamestring~ 128文字ロールモデル名
joinedAtlong参加日時