GS2-Ranking2 GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
transactionSetting | TransactionSetting | ✓ | トランザクション設定 | ||
logSetting | LogSetting | ログの出力設定 |
GetAttr
型 | 説明 | |
---|---|---|
Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Ranking2::Namespace
Properties:
Name: namespace1
Description: null
TransactionSetting: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, ranking2
class SampleStack(Stack):
def __init__(self):
super().__init__()
ranking2.Namespace(
stack=self,
name="namespace-0001",
options=ranking2.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\Ranking2\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Ranking2\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.ranking2.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.ranking2.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 ranking2 from "@/gs2cdk/ranking2";
class SampleStack extends core.Stack
{
public constructor() {
super();
new ranking2.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.Gs2Ranking2.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Ranking2.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::Ranking2::CurrentRankingMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2024-05-30",
"globalRankingModels": [
{
"name": "ranking-0001",
"orderDirection": "asc"
},
{
"name": "ranking-0002",
"orderDirection": "desc"
}
],
"clusterRankingModels": [
{
"name": "ranking-0001",
"clusterType": "Raw",
"orderDirection": "asc"
},
{
"name": "ranking-0002",
"clusterType": "Gs2Guild::Guild",
"orderDirection": "desc"
}
],
"subscribeRankingModels": [
{
"name": "ranking-0001",
"orderDirection": "asc"
},
{
"name": "ranking-0002",
"orderDirection": "desc"
}
]
}
from gs2_cdk import Stack, core, ranking2
class SampleStack(Stack):
def __init__(self):
super().__init__()
ranking2.Namespace(
stack=self,
# 省略
).master_data(
global_ranking_models=[
ranking2.GlobalRankingModel(
name='ranking-0001',
order_direction='asc',
),
ranking2.GlobalRankingModel(
name='ranking-0002',
order_direction='desc',
),
],
cluster_ranking_models=[
ranking2.ClusterRankingModel(
name='ranking-0001',
cluster_type='Raw',
order_direction='asc',
),
ranking2.ClusterRankingModel(
name='ranking-0002',
cluster_type='Gs2Guild::Guild',
order_direction='desc',
),
],
subscribe_ranking_models=[
ranking2.SubscribeRankingModel(
name='ranking-0001',
order_direction='asc',
),
ranking2.SubscribeRankingModel(
name='ranking-0002',
order_direction='desc',
),
],
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Ranking2\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Ranking2\Model\GlobalRankingModel(
name:"ranking-0001",
orderDirection: \Gs2Cdk\Ranking2\Model\Enums\GlobalRankingModelOrderDirection::ASC
),
new \Gs2Cdk\Ranking2\Model\GlobalRankingModel(
name:"ranking-0002",
orderDirection: \Gs2Cdk\Ranking2\Model\Enums\GlobalRankingModelOrderDirection::DESC
)
],
[
new \Gs2Cdk\Ranking2\Model\ClusterRankingModel(
name:"ranking-0001",
clusterType: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelClusterType::RAW,
orderDirection: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelOrderDirection::ASC
),
new \Gs2Cdk\Ranking2\Model\ClusterRankingModel(
name:"ranking-0002",
clusterType: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelClusterType::GS2_GUILD::_GUILD,
orderDirection: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelOrderDirection::DESC
)
],
[
new \Gs2Cdk\Ranking2\Model\SubscribeRankingModel(
name:"ranking-0001",
orderDirection: \Gs2Cdk\Ranking2\Model\Enums\SubscribeRankingModelOrderDirection::ASC
),
new \Gs2Cdk\Ranking2\Model\SubscribeRankingModel(
name:"ranking-0002",
orderDirection: \Gs2Cdk\Ranking2\Model\Enums\SubscribeRankingModelOrderDirection::DESC
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.ranking2.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.ranking2.model.GlobalRankingModel(
"ranking-0001",
Asc
),
new io.gs2.cdk.ranking2.model.GlobalRankingModel(
"ranking-0002",
Desc
)
),
Arrays.asList(
new io.gs2.cdk.ranking2.model.ClusterRankingModel(
"ranking-0001",
Raw,
Asc
),
new io.gs2.cdk.ranking2.model.ClusterRankingModel(
"ranking-0002",
Gs2Guild::Guild,
Desc
)
),
Arrays.asList(
new io.gs2.cdk.ranking2.model.SubscribeRankingModel(
"ranking-0001",
Asc
),
new io.gs2.cdk.ranking2.model.SubscribeRankingModel(
"ranking-0002",
Desc
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import ranking2 from "@/gs2cdk/ranking2";
class SampleStack extends core.Stack
{
public constructor() {
super();
new ranking2.model.Namespace(
this,
// 省略
).masterData(
[
new ranking2.model.GlobalRankingModel(
"ranking-0001",
ranking2.model.GlobalRankingModelOrderDirection.ASC
),
new ranking2.model.GlobalRankingModel(
"ranking-0002",
ranking2.model.GlobalRankingModelOrderDirection.DESC
)
],
[
new ranking2.model.ClusterRankingModel(
"ranking-0001",
ranking2.model.ClusterRankingModelClusterType.RAW,
ranking2.model.ClusterRankingModelOrderDirection.ASC
),
new ranking2.model.ClusterRankingModel(
"ranking-0002",
ranking2.model.ClusterRankingModelClusterType.GS2_GUILD::_GUILD,
ranking2.model.ClusterRankingModelOrderDirection.DESC
)
],
[
new ranking2.model.SubscribeRankingModel(
"ranking-0001",
ranking2.model.SubscribeRankingModelOrderDirection.ASC
),
new ranking2.model.SubscribeRankingModel(
"ranking-0002",
ranking2.model.SubscribeRankingModelOrderDirection.DESC
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Ranking2.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Ranking2.Model.GlobalRankingModel(
"ranking-0001",
Gs2Cdk.Gs2Ranking2.Model.Enums.GlobalRankingModelOrderDirection.Asc
),
new Gs2Cdk.Gs2Ranking2.Model.GlobalRankingModel(
"ranking-0002",
Gs2Cdk.Gs2Ranking2.Model.Enums.GlobalRankingModelOrderDirection.Desc
)
},
new [] {
new Gs2Cdk.Gs2Ranking2.Model.ClusterRankingModel(
"ranking-0001",
Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelClusterType.Raw,
Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelOrderDirection.Asc
),
new Gs2Cdk.Gs2Ranking2.Model.ClusterRankingModel(
"ranking-0002",
Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelClusterType.Gs2Guild::Guild,
Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelOrderDirection.Desc
)
},
new [] {
new Gs2Cdk.Gs2Ranking2.Model.SubscribeRankingModel(
"ranking-0001",
Gs2Cdk.Gs2Ranking2.Model.Enums.SubscribeRankingModelOrderDirection.Asc
),
new Gs2Cdk.Gs2Ranking2.Model.SubscribeRankingModel(
"ranking-0002",
Gs2Cdk.Gs2Ranking2.Model.Enums.SubscribeRankingModelOrderDirection.Desc
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
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 | ランキング報酬リスト |
TransactionSetting
トランザクション設定
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
enableAutoRun | bool | ✓ | true | 発行したトランザクションをサーバーサイドで自動的に実行するか | |
distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペース |
queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペース |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子(Namespace ID)を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
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文字 | タグ名 |
AcquireAction
入手アクション
Config
コンフィグ設定
トランザクションの変数に適用する設定値
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
key | string | ✓ | ~ 64文字 | 名前 | |
value | string | ~ 51200文字 | 値 |