GS2-Ranking2 マスターデータリファレンス
{
"version": "2024-05-30",
"globalRankingModels": [
{
"name": "[string]ランキング名",
"metadata": "[string?]メタデータ",
"minimumValue": "[long?]スコアの最小値",
"maximumValue": "[long?]スコアの最大値",
"sum": "[bool]登録を受け付けたスコアを合算し、合計値を競う",
"orderDirection": "[string]スコアのソート方向",
"entryPeriodEventId": "[string?]GS2-Schedule イベントGRN",
"rankingRewards": [
{
"thresholdRank": "[int]順位閾値",
"metadata": "[string?]メタデータ",
"acquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
]
}
],
"accessPeriodEventId": "[string?]GS2-Schedule イベントGRN"
}
],
"clusterRankingModels": [
{
"name": "[string]ランキング名",
"metadata": "[string?]メタデータ",
"clusterType": "[string]クラスタータイプ",
"minimumValue": "[long?]スコアの最小値",
"maximumValue": "[long?]スコアの最大値",
"sum": "[bool]登録を受け付けたスコアを合算し、合計値を競う",
"orderDirection": "[string]スコアのソート方向",
"entryPeriodEventId": "[string?]GS2-Schedule イベントGRN",
"rankingRewards": [
{
"thresholdRank": "[int]順位閾値",
"metadata": "[string?]メタデータ",
"acquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
]
}
],
"accessPeriodEventId": "[string?]GS2-Schedule イベントGRN"
}
],
"subscribeRankingModels": [
{
"name": "[string]ランキング名",
"metadata": "[string?]メタデータ",
"minimumValue": "[long?]スコアの最小値",
"maximumValue": "[long?]スコアの最大値",
"sum": "[bool]登録を受け付けたスコアを合算し、合計値を競う",
"orderDirection": "[string]スコアのソート方向",
"entryPeriodEventId": "[string?]GS2-Schedule イベントGRN",
"accessPeriodEventId": "[string?]GS2-Schedule イベントGRN"
}
]
}
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
version | ✓ | 2024-05-30 | マスターデータのフォーマットバージョン | |||
globalRankingModels | List<GlobalRankingModel> | ~ 10 items | グローバルランキングモデル | |||
clusterRankingModels | List<ClusterRankingModel> | ~ 10 items | クラスターランキングモデル | |||
subscribeRankingModels | List<SubscribeRankingModel> | ~ 10 items | 購読ランキングモデル |
GlobalRankingModel
グローバルランキングモデル
グローバルランキングは全てのプレイヤーを対象としたランキングを実現するためのモデルです。
上位1000位までのランキングを表示することができます。
GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
globalRankingModelId | string | ✓ | ~ 1024文字 | グローバルランキングGRN | ||
name | string | ✓ | ~ 128文字 | ランキング名 | ||
metadata | string | ~ 1024文字 | メタデータ | |||
minimumValue | long | ~ 9223372036854775805 | スコアの最小値 | |||
maximumValue | long | ~ 9223372036854775805 | スコアの最大値 | |||
sum | bool | ✓ | false | 登録を受け付けたスコアを合算し、合計値を競う | ||
orderDirection | enum { “asc”, “desc” } | ✓ | ~ 128文字 | スコアのソート方向 | ||
entryPeriodEventId | string | ~ 1024文字 | GS2-Schedule イベントGRN | |||
rankingRewards | List<RankingReward> | {entryPeriodEventId} != null | ~ 100 items | ランキング報酬リスト | ||
accessPeriodEventId | string | ~ 1024文字 | GS2-Schedule イベントGRN |
orderDirection に指定する列挙型の定義
定義 | 説明 |
---|---|
asc | 昇順 |
desc | 降順 |
ClusterRankingModel
クラスターランキングモデル
クラスターランキングはギルドやギャザリング内のプレイヤーを対象としたランキングを実現するためのモデルです。
上位1000位までのランキングを表示することができます。
GS2-Schedule の繰り返しイベントと関連づけると、繰り返し回数に応じてランキングをリセットすることができます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
clusterRankingModelId | string | ✓ | ~ 1024文字 | クラスターランキングGRN | ||
name | string | ✓ | ~ 128文字 | ランキング名 | ||
metadata | string | ~ 1024文字 | メタデータ | |||
clusterType | enum { “Raw”, “Gs2Guild::Guild”, “Gs2Matchmaking::SeasonGathering” } | ✓ | ~ 128文字 | クラスタータイプ | ||
minimumValue | long | ~ 9223372036854775805 | スコアの最小値 | |||
maximumValue | long | ~ 9223372036854775805 | スコアの最大値 | |||
sum | bool | ✓ | false | 登録を受け付けたスコアを合算し、合計値を競う | ||
orderDirection | enum { “asc”, “desc” } | ✓ | ~ 128文字 | スコアのソート方向 | ||
entryPeriodEventId | string | ~ 1024文字 | GS2-Schedule イベントGRN | |||
rankingRewards | List<RankingReward> | {entryPeriodEventId} != null | ~ 100 items | ランキング報酬リスト | ||
accessPeriodEventId | string | ~ 1024文字 | GS2-Schedule イベントGRN |
clusterType に指定する列挙型の定義
定義 | 説明 |
---|---|
Raw | 検証なし |
Gs2Guild::Guild | GS2-Guild ギルド |
Gs2Matchmaking::SeasonGathering | GS2-Matchmaking シーズンギャザリング |
orderDirection に指定する列挙型の定義
定義 | 説明 |
---|---|
asc | 昇順 |
desc | 降順 |
SubscribeRankingModel
購読ランキングモデル
購読した他プレイヤーのスコアを集計し、ランキングを作成するモデルです。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
subscribeRankingModelId | string | ✓ | ~ 1024文字 | グローバルランキングGRN | ||
name | string | ✓ | ~ 128文字 | ランキング名 | ||
metadata | string | ~ 1024文字 | メタデータ | |||
minimumValue | long | ~ 9223372036854775805 | スコアの最小値 | |||
maximumValue | long | ~ 9223372036854775805 | スコアの最大値 | |||
sum | bool | ✓ | false | 登録を受け付けたスコアを合算し、合計値を競う | ||
orderDirection | enum { “asc”, “desc” } | ✓ | ~ 128文字 | スコアのソート方向 | ||
entryPeriodEventId | string | ~ 1024文字 | GS2-Schedule イベントGRN | |||
accessPeriodEventId | string | ~ 1024文字 | GS2-Schedule イベントGRN |
orderDirection に指定する列挙型の定義
定義 | 説明 |
---|---|
asc | 昇順 |
desc | 降順 |
SubscribeUser
購読情報
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
rankingName | string | ✓ | ~ 128文字 | ランキング名 | ||
userId | string | ✓ | ~ 128文字 | ユーザーID | ||
targetUserId | string | ✓ | ~ 128文字 | 購読対象ユーザID |
RankingReward
ランキング報酬モデル
スコアの登録期間が設定されたランキングで、登録期間外で参照期間内の時に受け取れる報酬を設定します。
繰り返し設定が有効な場合、直近に期間を終えたランキングが報酬の受け取り対象となります。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
thresholdRank | int | ✓ | 1 ~ 1001 | 順位閾値 | ||
metadata | string | ~ 1024文字 | メタデータ | |||
acquireActions | List<AcquireAction> | [] | ~ 100 items | ランキング報酬リスト |
VerifyActionResult
検証アクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128文字 | 検証アクションで実行するアクションの種類 | ||
verifyRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
statusCode | int | ~ 999 | ステータスコード | |||
verifyResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
定義 | 説明 |
---|
ConsumeActionResult
消費アクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128文字 | 消費アクションで実行するアクションの種類 | ||
consumeRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
statusCode | int | ~ 999 | ステータスコード | |||
consumeResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
定義 | 説明 |
---|
AcquireActionResult
入手アクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128文字 | 入手アクションで実行するアクションの種類 | ||
acquireRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
statusCode | int | ~ 999 | ステータスコード | |||
acquireResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
定義 | 説明 |
---|
TransactionResult
トランザクション実行結果
サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
transactionId | string | ✓ | 36 ~ 36文字 | トランザクションID | ||
verifyResults | List<VerifyActionResult> | ~ 10 items | 検証アクションの実行結果リスト | |||
consumeResults | List<ConsumeActionResult> | ~ 10 items | 消費アクションの実行結果リスト | |||
acquireResults | List<AcquireActionResult> | ~ 100 items | 入手アクションの実行結果リスト |
AcquireAction
入手アクション