GS2-Ranking2 Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例
Tags:

エンティティ

Deploy処理で操作の対象となるリソース

Namespace

ネームスペース

ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

Request

リソースの生成・更新リクエスト

型有効化条件必須デフォルト値の制限説明
namestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
descriptionstring~ 1024文字説明文
transactionSettingTransactionSetting
✓
トランザクション設定
ランキング報酬の付与に使用される分散トランザクションの設定です。入手アクションを自動実行するオートラン、全体の成否を保証するアトミックコミットをサポートします。
logSettingLogSettingログの出力設定
APIリクエスト・レスポンスログの出力先となる GS2-Log のネームスペースを指定します。スコア登録やランキング報酬配布の追跡に使用されます。

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemNamespace作成したネームスペース

実装例

Type: GS2::Ranking2::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/ranking2"
)


SampleStack := core.NewStack()
ranking2.NewNamespace(
    &SampleStack,
    "namespace-0001",
    ranking2.NamespaceOptions{
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(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()
                        .withLogSetting(new io.gs2.cdk.core.model.LogSetting(
                            "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                        ))
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Ranking2.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: 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
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
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

TransactionSetting

トランザクション設定

トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。

型有効化条件必須デフォルト値の制限説明
enableAutoRunboolfalse発行したトランザクションをサーバーサイドで自動的に実行するか
enableAtomicCommitbool{enableAutoRun} == truefalseトランザクションの実行をアトミックにコミットするか
※ enableAutoRun が true であれば 有効
transactionUseDistributorbool{enableAtomicCommit} == truefalseトランザクションを非同期処理で実行する
※ enableAtomicCommit が true であれば 有効
commitScriptResultInUseDistributorbool{transactionUseDistributor} == truefalseスクリプトの結果コミット処理を非同期処理で実行するか
※ transactionUseDistributor が true であれば 有効
acquireActionUseJobQueuebool{enableAtomicCommit} == truefalse入手アクションを実行する際に GS2-JobQueue を使用するか
※ enableAtomicCommit が true であれば 有効
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字トランザクションの実行に使用する GS2-Distributor ネームスペース GRN
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字トランザクションの実行に使用する GS2-JobQueue のネームスペース GRN

LogSetting

ログの出力設定

ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

型有効化条件必須デフォルト値の制限説明
loggingNamespaceIdstring
✓
~ 1024文字ログを出力する GS2-Log のネームスペース GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

CurrentRankingMaster

現在アクティブなランキングモデルのマスターデータ

現在ネームスペース内で有効な、ランキングモデルの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

Request

リソースの生成・更新リクエスト

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
mode文字列列挙型
enum {
  “direct”,
  “preUpload”
}
“direct”更新モード
定義説明
“direct”マスターデータを直接更新
“preUpload”マスターデータをアップロードしてから更新
settingsstring{mode} == “direct”
✓※
~ 5242880文字マスターデータ
※ mode が “direct” であれば必須
uploadTokenstring{mode} == “preUpload”
✓※
~ 1024文字事前アップロードで取得したトークン
アップロードしたマスターデータを適用するために使用されます。
※ mode が “preUpload” であれば必須

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemCurrentRankingMaster更新された現在アクティブなランキングモデルのマスターデータ

実装例

Type: GS2::Ranking2::CurrentRankingMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  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"
      }
    ]
  }
  UploadToken: null
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/ranking2"
)


SampleStack := core.NewStack()
ranking2.NewNamespace(
    &SampleStack,
    "namespace-0001",
    ranking2.NamespaceOptions{},
).MasterData(
    []ranking2.GlobalRankingModel{
        ranking2.NewGlobalRankingModel(
            "ranking-0001",
            false,
            ranking2.GlobalRankingModelOrderDirectionAsc,
            ranking2.GlobalRankingModelRewardCalculationIndexRank,
            ranking2.GlobalRankingModelOptions{
            },
        ),
        ranking2.NewGlobalRankingModel(
            "ranking-0002",
            false,
            ranking2.GlobalRankingModelOrderDirectionDesc,
            ranking2.GlobalRankingModelRewardCalculationIndexRank,
            ranking2.GlobalRankingModelOptions{
            },
        ),
    },
    []ranking2.ClusterRankingModel{
        ranking2.NewClusterRankingModel(
            "ranking-0001",
            ranking2.ClusterRankingModelClusterTypeRaw,
            false,
            ranking2.ClusterRankingModelOrderDirectionAsc,
            ranking2.ClusterRankingModelRewardCalculationIndexRank,
            ranking2.ClusterRankingModelOptions{
            },
        ),
        ranking2.NewClusterRankingModel(
            "ranking-0002",
            ranking2.ClusterRankingModelClusterTypeGs2Guild_guild,
            false,
            ranking2.ClusterRankingModelOrderDirectionDesc,
            ranking2.ClusterRankingModelRewardCalculationIndexRank,
            ranking2.ClusterRankingModelOptions{
            },
        ),
    },
    []ranking2.SubscribeRankingModel{
        ranking2.NewSubscribeRankingModel(
            "ranking-0001",
            false,
            ranking2.SubscribeRankingModelOrderDirectionAsc,
            ranking2.SubscribeRankingModelOptions{
            },
        ),
        ranking2.NewSubscribeRankingModel(
            "ranking-0002",
            false,
            ranking2.SubscribeRankingModelOrderDirectionDesc,
            ranking2.SubscribeRankingModelOptions{
            },
        ),
    },
)

println(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"
        ))->masterData(
            [
                new \Gs2Cdk\Ranking2\Model\GlobalRankingModel(
                    name:"ranking-0001",
                    sum: false,
                    orderDirection: \Gs2Cdk\Ranking2\Model\Enums\GlobalRankingModelOrderDirection::ASC,
                    rewardCalculationIndex: \Gs2Cdk\Ranking2\Model\Enums\GlobalRankingModelRewardCalculationIndex::RANK
                ),
                new \Gs2Cdk\Ranking2\Model\GlobalRankingModel(
                    name:"ranking-0002",
                    sum: false,
                    orderDirection: \Gs2Cdk\Ranking2\Model\Enums\GlobalRankingModelOrderDirection::DESC,
                    rewardCalculationIndex: \Gs2Cdk\Ranking2\Model\Enums\GlobalRankingModelRewardCalculationIndex::RANK
                )
            ],
            [
                new \Gs2Cdk\Ranking2\Model\ClusterRankingModel(
                    name:"ranking-0001",
                    clusterType: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelClusterType::RAW,
                    sum: false,
                    orderDirection: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelOrderDirection::ASC,
                    rewardCalculationIndex: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelRewardCalculationIndex::RANK
                ),
                new \Gs2Cdk\Ranking2\Model\ClusterRankingModel(
                    name:"ranking-0002",
                    clusterType: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelClusterType::GS2_GUILD__GUILD,
                    sum: false,
                    orderDirection: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelOrderDirection::DESC,
                    rewardCalculationIndex: \Gs2Cdk\Ranking2\Model\Enums\ClusterRankingModelRewardCalculationIndex::RANK
                )
            ],
            [
                new \Gs2Cdk\Ranking2\Model\SubscribeRankingModel(
                    name:"ranking-0001",
                    sum: false,
                    orderDirection: \Gs2Cdk\Ranking2\Model\Enums\SubscribeRankingModelOrderDirection::ASC
                ),
                new \Gs2Cdk\Ranking2\Model\SubscribeRankingModel(
                    name:"ranking-0002",
                    sum: false,
                    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,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.ranking2.model.GlobalRankingModel(
                    "ranking-0001",
                    false,
                    io.gs2.cdk.ranking2.model.enums.GlobalRankingModelOrderDirection.ASC,
                    io.gs2.cdk.ranking2.model.enums.GlobalRankingModelRewardCalculationIndex.RANK
                ),
                new io.gs2.cdk.ranking2.model.GlobalRankingModel(
                    "ranking-0002",
                    false,
                    io.gs2.cdk.ranking2.model.enums.GlobalRankingModelOrderDirection.DESC,
                    io.gs2.cdk.ranking2.model.enums.GlobalRankingModelRewardCalculationIndex.RANK
                )
            ),
            Arrays.asList(
                new io.gs2.cdk.ranking2.model.ClusterRankingModel(
                    "ranking-0001",
                    io.gs2.cdk.ranking2.model.enums.ClusterRankingModelClusterType.RAW,
                    false,
                    io.gs2.cdk.ranking2.model.enums.ClusterRankingModelOrderDirection.ASC,
                    io.gs2.cdk.ranking2.model.enums.ClusterRankingModelRewardCalculationIndex.RANK
                ),
                new io.gs2.cdk.ranking2.model.ClusterRankingModel(
                    "ranking-0002",
                    io.gs2.cdk.ranking2.model.enums.ClusterRankingModelClusterType.GS2_GUILD__GUILD,
                    false,
                    io.gs2.cdk.ranking2.model.enums.ClusterRankingModelOrderDirection.DESC,
                    io.gs2.cdk.ranking2.model.enums.ClusterRankingModelRewardCalculationIndex.RANK
                )
            ),
            Arrays.asList(
                new io.gs2.cdk.ranking2.model.SubscribeRankingModel(
                    "ranking-0001",
                    false,
                    io.gs2.cdk.ranking2.model.enums.SubscribeRankingModelOrderDirection.ASC
                ),
                new io.gs2.cdk.ranking2.model.SubscribeRankingModel(
                    "ranking-0002",
                    false,
                    io.gs2.cdk.ranking2.model.enums.SubscribeRankingModelOrderDirection.DESC
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Ranking2.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Ranking2.Model.GlobalRankingModel[] {
                new Gs2Cdk.Gs2Ranking2.Model.GlobalRankingModel(
                    name: "ranking-0001",
                    sum: false,
                    orderDirection: Gs2Cdk.Gs2Ranking2.Model.Enums.GlobalRankingModelOrderDirection.Asc,
                    rewardCalculationIndex: Gs2Cdk.Gs2Ranking2.Model.Enums.GlobalRankingModelRewardCalculationIndex.Rank
                ),
                new Gs2Cdk.Gs2Ranking2.Model.GlobalRankingModel(
                    name: "ranking-0002",
                    sum: false,
                    orderDirection: Gs2Cdk.Gs2Ranking2.Model.Enums.GlobalRankingModelOrderDirection.Desc,
                    rewardCalculationIndex: Gs2Cdk.Gs2Ranking2.Model.Enums.GlobalRankingModelRewardCalculationIndex.Rank
                )
            },
            new Gs2Cdk.Gs2Ranking2.Model.ClusterRankingModel[] {
                new Gs2Cdk.Gs2Ranking2.Model.ClusterRankingModel(
                    name: "ranking-0001",
                    clusterType: Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelClusterType.Raw,
                    sum: false,
                    orderDirection: Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelOrderDirection.Asc,
                    rewardCalculationIndex: Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelRewardCalculationIndex.Rank
                ),
                new Gs2Cdk.Gs2Ranking2.Model.ClusterRankingModel(
                    name: "ranking-0002",
                    clusterType: Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelClusterType.Gs2Guild_guild,
                    sum: false,
                    orderDirection: Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelOrderDirection.Desc,
                    rewardCalculationIndex: Gs2Cdk.Gs2Ranking2.Model.Enums.ClusterRankingModelRewardCalculationIndex.Rank
                )
            },
            new Gs2Cdk.Gs2Ranking2.Model.SubscribeRankingModel[] {
                new Gs2Cdk.Gs2Ranking2.Model.SubscribeRankingModel(
                    name: "ranking-0001",
                    sum: false,
                    orderDirection: Gs2Cdk.Gs2Ranking2.Model.Enums.SubscribeRankingModelOrderDirection.Asc
                ),
                new Gs2Cdk.Gs2Ranking2.Model.SubscribeRankingModel(
                    name: "ranking-0002",
                    sum: false,
                    orderDirection: Gs2Cdk.Gs2Ranking2.Model.Enums.SubscribeRankingModelOrderDirection.Desc
                )
            }
        );
    }
}

Debug.Log(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",
        ).masterData(
            [
                new ranking2.model.GlobalRankingModel(
                    "ranking-0001",
                    false,
                    ranking2.model.GlobalRankingModelOrderDirection.ASC,
                    ranking2.model.GlobalRankingModelRewardCalculationIndex.RANK
                ),
                new ranking2.model.GlobalRankingModel(
                    "ranking-0002",
                    false,
                    ranking2.model.GlobalRankingModelOrderDirection.DESC,
                    ranking2.model.GlobalRankingModelRewardCalculationIndex.RANK
                )
            ],
            [
                new ranking2.model.ClusterRankingModel(
                    "ranking-0001",
                    ranking2.model.ClusterRankingModelClusterType.RAW,
                    false,
                    ranking2.model.ClusterRankingModelOrderDirection.ASC,
                    ranking2.model.ClusterRankingModelRewardCalculationIndex.RANK
                ),
                new ranking2.model.ClusterRankingModel(
                    "ranking-0002",
                    ranking2.model.ClusterRankingModelClusterType.GS2_GUILD__GUILD,
                    false,
                    ranking2.model.ClusterRankingModelOrderDirection.DESC,
                    ranking2.model.ClusterRankingModelRewardCalculationIndex.RANK
                )
            ],
            [
                new ranking2.model.SubscribeRankingModel(
                    "ranking-0001",
                    false,
                    ranking2.model.SubscribeRankingModelOrderDirection.ASC
                ),
                new ranking2.model.SubscribeRankingModel(
                    "ranking-0002",
                    false,
                    ranking2.model.SubscribeRankingModelOrderDirection.DESC
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
from gs2_cdk import Stack, core, ranking2

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        ranking2.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            global_ranking_models=[
                ranking2.GlobalRankingModel(
                    name='ranking-0001',
                    sum=False,
                    order_direction=ranking2.GlobalRankingModelOrderDirection.ASC,
                    reward_calculation_index=ranking2.GlobalRankingModelRewardCalculationIndex.RANK
                ),
                ranking2.GlobalRankingModel(
                    name='ranking-0002',
                    sum=False,
                    order_direction=ranking2.GlobalRankingModelOrderDirection.DESC,
                    reward_calculation_index=ranking2.GlobalRankingModelRewardCalculationIndex.RANK
                ),
            ],
            cluster_ranking_models=[
                ranking2.ClusterRankingModel(
                    name='ranking-0001',
                    cluster_type=ranking2.ClusterRankingModelClusterType.RAW,
                    sum=False,
                    order_direction=ranking2.ClusterRankingModelOrderDirection.ASC,
                    reward_calculation_index=ranking2.ClusterRankingModelRewardCalculationIndex.RANK
                ),
                ranking2.ClusterRankingModel(
                    name='ranking-0002',
                    cluster_type=ranking2.ClusterRankingModelClusterType.GS2_GUILD__GUILD,
                    sum=False,
                    order_direction=ranking2.ClusterRankingModelOrderDirection.DESC,
                    reward_calculation_index=ranking2.ClusterRankingModelRewardCalculationIndex.RANK
                ),
            ],
            subscribe_ranking_models=[
                ranking2.SubscribeRankingModel(
                    name='ranking-0001',
                    sum=False,
                    order_direction=ranking2.SubscribeRankingModelOrderDirection.ASC
                ),
                ranking2.SubscribeRankingModel(
                    name='ranking-0002',
                    sum=False,
                    order_direction=ranking2.SubscribeRankingModelOrderDirection.DESC
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template

GlobalRankingModel

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

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

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

型有効化条件必須デフォルト値の制限説明
globalRankingModelIdstring
※
~ 1024文字グローバルランキング GRN
※ サーバーが自動で設定
namestring
✓
~ 128文字グローバルランキングモデル名
グローバルランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadatastring~ 1024文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
minimumValuelong0 ~ 9223372036854775805スコアの最小値
許容されるスコアの最小値です。この値を下回るスコアは登録時に拒否されます。無効または意図しないスコア値のフィルタリングに使用します。
maximumValuelong0 ~ 9223372036854775805スコアの最大値
許容されるスコアの最大値です。この値を超えるスコアは登録時に拒否されます。異常に高いスコアの登録防止に使用します。
sumboolfalseスコア合算
有効にすると、登録されたすべてのスコアが合算され、合計値でランキングが決定されます。無効の場合、ソート方向に応じた最良のスコア（最高値または最低値）のみがランキングに使用されます。
orderDirection文字列列挙型
enum {
  “asc”,
  “desc”
}
✓
ソート方向
ランキングスコアのソート方向です。低いスコアほど上位の場合（例：タイムアタック）は「昇順」、高いスコアほど上位の場合（例：ハイスコア）は「降順」を使用します。
定義説明
“asc”昇順
“desc”降順
entryPeriodEventIdstring~ 1024文字スコア登録可能期間イベント GRN
スコアを登録できる期間を定義する GS2-Schedule のイベントGRNです。繰り返しイベントと関連づけると、繰り返しサイクルごとにランキングがリセットされ、シーズン制ランキングを実現できます。
rankingRewardsList<RankingReward>{entryPeriodEventId} != null[]0 ~ 100 itemsランキング報酬リスト
各シーズン終了時のランキング順位に基づいて付与される報酬のリストです。スコア登録可能期間イベントが設定されている場合のみ利用可能です。各報酬は順位閾値と実行する入手アクションを定義します。
accessPeriodEventIdstring~ 1024文字ランキングデータアクセス可能期間イベント GRN
ランキング結果の閲覧と報酬の受け取りが可能な期間を定義する GS2-Schedule のイベントGRNです。通常、スコア登録期間の間のインターバルに設定します。
rewardCalculationIndex文字列列挙型
enum {
  “rank”,
  “index”
}
“rank”報酬計算インデックス
報酬をプレイヤーに対応付ける方法を決定します。「順位ベース」は1始まりのランキング順位を使用し（同スコアのプレイヤーは同じ順位を共有）、「インデックスベース」は0始まりの一意のソート位置を使用します（同順位なし）。通常のユースケースでは「順位ベース」を選択してください。
定義説明
“rank”順位ベースで報酬を決定
“index”インデックスベースで報酬を決定

RankingReward

ランキング報酬

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

型有効化条件必須デフォルト値の制限説明
thresholdRankint
✓
1 ~ 1001順位閾値
この報酬ティアの順位閾値です。順位（またはインデックス、rewardCalculationIndex の設定に依存）がこの閾値以上のプレイヤーがこの報酬を受け取ります。1001に設定すると、ランク外（上位1000位外）のプレイヤー向けの報酬を定義できます。
metadatastring~ 1024文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
acquireActionsList<AcquireAction>[]0 ~ 100 items入手アクションリスト
プレイヤーがこのランキング報酬を受け取る際に実行される入手アクションのリストです。この順位閾値を達成した報酬として付与されるアイテム、通貨、その他のリソースを定義します。

ClusterRankingModel

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

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

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

型有効化条件必須デフォルト値の制限説明
clusterRankingModelIdstring
※
~ 1024文字クラスターランキング GRN
※ サーバーが自動で設定
namestring
✓
~ 128文字クラスターランキングモデル名
クラスターランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadatastring~ 1024文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
clusterType文字列列挙型
enum {
  “Raw”,
  “Gs2Guild::Guild”,
  “Gs2Matchmaking::SeasonGathering”
}
✓
クラスタータイプ
ランキングのセグメンテーションに使用するグループ（クラスター）の種類を定義します。「Raw」は所属検証なしで任意のクラスター名を指定でき、「Gs2Guild::Guild」はGS2-Guildギルドへの所属を検証し、「Gs2Matchmaking::SeasonGathering」はGS2-Matchmakingシーズンギャザリングへの所属を検証します。
定義説明
“Raw”検証なし
“Gs2Guild::Guild”GS2-Guild ギルド
“Gs2Matchmaking::SeasonGathering”GS2-Matchmaking シーズンギャザリング
minimumValuelong0 ~ 9223372036854775805スコアの最小値
許容されるスコアの最小値です。この値を下回るスコアは登録時に拒否されます。
maximumValuelong0 ~ 9223372036854775805スコアの最大値
許容されるスコアの最大値です。この値を超えるスコアは登録時に拒否されます。
sumboolfalseスコア合算
有効にすると、登録されたすべてのスコアが合算され、合計値でランキングが決定されます。無効の場合、最良のスコアのみがランキングに使用されます。
orderDirection文字列列挙型
enum {
  “asc”,
  “desc”
}
✓
ソート方向
ランキングスコアのソート方向です。低いスコアほど上位の場合は「昇順」、高いスコアほど上位の場合は「降順」を使用します。
定義説明
“asc”昇順
“desc”降順
entryPeriodEventIdstring~ 1024文字スコア登録可能期間イベント GRN
スコアを登録できる期間を定義する GS2-Schedule のイベントGRNです。繰り返しイベントと関連づけると、シーズン制ランキングを実現できます。
rankingRewardsList<RankingReward>{entryPeriodEventId} != null[]0 ~ 100 itemsランキング報酬リスト
各シーズン終了時のランキング順位に基づいて付与される報酬のリストです。スコア登録可能期間イベントが設定されている場合のみ利用可能です。
accessPeriodEventIdstring~ 1024文字ランキングデータアクセス可能期間イベント GRN
ランキング結果の閲覧と報酬の受け取りが可能な期間を定義する GS2-Schedule のイベントGRNです。
rewardCalculationIndex文字列列挙型
enum {
  “rank”,
  “index”
}
“rank”報酬計算インデックス
報酬をプレイヤーに対応付ける方法を決定します。「順位ベース」は1始まりのランキング順位（同スコアは同順位）、「インデックスベース」は0始まりの一意のソート位置（同順位なし）を使用します。
定義説明
“rank”順位ベースで報酬を決定
“index”インデックスベースで報酬を決定

SubscribeRankingModel

購読ランキングモデル

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

型有効化条件必須デフォルト値の制限説明
subscribeRankingModelIdstring
※
~ 1024文字購読ランキング GRN
※ サーバーが自動で設定
namestring
✓
~ 128文字購読ランキングモデル名
購読ランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadatastring~ 1024文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
minimumValuelong0 ~ 9223372036854775805スコアの最小値
許容されるスコアの最小値です。この値を下回るスコアは登録時に拒否されます。
maximumValuelong0 ~ 9223372036854775805スコアの最大値
許容されるスコアの最大値です。この値を超えるスコアは登録時に拒否されます。
sumboolfalseスコア合算
有効にすると、登録されたすべてのスコアが合算され、合計値でランキングが決定されます。無効の場合、最良のスコアのみがランキングに使用されます。
orderDirection文字列列挙型
enum {
  “asc”,
  “desc”
}
✓
ソート方向
ランキングスコアのソート方向です。低いスコアほど上位の場合は「昇順」、高いスコアほど上位の場合は「降順」を使用します。
定義説明
“asc”昇順
“desc”降順
entryPeriodEventIdstring~ 1024文字スコア登録可能期間イベント GRN
スコアを登録できる期間を定義する GS2-Schedule のイベントGRNです。繰り返しイベントと関連づけると、シーズン制ランキングを実現できます。
accessPeriodEventIdstring~ 1024文字ランキングデータアクセス可能期間イベント GRN
ランキング結果の閲覧が可能な期間を定義する GS2-Schedule のイベントGRNです。

AcquireAction

入手アクション

型有効化条件必須デフォルト値の制限説明
action文字列列挙型
enum {
"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:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"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",
"Gs2Schedule:ExtendTriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
✓
入手アクションで実行するアクションの種類
requeststring
✓
~ 524288文字アクション実行時に使用されるリクエストのJSON文字列