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"
    }
  ]
}
有効化条件必須デフォルト値の制限説明
version2024-05-30マスターデータのフォーマットバージョン
globalRankingModelsList<GlobalRankingModel>~ 10 itemsグローバルランキングモデル
clusterRankingModelsList<ClusterRankingModel>~ 10 itemsクラスターランキングモデル
subscribeRankingModelsList<SubscribeRankingModel>~ 10 items購読ランキングモデル

GlobalRankingModel

グローバルランキングモデル

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

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

有効化条件必須デフォルト値の制限説明
globalRankingModelIdstring~ 1024文字グローバルランキングGRN
namestring~ 128文字ランキング名
metadatastring~ 1024文字メタデータ
minimumValuelong~ 9223372036854775805スコアの最小値
maximumValuelong~ 9223372036854775805スコアの最大値
sumboolfalse登録を受け付けたスコアを合算し、合計値を競う
orderDirectionenum [
“asc”,
“desc”
]
~ 128文字スコアのソート方向
entryPeriodEventIdstring~ 1024文字GS2-Schedule イベントGRN
rankingRewardsList<RankingReward>{entryPeriodEventId} != null~ 100 itemsランキング報酬リスト
accessPeriodEventIdstring~ 1024文字GS2-Schedule イベントGRN

ClusterRankingModel

クラスターランキングモデル

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

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

有効化条件必須デフォルト値の制限説明
clusterRankingModelIdstring~ 1024文字クラスターランキングGRN
namestring~ 128文字ランキング名
metadatastring~ 1024文字メタデータ
clusterTypeenum [
“Raw”,
“Gs2Guild::Guild”,
“Gs2Matchmaking::SeasonGathering”
]
~ 128文字クラスタータイプ
minimumValuelong~ 9223372036854775805スコアの最小値
maximumValuelong~ 9223372036854775805スコアの最大値
sumboolfalse登録を受け付けたスコアを合算し、合計値を競う
orderDirectionenum [
“asc”,
“desc”
]
~ 128文字スコアのソート方向
entryPeriodEventIdstring~ 1024文字GS2-Schedule イベントGRN
rankingRewardsList<RankingReward>{entryPeriodEventId} != null~ 100 itemsランキング報酬リスト
accessPeriodEventIdstring~ 1024文字GS2-Schedule イベントGRN

SubscribeRankingModel

購読ランキングモデル

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

有効化条件必須デフォルト値の制限説明
subscribeRankingModelIdstring~ 1024文字グローバルランキングGRN
namestring~ 128文字ランキング名
metadatastring~ 1024文字メタデータ
minimumValuelong~ 9223372036854775805スコアの最小値
maximumValuelong~ 9223372036854775805スコアの最大値
sumboolfalse登録を受け付けたスコアを合算し、合計値を競う
orderDirectionenum [
“asc”,
“desc”
]
~ 128文字スコアのソート方向
entryPeriodEventIdstring~ 1024文字GS2-Schedule イベントGRN
accessPeriodEventIdstring~ 1024文字GS2-Schedule イベントGRN

SubscribeUser

購読情報

有効化条件必須デフォルト値の制限説明
rankingNamestring~ 128文字ランキング名
userIdstring~ 128文字ユーザーID
targetUserIdstring~ 128文字購読対象ユーザID

RankingReward

ランキング報酬モデル

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

有効化条件必須デフォルト値の制限説明
thresholdRankint1 ~ 1001順位閾値
metadatastring~ 1024文字メタデータ
acquireActionsList<AcquireAction>[]~ 100 itemsランキング報酬リスト

AcquireAction

入手アクション

有効化条件必須デフォルト値の制限説明
actionenum [
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:UnlockIncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2SerialKey:RevertUseByUserId",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
]
~ 128文字スタンプシートを使用して実行するアクションの種類
requeststring~ 1048576文字リクエストのJSON