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

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

マスターデータのフォーマットと インポートする各種モデルのリファレンス




## マスターデータのフォーマット


**JSON**
```json
{
  "version": "2024-05-30",
  "globalRankingModels": [
    {
      "name": "[string]グローバルランキングモデル名",
      "metadata": "[string?]メタデータ",
      "minimumValue": "[long?]スコアの最小値",
      "maximumValue": "[long?]スコアの最大値",
      "sum": "[bool]スコア合算",
      "orderDirection": "[string (enum)]ソート方向",
      "entryPeriodEventId": "[string?]スコア登録可能期間イベントGRN",
      "rankingRewards": [
        {
          "thresholdRank": "[int]順位閾値",
          "metadata": "[string?]メタデータ",
          "acquireActions": [
            {
              "action": "[string]入手アクションで実行するアクションの種類",
              "request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
            }
          ]
        }
      ],
      "accessPeriodEventId": "[string?]ランキングデータアクセス可能期間イベントGRN",
      "rewardCalculationIndex": "[string (enum)]報酬計算インデックス"
    }
  ],
  "clusterRankingModels": [
    {
      "name": "[string]クラスターランキングモデル名",
      "metadata": "[string?]メタデータ",
      "clusterType": "[string (enum)]クラスタータイプ",
      "minimumValue": "[long?]スコアの最小値",
      "maximumValue": "[long?]スコアの最大値",
      "sum": "[bool]スコア合算",
      "orderDirection": "[string (enum)]ソート方向",
      "entryPeriodEventId": "[string?]スコア登録可能期間イベントGRN",
      "rankingRewards": [
        {
          "thresholdRank": "[int]順位閾値",
          "metadata": "[string?]メタデータ",
          "acquireActions": [
            {
              "action": "[string]入手アクションで実行するアクションの種類",
              "request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
            }
          ]
        }
      ],
      "accessPeriodEventId": "[string?]ランキングデータアクセス可能期間イベントGRN",
      "rewardCalculationIndex": "[string (enum)]報酬計算インデックス"
    }
  ],
  "subscribeRankingModels": [
    {
      "name": "[string]購読ランキングモデル名",
      "metadata": "[string?]メタデータ",
      "minimumValue": "[long?]スコアの最小値",
      "maximumValue": "[long?]スコアの最大値",
      "sum": "[bool]スコア合算",
      "orderDirection": "[string (enum)]ソート方向",
      "entryPeriodEventId": "[string?]スコア登録可能期間イベントGRN",
      "accessPeriodEventId": "[string?]ランキングデータアクセス可能期間イベントGRN"
    }
  ]
}
```


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2024-05-30 | | マスターデータのフォーマットバージョン |
| globalRankingModels | [List&lt;GlobalRankingModel&gt;](#globalrankingmodel) |  |  |  |  ~ 10 items | グローバルランキングモデル<br>グローバルランキングは全てのプレイヤーを対象としたランキングを実現するためのモデルです。<br>上位1000位までのランキングを表示することができます。<br><br>GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。 |
| clusterRankingModels | [List&lt;ClusterRankingModel&gt;](#clusterrankingmodel) |  |  |  |  ~ 10 items | クラスターランキングモデル<br>クラスターランキングはギルドやギャザリング内のプレイヤーを対象としたランキングを実現するためのモデルです。<br>上位1000位までのランキングを表示することができます。<br><br>GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。 |
| subscribeRankingModels | [List&lt;SubscribeRankingModel&gt;](#subscriberankingmodel) |  |  |  |  ~ 10 items | 購読ランキングモデル<br>購読した他プレイヤーのスコアを集計し、ランキングを作成するモデルです。 |

## モデル

### GlobalRankingModel

グローバルランキングモデル<br>

グローバルランキングは全てのプレイヤーを対象としたランキングを実現するためのモデルです。<br>
上位1000位までのランキングを表示することができます。<br>

GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| globalRankingModelId | string |  | ※ |  |  ~ 1024文字 | グローバルランキングGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | グローバルランキングモデル名<br>グローバルランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 1024文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| minimumValue | long |  |  |  | 0 ~ 9223372036854775805 | スコアの最小値<br>許容されるスコアの最小値です。この値を下回るスコアは登録時に拒否されます。無効または意図しないスコア値のフィルタリングに使用します。 |
| maximumValue | long |  |  |  | 0 ~ 9223372036854775805 | スコアの最大値<br>許容されるスコアの最大値です。この値を超えるスコアは登録時に拒否されます。異常に高いスコアの登録防止に使用します。 |
| sum | bool |  |  | false |  | スコア合算<br>有効にすると、登録されたすべてのスコアが合算され、合計値でランキングが決定されます。無効の場合、ソート方向に応じた最良のスコア（最高値または最低値）のみがランキングに使用されます。 |
| orderDirection | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"asc",<br>&nbsp;&nbsp;"desc"<br>}<br> |  | ✓ |  |  | ソート方向<br>ランキングスコアのソート方向です。低いスコアほど上位の場合（例：タイムアタック）は「昇順」、高いスコアほど上位の場合（例：ハイスコア）は「降順」を使用します。"asc": 昇順 / "desc": 降順 /  |
| entryPeriodEventId | string |  |  |  |  ~ 1024文字 | スコア登録可能期間イベントGRN<br>スコアを登録できる期間を定義する GS2-Schedule のイベントGRNです。繰り返しイベントと関連づけると、繰り返しサイクルごとにランキングがリセットされ、シーズン制ランキングを実現できます。 |
| rankingRewards | [List&lt;RankingReward&gt;](#rankingreward) | {entryPeriodEventId} != null |  | [] | 0 ~ 100 items | ランキング報酬リスト<br>各シーズン終了時のランキング順位に基づいて付与される報酬のリストです。スコア登録可能期間イベントが設定されている場合のみ利用可能です。各報酬は順位閾値と実行する入手アクションを定義します。 |
| accessPeriodEventId | string |  |  |  |  ~ 1024文字 | ランキングデータアクセス可能期間イベントGRN<br>ランキング結果の閲覧と報酬の受け取りが可能な期間を定義する GS2-Schedule のイベントGRNです。通常、スコア登録期間の間のインターバルに設定します。 |
| rewardCalculationIndex | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"rank",<br>&nbsp;&nbsp;"index"<br>}<br> |  |  | "rank" |  | 報酬計算インデックス<br>報酬をプレイヤーに対応付ける方法を決定します。「順位ベース」は1始まりのランキング順位を使用し（同スコアのプレイヤーは同じ順位を共有）、「インデックスベース」は0始まりの一意のソート位置を使用します（同順位なし）。通常のユースケースでは「順位ベース」を選択してください。"rank": 順位ベースで報酬を決定 / "index": インデックスベースで報酬を決定 /  |

---

### RankingReward

ランキング報酬<br>

スコアの登録期間が設定されたランキングで、登録期間外で参照期間内の時に受け取れる報酬を設定します。<br>
繰り返し設定が有効な場合、直近に期間を終えたランキングが報酬の受け取り対象となります。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| thresholdRank | int |  | ✓ |  | 1 ~ 1001 | 順位閾値<br>この報酬ティアの順位閾値です。順位（またはインデックス、rewardCalculationIndex の設定に依存）がこの閾値以上のプレイヤーがこの報酬を受け取ります。1001に設定すると、ランク外（上位1000位外）のプレイヤー向けの報酬を定義できます。 |
| metadata | string |  |  |  |  ~ 1024文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| acquireActions | [List&lt;AcquireAction&gt;](#acquireaction) |  |  | [] | 0 ~ 100 items | 入手アクションリスト<br>プレイヤーがこのランキング報酬を受け取る際に実行される入手アクションのリストです。この順位閾値を達成した報酬として付与されるアイテム、通貨、その他のリソースを定義します。 |

---

### AcquireAction

入手アクション

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| action | 文字列列挙型<br>enum {<br>}<br> |  | ✓ |  |  | 入手アクションで実行するアクションの種類 |
| request | string |  | ✓ |  |  ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |

---

### ClusterRankingModel

クラスターランキングモデル<br>

クラスターランキングはギルドやギャザリング内のプレイヤーを対象としたランキングを実現するためのモデルです。<br>
上位1000位までのランキングを表示することができます。<br>

GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| clusterRankingModelId | string |  | ※ |  |  ~ 1024文字 | クラスターランキングGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | クラスターランキングモデル名<br>クラスターランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 1024文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| clusterType | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"Raw",<br>&nbsp;&nbsp;"Gs2Guild::Guild",<br>&nbsp;&nbsp;"Gs2Matchmaking::SeasonGathering"<br>}<br> |  | ✓ |  |  | クラスタータイプ<br>ランキングのセグメンテーションに使用するグループ（クラスター）の種類を定義します。「Raw」は所属検証なしで任意のクラスター名を指定でき、「Gs2Guild::Guild」はGS2-Guildギルドへの所属を検証し、「Gs2Matchmaking::SeasonGathering」はGS2-Matchmakingシーズンギャザリングへの所属を検証します。"Raw": 検証なし / "Gs2Guild::Guild": GS2-Guild ギルド / "Gs2Matchmaking::SeasonGathering": GS2-Matchmaking シーズンギャザリング /  |
| minimumValue | long |  |  |  | 0 ~ 9223372036854775805 | スコアの最小値<br>許容されるスコアの最小値です。この値を下回るスコアは登録時に拒否されます。 |
| maximumValue | long |  |  |  | 0 ~ 9223372036854775805 | スコアの最大値<br>許容されるスコアの最大値です。この値を超えるスコアは登録時に拒否されます。 |
| sum | bool |  |  | false |  | スコア合算<br>有効にすると、登録されたすべてのスコアが合算され、合計値でランキングが決定されます。無効の場合、最良のスコアのみがランキングに使用されます。 |
| orderDirection | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"asc",<br>&nbsp;&nbsp;"desc"<br>}<br> |  | ✓ |  |  | ソート方向<br>ランキングスコアのソート方向です。低いスコアほど上位の場合は「昇順」、高いスコアほど上位の場合は「降順」を使用します。"asc": 昇順 / "desc": 降順 /  |
| entryPeriodEventId | string |  |  |  |  ~ 1024文字 | スコア登録可能期間イベントGRN<br>スコアを登録できる期間を定義する GS2-Schedule のイベントGRNです。繰り返しイベントと関連づけると、シーズン制ランキングを実現できます。 |
| rankingRewards | [List&lt;RankingReward&gt;](#rankingreward) | {entryPeriodEventId} != null |  | [] | 0 ~ 100 items | ランキング報酬リスト<br>各シーズン終了時のランキング順位に基づいて付与される報酬のリストです。スコア登録可能期間イベントが設定されている場合のみ利用可能です。 |
| accessPeriodEventId | string |  |  |  |  ~ 1024文字 | ランキングデータアクセス可能期間イベントGRN<br>ランキング結果の閲覧と報酬の受け取りが可能な期間を定義する GS2-Schedule のイベントGRNです。 |
| rewardCalculationIndex | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"rank",<br>&nbsp;&nbsp;"index"<br>}<br> |  |  | "rank" |  | 報酬計算インデックス<br>報酬をプレイヤーに対応付ける方法を決定します。「順位ベース」は1始まりのランキング順位（同スコアは同順位）、「インデックスベース」は0始まりの一意のソート位置（同順位なし）を使用します。"rank": 順位ベースで報酬を決定 / "index": インデックスベースで報酬を決定 /  |

---

### SubscribeRankingModel

購読ランキングモデル<br>

購読した他プレイヤーのスコアを集計し、ランキングを作成するモデルです。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| subscribeRankingModelId | string |  | ※ |  |  ~ 1024文字 | 購読ランキングGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | 購読ランキングモデル名<br>購読ランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 1024文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| minimumValue | long |  |  |  | 0 ~ 9223372036854775805 | スコアの最小値<br>許容されるスコアの最小値です。この値を下回るスコアは登録時に拒否されます。 |
| maximumValue | long |  |  |  | 0 ~ 9223372036854775805 | スコアの最大値<br>許容されるスコアの最大値です。この値を超えるスコアは登録時に拒否されます。 |
| sum | bool |  |  | false |  | スコア合算<br>有効にすると、登録されたすべてのスコアが合算され、合計値でランキングが決定されます。無効の場合、最良のスコアのみがランキングに使用されます。 |
| orderDirection | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"asc",<br>&nbsp;&nbsp;"desc"<br>}<br> |  | ✓ |  |  | ソート方向<br>ランキングスコアのソート方向です。低いスコアほど上位の場合は「昇順」、高いスコアほど上位の場合は「降順」を使用します。"asc": 昇順 / "desc": 降順 /  |
| entryPeriodEventId | string |  |  |  |  ~ 1024文字 | スコア登録可能期間イベントGRN<br>スコアを登録できる期間を定義する GS2-Schedule のイベントGRNです。繰り返しイベントと関連づけると、シーズン制ランキングを実現できます。 |
| accessPeriodEventId | string |  |  |  |  ~ 1024文字 | ランキングデータアクセス可能期間イベントGRN<br>ランキング結果の閲覧が可能な期間を定義する GS2-Schedule のイベントGRNです。 |

---