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

# GS2-Ranking2 Transaction Actions

Specification of verify/consume/acquire transaction actions




## Verify Action



### Gs2Ranking2:VerifyGlobalRankingScoreByUserId

Verify the score of the global ranking specifying User ID

Verifies the global ranking score of the specified user against a specified value using comparison operators (less, lessEqual, greater, greaterEqual, equal, notEqual).

**Quantity specification supported: YES**

|  | 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 (.). |
| userId | string |  | ✓|  |  ~ 128 chars | User ID<br>Specify `#{userId}` to substitute the currently logged-in user's ID. |
| rankingName | string |  | ✓|  |  ~ 128 chars | Global Ranking Model name<br>Unique Global Ranking Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| verifyType | string (enum)<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> |  | ✓|  |  | Type of verification"less": Score is less than the specified value / "lessEqual": Score is less than or equal to the specified value / "greater": Score is greater than the specified value / "greaterEqual": Score is greater than or equal to the specified value / "equal": Score is equal to the specified value / "notEqual": Score is not equal to the specified value /  |
| season | long |  | |  | 0 ~ 9223372036854775805 | Season |
| score | long |  | ✓|  | 0 ~ 9223372036854775805 | Score<br>The score value submitted by the user. Must be within the range defined by the ranking model's minimumValue and maximumValue settings. |
| multiplyValueSpecifyingQuantity | bool |  | | true |  | Whether to multiply the value used for verification when specifying the quantity |
| timeOffsetToken | string |  | |  |  ~ 1024 chars | Time offset token |




**JSON**
```json
{
    "action": "Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "rankingName": "[string]Global Ranking Model name",
        "verifyType": "[string]Type of verification",
        "season": "[long]Season",
        "score": "[long]Score",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:VerifyGlobalRankingScoreByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  rankingName: "[string]Global Ranking Model name"
  verifyType: "[string]Type of verification"
  season: "[long]Season"
  score: "[long]Score"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
  timeOffsetToken: "[string]Time offset token"
```

**GS2-Script**
```lua

transaction.service("ranking2").verify.verify_global_ranking_score_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    rankingName="[string]Global Ranking Model name",
    verifyType="[string]Type of verification",
    season="[long]Season",
    score="[long]Score",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
    timeOffsetToken="[string]Time offset token",
})
```


---

### Gs2Ranking2:VerifyClusterRankingScoreByUserId

Verify the score of the cluster ranking specifying User ID

Verifies the cluster ranking score of the specified user against a specified value using comparison operators (less, lessEqual, greater, greaterEqual, equal, notEqual).

**Quantity specification supported: YES**

|  | 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 (.). |
| userId | string |  | ✓|  |  ~ 128 chars | User ID<br>Specify `#{userId}` to substitute the currently logged-in user's ID. |
| rankingName | string |  | ✓|  |  ~ 128 chars | Cluster Ranking Model name<br>Unique Cluster Ranking Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| clusterName | string |  | ✓|  |  ~ 1024 chars | Cluster Name<br>The name of the cluster (guild, gathering, or arbitrary group) that this score belongs to. Verified against the cluster type setting to ensure the user is a member. |
| verifyType | string (enum)<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> |  | ✓|  |  | Type of verification"less": Score is less than the specified value / "lessEqual": Score is less than or equal to the specified value / "greater": Score is greater than the specified value / "greaterEqual": Score is greater than or equal to the specified value / "equal": Score is equal to the specified value / "notEqual": Score is not equal to the specified value /  |
| season | long |  | |  | 0 ~ 9223372036854775805 | Season |
| score | long |  | ✓|  | 0 ~ 9223372036854775805 | Score<br>The score value submitted by the user within this cluster. |
| multiplyValueSpecifyingQuantity | bool |  | | true |  | Whether to multiply the value used for verification when specifying the quantity |
| timeOffsetToken | string |  | |  |  ~ 1024 chars | Time offset token |




**JSON**
```json
{
    "action": "Gs2Ranking2:VerifyClusterRankingScoreByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "rankingName": "[string]Cluster Ranking Model name",
        "clusterName": "[string]Cluster Name",
        "verifyType": "[string]Type of verification",
        "season": "[long]Season",
        "score": "[long]Score",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:VerifyClusterRankingScoreByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  rankingName: "[string]Cluster Ranking Model name"
  clusterName: "[string]Cluster Name"
  verifyType: "[string]Type of verification"
  season: "[long]Season"
  score: "[long]Score"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
  timeOffsetToken: "[string]Time offset token"
```

**GS2-Script**
```lua

transaction.service("ranking2").verify.verify_cluster_ranking_score_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    rankingName="[string]Cluster Ranking Model name",
    clusterName="[string]Cluster Name",
    verifyType="[string]Type of verification",
    season="[long]Season",
    score="[long]Score",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
    timeOffsetToken="[string]Time offset token",
})
```


---

### Gs2Ranking2:VerifySubscribeRankingScoreByUserId

Verify the score of the subscribe ranking specifying User ID

Verifies the subscribe ranking score of the specified user against a specified value using comparison operators (less, lessEqual, greater, greaterEqual, equal, notEqual).

**Quantity specification supported: YES**

|  | 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 (.). |
| userId | string |  | ✓|  |  ~ 128 chars | User ID<br>Specify `#{userId}` to substitute the currently logged-in user's ID. |
| rankingName | string |  | ✓|  |  ~ 128 chars | Subscribe Ranking Model name<br>Unique Subscribe Ranking Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| verifyType | string (enum)<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> |  | ✓|  |  | Type of verification"less": Score is less than the specified value / "lessEqual": Score is less than or equal to the specified value / "greater": Score is greater than the specified value / "greaterEqual": Score is greater than or equal to the specified value / "equal": Score is equal to the specified value / "notEqual": Score is not equal to the specified value /  |
| season | long |  | |  | 0 ~ 9223372036854775805 | Season |
| score | long |  | ✓|  | 0 ~ 9223372036854775805 | Score |
| multiplyValueSpecifyingQuantity | bool |  | | true |  | Whether to multiply the value used for verification when specifying the quantity |
| timeOffsetToken | string |  | |  |  ~ 1024 chars | Time offset token |




**JSON**
```json
{
    "action": "Gs2Ranking2:VerifySubscribeRankingScoreByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "rankingName": "[string]Subscribe Ranking Model name",
        "verifyType": "[string]Type of verification",
        "season": "[long]Season",
        "score": "[long]Score",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:VerifySubscribeRankingScoreByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  rankingName: "[string]Subscribe Ranking Model name"
  verifyType: "[string]Type of verification"
  season: "[long]Season"
  score: "[long]Score"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
  timeOffsetToken: "[string]Time offset token"
```

**GS2-Script**
```lua

transaction.service("ranking2").verify.verify_subscribe_ranking_score_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    rankingName="[string]Subscribe Ranking Model name",
    verifyType="[string]Type of verification",
    season="[long]Season",
    score="[long]Score",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
    timeOffsetToken="[string]Time offset token",
})
```


---

## Consume Action



### Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId

Record global ranking reward receipt history specifying User ID

Records a reward receipt history for the specified global ranking on behalf of the specified user.

**Quantity specification supported: NO**

**Reversible action: NO**

|  | 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 (.). |
| rankingName | string |  | ✓|  |  ~ 128 chars | Global Ranking Model name<br>Unique Global Ranking Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| userId | string |  | ✓|  |  ~ 128 chars | User ID<br>Specify `#{userId}` to substitute the currently logged-in user's ID. |
| season | long |  | |  | 0 ~ 9223372036854775805 | Season |
| timeOffsetToken | string |  | |  |  ~ 1024 chars | Time offset token |




**JSON**
```json
{
    "action": "Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rankingName": "[string]Global Ranking Model name",
        "userId": "[string]User ID",
        "season": "[long]Season",
        "timeOffsetToken": "[string]Time offset token"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId
request:
  namespaceName: "[string]Namespace name"
  rankingName: "[string]Global Ranking Model name"
  userId: "[string]User ID"
  season: "[long]Season"
  timeOffsetToken: "[string]Time offset token"
```

**GS2-Script**
```lua

transaction.service("ranking2").consume.create_global_ranking_received_reward_by_user_id({
    namespaceName="[string]Namespace name",
    rankingName="[string]Global Ranking Model name",
    userId="[string]User ID",
    season="[long]Season",
    timeOffsetToken="[string]Time offset token",
})
```


---

### Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId

Record Cluster Ranking Reward Received History by User ID

Records a reward receipt history for the specified cluster ranking and cluster on behalf of the specified user.

**Quantity specification supported: NO**

**Reversible action: NO**

|  | 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 (.). |
| rankingName | string |  | ✓|  |  ~ 128 chars | Cluster Ranking Model name<br>Unique Cluster Ranking Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| clusterName | string |  | ✓|  |  ~ 1024 chars | Cluster Name<br>The name of the cluster for which the ranking reward was received. |
| userId | string |  | ✓|  |  ~ 128 chars | User ID<br>Specify `#{userId}` to substitute the currently logged-in user's ID. |
| season | long |  | |  | 0 ~ 9223372036854775805 | Season |
| timeOffsetToken | string |  | |  |  ~ 1024 chars | Time offset token |




**JSON**
```json
{
    "action": "Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rankingName": "[string]Cluster Ranking Model name",
        "clusterName": "[string]Cluster Name",
        "userId": "[string]User ID",
        "season": "[long]Season",
        "timeOffsetToken": "[string]Time offset token"
    }
}
```

**YAML**
```yaml

action: Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId
request:
  namespaceName: "[string]Namespace name"
  rankingName: "[string]Cluster Ranking Model name"
  clusterName: "[string]Cluster Name"
  userId: "[string]User ID"
  season: "[long]Season"
  timeOffsetToken: "[string]Time offset token"
```

**GS2-Script**
```lua

transaction.service("ranking2").consume.create_cluster_ranking_received_reward_by_user_id({
    namespaceName="[string]Namespace name",
    rankingName="[string]Cluster Ranking Model name",
    clusterName="[string]Cluster Name",
    userId="[string]User ID",
    season="[long]Season",
    timeOffsetToken="[string]Time offset token",
})
```


---