GS2-Ranking
GS2-Deploy のテンプレートで使用できるリソース定義のリファレンス
GS2-Deploy リファレンス
エンティティ
Namespace
Namespace
Type: GS2::Ranking::Namespace
Properties:
Name: namespace1
Description: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
logSetting | LogSetting | ログの出力設定 |
CategoryModelMaster
CategoryModelMaster
Type: GS2::Ranking::CategoryModelMaster
Properties:
NamespaceName: namespace1
Name: category-0001
Description: null
Metadata: null
MinimumValue: null
MaximumValue: null
OrderDirection: asc
Scope: global
UniqueByUserId: false
CalculateFixedTimingHour: null
CalculateFixedTimingMinute: null
CalculateIntervalMinutes: 15
EntryPeriodEventId: null
AccessPeriodEventId: null
Generation: null
集計スコープ
グローバルランキングモードで使用可能。
通常グローバルランキングは登録されたスコア全てを対象にランキングの集計が行われます。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
name | string | ✓ | ~ 128文字 | カテゴリモデル名 | |
description | string | ~ 1024文字 | 説明文 | ||
metadata | string | ~ 1024文字 | メタデータ | ||
minimumValue | long | ~ 9223372036854775806 | スコアの最小値 | ||
maximumValue | long | ~ 9223372036854775806 | スコアの最大値 | ||
orderDirection | string | ✓ | ~ 128文字 | スコアのソート方向 | |
scope | string | ✓ | ~ 128文字 | ランキングの種類 | |
uniqueByUserId | bool | {scope} == "global" | ユーザID毎にスコアを1つしか登録されないようにする | ||
calculateFixedTimingHour | int | {scope} == "global" | -1 | ~ 23 | スコアの固定集計開始時刻(時) |
calculateFixedTimingMinute | int | {scope} == "global" | 0 | ~ 59 | スコアの固定集計開始時刻(分) |
calculateIntervalMinutes | int | {scope} == "global" | 15 ~ 1440 | スコアの集計間隔(分) | |
entryPeriodEventId | string | ~ 1024文字 | スコアの登録を受け付ける期間を設定した GS2-Schedule のイベント | ||
accessPeriodEventId | string | ~ 1024文字 | ランキングを参照できる期間を設定した GS2-Schedule のイベント | ||
generation | string | {scope} == "global" | ~ 256文字 | ランキングの世代 |
CurrentRankingMaster
CurrentRankingMaster
Type: GS2::Ranking::CurrentRankingMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-09-17",
"categories": [
{
"name": "category-0001",
"orderDirection": "asc",
"scope": "global",
"calculateIntervalMinutes": 15,
"uniqueByUserId": true
},
{
"name": "category-0002",
"orderDirection": "desc",
"scope": "global",
"calculateIntervalMinutes": 15,
"uniqueByUserId": false
},
{
"name": "category-0003",
"orderDirection": "asc",
"scope": "scoped",
"minimumValue": 100,
"maximumValue": 10000,
"uniqueByUserId": true
},
{
"name": "category-0004",
"orderDirection": "desc",
"scope": "scoped",
"minimumValue": 100,
"maximumValue": 10000,
"uniqueByUserId": false
},
{
"name": "category-0005",
"orderDirection": "asc",
"scope": "global",
"calculateIntervalMinutes": 15,
"uniqueByUserId": true
}
]
}
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
settings | string | ✓ | ~ 5242880文字 | マスターデータ |