GS2-Ranking GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
logSetting | LogSetting | ログの出力設定 |
GetAttr
型 | 説明 | |
---|---|---|
Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Ranking::Namespace
Properties:
Name: namespace1
Description: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, ranking
class SampleStack(Stack):
def __init__(self):
super().__init__()
ranking.Namespace(
stack=self,
name="namespace-0001",
options=ranking.NamespaceOptions(
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Ranking\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Ranking\Model\Options\NamespaceOptions(
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
)
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.ranking.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.ranking.model.options.NamespaceOptions() {
{
logSetting = new io.gs2.cdk.core.model.LogSetting(
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import ranking from "@/gs2cdk/ranking";
class SampleStack extends core.Stack
{
public constructor() {
super();
new ranking.model.Namespace(
this,
"namespace-0001",
{
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Ranking.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Ranking.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
CurrentRankingMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | |
settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
型 | 説明 | |
---|---|---|
Item | CurrentRankingMaster | 更新した現在有効なランキング設定 |
実装例
Type: GS2::Ranking::CurrentRankingMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-09-17",
"categoryModels": [
{
"name": "category-0001",
"orderDirection": "asc",
"scope": "global"
},
{
"name": "category-0002",
"orderDirection": "asc",
"scope": "scoped",
"metadata": "CATEGORY_0002",
"minimumValue": 1000,
"maximumValue": 100000
}
]
}
from gs2_cdk import Stack, core, ranking
class SampleStack(Stack):
def __init__(self):
super().__init__()
ranking.Namespace(
stack=self,
# 省略
).master_data(
category_models=[
ranking.CategoryModel(
name='category-0001',
order_direction='asc',
scope='global',
),
ranking.CategoryModel(
name='category-0002',
order_direction='asc',
scope='scoped',
options=ranking.CategoryModelOptions(
metadata='CATEGORY_0002',
minimum_value=1000,
maximum_value=100000,
),
),
],
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Ranking\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Ranking\Model\CategoryModel(
name:"category-0001",
orderDirection: \Gs2Cdk\Ranking\Model\Enums\CategoryModelOrderDirection::ASC,
scope: \Gs2Cdk\Ranking\Model\Enums\CategoryModelScope::GLOBAL
),
new \Gs2Cdk\Ranking\Model\CategoryModel(
name:"category-0002",
orderDirection: \Gs2Cdk\Ranking\Model\Enums\CategoryModelOrderDirection::ASC,
scope: \Gs2Cdk\Ranking\Model\Enums\CategoryModelScope::SCOPED,
options: new \Gs2Cdk\Ranking\Model\Options\CategoryModelOptions(
metadata:"CATEGORY_0002",
minimumValue:1000,
maximumValue:100000
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.ranking.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.ranking.model.CategoryModel(
"category-0001",
Asc,
Global
),
new io.gs2.cdk.ranking.model.CategoryModel(
"category-0002",
Asc,
Scoped,
new io.gs2.cdk.ranking.model.options.CategoryModelOptions() {
{
metadata: "CATEGORY_0002";
minimumValue: 1000L;
maximumValue: 100000L;
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import ranking from "@/gs2cdk/ranking";
class SampleStack extends core.Stack
{
public constructor() {
super();
new ranking.model.Namespace(
this,
// 省略
).masterData(
[
new ranking.model.CategoryModel(
"category-0001",
ranking.model.CategoryModelOrderDirection.ASC,
ranking.model.CategoryModelScope.GLOBAL
),
new ranking.model.CategoryModel(
"category-0002",
ranking.model.CategoryModelOrderDirection.ASC,
ranking.model.CategoryModelScope.SCOPED,
{
metadata: "CATEGORY_0002",
minimumValue: 1000,
maximumValue: 100000
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Ranking.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Ranking.Model.CategoryModel(
"category-0001",
Gs2Cdk.Gs2Ranking.Model.Enums.CategoryModelOrderDirection.Asc,
Gs2Cdk.Gs2Ranking.Model.Enums.CategoryModelScope.Global
),
new Gs2Cdk.Gs2Ranking.Model.CategoryModel(
"category-0002",
Gs2Cdk.Gs2Ranking.Model.Enums.CategoryModelOrderDirection.Asc,
Gs2Cdk.Gs2Ranking.Model.Enums.CategoryModelScope.Scoped,
new Gs2Cdk.Gs2Ranking.Model.Options.CategoryModelOptions {
metadata = "CATEGORY_0002",
minimumValue = 1000L,
maximumValue = 100000L
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
Ranking
ランキング
ランキングには「参加者全員が同じボード上で競い合う」 グローバルランキング と、「購読したプレイヤーのスコアと競い合う」 スコープランキング があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
rank | long | ✓ | 1 ~ 9223372036854775805 | 順位 | |
index | long | ✓ | ~ 9223372036854775805 | 1位からのインデックス | |
categoryName | string | ✓ | ~ 128文字 | カテゴリ名 | |
userId | string | ✓ | ~ 128文字 | ユーザーID | |
score | long | ✓ | ~ 9223372036854775805 | スコア | |
metadata | string | ~ 512文字 | メタデータ | ||
createdAt | long | ✓ | 作成日時 |
Scope
集計スコープ
グローバルランキングモードで使用可能。 通常グローバルランキングは登録されたスコア全てを対象にランキングの集計が行われます。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | スコープ名 | |
targetDays | long | ✓ | 1 ~ 365 | 集計対象日数 |
GlobalRankingSetting
グローバルランキング設定
グローバルは全プレイヤーが同じ結果を参照するものです。 ランキングの集計間隔を15分~24時間で設定できます。
ランキングデータには世代という設定があり、世代を変更することで登録されたスコアをリセットすることができます。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
uniqueByUserId | bool | ✓ | true | ユーザID毎にスコアを1つしか登録されないようにする | |
calculateIntervalMinutes | int | ✓ | 15 ~ 1440 | スコアの集計間隔(分) | |
calculateFixedTiming | FixedTiming | スコアの固定集計開始時刻 | |||
additionalScopes | List<Scope> | ~ 10 items | スコープリスト | ||
ignoreUserIds | List<string> | ~ 10000 items | ランキングに反映しないユーザーIDリスト | ||
generation | string | ~ 256文字 | ランキングの世代 |
FixedTiming
集計時刻固定設定
グローバルランキングの集計タイミングを固定するための設定です。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
hour | int | ~ 23 | スコアの固定集計開始時刻(時) | ||
minute | int | ~ 59 | スコアの固定集計開始時刻(分) |
CalculatedAt
最終集計日時
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
categoryName | string | ✓ | ~ 128文字 | カテゴリ名 | |
calculatedAt | long | ✓ | 集計日時 |
GitHubCheckoutSetting
GitHubからマスターデータをチェックアウトする設定
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
apiKeyId | string | ✓ | ~ 1024文字 | GitHub のAPIキーGRN | |
repositoryName | string | ✓ | ~ 1024文字 | リポジトリ名 | |
sourcePath | string | ✓ | ~ 1024文字 | ソースコードのファイルパス | |
referenceType | enum [ “commit_hash”, “branch”, “tag” ] | ✓ | ~ 128文字 | コードの取得元 | |
commitHash | string | {referenceType} == “commit_hash” | ~ 1024文字 | コミットハッシュ | |
branchName | string | {referenceType} == “branch” | ~ 1024文字 | ブランチ名 | |
tagName | string | {referenceType} == “tag” | ~ 1024文字 | タグ名 |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子(Namespace ID)を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |