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

# GS2-Ranking2 トランザクションアクション

検証/消費/入手の各トランザクションアクションの仕様




## Verify Action

検証アクション

### Gs2Ranking2:VerifyGlobalRankingScoreByUserId

ユーザーIDを指定してグローバルランキングのスコアを検証<br>

指定したユーザーのグローバルランキングスコアを比較演算子（less, lessEqual, greater, greaterEqual, equal, notEqual）を使用して指定した値と比較検証します。

**数量指定可能なアクション：はい**

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string |  | ✓|  |  ~ 128文字 | ユーザーID<br>`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| rankingName | string |  | ✓|  |  ~ 128文字 | グローバルランキングモデル名<br>グローバルランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| verifyType | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"less",<br>&nbsp;&nbsp;"lessEqual",<br>&nbsp;&nbsp;"greater",<br>&nbsp;&nbsp;"greaterEqual",<br>&nbsp;&nbsp;"equal",<br>&nbsp;&nbsp;"notEqual"<br>}<br> |  | ✓|  |  | 検証の種類"less": スコアが指定値未満であること / "lessEqual": スコアが指定値以下であること / "greater": スコアが指定値超過であること / "greaterEqual": スコアが指定値以上であること / "equal": スコアが指定値と一致すること / "notEqual": スコアが指定値と一致しないこと /  |
| season | long |  | |  | 0 ~ 9223372036854775805 | シーズン |
| score | long |  | ✓|  | 0 ~ 9223372036854775805 | スコア<br>ユーザーが登録したスコア値です。ランキングモデルの minimumValue と maximumValue で定義された範囲内である必要があります。 |
| multiplyValueSpecifyingQuantity | bool |  | | true |  | 数量指定した際に、検証に使用する値も乗算するか |
| timeOffsetToken | string |  | |  |  ~ 1024文字 | タイムオフセットトークン |




**JSON**
```json
{
    "action": "Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "rankingName": "[string]グローバルランキングモデル名",
        "verifyType": "[string]検証の種類",
        "season": "[long]シーズン",
        "score": "[long]スコア",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:VerifyGlobalRankingScoreByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  rankingName: "[string]グローバルランキングモデル名"
  verifyType: "[string]検証の種類"
  season: "[long]シーズン"
  score: "[long]スコア"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
```

**GS2-Script**
```lua

transaction.service("ranking2").verify.verify_global_ranking_score_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    rankingName="[string]グローバルランキングモデル名",
    verifyType="[string]検証の種類",
    season="[long]シーズン",
    score="[long]スコア",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})
```


---

### Gs2Ranking2:VerifyClusterRankingScoreByUserId

ユーザーIDを指定してクラスターランキングのスコアを検証<br>

指定したユーザーのクラスターランキングスコアを比較演算子（less, lessEqual, greater, greaterEqual, equal, notEqual）を使用して指定した値と比較検証します。

**数量指定可能なアクション：はい**

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string |  | ✓|  |  ~ 128文字 | ユーザーID<br>`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| rankingName | string |  | ✓|  |  ~ 128文字 | クラスターランキングモデル名<br>クラスターランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| clusterName | string |  | ✓|  |  ~ 1024文字 | クラスター名<br>このスコアが属するクラスター（ギルド、ギャザリング、または任意のグループ）の名前です。クラスタータイプ設定に基づいてユーザーの所属が検証されます。 |
| verifyType | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"less",<br>&nbsp;&nbsp;"lessEqual",<br>&nbsp;&nbsp;"greater",<br>&nbsp;&nbsp;"greaterEqual",<br>&nbsp;&nbsp;"equal",<br>&nbsp;&nbsp;"notEqual"<br>}<br> |  | ✓|  |  | 検証の種類"less": スコアが指定値未満であること / "lessEqual": スコアが指定値以下であること / "greater": スコアが指定値超過であること / "greaterEqual": スコアが指定値以上であること / "equal": スコアが指定値と一致すること / "notEqual": スコアが指定値と一致しないこと /  |
| season | long |  | |  | 0 ~ 9223372036854775805 | シーズン |
| score | long |  | ✓|  | 0 ~ 9223372036854775805 | スコア<br>このクラスター内でユーザーが登録したスコア値です。 |
| multiplyValueSpecifyingQuantity | bool |  | | true |  | 数量指定した際に、検証に使用する値も乗算するか |
| timeOffsetToken | string |  | |  |  ~ 1024文字 | タイムオフセットトークン |




**JSON**
```json
{
    "action": "Gs2Ranking2:VerifyClusterRankingScoreByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "rankingName": "[string]クラスターランキングモデル名",
        "clusterName": "[string]クラスター名",
        "verifyType": "[string]検証の種類",
        "season": "[long]シーズン",
        "score": "[long]スコア",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:VerifyClusterRankingScoreByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  rankingName: "[string]クラスターランキングモデル名"
  clusterName: "[string]クラスター名"
  verifyType: "[string]検証の種類"
  season: "[long]シーズン"
  score: "[long]スコア"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
```

**GS2-Script**
```lua

transaction.service("ranking2").verify.verify_cluster_ranking_score_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    rankingName="[string]クラスターランキングモデル名",
    clusterName="[string]クラスター名",
    verifyType="[string]検証の種類",
    season="[long]シーズン",
    score="[long]スコア",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})
```


---

### Gs2Ranking2:VerifySubscribeRankingScoreByUserId

ユーザーIDを指定して購読ランキングのスコアを検証<br>

指定したユーザーの購読ランキングスコアを比較演算子（less, lessEqual, greater, greaterEqual, equal, notEqual）を使用して指定した値と比較検証します。

**数量指定可能なアクション：はい**

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string |  | ✓|  |  ~ 128文字 | ユーザーID<br>`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| rankingName | string |  | ✓|  |  ~ 128文字 | 購読ランキングモデル名<br>購読ランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| verifyType | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"less",<br>&nbsp;&nbsp;"lessEqual",<br>&nbsp;&nbsp;"greater",<br>&nbsp;&nbsp;"greaterEqual",<br>&nbsp;&nbsp;"equal",<br>&nbsp;&nbsp;"notEqual"<br>}<br> |  | ✓|  |  | 検証の種類"less": スコアが指定値未満であること / "lessEqual": スコアが指定値以下であること / "greater": スコアが指定値超過であること / "greaterEqual": スコアが指定値以上であること / "equal": スコアが指定値と一致すること / "notEqual": スコアが指定値と一致しないこと /  |
| season | long |  | |  | 0 ~ 9223372036854775805 | シーズン |
| score | long |  | ✓|  | 0 ~ 9223372036854775805 | スコア |
| multiplyValueSpecifyingQuantity | bool |  | | true |  | 数量指定した際に、検証に使用する値も乗算するか |
| timeOffsetToken | string |  | |  |  ~ 1024文字 | タイムオフセットトークン |




**JSON**
```json
{
    "action": "Gs2Ranking2:VerifySubscribeRankingScoreByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "rankingName": "[string]購読ランキングモデル名",
        "verifyType": "[string]検証の種類",
        "season": "[long]シーズン",
        "score": "[long]スコア",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:VerifySubscribeRankingScoreByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  rankingName: "[string]購読ランキングモデル名"
  verifyType: "[string]検証の種類"
  season: "[long]シーズン"
  score: "[long]スコア"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
```

**GS2-Script**
```lua

transaction.service("ranking2").verify.verify_subscribe_ranking_score_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    rankingName="[string]購読ランキングモデル名",
    verifyType="[string]検証の種類",
    season="[long]シーズン",
    score="[long]スコア",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})
```


---

## Consume Action

消費アクション

### Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId

ユーザーIDを指定してグローバルランキング報酬受け取り履歴を記録<br>

指定したユーザーに代わって、指定したグローバルランキングの報酬受け取り履歴を記録します。

**数量指定可能なアクション：いいえ**

**反転可能なアクション：いいえ**

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| rankingName | string |  | ✓|  |  ~ 128文字 | グローバルランキングモデル名<br>グローバルランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string |  | ✓|  |  ~ 128文字 | ユーザーID<br>`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| season | long |  | |  | 0 ~ 9223372036854775805 | シーズン |
| timeOffsetToken | string |  | |  |  ~ 1024文字 | タイムオフセットトークン |




**JSON**
```json
{
    "action": "Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "rankingName": "[string]グローバルランキングモデル名",
        "userId": "[string]ユーザーID",
        "season": "[long]シーズン",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId
request:
  namespaceName: "[string]ネームスペース名"
  rankingName: "[string]グローバルランキングモデル名"
  userId: "[string]ユーザーID"
  season: "[long]シーズン"
  timeOffsetToken: "[string]タイムオフセットトークン"
```

**GS2-Script**
```lua

transaction.service("ranking2").consume.create_global_ranking_received_reward_by_user_id({
    namespaceName="[string]ネームスペース名",
    rankingName="[string]グローバルランキングモデル名",
    userId="[string]ユーザーID",
    season="[long]シーズン",
    timeOffsetToken="[string]タイムオフセットトークン",
})
```


---

### Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId

ユーザーIDを指定してクラスターランキング報酬受け取り履歴を記録<br>

指定したユーザーに代わって、指定したクラスターランキングおよびクラスターの報酬受け取り履歴を記録します。

**数量指定可能なアクション：いいえ**

**反転可能なアクション：いいえ**

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| rankingName | string |  | ✓|  |  ~ 128文字 | クラスターランキングモデル名<br>クラスターランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| clusterName | string |  | ✓|  |  ~ 1024文字 | クラスター名<br>ランキング報酬を受け取ったクラスターの名前です。 |
| userId | string |  | ✓|  |  ~ 128文字 | ユーザーID<br>`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| season | long |  | |  | 0 ~ 9223372036854775805 | シーズン |
| timeOffsetToken | string |  | |  |  ~ 1024文字 | タイムオフセットトークン |




**JSON**
```json
{
    "action": "Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "rankingName": "[string]クラスターランキングモデル名",
        "clusterName": "[string]クラスター名",
        "userId": "[string]ユーザーID",
        "season": "[long]シーズン",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId
request:
  namespaceName: "[string]ネームスペース名"
  rankingName: "[string]クラスターランキングモデル名"
  clusterName: "[string]クラスター名"
  userId: "[string]ユーザーID"
  season: "[long]シーズン"
  timeOffsetToken: "[string]タイムオフセットトークン"
```

**GS2-Script**
```lua

transaction.service("ranking2").consume.create_cluster_ranking_received_reward_by_user_id({
    namespaceName="[string]ネームスペース名",
    rankingName="[string]クラスターランキングモデル名",
    clusterName="[string]クラスター名",
    userId="[string]ユーザーID",
    season="[long]シーズン",
    timeOffsetToken="[string]タイムオフセットトークン",
})
```


---