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

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

GuildModel

ギルドモデルマスター

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

有効化条件必須デフォルト値の制限説明
guildModelIdstring~ 1024文字ギルドモデルGRN
namestring~ 128文字ギルドモデル名
metadatastring~ 2048文字メタデータ
defaultMaximumMemberCountint1 ~ 2147483646ギルド作成時に適用されるギルドメンバーの最大数
maximumMemberCountint1 ~ 2147483646ギルドメンバーの引き上げを行える最大値
inactivityPeriodDaysint71 ~ 365ギルドメンバーから新しいギルドマスターを選出するためのギルドマスターの無活動期間(日)
rolesList<RoleModel>1 ~ 10 itemsギルド内の各役職ごとの権限設定リスト
guildMasterRolestring~ 128文字ギルドマスターが持つ権限
guildMemberDefaultRolestring~ 128文字ギルドメンバーが初期状態に持つロール
rejoinCoolTimeMinutesint0~ 2147483646ギルド離脱後に再度参加できるまでのクールタイム(分)
maxConcurrentJoinGuildsint1 ~ 10同時に参加可能なギルドの最大数
maxConcurrentGuildMasterCountint1 ~ 100同時に存在可能なギルドマスターの最大人数

RoleModel

ロールモデル

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

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

Member

メンバー

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

有効化条件必須デフォルト値の制限説明
userIdstring~ 128文字ユーザーID
roleNamestring~ 128文字ロールモデル名
joinedAtlong現在時刻参加日時 (UNIX時間 単位:ミリ秒)

VerifyActionResult

検証アクションの実行結果

有効化条件必須デフォルト値の制限説明
actionenum {
}
~ 128文字検証アクションで実行するアクションの種類
verifyRequeststring~ 1048576文字リクエストのJSON
statusCodeint~ 999ステータスコード
verifyResultstring~ 1048576文字結果内容

action に指定する列挙型の定義

定義説明

ConsumeActionResult

消費アクションの実行結果

有効化条件必須デフォルト値の制限説明
actionenum {
}
~ 128文字消費アクションで実行するアクションの種類
consumeRequeststring~ 1048576文字リクエストのJSON
statusCodeint~ 999ステータスコード
consumeResultstring~ 1048576文字結果内容

action に指定する列挙型の定義

定義説明

AcquireActionResult

入手アクションの実行結果

有効化条件必須デフォルト値の制限説明
actionenum {
}
~ 128文字入手アクションで実行するアクションの種類
acquireRequeststring~ 1048576文字リクエストのJSON
statusCodeint~ 999ステータスコード
acquireResultstring~ 1048576文字結果内容

action に指定する列挙型の定義

定義説明

TransactionResult

トランザクション実行結果

サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果

有効化条件必須デフォルト値の制限説明
transactionIdstring36 ~ 36文字トランザクションID
verifyResultsList<VerifyActionResult>~ 10 items検証アクションの実行結果リスト
consumeResultsList<ConsumeActionResult>~ 10 items消費アクションの実行結果リスト
acquireResultsList<AcquireActionResult>~ 100 items入手アクションの実行結果リスト