GS2-Ranking2 マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
マスターデータのフォーマット
{
"version": "2024-05-30",
"globalRankingModels": [
{
"name": "[string]グローバルランキングモデル名",
"metadata": "[string?]メタデータ",
"minimumValue": "[long?]スコアの最小値",
"maximumValue": "[long?]スコアの最大値",
"sum": "[bool]登録を受け付けたスコアを合算し、合計値を競う",
"orderDirection": "[string enum]スコアのソート方向",
"entryPeriodEventId": "[string?]スコアの登録可能期間 GS2-Schedule イベントGRN",
"rankingRewards": [
{
"thresholdRank": "[int]順位閾値",
"metadata": "[string?]メタデータ",
"acquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
}
]
}
],
"accessPeriodEventId": "[string?]ランキングデータへのアクセス可能期間 GS2-Schedule イベントGRN",
"rewardCalculationIndex": "[string enum]報酬計算インデックス"
}
],
"clusterRankingModels": [
{
"name": "[string]クラスターランキングモデル名",
"metadata": "[string?]メタデータ",
"clusterType": "[string enum]クラスタータイプ",
"minimumValue": "[long?]スコアの最小値",
"maximumValue": "[long?]スコアの最大値",
"sum": "[bool]登録を受け付けたスコアを合算し、合計値を競う",
"orderDirection": "[string enum]スコアのソート方向",
"entryPeriodEventId": "[string?]スコアの登録可能期間 GS2-Schedule イベントGRN",
"rankingRewards": [
{
"thresholdRank": "[int]順位閾値",
"metadata": "[string?]メタデータ",
"acquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
}
]
}
],
"accessPeriodEventId": "[string?]ランキングデータへのアクセス可能期間 GS2-Schedule イベントGRN",
"rewardCalculationIndex": "[string enum]報酬計算インデックス"
}
],
"subscribeRankingModels": [
{
"name": "[string]購読ランキングモデル名",
"metadata": "[string?]メタデータ",
"minimumValue": "[long?]スコアの最小値",
"maximumValue": "[long?]スコアの最大値",
"sum": "[bool]登録を受け付けたスコアを合算し、合計値を競う",
"orderDirection": "[string enum]スコアのソート方向",
"entryPeriodEventId": "[string?]スコアの登録可能期間 GS2-Schedule イベントGRN",
"accessPeriodEventId": "[string?]ランキングデータへのアクセス可能期間 GS2-Schedule イベントGRN"
}
]
}| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2024-05-30 | マスターデータのフォーマットバージョン | ||
| globalRankingModels | List<GlobalRankingModel> | ~ 10 items | グローバルランキングモデル グローバルランキングは全てのプレイヤーを対象としたランキングを実現するためのモデルです。 上位1000位までのランキングを表示することができます。 GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。 | |||
| clusterRankingModels | List<ClusterRankingModel> | ~ 10 items | クラスターランキングモデル クラスターランキングはギルドやギャザリング内のプレイヤーを対象としたランキングを実現するためのモデルです。 上位1000位までのランキングを表示することができます。 GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。 | |||
| subscribeRankingModels | List<SubscribeRankingModel> | ~ 10 items | 購読ランキングモデル 購読した他プレイヤーのスコアを集計し、ランキングを作成するモデルです。 |
モデル
GlobalRankingModel
グローバルランキングモデル
グローバルランキングは全てのプレイヤーを対象としたランキングを実現するためのモデルです。
上位1000位までのランキングを表示することができます。
GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| globalRankingModelId | string | ✓* | ~ 1024文字 | グローバルランキング
GRN ※ サーバー側で自動的に設定 | ||||||||
| name | string | ✓ | ~ 128文字 | グローバルランキングモデル名 グローバルランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||||||||
| metadata | string | ~ 1024文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||||||||
| minimumValue | long | 0 ~ 9223372036854775805 | スコアの最小値 | |||||||||
| maximumValue | long | 0 ~ 9223372036854775805 | スコアの最大値 | |||||||||
| sum | bool | ✓ | false | 登録を受け付けたスコアを合算し、合計値を競う | ||||||||
| orderDirection | 文字列列挙型 enum { “asc”, “desc” } | ✓ | スコアのソート方向
| |||||||||
| entryPeriodEventId | string | ~ 1024文字 | スコアの登録可能期間 GS2-Schedule イベント GRN | |||||||||
| rankingRewards | List<RankingReward> | {entryPeriodEventId} != null | [] | 0 ~ 100 items | ランキング報酬リスト | |||||||
| accessPeriodEventId | string | ~ 1024文字 | ランキングデータへのアクセス可能期間 GS2-Schedule イベント GRN | |||||||||
| rewardCalculationIndex | 文字列列挙型 enum { “rank”, “index” } | ✓ | “rank” | 報酬計算インデックス
|
RankingReward
ランキング報酬モデル
スコアの登録期間が設定されたランキングで、登録期間外で参照期間内の時に受け取れる報酬を設定します。
繰り返し設定が有効な場合、直近に期間を終えたランキングが報酬の受け取り対象となります。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| thresholdRank | int | ✓ | 1 ~ 1001 | 順位閾値 | ||
| metadata | string | ~ 1024文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||
| acquireActions | List<AcquireAction> | [] | 0 ~ 100 items | ランキング報酬リスト |
AcquireAction
入手アクション
ClusterRankingModel
クラスターランキングモデル
クラスターランキングはギルドやギャザリング内のプレイヤーを対象としたランキングを実現するためのモデルです。
上位1000位までのランキングを表示することができます。
GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| clusterRankingModelId | string | ✓* | ~ 1024文字 | クラスターランキング
GRN ※ サーバー側で自動的に設定 | ||||||||||
| name | string | ✓ | ~ 128文字 | クラスターランキングモデル名 クラスターランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||||||||||
| metadata | string | ~ 1024文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||||||||||
| clusterType | 文字列列挙型 enum { “Raw”, “Gs2Guild::Guild”, “Gs2Matchmaking::SeasonGathering” } | ✓ | クラスタータイプ
| |||||||||||
| minimumValue | long | 0 ~ 9223372036854775805 | スコアの最小値 | |||||||||||
| maximumValue | long | 0 ~ 9223372036854775805 | スコアの最大値 | |||||||||||
| sum | bool | ✓ | false | 登録を受け付けたスコアを合算し、合計値を競う | ||||||||||
| orderDirection | 文字列列挙型 enum { “asc”, “desc” } | ✓ | スコアのソート方向
| |||||||||||
| entryPeriodEventId | string | ~ 1024文字 | スコアの登録可能期間 GS2-Schedule イベント GRN | |||||||||||
| rankingRewards | List<RankingReward> | {entryPeriodEventId} != null | [] | 0 ~ 100 items | ランキング報酬リスト | |||||||||
| accessPeriodEventId | string | ~ 1024文字 | ランキングデータへのアクセス可能期間 GS2-Schedule イベント GRN | |||||||||||
| rewardCalculationIndex | 文字列列挙型 enum { “rank”, “index” } | ✓ | “rank” | 報酬計算インデックス
|
SubscribeRankingModel
購読ランキングモデル
購読した他プレイヤーのスコアを集計し、ランキングを作成するモデルです。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| subscribeRankingModelId | string | ✓* | ~ 1024文字 | 購読ランキング
GRN ※ サーバー側で自動的に設定 | ||||||||
| name | string | ✓ | ~ 128文字 | 購読ランキングモデル名 購読ランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||||||||
| metadata | string | ~ 1024文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||||||||
| minimumValue | long | 0 ~ 9223372036854775805 | スコアの最小値 | |||||||||
| maximumValue | long | 0 ~ 9223372036854775805 | スコアの最大値 | |||||||||
| sum | bool | ✓ | false | 登録を受け付けたスコアを合算し、合計値を競う | ||||||||
| orderDirection | 文字列列挙型 enum { “asc”, “desc” } | ✓ | スコアのソート方向
| |||||||||
| entryPeriodEventId | string | ~ 1024文字 | スコアの登録可能期間 GS2-Schedule イベント GRN | |||||||||
| accessPeriodEventId | string | ~ 1024文字 | ランキングデータへのアクセス可能期間 GS2-Schedule イベント GRN |