> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Ranking Deploy/CDK リファレンス

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




## エンティティ

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

### Namespace

ネームスペース<br>

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

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

#### Request

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  | |  |  ~ 1024文字 | 説明文 |
| transactionSetting | [TransactionSetting](#transactionsetting) |  | |  |  | トランザクション設定<br>ランキング操作時のトランザクションの処理方法を制御する設定です。 |
| logSetting | [LogSetting](#logsetting) |  | |  |  | ログ出力設定<br>ランキング関連の操作ログを GS2-Log に出力するための設定。<br/>設定すると、スコア登録、ランキング取得、購読変更などのアクションが分析や監査のために記録されます。 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | 作成したネームスペース

#### 実装例




**GS2-Deploy(YAML)**
```yaml

Type: GS2::Ranking::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

```

**Go**
```go

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/ranking"
)


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

println(SampleStack.Yaml())  // Generate Template

```

**PHP**
```php

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

```

**Java**
```java

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()
                        .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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Ranking.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: 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

```

**TypeScript**
```typescript

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

```

**Python**
```python

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

```


#### TransactionSetting

トランザクション設定<br>

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

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

#### LogSetting

ログの出力設定<br>

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

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

---

### CurrentRankingMaster

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

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

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。<br>
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
{{% alert title="Note" color="info" %}}
JSONファイルの形式については [GS2-Ranking マスターデータリファレンス](api_reference/ranking/master_data/) をご参照ください。
{{% /alert %}}

#### Request

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

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

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [CurrentRankingMaster](../sdk#currentrankingmaster) | 更新された現在アクティブなランキングモデルのマスターデータ

#### 実装例




**GS2-Deploy(YAML)**
```yaml

Type: GS2::Ranking::CurrentRankingMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2019-09-17",
    "categories": []
    
  }
  UploadToken: null

```

**Go**
```go

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/ranking"
)


SampleStack := core.NewStack()
ranking.NewNamespace(
    &SampleStack,
    "namespace-0001",
    ranking.NamespaceOptions{},
).MasterData(
    []ranking.CategoryModel{
    },
)

println(SampleStack.Yaml())  // Generate Template

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Ranking\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.ranking.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Ranking.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Ranking.Model.CategoryModel[] {
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

```

**TypeScript**
```typescript

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",
        ).masterData(
            [
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

```

**Python**
```python

from gs2_cdk import Stack, core, ranking

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        ranking.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            categories=[
            ],
        )

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

```


#### CategoryModel

カテゴリーモデル<br>

カテゴリー毎に異なるランキングを作成できます。<br>

カテゴリーには登録できるスコアの最小値・最大値を設定でき、その範囲外のスコアは破棄されます。<br>
ランキングを集計する際にスコアを小さいものを上位（昇順）にするか、大きいものを上位（降順）にするかを設定できます。<br>

ランキングの種類として `グローバル` と `スコープ` を選択できます。<br>
グローバルは全プレイヤーが同じ結果を参照するもので、スコープはフレンド内ランキングや、ギルド内ランキングのようなゲームプレイヤー毎に結果の異なるランキングです。<br>

グローバルランキングはカテゴリーごとにランキングの集計間隔を15分～24時間で設定できます。<br>
スコープランキングはリアルタイムで集計結果が反映されます。<br>

ランキングデータには世代という設定があり、世代を変更することで登録されたスコアをリセットすることができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| categoryModelId | string |  | ※ |  |  ~ 1024文字 | カテゴリーモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | カテゴリーモデル名<br>カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 1024文字 | メタデータ<br>メタデータには任意の値を設定できます。<br/>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| minimumValue | long |  |  |  | 0 ~ 9223372036854775805 | スコアの最小値<br>このカテゴリーに登録できるスコアの最小値。<br/>この閾値を下回るスコアは登録時に拒否されます。未設定の場合、下限はありません。 |
| maximumValue | long |  |  |  | 0 ~ 9223372036854775805 | スコアの最大値<br>このカテゴリーに登録できるスコアの最大値。<br/>この閾値を上回るスコアは登録時に拒否されます。未設定の場合、上限はありません。 |
| sum | bool |  |  | false |  | 合算モード<br>有効にすると、新しく登録されたスコアは既存のスコアを置き換えるのではなく、合計に加算されます。<br/>ランキングは蓄積された合計値に基づいて計算されます。無効の場合、各スコア登録は独立したエントリとして扱われます。 |
| orderDirection | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"asc",<br>&nbsp;&nbsp;"desc"<br>}<br> |  | ✓ |  |  | ソート方向<br>ランキング集計のソート順を決定します。<br/>"asc"（昇順）は低いスコアを上位とし、タイムベースやゴルフ式のランキングに適しています。<br/>"desc"（降順）は高いスコアを上位とし、ポイントベースやハイスコアランキングに適しています。"asc": 昇順 / "desc": 降順 /  |
| scope | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"global",<br>&nbsp;&nbsp;"scoped"<br>}<br> |  | ✓ |  |  | ランキングの種類<br>このカテゴリーのランキングタイプ。<br/>"global" は全プレイヤーが共有する単一のリーダーボードを作成し、設定された間隔でバッチ集計されます。<br/>"scoped" は購読したプレイヤー（フレンドやギルドメンバー等）に基づくユーザーごとのリーダーボードを作成し、スコアがリアルタイムで反映されます。"global": グローバル / "scoped": スコープ /  |
| globalRankingSetting | [GlobalRankingSetting](#globalrankingsetting) | {scope} == "global" | ✓※ |  |  | グローバルランキング設定<br>グローバルランキングモード固有の設定。集計間隔、固定時刻、スコアのユニーク性、世代管理、および追加の期間限定スコープを含みます。<br/>scope が "global" に設定されている場合のみ適用されます。<br>※ scope が "global" であれば 必須 |
| entryPeriodEventId | string |  |  |  |  ~ 1024文字 | スコア登録期間イベントID<br>スコア登録を受け付ける期間を定義する GS2-Schedule イベントの GRN。<br/>この期間外のスコア登録リクエストは拒否されます。未設定の場合、スコアはいつでも登録できます。 |
| accessPeriodEventId | string |  |  |  |  ~ 1024文字 | アクセス期間イベントID<br>ランキングデータを閲覧できる期間を定義する GS2-Schedule イベントの GRN。<br/>この期間外のランキング取得リクエストは拒否されます。未設定の場合、ランキングはいつでもアクセスできます。 |

#### Scope

集計スコープ<br>

グローバルランキングモードにおける追加の期間限定集計スコープを定義します。<br>
通常、グローバルランキングは登録されたスコア全てを対象に集計が行われます。<br>
スコープを追加することで、指定した日数以内に登録されたスコアのみを対象とする別ランキングを作成でき、全期間ランキングと併せてデイリー・ウィークリー・マンスリーなどのリーダーボードを実現できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128文字 | スコープ名<br>カテゴリー内でこの集計スコープを一意に識別する名前。<br/>複数の期間限定ランキングボードを区別するために使用されます（例: "daily", "weekly"）。最大128文字。 |
| targetDays | long |  | ✓ |  | 1 ~ 365 | 集計対象日数<br>集計ウィンドウに含める日数。<br/>現在時刻からこの日数以内に登録されたスコアのみがスコープランキングの対象となります。範囲: 1～365日。 |

#### GlobalRankingSetting

グローバルランキング設定<br>

グローバルは全プレイヤーが同じ結果を参照するものです。<br>
ランキングの集計間隔を15分～24時間で設定できます。<br>

ランキングデータには世代という設定があり、世代を変更することで登録されたスコアをリセットすることができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| uniqueByUserId | bool |  |  | true |  | ユーザーID毎にユニーク<br>有効にすると、ランキング内でユーザーIDごとに1つのスコアのみ保持されます。<br/>ユーザーが新しいスコアを登録すると、ソート方向に基づいてより良いスコアに置き換えられます。<br/>無効にすると、同一ユーザーから複数のスコアエントリが許可され、合算モードや複数エントリによる競争が可能になります。 |
| calculateIntervalMinutes | int |  | ✓ |  | 15 ~ 1440 | 集計間隔（分）<br>連続するランキング再集計の間隔（分）。<br/>システムはこの間隔で、登録された全スコアに基づいてグローバルランキングを定期的に再集計します。<br/>範囲: 15～1440分（15分～24時間）。 |
| calculateFixedTiming | [FixedTiming](#fixedtiming) |  |  |  |  | 集計時刻固定設定<br>ランキング再集計が開始される1日の固定時刻（UTC）を指定します。<br/>未設定の場合、再集計は不定の基準時刻から定期間隔で実行されます。<br/>これを設定することで、毎日予測可能で一貫した時刻に再集計が行われるようになります。 |
| additionalScopes | [List&lt;Scope&gt;](#scope) |  |  |  | 0 ~ 10 items | 追加スコープリスト<br>追加の期間限定集計スコープのリスト。<br/>各スコープは指定した日数以内に登録されたスコアのみを対象とする別ランキングを定義します。<br/>全期間のグローバルランキングと併せて、デイリー・ウィークリー・マンスリーなどのリーダーボードを作成できます。最大10件。 |
| ignoreUserIds | List&lt;string&gt; |  |  |  | 0 ~ 10000 items | 除外ユーザーIDリスト<br>ランキング集計からスコアを除外するユーザーIDのリスト。<br/>テストアカウント、管理者アカウント、または既知の不正ユーザーをリーダーボードから除外するのに使用します。最大10,000件。 |
| generation | string |  |  |  |  ~ 256文字 | 世代<br>現在のランキング世代を表す任意の文字列。<br/>この値を変更すると、前の世代のスコアはランキング集計に含まれなくなるため、実質的にスコアがリセットされます。<br/>シーズン制リセットや定期的なランキングリセットの実装に使用します。最大256文字。 |

#### FixedTiming

集計時刻固定設定<br>

グローバルランキングの集計が開始される固定時刻を指定します。<br>
この設定がない場合、ランキング集計は不定の基準時刻から定期間隔で実行されます。<br>
固定の時・分を指定することで、毎日の集計開始時刻（UTC）を予測可能にでき、深夜0時や特定の時刻に集計を開始するよう制御できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| hour | int |  |  |  | 0 ~ 23 | 時<br>ランキング集計が開始される時刻の時（UTC）。<br/>0～23 の整数で指定します。 |
| minute | int |  |  |  | 0 ~ 59 | 分<br>指定した時刻の分。<br/>0～59 の整数で指定します。 |

---