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

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

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




## エンティティ

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

### Namespace

ネームスペース<br>

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

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

#### Request

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  | |  |  ~ 1024文字 | 説明文 |
| transactionSettingV2 | [TransactionSettingV2](#transactionsettingv2) |  | |  |  | トランザクション設定（V2）<br>このネームスペースが発行するトランザクションをどのように実行するかを決める設定です。設定する項目は、実行に使用する GS2-Distributor のネームスペースと、トランザクションに含まれるアクションを 1 件ずつ実行して先に実行されたアクションの結果を後続のアクションから使えるようにするか、まとめて同時に実行してレスポンスタイムを短くするか、の 2 つだけです。<br>新しく作成するネームスペースではこちらを設定してください。これに置き換えられて非推奨となった `transactionSetting` は、こちらが設定されていない間だけ使用されます。 |
| changeNotification | [NotificationSetting](#notificationsetting) |  | |  |  | ギルド変更通知<br>ギルド情報（表示名、属性、参加ポリシーなど）が更新されたときに GS2-Gateway 経由で送信されるプッシュ通知です。ギルドメンバーがギルドの変更についてリアルタイムで更新を受け取ることができます。 |
| joinNotification | [NotificationSetting](#notificationsetting) |  | |  |  | メンバー参加通知<br>新しいメンバーがギルドに参加したときに GS2-Gateway 経由で送信されるプッシュ通知です。自由参加または参加リクエストの承認によるものの両方に対応します。既存メンバーが新規追加を通知されるようになります。 |
| leaveNotification | [NotificationSetting](#notificationsetting) |  | |  |  | メンバー離脱通知<br>メンバーがギルドから離脱または除籍されたときに GS2-Gateway 経由で送信されるプッシュ通知です。自発的な脱退とギルドマスターによる追放の両方に対応します。 |
| changeMemberNotification | [NotificationSetting](#notificationsetting) |  | |  |  | メンバー変更通知<br>ギルドメンバーの情報（ロール、メタデータ）が更新されたときに GS2-Gateway 経由で送信されるプッシュ通知です。メタデータの変更でこの通知がトリガーされるかどうかは changeMemberNotificationIgnoreChangeMetadata で制御できます。 |
| changeMemberNotificationIgnoreChangeMetadata | bool? |  | | false |  | メンバーの情報が更新されたときの通知を発行する際にメタデータの変更を無視する |
| receiveRequestNotification | [NotificationSetting](#notificationsetting) |  | |  |  | リクエスト受信通知<br>ユーザーからの新しい参加リクエストをギルドが受信したときに GS2-Gateway 経由で送信されるプッシュ通知です。ギルドマスターや権限を持つメンバーが承認待ちのリクエストを通知されるようになります。 |
| removeRequestNotification | [NotificationSetting](#notificationsetting) |  | |  |  | リクエスト削除通知<br>ギルド参加リクエストが削除されたときに GS2-Gateway 経由で送信されるプッシュ通知です。送信者によるキャンセル、ギルドによる拒否、または承認（リクエスト削除とメンバー追加）のいずれかに対応します。 |
| createGuildScript | [ScriptSetting](#scriptsetting) |  | |  |  | ギルドを作成するときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`createGuild`](../script/#createguild) |
| updateGuildScript | [ScriptSetting](#scriptsetting) |  | |  |  | ギルドを更新するときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`updateGuild`](../script/#updateguild) |
| joinGuildScript | [ScriptSetting](#scriptsetting) |  | |  |  | ギルドに参加するときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`joinGuild`](../script/#joinguild) |
| receiveJoinRequestScript | [ScriptSetting](#scriptsetting) |  | |  |  | ギルドに参加申請を受け付けたときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`receiveJoinRequest`](../script/#receivejoinrequest) |
| leaveGuildScript | [ScriptSetting](#scriptsetting) |  | |  |  | ギルドを脱退するときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`leaveGuild`](../script/#leaveguild) |
| changeRoleScript | [ScriptSetting](#scriptsetting) |  | |  |  | メンバーに割り当てているロールを変更するときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`changeRole`](../script/#changerole) |
| deleteGuildScript | [ScriptSetting](#scriptsetting) |  | |  |  | ギルドを削除するときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`deleteGuild`](../script/#deleteguild) |
| logSetting | [LogSetting](#logsetting) |  | |  |  | ログの出力設定<br>ギルド操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、ギルド作成、参加、脱退、ロール変更の API リクエスト・レスポンスログを収集できます。 |

#### GetAttr

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

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

#### 実装例




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

Type: GS2::Guild::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSettingV2: null
  ChangeNotification: null
  JoinNotification: null
  LeaveNotification: null
  ChangeMemberNotification: null
  ChangeMemberNotificationIgnoreChangeMetadata: null
  ReceiveRequestNotification: null
  RemoveRequestNotification: null
  CreateGuildScript: null
  UpdateGuildScript: null
  JoinGuildScript: null
  ReceiveJoinRequestScript: null
  LeaveGuildScript: null
  ChangeRoleScript: null
  DeleteGuildScript: 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/guild"
)


SampleStack := core.NewStack()
guild.NewNamespace(
    &SampleStack,
    "namespace-0001",
    guild.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\Guild\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Guild\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.guild.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.guild.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.Gs2Guild.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Guild.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 guild from "@/gs2cdk/guild";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new guild.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, guild

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        guild.Namespace(
            stack=self,
            name='namespace-0001',
            options=guild.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

```


### TransactionSettingV2

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

トランザクション設定（V2）は、ネームスペースが発行するトランザクションをどのように実行するかを決める設定です。<br>

設定する項目は次の 2 つだけです。<br>

- `distributorNamespaceId`: トランザクションの実行に使用する GS2-Distributor のネームスペース<br>
- `enableParallelExecution`: トランザクションに含まれるアクションを 1 件ずつ実行するか、まとめて同時に実行するか<br>

どちらを選んでも、トランザクションは発行された時点でサーバーが実行し、成否はトランザクション全体でひとつになります。あるアクションが失敗した場合は、それまでに実行されたアクションもろとも取り消され、1 つも反映されません。トランザクションの実行方法に関するそれ以外の項目は推奨構成に固定されているため、設定する必要はありません。<br>

1 件ずつ実行する場合（既定 / `enableParallelExecution` が `false`）、各アクションは先に実行されたアクションの書き込みを踏まえて動作します。アクションは verify・consume・acquire の順に実行され、次のことができます。<br>

- 1 つのトランザクションの中で、同じ行を複数のアクションから更新する（まとめて同時に実行する場合は失敗します）<br>
- 先に実行されたアクションの書き込みを読む。List や Query の結果でも、入れ子になったトランザクションの内側でも読めます<br>
- `%{Gs2Xxx:ActionName.path[0].field}` を使って、先に実行された verify や consume アクションの結果を、後続の verify・consume・acquire アクションの引数として渡す<br>

代わりに、レスポンスタイムは各アクションの実行時間の合計になり、1 つのトランザクションに含められるアクションは最大 20 件になります。また、各フェーズの中での実行順はアクション名、次に対象リソースの順で決まるため、リクエストに並べた順序で実行順を指定することはできません。実行は最初に失敗したアクションで停止します。<br>

まとめて同時に実行する場合（`enableParallelExecution` が `true`）、アクションは同一のデータスナップショットに対して並列に実行されるため、レスポンスタイムは最も遅いアクション 1 件分で済み、アクション数の上限もありません。<br>

代わりに、あるアクションから他のアクションの書き込みを読むことはできず、同じ行を 2 つのアクションが書き換えるとトランザクションは `database:transaction:same.resource`（400）で失敗します。同一トランザクション内で同じデータを 2 つ以上のアクションが書き換えないことを保証できる場合にだけ選択してください。`%{...}` は先行するフェーズ（verify → consume → acquire の順）の結果だけを参照でき、同じフェーズ内のアクションへの参照は解決されずにそのまま残ります。`%{...}` を含むフェーズは先行するフェーズの完了を待ってから実行されるため、その分だけレスポンスタイムが伸びます。<br>

トランザクション設定は、トランザクション設定（V2）に置き換えられた非推奨の設定で、トランザクション設定（V2）が存在しなかった頃に作成されたネームスペースのために残されています。トランザクション設定（V2）が設定されていない間だけ適用され、トランザクション設定（V2）を設定するとそちらが優先されます。トランザクション設定で可能だった、トランザクションをクライアント実行のスタンプシートとして実行する・GS2-Distributor による AutoRun の非同期実行を行う・入手アクションを GS2-JobQueue に畳み込む、という 3 つの挙動は、こちらではあえて提供していません。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| distributorNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:distributor:default" |  ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペースGRN |
| enableParallelExecution | bool |  |  | false |  | アクションを直列ではなく並列に実行するか |

### ScriptSetting

スクリプト設定<br>

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。<br>
このモデルは、スクリプトの実行をトリガーするための設定を保持します。<br>

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。<br>
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。<br>
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。<br>

一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。<br>
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。<br>
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。<br>

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。<br>
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| triggerScriptId | string |  |  |  |  ~ 1024文字 | API 実行時に同期的に実行される GS2-Script のスクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |
| doneTriggerTargetType | 文字列列挙型<br>enum {<br>"none",<br>"gs2_script",<br>"aws"<br>}<br> |  |  | "none" |  | 非同期スクリプトの実行方法<br>非同期実行で使用するスクリプトの種類を指定します。<br>「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。none: なし / gs2_script: GS2-Script / aws: Amazon EventBridge /  |
| doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行する GS2-Script スクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行スクリプトを実行する GS2-JobQueue ネームスペースGRN<br>非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。<br>GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |

### NotificationSetting

プッシュ通知に関する設定<br>

GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。<br>
ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。<br>
たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。<br>

GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。<br>
モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| gatewayNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:gateway:default" |  ~ 1024文字 | プッシュ通知に使用する GS2-Gateway のネームスペース<br>「grn:gs2:」から始まる GRN 形式で GS2-Gateway のネームスペースIDを指定します。 |
| enableTransferMobileNotification | bool? |  |  | false |  | モバイルプッシュ通知へ転送するか<br>この通知を送信しようとした時、通知先のデバイスがオフラインだった場合、モバイルプッシュ通知へ転送するかどうかを指定します。 |
| sound | string | {enableTransferMobileNotification} == true |  |  |  ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名<br>ここで指定したサウンドファイル名は、モバイルプッシュ通知を送信する際に使用され、特別なサウンドで通知を出すことができます。<br>※ enableTransferMobileNotification が true であれば 有効 |
| mobileNotificationMessages | [List&lt;MobileNotificationMessage&gt;](#mobilenotificationmessage) | {enableTransferMobileNotification} == true |  |  | 0 ~ 100 items | モバイルプッシュ通知へ転送するときの言語別のタイトルと本文<br>オフラインのプレイヤーへモバイルプッシュ通知として転送するときの、言語別のタイトルと本文です。<br>デバイストークンに登録された locale に一致するエントリ → `default` → 先頭 の順に採用します。<br>未設定なら通知の payload の `mobile` 配列、それも無ければ payload をそのまま本文にします。<br>※ enableTransferMobileNotification が true であれば 有効 |
| enable | 文字列列挙型<br>enum {<br>"Enabled",<br>"Disabled"<br>}<br> |  |  | "Enabled" |  | プッシュ通知を有効にするかEnabled: 有効 / Disabled: 無効 /  |

### 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で指定する必要があります。 |

### TransactionSetting

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

トランザクション設定は非推奨です。トランザクション設定（V2）がこれに置き換わります。トランザクション設定（V2）が存在しなかった頃に作成されたネームスペースのために残されており、トランザクション設定（V2）が設定されていない間だけ適用されます。新しく作成するネームスペースでは使用しないでください。<br>

この設定は、トランザクションの実行に関わる要素――自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化、直列実行――をそれぞれ個別の項目として公開しているため、推奨構成以外の組み合わせも作れます。その推奨構成を 1 つの設定としてまとめたものがトランザクション設定（V2）です。トランザクション設定を使い続けるのは、トランザクション設定（V2）が提供しない挙動――トランザクションをクライアント実行のスタンプシートとして実行する、GS2-Distributor による AutoRun の非同期実行を行う、入手アクションを 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 であれば 有効 |
| enableSequentialExecution | bool | {enableAtomicCommit} == true |  | false |  | アトミックコミットのアクションを直列に実行し、同じ行を複数のアクションで更新できるようにするか<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 |

### MobileNotificationMessage

モバイルプッシュ通知の言語別メッセージ<br>

通知をモバイルプッシュ通知へ転送する際に使用する、言語別メッセージリストの 1 要素です。1 つの要素が 1 つのロケールに対するタイトルと本文を保持します。<br>
採用される要素は、Firebase デバイストークンに登録されたロケールと `locale` が一致する要素 → `locale` が `default` の要素 → リストの先頭の要素、の順で選択されます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| locale | string |  |  |  |  ~ 32文字 | メッセージの言語<br>この要素がどの言語に対するものかを表します。Firebase デバイストークンに登録されたロケールと照合されます。`ja` や `en` のような任意の文字列を指定できます。`default` は特別な値で、端末のロケールに一致する要素がなかったときに使われるフォールバックの要素であることを表します。 |
| title | string |  |  |  |  ~ 256文字 | プッシュ通知のタイトル<br>この要素が採用されたときに、モバイルプッシュ通知のタイトルとして表示されるテキストです。省略した場合は、通知の件名が使用されます。 |
| message | string |  |  |  |  ~ 1024文字 | プッシュ通知の本文<br>この要素が採用されたときに、モバイルプッシュ通知の本文として表示されるテキストです。 |

---

### CurrentGuildMaster

現在アクティブなギルドモデルのマスターデータ<br>

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

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。<br>
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
**ℹ️ Note**

JSONファイルの形式については [GS2-Guild マスターデータリファレンス](api_reference/guild/master_data/) をご参照ください。

#### Request

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| mode | 文字列列挙型<br>enum {<br>"direct",<br>"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 | [CurrentGuildMaster](../sdk#currentguildmaster) | 更新された現在アクティブなギルドモデルのマスターデータ

#### 実装例




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

Type: GS2::Guild::CurrentGuildMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2024-04-25",
    "guildModels": [
      {
        "name": "guild-0001",
        "defaultMaximumMemberCount": 10,
        "maximumMemberCount": 50,
        "inactivityPeriodDays": 10,
        "roles": [
          {
            "name": "master",
            "policyDocument": "{\\"Version\\": \\"2016-04-01\\", \\"Statements\\": [{\\"Effect\\": \\"Allow\\", \\"Actions\\": [\\"Gs2Guild:UpdateGuild\\"], \\"Resources\\": [\\"*\\"]}]}"
          },
          {
            "name": "member",
            "policyDocument": "{\\"Version\\": \\"2016-04-01\\", \\"Statements\\": [{\\"Effect\\": \\"Allow\\", \\"Actions\\": [\\"Gs2Guild:UpdateGuild\\"], \\"Resources\\": [\\"*\\"]}]}"
          }
        ],
        "guildMasterRole": "master",
        "guildMemberDefaultRole": "member",
        "rejoinCoolTimeMinutes": 1440
      },
      {
        "name": "guild-0002",
        "defaultMaximumMemberCount": 20,
        "maximumMemberCount": 40,
        "inactivityPeriodDays": 10,
        "roles": [
          {
            "name": "master",
            "policyDocument": "{\\"Version\\": \\"2016-04-01\\", \\"Statements\\": [{\\"Effect\\": \\"Allow\\", \\"Actions\\": [\\"Gs2Guild:UpdateGuild\\"], \\"Resources\\": [\\"*\\"]}]}"
          },
          {
            "name": "member",
            "policyDocument": "{\\"Version\\": \\"2016-04-01\\", \\"Statements\\": [{\\"Effect\\": \\"Allow\\", \\"Actions\\": [\\"Gs2Guild:UpdateGuild\\"], \\"Resources\\": [\\"*\\"]}]}"
          }
        ],
        "guildMasterRole": "master",
        "guildMemberDefaultRole": "member",
        "rejoinCoolTimeMinutes": 360
      }
    ]
  }
  UploadToken: null

```

**Go**
```go

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


SampleStack := core.NewStack()
guild.NewNamespace(
    &SampleStack,
    "namespace-0001",
    guild.NamespaceOptions{},
).MasterData(
    []guild.GuildModel{
        guild.NewGuildModel(
            "guild-0001",
            10,
            50,
            10,
            []guild.RoleModel{
                guild.NewRoleModel(
                    "master",
                    "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                    guild.RoleModelOptions{},
                ),
                guild.NewRoleModel(
                    "member",
                    "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                    guild.RoleModelOptions{},
                ),
            },
            "master",
            "member",
            1440,
            guild.GuildModelOptions{
            },
        ),
        guild.NewGuildModel(
            "guild-0002",
            20,
            40,
            10,
            []guild.RoleModel{
                guild.NewRoleModel(
                    "master",
                    "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                    guild.RoleModelOptions{},
                ),
                guild.NewRoleModel(
                    "member",
                    "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                    guild.RoleModelOptions{},
                ),
            },
            "master",
            "member",
            360,
            guild.GuildModelOptions{
            },
        ),
    },
)

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

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Guild\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Guild\Model\GuildModel(
                    name:"guild-0001",
                    defaultMaximumMemberCount:10,
                    maximumMemberCount:50,
                    inactivityPeriodDays:10,
                    roles:[
                        new \Gs2Cdk\Guild\Model\RoleModel(
                            name: "master",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                        ),
                        new \Gs2Cdk\Guild\Model\RoleModel(
                            name: "member",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                        ),
                    ],
                    guildMasterRole:"master",
                    guildMemberDefaultRole:"member",
                    rejoinCoolTimeMinutes:1440
                ),
                new \Gs2Cdk\Guild\Model\GuildModel(
                    name:"guild-0002",
                    defaultMaximumMemberCount:20,
                    maximumMemberCount:40,
                    inactivityPeriodDays:10,
                    roles:[
                        new \Gs2Cdk\Guild\Model\RoleModel(
                            name: "master",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                        ),
                        new \Gs2Cdk\Guild\Model\RoleModel(
                            name: "member",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                        ),
                    ],
                    guildMasterRole:"master",
                    guildMemberDefaultRole:"member",
                    rejoinCoolTimeMinutes:360
                )
            ]
        );
    }
}

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

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.guild.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.guild.model.GuildModel(
                    "guild-0001",
                    10,
                    50,
                    10,
                    Arrays.asList(
                        new io.gs2.cdk.guild.model.RoleModel(
                            "master",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        ),
                        new io.gs2.cdk.guild.model.RoleModel(
                            "member",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        )
                    ),
                    "master",
                    "member",
                    1440
                ),
                new io.gs2.cdk.guild.model.GuildModel(
                    "guild-0002",
                    20,
                    40,
                    10,
                    Arrays.asList(
                        new io.gs2.cdk.guild.model.RoleModel(
                            "master",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        ),
                        new io.gs2.cdk.guild.model.RoleModel(
                            "member",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        )
                    ),
                    "master",
                    "member",
                    360
                )
            )
        );
    }
}

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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Guild.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Guild.Model.GuildModel[] {
                new Gs2Cdk.Gs2Guild.Model.GuildModel(
                    name: "guild-0001",
                    defaultMaximumMemberCount: 10,
                    maximumMemberCount: 50,
                    inactivityPeriodDays: 10,
                    roles: new Gs2Cdk.Gs2Guild.Model.RoleModel[]
                    {
                        new Gs2Cdk.Gs2Guild.Model.RoleModel(
                            name: "master",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        ),
                        new Gs2Cdk.Gs2Guild.Model.RoleModel(
                            name: "member",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        )
                    },
                    guildMasterRole: "master",
                    guildMemberDefaultRole: "member",
                    rejoinCoolTimeMinutes: 1440
                ),
                new Gs2Cdk.Gs2Guild.Model.GuildModel(
                    name: "guild-0002",
                    defaultMaximumMemberCount: 20,
                    maximumMemberCount: 40,
                    inactivityPeriodDays: 10,
                    roles: new Gs2Cdk.Gs2Guild.Model.RoleModel[]
                    {
                        new Gs2Cdk.Gs2Guild.Model.RoleModel(
                            name: "master",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        ),
                        new Gs2Cdk.Gs2Guild.Model.RoleModel(
                            name: "member",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        )
                    },
                    guildMasterRole: "master",
                    guildMemberDefaultRole: "member",
                    rejoinCoolTimeMinutes: 360
                )
            }
        );
    }
}

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

```

**TypeScript**
```typescript

import core from "@/gs2cdk/core";
import guild from "@/gs2cdk/guild";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new guild.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new guild.model.GuildModel(
                    "guild-0001",
                    10,
                    50,
                    10,
                    [
                        new guild.model.RoleModel(
                            "master",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        ),
                        new guild.model.RoleModel(
                            "member",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        ),
                    ],
                    "master",
                    "member",
                    1440
                ),
                new guild.model.GuildModel(
                    "guild-0002",
                    20,
                    40,
                    10,
                    [
                        new guild.model.RoleModel(
                            "master",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        ),
                        new guild.model.RoleModel(
                            "member",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"
                        ),
                    ],
                    "master",
                    "member",
                    360
                )
            ]
        );
    }
}

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

```

**Python**
```python

from gs2_cdk import Stack, core, guild

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        guild.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            guild_models=[
                guild.GuildModel(
                    name='guild-0001',
                    default_maximum_member_count=10,
                    maximum_member_count=50,
                    inactivity_period_days=10,
                    roles=[
                        guild.RoleModel(
                            name='master',
                            policy_document='{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}',        
                        ),
                        guild.RoleModel(
                            name='member',
                            policy_document='{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}',        
                        ),
                    ],
                    guild_master_role='master',
                    guild_member_default_role='member',
                    rejoin_cool_time_minutes=1440
                ),
                guild.GuildModel(
                    name='guild-0002',
                    default_maximum_member_count=20,
                    maximum_member_count=40,
                    inactivity_period_days=10,
                    roles=[
                        guild.RoleModel(
                            name='master',
                            policy_document='{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}',        
                        ),
                        guild.RoleModel(
                            name='member',
                            policy_document='{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}',        
                        ),
                    ],
                    guild_master_role='master',
                    guild_member_default_role='member',
                    rejoin_cool_time_minutes=360
                ),
            ],
        )

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

```


### GuildModel

ギルドモデル<br>

ギルドモデルとは、ギルドの加入可能最大人数の設定や、ギルド内での役職ごとの権限設定を持つエンティティです。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| guildModelId | string |  | ※ |  |  ~ 1024文字 | ギルドモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | ギルドモデル名<br>ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| defaultMaximumMemberCount | int |  | ✓ |  | 1 ~ 2147483646 | デフォルト最大メンバー数<br>新しいギルドが作成される際に許可されるメンバーの初期最大数です。この値は新規ギルドの currentMaximumMemberCount の初期値として使用されます。ギルド操作や入手アクションを通じて、後から maximumMemberCount の上限まで増加させることができます。 |
| maximumMemberCount | int |  | ✓ |  | 1 ~ 2147483646 | 最大メンバー数上限<br>ギルドが持つことができるメンバー数の絶対的な上限です。ギルドの currentMaximumMemberCount はこの値を超えることができません。ギルドが意図されたサイズを超えて成長するのを防ぐハードキャップとして機能します。 |
| inactivityPeriodDays | int |  |  | 7 | 1 ~ 365 | 無活動期間（日数）<br>ギルドマスターの無活動がこの日数を超えた場合に、残りのギルドメンバーから新しいギルドマスターが自動的に選出されます。ギルドマスターがプレイを停止した際にギルドが管理不能になるのを防ぎます。 |
| roles | [List&lt;RoleModel&gt;](#rolemodel) |  | ✓ |  | 1 ~ 10 items | ロールモデルリスト<br>このタイプのギルド内で利用可能なロール定義のリストです。guildMasterRole および guildMemberDefaultRole で参照されるロールを少なくとも含む必要があります。各ロールはポリシードキュメントを介して固有の権限セットを定義します。最大10個のロールを定義できます。 |
| guildMasterRole | string |  | ✓ |  |  ~ 128文字 | ギルドマスターロール名<br>ギルドマスターに割り当てられるロールの名前です。roles リストで定義されたロールを参照する必要があります。ギルドマスターは通常、参加リクエストの承認、メンバー追放、ロール変更、ギルド設定の更新など、ギルドを管理する全権限を持ちます。 |
| guildMemberDefaultRole | string |  | ✓ |  |  ~ 128文字 | デフォルトメンバーロール名<br>新しいギルドメンバーが参加した際に自動的に割り当てられるロールの名前です。roles リストで定義されたロールを参照する必要があります。これはギルドマスターによるロール変更前の一般メンバーの基本権限セットです。 |
| rejoinCoolTimeMinutes | int |  |  | 0 | 0 ~ 2147483646 | 再参加クールタイム（分）<br>ユーザーがギルドを離脱した後、再度ギルドに参加できるようになるまでのクールダウン期間（分）です。0 に設定すると即時再参加が可能になります。ユーザーが繰り返しギルドに参加・離脱する悪用パターンを防止します。 |
| maxConcurrentJoinGuilds | int |  |  |  | 1 ~ 10 | 同時参加可能ギルド最大数<br>ユーザーがこのタイプのギルドに同時にメンバーとして参加できる最大数です。プレイヤーが複数のギルドに同時に所属できるデザイン（例: 戦闘ギルドとソーシャルギルド）を可能にします。値は 1 から 10 の範囲です。 |
| maxConcurrentGuildMasterCount | int |  |  |  | 1 ~ 100 | 同時存在可能ギルドマスター最大数<br>1つのギルドに同時に存在できるギルドマスターの最大人数です。複数のプレイヤーがギルドマスターの責任と権限を共有する共同リーダーシップのデザインを可能にします。値は 1 から 100 の範囲です。 |

### RoleModel

ロールモデル<br>

ロールモデルはギルド内での役割を定義し、その役割ごと実行できる処理に関する権限を設定します。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128文字 | ロールモデル名<br>ロールモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| policyDocument | string |  | ✓ |  |  ~ 10240文字 | ポリシードキュメント<br>このロールの権限を定義する JSON 形式のポリシードキュメントです。このロールに割り当てられたメンバーに対して、どのギルド操作（参加リクエストの承認/拒否、メンバー追放、ギルド情報の更新、メンバーロールの変更など）が許可または拒否されるかを指定します。 |

---