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

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

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




## Verify Action

検証アクション

### Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName

ギルド名を指定して最大参加可能人数を検証<br>

選択された比較演算子を使用して、指定されたギルドの currentMaximumMemberCount を指定された値と比較検証します（サーバーサイド操作）。<br>
サポートされる演算子：less、lessEqual、greater、greaterEqual、equal、notEqual。

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| guildModelName | string |  | ✓|  |  ~ 128文字 | ギルドモデル名<br>ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| guildName | string |  | ✓|  |  ~ 128文字 | ギルド名 |
| 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": 最大参加可能人数が指定値と一致しないこと /  |
| value | int |  | |  | 1 ~ 2147483646 | 最大参加可能人数 |
| multiplyValueSpecifyingQuantity | bool |  | | false |  | 数量指定した際に、検証に使用する値も乗算するか |




**JSON**
```json
{
    "action": "Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildModelName": "[string]ギルドモデル名",
        "guildName": "[string]ギルド名",
        "verifyType": "[string]検証の種類",
        "value": "[int]最大参加可能人数",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]ネームスペース名"
  guildModelName: "[string]ギルドモデル名"
  guildName: "[string]ギルド名"
  verifyType: "[string]検証の種類"
  value: "[int]最大参加可能人数"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
```

**GS2-Script**
```lua

transaction.service("guild").verify.verify_current_maximum_member_count_by_guild_name({
    namespaceName="[string]ネームスペース名",
    guildModelName="[string]ギルドモデル名",
    guildName="[string]ギルド名",
    verifyType="[string]検証の種類",
    value="[int]最大参加可能人数",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
})
```


---

### Gs2Guild:VerifyIncludeMemberByUserId

ユーザーIDを指定してギルドメンバーにユーザーIDが含まれているかを検証<br>

指定されたユーザーがギルドのメンバーであるかどうかを検証します（サーバーサイド操作）。<br>
2つの検証タイプをサポートします：'include' と 'notInclude'。

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| guildModelName | string |  | ✓|  |  ~ 128文字 | ギルドモデル名<br>ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| guildName | string |  | ✓| UUID |  ~ 36文字 | ギルド名<br>ギルドの一意な名前を保持します。<br>名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各ギルドを識別するために使用されます。 |
| userId | string |  | ✓|  |  ~ 128文字 | ユーザーID<br>`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| verifyType | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"include",<br>&nbsp;&nbsp;"notInclude"<br>}<br> |  | ✓|  |  | 検証の種類"include": ギルドメンバーに指定したユーザーが含まれていること / "notInclude": ギルドメンバーに指定したユーザーが含まれないこと /  |
| timeOffsetToken | string |  | |  |  ~ 1024文字 | タイムオフセットトークン |




**JSON**
```json
{
    "action": "Gs2Guild:VerifyIncludeMemberByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildModelName": "[string]ギルドモデル名",
        "guildName": "[string]ギルド名",
        "userId": "[string]ユーザーID",
        "verifyType": "[string]検証の種類",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:VerifyIncludeMemberByUserId
request:
  namespaceName: "[string]ネームスペース名"
  guildModelName: "[string]ギルドモデル名"
  guildName: "[string]ギルド名"
  userId: "[string]ユーザーID"
  verifyType: "[string]検証の種類"
  timeOffsetToken: "[string]タイムオフセットトークン"
```

**GS2-Script**
```lua

transaction.service("guild").verify.verify_include_member_by_user_id({
    namespaceName="[string]ネームスペース名",
    guildModelName="[string]ギルドモデル名",
    guildName="[string]ギルド名",
    userId="[string]ユーザーID",
    verifyType="[string]検証の種類",
    timeOffsetToken="[string]タイムオフセットトークン",
})
```


---

## Consume Action

消費アクション

### Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName

ギルド名を指定して最大参加可能人数を減算<br>

指定されたギルドの currentMaximumMemberCount を指定された値だけ減少させます（サーバーサイド操作）。<br>
結果の値はゼロ未満にはなりません。

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

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| guildModelName | string |  | ✓|  |  ~ 128文字 | ギルドモデル名<br>ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| guildName | string |  | ✓|  |  ~ 128文字 | ギルド名 |
| value | int |  | |  | 1 ~ 2147483646 | 最大人数の減少量 |




**JSON**
```json
{
    "action": "Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildModelName": "[string]ギルドモデル名",
        "guildName": "[string]ギルド名",
        "value": "[int]最大人数の減少量"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]ネームスペース名"
  guildModelName: "[string]ギルドモデル名"
  guildName: "[string]ギルド名"
  value: "[int]最大人数の減少量"
```

**GS2-Script**
```lua

transaction.service("guild").consume.decrease_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]ネームスペース名",
    guildModelName="[string]ギルドモデル名",
    guildName="[string]ギルド名",
    value="[int]最大人数の減少量",
})
```


---

## Acquire Action

入手アクション

### Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName

ギルド名を指定して最大参加可能人数を加算<br>

ギルドの currentMaximumMemberCount を指定された値だけ増加させます。<br>
結果の値はギルドモデルで定義された maximumMemberCount を超えてはなりません。

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

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| guildModelName | string |  | ✓|  |  ~ 128文字 | ギルドモデル名<br>ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| guildName | string |  | ✓|  |  ~ 128文字 | ギルド名 |
| value | int |  | |  | 1 ~ 2147483646 | 最大人数の増加量 |




**JSON**
```json
{
    "action": "Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildModelName": "[string]ギルドモデル名",
        "guildName": "[string]ギルド名",
        "value": "[int]最大人数の増加量"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]ネームスペース名"
  guildModelName: "[string]ギルドモデル名"
  guildName: "[string]ギルド名"
  value: "[int]最大人数の増加量"
```

**GS2-Script**
```lua

transaction.service("guild").acquire.increase_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]ネームスペース名",
    guildModelName="[string]ギルドモデル名",
    guildName="[string]ギルド名",
    value="[int]最大人数の増加量",
})
```


---

### Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName

ギルド名を指定して最大参加可能人数を設定<br>

ギルドの currentMaximumMemberCount を指定された絶対値に設定します。<br>
増減操作とは異なり、差分を適用するのではなく値を直接設定します。<br>
更新後のギルドと更新前のギルド状態の両方を返し、呼び出し元が変更を追跡できるようにします。

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

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| guildName | string |  | ✓|  |  ~ 128文字 | ギルド名 |
| guildModelName | string |  | ✓|  |  ~ 128文字 | ギルドモデル名<br>ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| value | int |  | |  | 1 ~ 2147483646 | 設定する最大人数 |




**JSON**
```json
{
    "action": "Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildName": "[string]ギルド名",
        "guildModelName": "[string]ギルドモデル名",
        "value": "[int]設定する最大人数"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]ネームスペース名"
  guildName: "[string]ギルド名"
  guildModelName: "[string]ギルドモデル名"
  value: "[int]設定する最大人数"
```

**GS2-Script**
```lua

transaction.service("guild").acquire.set_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]ネームスペース名",
    guildName="[string]ギルド名",
    guildModelName="[string]ギルドモデル名",
    value="[int]設定する最大人数",
})
```


---