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

# GS2-Ranking Deploy/CDK Reference

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK




## Entities

Resources managed by the Deploy operation

### Namespace

Namespace

A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts.
Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the Namespace differs, the data is treated as a completely independent data space.

Therefore, you must create a Namespace before you can start using each service.

#### Request

Resource creation and update requests

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128 chars | Namespace name<br>Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| description | string |  | |  |  ~ 1024 chars | Description |
| transactionSettingV2 | [TransactionSettingV2](#transactionsettingv2) |  | |  |  | Transaction Setting (V2)<br>Decides how the transactions this Namespace issues are executed. There are only two things to set: the GS2-Distributor Namespace that executes them, and whether the actions in a transaction run one at a time -- so that a later action can build on what an earlier one wrote -- or all at once for a shorter response time.<br>Set this on a new Namespace. `transactionSetting`, the obsolete setting it replaces, is used only while this is unset. |
| logSetting | [LogSetting](#logsetting) |  | |  |  | Log Setting<br>Configuration for outputting ranking-related operation logs to GS2-Log.<br>When configured, actions such as score registration, ranking retrieval, and subscription changes are recorded for analysis and auditing. |

#### GetAttr

Resource creation results that can be retrieved using the [!GetAttr](/articles/tech/deploy/#getattr) tag

| | Type | Description |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | Namespace created

#### Implementation Example




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

Type: GS2::Ranking::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSettingV2: 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

```


### TransactionSettingV2

Transaction Setting (V2)

Transaction Setting (V2) decides how the transactions issued by a Namespace are executed.

There are only two things to set:

- `distributorNamespaceId`: the GS2-Distributor Namespace used to execute the transaction
- `enableParallelExecution`: whether the actions in a transaction run one at a time or all at once

Whichever you choose, the transaction is executed by the server the moment it is issued, and it succeeds or fails as a whole: when an action fails, the actions that already ran are undone with it and nothing is left applied. Everything else about how a transaction runs is fixed to the recommended configuration, so there is nothing else to set.

Running the actions one at a time (the default, `enableParallelExecution` is `false`) lets each action work on top of what the actions before it wrote. The actions run in verify, consume, acquire order, and this is what lets you:

- update the same row from more than one action in a single transaction, which fails when they run all at once
- read what an earlier action wrote, including from List and Query and from inside a nested transaction
- use `%{Gs2Xxx:ActionName.path[0].field}` to feed the result of an earlier verify or consume action into the parameters of a later verify, consume or acquire action

In exchange, the response time is the sum of the time taken by each action, and a transaction may contain at most 20 actions. The order within each phase is decided by the action name and then by the target resource, so you cannot choose the execution order by rearranging the actions in the request, and execution stops at the first action that fails.

Running the actions all at once (`enableParallelExecution` is `true`) executes them in parallel against a single snapshot of the data, so the response time is that of the slowest single action and there is no limit on the number of actions.

In exchange, an action cannot see what the other actions wrote, and two actions that write the same row fail the transaction with `database:transaction:same.resource` (400), so choose this only when you can guarantee that no two actions in the same transaction write the same data. `%{...}` may reference only the results of an earlier phase (verify, then consume, then acquire); a reference to an action in the same phase is left unresolved, and a phase that contains `%{...}` waits for the earlier phases to complete, which lengthens the response time by that amount.

Transaction Setting is the obsolete setting that Transaction Setting (V2) replaces, kept for Namespaces created before Transaction Setting (V2) existed. It applies only while Transaction Setting (V2) is unset, and setting Transaction Setting (V2) supersedes it. Three behaviours it allowed are deliberately not offered here: executing a transaction as a client-run stamp sheet, running AutoRun asynchronously via GS2-Distributor, and folding acquire actions into GS2-JobQueue.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| distributorNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:distributor:default" |  ~ 1024 chars | GS2-Distributor Namespace GRN used to execute transactions |
| enableParallelExecution | bool |  |  | false |  | Whether to execute the actions in parallel instead of sequentially |

### LogSetting

Log Output Setting

Log Output Setting defines how log data is exported. This type holds the GS2-Log Namespace identifier (Namespace ID), which is used to export log data.
Specify the GS2-Log Namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId).
Configuring this setting ensures that log data for API requests and responses occurring within the specified Namespace is output to the target GS2-Log Namespace.
GS2-Log provides real-time logs that can be used for system monitoring, analysis, debugging, and other operational purposes.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| loggingNamespaceId | string |  | ✓ |  |  ~ 1024 chars | GS2-Log Namespace GRN to output logs<br>Must be specified in GRN format starting with "grn:gs2:". |

### TransactionSetting

Transaction Setting

Transaction Setting is obsolete: Transaction Setting (V2) replaces it. It is kept for Namespaces created before Transaction Setting (V2) existed, applies only while Transaction Setting (V2) is unset, and should not be chosen for a new Namespace.

It exposes each part of transaction execution as a separate field -- AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, asynchronous processing of acquire actions via GS2-JobQueue, and sequential execution -- so combinations other than the recommended one can be built. Transaction Setting (V2) is that recommended combination expressed as a single setting. Keep using Transaction Setting only on a Namespace that already depends on a behaviour Transaction Setting (V2) does not offer: executing a transaction as a client-run stamp sheet, running AutoRun asynchronously via GS2-Distributor, or folding acquire actions into GS2-JobQueue.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| enableAutoRun | bool |  |  | false |  | Whether to automatically execute issued transactions on the server side |
| enableAtomicCommit | bool | {enableAutoRun} == true |  | false |  | Whether to commit transactions atomically<br>* Enabled only if enableAutoRun is true |
| transactionUseDistributor | bool | {enableAtomicCommit} == true |  | false |  | Whether to execute transactions asynchronously<br>* Enabled only if enableAtomicCommit is true |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true |  | false |  | Whether to execute the commit processing of the script result asynchronously<br>* Enabled only if transactionUseDistributor is true |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true |  | false |  | Whether to use GS2-JobQueue to execute the acquire action<br>* Enabled only if enableAtomicCommit is true |
| enableSequentialExecution | bool | {enableAtomicCommit} == true |  | false |  | Whether to execute the actions of an atomic commit sequentially so that multiple actions may update the same row<br>* Enabled only if enableAtomicCommit is true |
| distributorNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:distributor:default" |  ~ 1024 chars | GS2-Distributor Namespace GRN used to execute transactions |
| queueNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:queue:default" |  ~ 1024 chars | GS2-JobQueue Namespace GRN used to execute transactions |

---

### CurrentRankingMaster

Currently active Ranking Model master data

This master data defines the Ranking Models currently active within the Namespace.
GS2 uses JSON format files for managing master data.
By uploading these files, you can apply the master data to the server.

To create JSON files, GS2 provides a master data editor within the management console.
Additionally, you can create tools better suited for game operations and export JSON files in the appropriate format.
**ℹ️ Note**

Please refer to [GS2-Ranking Master Data Reference](api_reference/ranking/master_data/) for the JSON file format.

#### Request

Resource creation and update requests

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128 chars | Namespace name<br>Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| mode | string (enum)<br>enum {<br>"direct",<br>"preUpload"<br>}<br> |  | | "direct" |  | Update modedirect: Directly update master data / preUpload: Upload master data and then update /  |
| settings | string | {mode} == "direct" | ✓*|  |  ~ 5242880 bytes (5MB) | Master Data<br>* Required if mode is "direct" |
| uploadToken | string | {mode} == "preUpload" | ✓*|  |  ~ 1024 chars | Token obtained by pre-upload<br>Used to apply the uploaded master data.<br>* Required if mode is "preUpload" |

#### GetAttr

Resource creation results that can be retrieved using the [!GetAttr](/articles/tech/deploy/#getattr) tag

| | Type | Description |
| --- | --- | --- |
| Item | [CurrentRankingMaster](../sdk#currentrankingmaster) | Updated master data of the currently active Ranking Models

#### Implementation Example




**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

Category Model

Different rankings can be created for different categories.

Categories can have a minimum and maximum score that can be registered, and scores outside of that range are discarded.
When calculating rankings, it is possible to set whether the scores are to be ranked in ascending or descending order, with the smallest scores being ranked higher (ascending order) or the largest scores being ranked lower (descending order).

You can select `global` or `scoped` as the type of ranking.
Global is a ranking where all players see the same results, and Scope is a ranking where each game player has a different result, such as a ranking among friends or a ranking in a guild.

For global ranking, you can set the ranking interval from 15 minutes to 24 hours for each category.
Scope rankings reflect calculation results in real time.

The ranking data has a setting called "generation," and the registered scores can be reset by changing the generation.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| categoryModelId | string |  | * |  |  ~ 1024 chars | Category Model GRN<br>* Set automatically by the server |
| name | string |  | ✓ |  |  ~ 128 chars | Category Model name<br>Unique Category Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| metadata | string |  |  |  |  ~ 1024 chars | Metadata<br>Arbitrary values can be set in the metadata.<br>Since they do not affect GS2’s behavior, they can be used to store information used in the game. |
| minimumValue | long |  |  |  | 0 ~ 9223372036854775805 | Minimum Value<br>The minimum score value that can be registered in this category.<br>Scores below this threshold are rejected at registration time. If not set, there is no lower bound. |
| maximumValue | long |  |  |  | 0 ~ 9223372036854775805 | Maximum Value<br>The maximum score value that can be registered in this category.<br>Scores above this threshold are rejected at registration time. If not set, there is no upper bound. |
| sum | bool |  |  | false |  | Sum Mode<br>When enabled, newly registered scores are added to the user's existing score total rather than replacing it.<br>The ranking is then based on the accumulated total. When disabled, each score registration is treated as an independent entry. |
| orderDirection | string (enum)<br>enum {<br>"asc",<br>"desc"<br>}<br> |  | ✓ |  |  | Order Direction<br>Determines the sort order for ranking calculation.<br>`asc` (ascending) ranks lower scores higher, suitable for time-based or golf-style rankings.<br>`desc` (descending) ranks higher scores higher, suitable for point-based or high-score rankings.asc: ascending-order / desc: descending-order /  |
| scope | string (enum)<br>enum {<br>"global",<br>"scoped"<br>}<br> |  | ✓ |  |  | Scope<br>The type of ranking for this category.<br>`global` creates a single leaderboard shared by all players, recalculated at configured intervals (batch processing).<br>`scoped` creates per-user leaderboards based on subscribed players (e.g., friends or guild members), with real-time score reflection.global: Global / scoped: Scoped /  |
| globalRankingSetting | [GlobalRankingSetting](#globalrankingsetting) | {scope} == "global" | ✓* |  |  | Global Ranking Setting<br>Configuration specific to global ranking mode, including calculation interval, fixed timing, score uniqueness, generation management, and additional time-windowed scopes.<br>Only applicable when scope is set to `global`.<br>* Required if scope is "global" |
| entryPeriodEventId | string |  |  |  |  ~ 1024 chars | Entry Period Event ID<br>GRN of a GS2-Schedule event that defines the time window during which score registration is accepted.<br>Outside this period, score submission requests are rejected. If not set, scores can be registered at any time. |
| accessPeriodEventId | string |  |  |  |  ~ 1024 chars | Access Period Event ID<br>GRN of a GS2-Schedule event that defines the time window during which ranking data can be viewed.<br>Outside this period, ranking retrieval requests are rejected. If not set, rankings can be accessed at any time. |

### Scope

Aggregation Scope

Defines an additional time-windowed aggregation scope for Global Ranking mode.
Normally, global ranking is calculated for all registered scores regardless of when they were submitted.
By adding scopes, you can create separate rankings that only consider scores registered within a specified number of days, enabling daily, weekly, or monthly leaderboards alongside the all-time ranking.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128 chars | Scope Name<br>A unique name identifying this aggregation scope within the category.<br>Used to distinguish between multiple time-windowed ranking boards (e.g., "daily", "weekly"). Maximum 128 characters. |
| targetDays | long |  | ✓ |  | 1 ~ 365 | Target Days<br>The number of days to include in the aggregation window.<br>Only scores registered within this number of days from the current time are considered for the scoped ranking. Range: 1-365 days. |

### GlobalRankingSetting

Global Ranking Setting

Global is a ranking where all players see the same results.
The ranking interval can be set from 15 minutes to 24 hours.

The ranking data has a setting called "generation," and the registered scores can be reset by changing the generation.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| uniqueByUserId | bool |  |  | true |  | Unique By User ID<br>When enabled, only one score per user ID is kept in the ranking.<br>If a user submits a new score, it replaces the previous one (keeping the better score based on the sort direction).<br>When disabled, multiple score entries from the same user are allowed, enabling sum-mode or multi-entry competition. |
| calculateIntervalMinutes | int |  | ✓ |  | 15 ~ 1440 | Calculate Interval Minutes<br>The interval in minutes between successive ranking recalculations.<br>The system periodically recalculates the global ranking based on all registered scores at this interval.<br>Range: 15 to 1440 minutes (15 minutes to 24 hours). |
| calculateFixedTiming | [FixedTiming](#fixedtiming) |  |  |  |  | Calculate Fixed Timing<br>Specifies a fixed time of day (UTC) at which ranking recalculation starts.<br>If not set, recalculation occurs at regular intervals from an unspecified base time.<br>Setting this ensures recalculations happen at a predictable, consistent time each day. |
| additionalScopes | [List&lt;Scope&gt;](#scope) |  |  |  | 0 ~ 10 items | Additional Scopes<br>A list of additional time-windowed aggregation scopes.<br>Each scope defines a separate ranking that only considers scores registered within a specified number of days.<br>This enables creating daily, weekly, or monthly leaderboards alongside the all-time global ranking. Maximum 10 scopes. |
| ignoreUserIds | List&lt;string&gt; |  |  |  | 0 ~ 10000 items | Ignore User IDs<br>A list of user IDs whose scores should be excluded from ranking calculation.<br>Useful for filtering out test accounts, administrator accounts, or known cheaters from the leaderboard. Maximum 10,000 entries. |
| generation | string |  |  |  |  ~ 256 chars | Generation<br>An arbitrary string representing the current ranking generation.<br>Changing this value effectively resets all registered scores, as scores from a previous generation are no longer included in ranking calculations.<br>Useful for implementing seasonal resets or periodic ranking resets. Maximum 256 characters. |

### FixedTiming

Fixed Timing

Specifies the fixed time of day at which global ranking calculations start.
Without this setting, ranking calculation occurs at regular intervals from an unspecified base time.
By specifying a fixed hour and minute, you can ensure that ranking recalculation always begins at a predictable time (in UTC), such as midnight or a specific hour.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| hour | int |  |  |  | 0 ~ 23 | Hour<br>The hour (UTC) at which ranking calculation starts.<br>Specified as an integer from 0 to 23. |
| minute | int |  |  |  | 0 ~ 59 | Minute<br>The minute at which ranking calculation starts within the specified hour.<br>Specified as an integer from 0 to 59. |

---