/ja/tags/unreal-engine-5/ Recent content in Unreal Engine 5 on Game Server Services | Docs Hugo ja /ja/api_reference/initialize/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/initialize/game_engine/ SDK の初期化 GS2 の利用を開始するには、まずは GS2-SDK の初期化処理を行います。 Gs2Client.Create を呼び出すことで GS2 のクライアントインスタンスである Gs2Domain を取得できます。 初期化に必要なパラメータは以下です。 パラメータ 引数名 型 説明 credential BasicGs2Credential クレデンシャル情報 region Region 接続先のGS2リージョン BasicGs2Credential 「クライアントID」と「クライアントシークレット」を指定します。 これらの値は GS2-Identifier で管理しています。 Region GS2 のデータセンターを指定します。 指定可能な値については リージョン を参照してください。 実装例 Game Engine: Unity (UniTask) Unity (Vanilla) Unreal Engine 5 var gs2 = await Gs2.Unity.Core.Gs2Client.CreateAsync( new Gs2.Core.Model.BasicGs2Credential( "your client id", "your client secret" ), Gs2.Core.Model.Region.ApNortheast1 ); var future = Gs2.Unity.Core.Gs2Client.CreateFuture( new Gs2.Core.Model.BasicGs2Credential( "your client id", "your client secret" /ja/api_reference/transaction/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/transaction/game_engine/ トランザクションとは GS2 におけるトランザクション処理とは、「消費アクション」「入手アクション」として定義したリソースの交換処理を実行する塊を指します。 トランザクションを発行するAPIは、GS2-Exchange の交換実行関数(Exchange) であったり、GS2-Showcase の商品購入関数(Buy)であったり、GS2-Quest のクエスト開始関数(Start) のようなものがあります。 「消費アクション」はプレイヤーにとってデメリットとなるユーザーデータの操作、逆に「入手アクション」はプレイヤーにとってメリットとなるユーザーデータ操作を指します。 具体的には GS2-Inventory であれば、アイテムの消費が「消費アクション」、アイテムの入手が「入手アクション」となります。 もう少し変わった例を示すとすれば GS2-Inbox のメッセージの開封フラグを立てる操作を「消費アクション」、メッセージに添付されたアイテムを受け取るのが「入手アクション」となります。 GS2 ではユーザーデータを書き換えるトランザクションを発行して実行することを繰り返すことで、ゲームサイクルを実現すると理解してください。 トランザクションとスタンプシート GS2 では、トランザクション処理を「スタンプシート」という名前で呼んでいました。 そのため、コードやドキュメントの各所にそのような記述がみられます。 近年はこの名称は積極的に用いておらず「トランザクション処理」と呼んでいますが、同じものを指していると理解してください。 類似するワードとして「スタンプタスク」という名称もありますが、こちらはトランザクション内に含まれる「消費アクション」を指していました。 トランザクションの実行 GS2-Exchange の Exchange や、 GS2-Showcase の Buy を呼び出すと、EzTransactionDomain というオブジェクトが返されます。 EzTransactionDomain には Wait 関数が用意されており、この関数を呼び出すことで、トランザクション処理の完了を待つことができます。 ただし、トランザクション処理が完了するまでの時間に保証がないため、タイムアウトを実装することを強く推奨します。 Wait 関数には all という引数が用意されており、こちらに true を指定することで、トランザクション処理内で新しいトランザクションが発行された場合にそのトランザクションの実行完了も待つことが可能です。 Wait 関数を呼び出さない場合は、Gs2Domain::Dispatch を定期的に呼び出す必要があります。 Deep Dive ここから先はトランザクション処理の詳細な実装について解説します。 多くの開発者は以下に書かれている内容について理解する必要はありません。 消費アクションと入手アクションの実行順番 トランザクションに含まれる「消費アクション」を全て実行すると「入手アクション」が実行できるようになるように制御されています。 そのため、実行順番は「消費アクション」が先で、「入手アクション」が後になります。これはチート耐性を実現するために重要な仕様です。 このような処理の流れを、日本企業が決裁を行う「稟議」にたとえ、 いろいろな役職者（マイクロサービス）に許可をもらい（消費アクションを実行）稟議書にハンコを押してもらい、 全てのマイクロサービスに許可をもらうと本当にやりたかったこと（入手アクション）が実行できるということからスタンプシートと呼んでいました。 トランザクションの実行 GS2が提供しているマイクロサービスは、トランザクションに含まれる「消費アクション」や「入手アクション」を渡すことで、処理を実行する機能が備わっています。 しかし、トランザクションに含まれるアクションをどのマイクロサービスのどのAPIに渡すべきかはアクションの種類によって決定し、実行するのも一苦労です。 そこで、GS2-Distributor マイクロサービスが活躍します。 GS2-Distributor はトランザクションアクションを受け取ると、アクションの内容に応じて適切なマイクロサービスのAPIに転送する処理を持っています。 これによってあなたは何も考えずに、トランザクションデータを GS2-Distributor に渡すだけでトランザクションを実行できます。 エラー処理 次に考えるべきはエラーハンドリングです。GS2 は様々なマイクロサービスを提供しており、障害が発生するときはマイクロサービス単位で発生する可能性があります。 つまり、「消費アクション」の実行に成功したが「入手アクション」の実行に失敗した。というケースがありえます。 この場合は「入手アクション」が成功するまでリトライしなければ、プレイヤーが損をした状態で処理が止まってしまいます。 /ja/get_start/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/get_start/ SDK Game Engine Game Server Services は 主要なゲームエンジンから利用できるSDKを提供しています。 ゲームエンジン向け SDK では、ゲーム内から利用することにフォーカスして通常の SDK より高レベルなAPI形式で提供しています。 Language: Unity Unreal Engine 5 GS2 SDK for Unity 本 SDK は Apache License 2.0 で提供されています。 プログラムのどこかで Apache License 2.0 で提供されているライブラリを使用していることを明示する必要があります。 本 SDK にはパブリックドメインである LitJson(Gs2/Plugin/LitJSON.dll) が含まれています。 この dll は GS2 SDK の動作の根幹に関わる動作に利用されているため、削除することが出来ません。 本 SDK には MIT License である websocket-sharp(Gs2/Plugin/websocket-sharp.dll) が含まれています。 表示・表記が必要なライセンス条文は以下です。 https://raw.githubusercontent.com/sta/websocket-sharp/master/LICENSE.txt この dll は GS2 SDK の動作の根幹に関わる動作に利用されているため、削除することが出来ません。 本 SDK には BSD License である protobuf(Gs2/Plugin/Google.Protobuf.dll) が含まれています。 表示・表記が必要なライセンス条文は以下です。 /ja/get_start/tutorial/coding/all/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/get_start/tutorial/coding/all/ Game Engine: Unity Unreal Engine using System.Collections; using Gs2.Core.Model; using Gs2.Unity.Core; using Gs2.Unity.Gs2Account.Model; using Gs2.Unity.Util; using UnityEngine; public class Tutorial : MonoBehaviour { IEnumerator Start() { // Setup variables var clientId = "YourClientId"; var clientSecret = "YourClientSecret"; var accountNamespaceName = "game-0001"; // Initialize GS2 SDK Gs2Domain gs2; { var future = Gs2Client.CreateFuture( new BasicGs2Credential( clientId, clientSecret ), Region.ApNortheast1 ); yield return future; if (future.Error != null) { throw future.Error; } gs2 = future. /ja/api_reference/account/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/account/game_engine/ モデル EzAccount ゲームプレイヤーアカウント ゲームプレイヤーを識別するID情報のエンティティです。 ゲームプレイヤーアカウントは匿名アカウントであり、ユーザーID(UUID)とパスワード(ランダムな32文字の文字列)で構成されるため、ゲームプレイヤーはメールアドレスなどの情報を入力する必要はありません。 発行されたゲームプレイヤーアカウントは、デバイスのローカルストレージに保存しておき、次回以降ログインに使用します。 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ UUID ~ 128文字 ユーザーID password string ✓ ~ 128文字 パスワードアカウントのセキュリティを確保するためのパスワードを格納します。パスワードは最大128文字の長さを持ち、アカウントの保護に重要な役割を果たします。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 関連するメソッド: authentication - アカウントにログインする create - 新しいゲームプレイヤーアカウントを作成する doTakeOver - アカウントの引き継ぎを実行する doTakeOverOpenIdConnect - OpenID Connect を使ってアカウントの引き継ぎを実行する EzTakeOver 引き継ぎ情報 引き継ぎ情報とは、デバイスの機種変更やプラットフォーム間のアカウントの移動・共有時に使用する情報です。 個人を識別するユニークな文字列とパスワードで構成され、その適切な組み合わせを入力することで、Account(匿名アカウント)を取得することができます。 1つの Account に対して複数の引き継ぎ情報を設定できます。 複数の引き継ぎ情報を設定するにはそれぞれ異なるスロットを指定する必要があります。 スロットには0～1024を指定できますので、最大1025種類の引き継ぎ情報を設定可能です。 具体的な用例としては 0 には Sign in with Apple のアカウント情報を、1 には Google のアカウント情報を保存するようにする。というような使い方が想定されています。 あくまでこの引き継ぎ情報はデータホルダーであり、ソーシャルアカウントとの認証の仕組みは別途用意する必要があります。 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID type int ✓ 0 ~ 1024 スロット番号0から1024までの範囲で指定され、異なる引き継ぎ情報を区別します。 userIdentifier string ✓ ~ 1024文字 引き継ぎ用ユーザーIDアカウントを引き継ぐ際に使用される個人を識別するためのユニークなキーです。異なるアカウントで同一の userIdentifier を指定した場合、後で設定した値が優先されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 関連するメソッド: addTakeOverSetting - 引き継ぎ情報を登録する addTakeOverSettingOpenIdConnect - OpenID Connect を使って引き継ぎ情報を登録する deleteTakeOverSetting - 引き継ぎ情報を削除する get - 指定したタイプの引き継ぎ情報を取得する listTakeOverSettings - 引き継ぎ情報の一覧を取得する updateTakeOverSetting - 引き継ぎ用パスワードを変更する EzPlatformId プラットフォームID /ja/api_reference/ad_reward/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ad_reward/game_engine/ モデル EzPoint 広告を視聴することで獲得したポイント プレイヤーが広告視聴によって獲得したポイントの合計を表すモデルです。 プレイヤーは広告視聴のたびにポイントを獲得し、これらのポイントは報酬の交換やゲーム内特典の購入などに使用できます。 型 有効化条件 必須 デフォルト 値の制限 説明 point long 0 0 ~ 9223372036854775805 ポイントの所持数ユーザーが保持しているポイントの数を示します。この数値は、ユーザーが広告を視聴することで増加し、報酬や特典と交換することで減少します。 関連するメソッド: getPoint - 広告視聴で獲得したポイントの現在値を取得する メソッド getPoint 広告視聴で獲得したポイントの現在値を取得する リワード広告（AdMob、Unity Ads、AppLovin MAX など）の視聴によってプレイヤーが獲得したポイント数を取得します。 UIにポイント残高を表示したり、ポイントを使用する前に残高が足りているかを確認する際に使います。 まだポイントの記録がない場合は、0ポイントの記録が自動的に作成されて返されます。 Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 gameSession GameSession ✓ GameSession Result 型 説明 item EzPoint 広告を視聴することで獲得したポイント 実装例 Game Engine: Unity (UniTask) Unity (Vanilla) Unreal Engine 5 var domain = gs2. /ja/api_reference/auth/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/auth/game_engine/ モデル EzAccessToken アクセストークン ユーザー認証後に発行されるアクセストークンを管理するモデルです。 アクセストークンは、ユーザーがサービスにログインしている間、そのセッションの身元を証明するために使用されます。 トークンには有効期限が設定されており、期限切れになると再認証が必要になります。 型 有効化条件 必須 デフォルト 値の制限 説明 token string ✓ ~ 1024文字 アクセストークンアクセスを認証するためのトークンです。このトークンはシステムによって自動的に生成され、ユーザーのセッションを識別します。 userId string ✓ ~ 128文字 ユーザーID expire long 現在時刻から1時間後の絶対時刻 有効期限トークンの有効期限を示すタイムスタンプです。この期限が過ぎると、トークンは無効になります。UNIX 時間・ミリ秒 メソッド login アカウントの認証情報を使って GS2 にログインする GS2-Account::Authentication で取得した body と signature を渡してログインし、アクセストークン を受け取ります。 アクセストークン は有効期限1時間の一時的なログイン情報で、GS2 の各サービスをそのプレイヤーとして利用するために必要です。 通常、このAPIを直接呼び出す必要はありません。 Unity や Unreal Engine 5 の SDK では、GS2-Account::Authentication とこのAPIをまとめて実行する Profile::Login が用意されています。 詳しくは 初期化処理 / Game Engine を参照してください。 Request 型 有効化条件 必須 デフォルト 値の制限 説明 keyId string “grn:gs2:{region}:{ownerId}:key:default:key:default” ~ 1024文字 暗号鍵 GRN body string ✓ ~ 524288文字 署名対象のアカウント認証情報 signature string ✓ ~ 1024文字 署名 Result 型 説明 token string アクセストークンアクセスを認証するためのトークンです。このトークンはシステムによって自動的に生成され、ユーザーのセッションを識別します。 userId string ユーザーID expire long 有効期限トークンの有効期限を示すタイムスタンプです。この期限が過ぎると、トークンは無効になります。UNIX 時間・ミリ秒 実装例 Game Engine: Unity (UniTask) Unity (Vanilla) Unreal Engine 5 var domain = gs2. /ja/api_reference/buff/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/buff/game_engine/ モデル EzBuffEntryModel バフエントリーモデル バフの適用量はバフエントリーモデルで管理し、同一の対象に対して複数のバフエントリーモデルを関連づけることが可能です。 バフエントリーモデルの適用順番はバフエントリーモデルの priority で管理し、priority の値が小さいほど優先度が高くなります。 バフの適用方式は3種類存在し「Rate Add」、「Mul」と「Value Add」があります。 Rate Add はバフの適用レートに加算する命令、Mul はバフの適用レートに乗算する命令です。 Value Add はバフの補正計算後の値に加算を行う命令です。 たとえば、デフォルトのレートが 1.0 で、Rate Add 0.2 と設定するとバフの適用レートは 1.2 になります。 Mul 0.5 と設定するとバフの適用レートは 0.5 倍になります。 バフエントリーモデルには GS2-Schedule のイベントを関連づけることができ、イベントの開催期間中のみバフを適用するような設定も可能です。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 バフエントリーモデル名バフエントリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 targetType 文字列列挙型 enum { “model”, “action” } ✓ バフを適用する対象の種類バフをモデルのフィールド値に適用するか、アクションのパラメータに適用するかを指定します。「Model」は GS2 リソースモデルのフィールドを対象とし、「Action」は GS2 アクション（例：入手量や消費量）のパラメータを対象とします。定義説明“model”モデル“action”アクション targetModel EzBuffTargetModel {targetType} == “model” ✓※ バフを適用する対象のモデルバフを適用する GS2 リソースモデルとフィールドを指定します。モデル名、フィールド名、対象リソースを特定する条件GRN、およびレート値が含まれます。 /ja/api_reference/chat/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/chat/game_engine/ モデル EzRoom ルーム ルームはチャットのメッセージを届けられる範囲を表しています。 GS2-Chat のルームには参加という概念はありません。 そのため、メッセージを受信するにはルームの名前を知っているだけでよく、ルームへの参加やメンバー登録は必要ありません。 ルームのメッセージを閲覧できるゲームプレイヤーを限定したい場合は2つの方法があります。 1つ目はルームにパスワードを設定することです。 2つ目はルームに設定可能なホワイトリストでゲームプレイヤーのユーザーIDを設定することで限定ができます。 パスワードを設定した場合、パスワードを知らなければゲームの管理者でもメッセージの取得が出来なくなることに注意してください。 これは日本国憲法で定められた通信の秘密に該当する可能性があるためです。 ルームを購読すると、ルームに対して新しいメッセージが送信された際に GS2-Gateway のプッシュ通知を受けることが可能です。 この通知機能を利用することで、ルームに対してポーリングすることなく新しいメッセージの有無を知ることが可能となります。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ UUID ~ 128文字 ルーム名ルーム固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 metadata string ~ 1024文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 whiteListUserIds List<string> [] 0 ~ 1000 items ルームにアクセス可能なユーザーIDリスト設定すると、リストに含まれるユーザーのみがルームのメッセージを取得・投稿できるようになります。空の場合、ユーザーIDによるアクセス制限は適用されません（ただしパスワードは別途必要な場合があります）。 関連するメソッド: createRoom - チャットルームを作成する deleteRoom - チャットルームを削除する getRoom - チャットルームの情報を取得する EzMessage メッセージ メッセージはルームに投稿されたデータです。 カテゴリというフィールドを持ちますので、メッセージの分類が可能です。 たとえば、カテゴリが 0 の場合は通常のテキストメッセージとして解釈し、1 の場合はスタンプ（ステッカー）として処理するようにクライアントを実行することができます。 投稿されたメッセージは投稿後、Chat Namespace の messageLifeTimeDays で設定したメッセージ保持期間が経過すると自動的に削除されます。 /ja/api_reference/datastore/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/datastore/game_engine/ モデル EzDataObject データオブジェクト データオブジェクトはゲームプレイヤーがアップロードしたデータです。 データは世代管理され、30日分の過去のデータも保管されます。 データにはアクセス権限を設定できます。 スコープには3種類あり、 だれでもアクセスできる public 指定したユーザーIDのゲームプレイヤーのみがアクセスできる protected 自身のみがアクセスできる private があります。 型 有効化条件 必須 デフォルト 値の制限 説明 dataObjectId string ※ ~ 1024文字 データオブジェクト GRN ※ サーバーが自動で設定 name string ✓ UUID ~ 128文字 データオブジェクトの名前データオブジェクトを識別する一意な名前です。デフォルトでは UUID 形式で自動生成されます。ネームスペース内でアップロードされたデータの参照・管理に使用されます。 userId string ✓ ~ 128文字 ユーザーID scope 文字列列挙型 enum { “public”, “protected”, “private” } “private” ファイルのアクセス権このデータオブジェクトにアクセスできるユーザーを制御します。public は誰でもアクセス可能、protected は allowUserIds に指定されたユーザーIDのみアクセス可能、private はオーナー本人のみアクセス可能です。定義説明“public”公開“protected”指定したユーザーにのみ公開“private”非公開 allowUserIds List<string> {scope} == “protected” ※ [] 0 ~ 100 items 公開するユーザーIDリストスコープが protected に設定されている場合に、このデータオブジェクトにアクセスできるユーザーを指定します。このリストに含まれるユーザーIDのユーザーのみが読み取りアクセスを許可されます。 /ja/api_reference/dictionary/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/dictionary/game_engine/ モデル EzEntry ゲームプレイヤーが入手したエントリー ゲームプレイヤーが収集した図鑑エントリーの1件を表します。各エントリーは EntryModel に対応し、入手日時を記録します。所持状態は「存在する（収集済み）/ 存在しない」の2値で管理され、数量の概念はありません。 型 有効化条件 必須 デフォルト 値の制限 説明 entryId string ※ ~ 1024文字 エントリー GRN ※ サーバーが自動で設定 userId string ~ 128文字 ユーザーID name string ✓ ~ 128文字 エントリーモデル名エントリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 acquiredAt long ※ 現在時刻 入手日時このエントリーがゲームプレイヤーによって初めて収集された日時です。登録時に現在時刻が自動的に設定され、その後変更することはできません。 関連するメソッド: getEntry - プレイヤーが特定のエントリーを収集済みか確認する getEntryWithSignature - 改ざん防止の署名付きでエントリーを取得する listEntries - プレイヤーが収集済みのエントリー一覧を取得する EzLike お気に入りに登録したエントリー ゲームプレイヤーがお気に入り（いいね）に登録した図鑑エントリーを表します。プレイヤーが図鑑内の特定のエントリーをブックマークしてすぐにアクセスできるようにします。各お気に入りは EntryModel を名前で参照し、ユーザーごとに一意です。同じエントリーを重複してお気に入りに登録することはできません。 型 有効化条件 必須 デフォルト 値の制限 説明 likeId string ※ ~ 1024文字 お気に入りエントリー GRN ※ サーバーが自動で設定 userId string ~ 128文字 ユーザーID name string ✓ ~ 128文字 エントリーモデル名エントリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) . /ja/api_reference/distributor/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/distributor/game_engine/ モデル EzStampSheetResult トランザクション実行結果（レガシー） サーバーサイドの自動実行で処理されたトランザクションの実行結果を記録します。 各フェーズのリクエスト内容とレスポンス結果を含みます：検証アクション（事前条件チェック）、消費アクション、入手アクション。エラー検出とリトライロジックのために HTTP ステータスコードも追跡します。 型 有効化条件 必須 デフォルト 値の制限 説明 transactionId string ✓ 36 ~ 36文字 トランザクションIDこのトランザクションを一意に識別する UUID です。トランザクションとその実行結果、および連鎖する後続トランザクションの関連付けに使用されます。 taskRequests List<EzConsumeAction> 0 ~ 100 items 消費アクションのリクエスト内容 sheetRequest EzAcquireAction ✓ 入手アクションのリクエスト内容 taskResults List<string> [] 0 ~ 100 items 消費アクションの実行結果 sheetResult string ~ 1048576文字 入手アクションの実行結果レスポンス内容 関連するメソッド: getStampSheetResult - 完了したトランザクションの結果を取得する（レガシー） EzTransactionResult トランザクション実行結果 サーバーサイドの自動実行で処理された分散トランザクションの実行結果を記録します。 各フェーズの構造化された結果を含みます：検証アクション（事前条件チェック）、消費アクション（リソース消費）、入手アクション（リソース付与）。各アクション結果にはリクエスト、HTTP ステータスコード、レスポンスペイロードが含まれます。ステータスコード（非2xx）によるエラー検出と、コンフリクト（409）やサーバーエラー（5xx）でのリトライがサポートされます。 型 有効化条件 必須 デフォルト 値の制限 説明 transactionId string ✓ 36 ~ 36文字 トランザクションIDこの分散トランザクションを一意に識別する UUID です。実行結果の検索や、元の API リクエストとの関連付けに使用されます。 verifyResults List<EzVerifyActionResult> 0 ~ 100 items 検証アクションの実行結果リスト consumeResults List<EzConsumeActionResult> 0 ~ 100 items 消費アクションの実行結果リスト acquireResults List<EzAcquireActionResult> 0 ~ 100 items 入手アクションの実行結果リスト 関連するメソッド: getTransactionResult - 完了したトランザクションの結果を取得する EzDistributorModel 配信モデル /ja/api_reference/enchant/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/enchant/game_engine/ モデル EzBalanceParameterStatus バランスパラメータの状態 ユーザーが所有する特定のリソースに対して抽選されたパラメータの実際の値を表します。各ステータスはバランスパラメータモデルに関連付けられ、抽選処理後に各パラメータスロットに割り当てられた具体的な値を保持します。 型 有効化条件 必須 デフォルト 値の制限 説明 parameterName string ✓ ~ 128文字 バランスパラメータモデル名このステータスの抽選条件を定義するバランスパラメータモデルの名前です。合計値、配分方針、利用可能なパラメータスロットを指定するモデルを参照します。 propertyId string ✓ ~ 1024文字 パラメータの保有元リソースのプロパティIDこれらのバランスパラメータが紐付けられている特定のゲームリソース（例: 武器や装備アイテム）を識別します。通常、GS2-Inventory のアイテムなどのリソースをプロパティ ID で参照します。 parameterValues List<EzBalanceParameterValue> ✓ 1 ~ 10 items バランスパラメータの値リスト抽選処理後に各パラメータスロットに割り当てられた具体的な値です。各エントリはモデルで定義されたパラメータスロットに対応し、割り当てられた実際の数値を保持します。すべての値の合計はモデルで指定された合計値と等しくなります。 関連するメソッド: getBalanceParameterStatus - 特定のアイテムのバランスパラメータ値を取得する listBalanceParameterStatuses - プレイヤーのバランスパラメータ値の一覧を取得する EzRarityParameterStatus レアリティパラメータの状態 ユーザーが所有する特定のリソースに対して抽選されたパラメータの実際の値を表します。各ステータスはレアリティパラメータモデルに関連付けられ、付与された各パラメータスロットに対して重み付き抽選で選択された具体的な値を保持します。 型 有効化条件 必須 デフォルト 値の制限 説明 parameterName string ✓ ~ 128文字 レアリティパラメータモデル名このステータスの抽選条件を定義するレアリティパラメータモデルの名前です。最大パラメータ数、付与数の抽選重み、値の抽選プールを指定するモデルを参照します。 propertyId string ✓ ~ 1024文字 パラメータの保有元リソースのプロパティIDこれらのレアリティパラメータが紐付けられている特定のゲームリソース（例: 武器や装備アイテム）を識別します。通常、GS2-Inventory のアイテムなどのリソースをプロパティ ID で参照します。 parameterValues List<EzRarityParameterValue> 0 ~ 10 items レアリティパラメータの値リスト付与された各スロットに対して重み付き抽選で選択された具体的なパラメータ値です。エントリ数は付与数の抽選で決定され、各エントリの値は値モデルプールから選択されます。最大パラメータ数より少ないエントリ数になる場合があります。 関連するメソッド: getRarityParameterStatus - 特定のアイテムのレアリティパラメータ値を取得する listRarityParameterStatuses - プレイヤーのレアリティパラメータ値の一覧を取得する verifyRarityParameterStatus - 特定のアイテムのレアリティパラメータを検証する EzBalanceParameterModel バランスパラメータモデル /ja/api_reference/enhance/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/enhance/game_engine/ モデル EzProgress 強化進行状況 強化の開始時に作成され、終了時に削除されます。 強化の途中でアプリを終了した際にはこのデータが残った状態となり エンティティが保持する進行中の強化情報からゲームをリジュームすることが可能です。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ UUID ~ 36文字 強化進行状況ID強化進行状況の一意なIDを保持します。IDは UUID（Universally Unique Identifier）フォーマットで自動的に生成され、強化進行状況を識別するために使用されます。 rateName string ✓ ~ 128文字 強化レートモデル名この強化操作のパラメータを定義する強化レートモデルの名前です。対象インベントリ、素材インベントリ、経験値階層、ボーナスレートを指定するモデルを参照します。 propertyId string ✓ ~ 1024文字 強化対象のプロパティID強化される GS2-Inventory アイテムのプロパティ ID です。強化完了時に経験値を受け取る特定のアイテムインスタンスを識別します。 experienceValue long ✓ 0 ~ 9223372036854775805 入手できる経験値消費した素材から算出された基本経験値です。この値は、各素材のメタデータに定義された経験値に素材数量を乗じた合計として決定されます。 rate float ✓ 0 ~ 100.0 経験値倍率基本経験値に適用されるボーナス倍率です。強化レートモデルのボーナスレートからの重み付き抽選で決定されます。1.0 はボーナスなし、1.0 より大きい値は「大成功」ボーナスを表します（例: 1.5 で経験値 150%）。 関連するメソッド: deleteProgress - 進行中の強化をキャンセルする end - 強化を完了する（2フェーズフロー） getProgress - 現在の強化の進行情報を取得する EzRateModel 強化レートモデル 強化レートは強化に使用する素材と強化対象を定義したデータです。 /ja/api_reference/exchange/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/exchange/game_engine/ モデル EzAwait 交換待機 報酬を受け取る前に実時間の経過が必要な交換の実行状態を表します。プレイヤーが await タイミングタイプの交換を開始した際に作成され、報酬が利用可能になるまでの待機期間を追跡します。待ち時間を短縮または解消するスキップ機能をサポートし、報酬取得時のデフォルト設定値を保存します。 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID rateName string ✓ ~ 128文字 交換レートモデル名交換レートモデルの種類固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 name string ✓ UUID ~ 36文字 交換待機の名前交換待機の一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、交換待機を識別するために使用されます。 skipSeconds int 0 0 ~ 2147483646 スキップ秒数待ち時間から差し引く秒数です。スキップ秒数が適用されると、acquirableAt のタイムスタンプがこの分だけ前倒しされます。プレイヤーがリソースを支払って待ち時間を短縮する仕組みを実装するために使用されます。 config List<EzConfig> [] 0 ~ 32 items 報酬取得時に適用するデフォルト設定値待機完了時に報酬が配布される際にトランザクションのプレースホルダ変数として使用されるキーと値のペアです。これらの値は交換開始時に設定され、入手アクションのトランザクションパラメータに適用されます。 exchangedAt long 交換時間交換が開始され待機が作成されたタイムスタンプです。報酬が利用可能になる時刻を計算するための基準時刻として使用されます（acquirableAt = exchangedAt + lockTime - skipSeconds）。 acquirableAt long 報酬を受け取れるようになる時間待機期間が満了し報酬が受け取り可能になるタイムスタンプです。exchangedAt + lockTime - skipSeconds として計算されます。現在時刻がこのタイムスタンプを過ぎると、プレイヤーは取得 API を呼び出せるようになります。 関連するメソッド: acquire - 完了した時間制交換の報酬を受け取る deleteAwait - 待機中の時間制交換をキャンセルする getAwait - 特定の待機中の時間制交換を取得する listAwaits - 待機中の時間制交換の一覧を取得する EzRateModel 交換レートモデル /ja/api_reference/experience/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/experience/game_engine/ モデル EzStatus ステータス ステータスとはプロパティID毎に存在するエンティティで、 現在の経験値やランクキャップの値を保持します。 プロパティID とはステータス固有のIDで、開発者が任意の値を設定できます。 GS2 では経験値を有する GS2-Inventory のアイテムセットGRN や GS2-Dictionary のエントリーGRN の後ろに 経験値モデルとなるサフィックスを追加した値をプロパティIDとすることを推奨しています。 型 有効化条件 必須 デフォルト 値の制限 説明 experienceName string ✓ ~ 128文字 経験値モデル名このステータスのランキングルールを定義する経験値モデルの名前です。どのランクアップ閾値テーブルとランクキャップ設定が適用されるかを決定します。 propertyId string ✓ ~ 1024文字 プロパティIDユーザースコープ内でこのステータスを一意に識別する開発者定義の識別子です。経験値を持つ GS2-Inventory のアイテムセット GRN や GS2-Dictionary のエントリー GRN の末尾に経験値モデルのサフィックスを付与した値を使用することを推奨します。 experienceValue long 0 0 ~ 9223372036854775805 累計獲得経験値このステータスが蓄積した合計経験値です。現在のランクはこの値からランクアップ閾値テーブルを使用して算出されます。現在のランクキャップに対応する閾値を超えて経験値を獲得することはできません。 rankValue long 0 0 ~ 9223372036854775805 現在のランクランクアップ閾値テーブルを使用して累計経験値から算出されるランク（レベル）です。0 から開始し、経験値閾値を超えるごとに増加します。現在のランクキャップ値を超えることはできません。 rankCapValue long ✓ 0 ~ 9223372036854775805 現在のランクキャップこのステータスが現在到達できる最大ランクです。初期値は経験値モデルの defaultRankCap に設定され、限界突破などのランクキャップ増加操作により maxRankCap まで引き上げることができます。 nextRankUpExperienceValue long 0 0 ~ 9223372036854775805 次のランクアップの経験値量次のランクに到達するために必要な累計経験値の閾値です。ステータスが既にランクキャップに到達している場合は 0 を返します。ゲーム UI でプログレスバーや残り経験値を表示するのに便利です。 関連するメソッド: getStatus - 特定のアイテムやキャラクターのレベル・経験値ステータスを取得する getStatusWithSignature - 改ざん防止の署名付きでレベル・経験値ステータスを取得する listStatuses - プレイヤーのレベル・経験値ステータスの一覧を取得する EzExperienceModel 経験値モデル /ja/api_reference/formation/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/formation/game_engine/ モデル EzMold フォームの保存領域 ゲームプレイヤーが編成した情報を保持するエンティティです。 編成情報(Form) は フォームの保存領域(Mold) ごとに複数保持することができ、いくつ保持できるかのキャパシティをゲームプレイヤー×フォームの保存領域 ごとに個別に設定できます。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 フォームの保存領域モデルの名前フォームの保存領域モデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID capacity int ✓ 0 ~ 2147483646 現在のキャパシティこの保存領域でこのプレイヤーが現在利用できるフォーム保存スロット数です。初期値は保存領域モデルの initialMaxCapacity に設定され、キャパシティ増加操作により maxCapacity まで拡張できます。 関連するメソッド: getMold - 名前を指定して編成プリセット保存領域を取得する listMolds - プレイヤーの編成プリセット保存領域の一覧を取得する deleteForm - 保存済み編成プリセットを削除する getForm - 特定の保存済み編成プリセットを取得する getFormWithSignature - 改ざん防止の署名付きで編成プリセットを取得する setForm - 編成プリセットの変更を保存する EzForm フォーム 編成状況を表すエンティティです。 編成できる領域として スロット を定義できます。 武器・防具 であれば 「右手」「左手」「胴」「腕」のような部位をスロットとし、 パーティであれば「前衛」「中衛」「後衛」のようなポジションをスロットとして表現できます。 /ja/api_reference/friend/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/friend/game_engine/ モデル EzProfile プロフィール プロフィールはゲームプレイヤーに関する情報を格納します。 プロフィールは公開範囲ごとに設定することが可能で、3種類あります。 friend フレンド関係が成立している相手に閲覧可能な内容 follow フォローされている相手が閲覧可能な内容 public 誰でも閲覧可能な内容 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID publicProfile string ~ 1024文字 公開されるプロフィール関係性に関わらずすべてのプレイヤーに表示されるプロフィール情報です。通常、表示名、アバター、その他公開可能な情報に使用されます。 followerProfile string ~ 1024文字 フォロワー向けに公開されるプロフィールこのユーザーをフォローしているプレイヤーにのみ表示されるプロフィール情報です。公開プロフィールよりも詳細な情報（ゲームプレイ統計やステータスメッセージなど）を含むことができます。 friendProfile string ~ 1024文字 フレンド向けに公開されるプロフィール相互フレンド関係が成立しているプレイヤーにのみ表示されるプロフィール情報です。最もプライベートなプロフィールレベルで、連絡先やプライベートメッセージなどの個人情報の共有に適しています。 関連するメソッド: getProfile - プレイヤー自身のプロフィールを取得する updateProfile - プレイヤー自身のプロフィールを更新する EzBlackList ブラックリスト プレイヤーがブロックしたユーザーのリストを管理します。ブロックされたユーザーはこのプレイヤーにフレンドリクエストやフォローリクエストを送信できなくなり、望まないインタラクションを制御するメカニズムを提供します。 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID targetUserIds List<string> 0 ~ 1000 items ブラックリストのユーザーIDリストこのプレイヤーがブロックしたユーザー ID のリストです。ブロックされたユーザーはこのプレイヤーにフレンドリクエストやフォローリクエストを送信できません。 関連するメソッド: registerBlackList - プレイヤーをブロックする unregisterBlackList - プレイヤーのブロックを解除する EzFollowUser フォローユーザー /ja/api_reference/gateway/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/gateway/game_engine/ モデル EzWebSocketSession WebSocketSession WebSocketセッションはGS2サーバとクライアント間の持続的な接続で、リアルタイムに双方向通信を行います。 サーバに対してクライアント側から識別子としてユーザーIDを登録します。 型 有効化条件 必須 デフォルト 値の制限 説明 connectionId string ✓ ~ 128文字 コネクションIDこの WebSocket 接続に割り当てられた一意な識別子です。通知送信時に特定のクライアント接続を識別するために使用されます。 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID 関連するメソッド: setUserId - サーバーからのプッシュ通知を受け取るためにプレイヤーの接続を登録する メソッド setUserId サーバーからのプッシュ通知を受け取るためにプレイヤーの接続を登録する 現在のWebSocket接続をプレイヤーのユーザーIDに紐づけて、サーバーからこのクライアントにリアルタイムのプッシュ通知を送信できるようにします。 通常はプレイヤーがログインしてサーバーに接続した直後に呼び出します。このステップなしでは、サーバーはどの接続がどのプレイヤーのものか判別できません。 allowConcurrentAccess フラグで、同じプレイヤーが複数のデバイスから同時に接続できるかを制御します： true: 複数の同時接続を許可（スマホとタブレットの両方でプレイするなど） false: プレイヤーごとに1接続のみ許可（重複ログイン防止。古い接続は切断されます） ゲームのログイン・初期化フローの一部として使います。リアルタイムチャット通知、フレンドリクエストのアラート、マッチング成立の通知などの機能を有効にするのに必要です。 Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 gameSession GameSession ✓ GameSession allowConcurrentAccess bool true 同時に異なるクライアントからの接続を許容するか sessionId string {allowConcurrentAccess} == false ~ 128文字 allowConcurrentAccess を false にした場合でも、既存接続と同一の sessionId であれば接続を許可するために指定します。 /ja/api_reference/grade/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/grade/game_engine/ モデル EzStatus ステータス ステータスとはプロパティID毎に存在するエンティティで、 現在のグレードの値を保持します。 プロパティID とはステータス固有のIDで、開発者が任意の値を設定できます。 連動する GS2-Experience のプロパティIDと完全に一致する値を使用することを強く推奨しています。 型 有効化条件 必須 デフォルト 値の制限 説明 gradeName string ✓ ~ 128文字 グレードモデル名このステータスが属するグレードモデルの名前です。グレードエントリのマッピング、連動する経験値モデル、報酬加算テーブルを含むグレードモデル定義を参照します。 propertyId string ✓ ~ 1024文字 プロパティIDこのグレードステータスの開発者定義の識別子で、ユーザーとグレードモデル内で一意です。連動する GS2-Experience ステータスのプロパティIDと同じ値を使用することを強く推奨します。これにより、グレード値とランクキャップの正しい同期が保証されます。 gradeValue long 1 1 ~ 9223372036854775805 現在のグレードこのステータスの現在のグレード値です。連動する GS2-Experience モデルのランクキャップを決定するために、グレードモデルのグレードエントリ配列のインデックスとして使用されます。この値が変更されると、関連する経験値ステータスのランクキャップが対応するグレードエントリで定義された値に自動更新されます。 関連するメソッド: applyRankCap - 現在の限界突破グレードに合わせて最大レベルを同期する getStatus - 特定のアイテムやキャラクターの限界突破・覚醒ステータスを取得する listStatuses - プレイヤーの限界突破・覚醒ステータスの一覧を取得する EzGradeModel グレードモデル グレードモデルとは、キャラクターや装備のランクを示すエンティティで、グレードによって GS2-Experience のランクキャップを設定することができます。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 グレードモデル名グレードモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 experienceModelId string ✓ ~ 1024文字 GS2-Experience 経験値モデル GRN このグレードモデルと連動させる GS2-Experience の経験値モデルの GRN です。グレード値が変更されると、グレードエントリのマッピングに基づいて連動する経験値モデルのランクキャップが自動的に更新されます。これにより、高いグレードが高いランクキャップを解放するグレード駆動の成長が実現できます。 gradeEntries List<EzGradeEntryModel> ✓ 1 ~ 100 items グレードエントリーモデルリスト各グレード値を連動する GS2-Experience モデルのランクキャップにマッピングするグレードエントリの順序付きリストです。配列のインデックスがグレード値に対応し、最初のエントリ（インデックス 0）がグレード 0 のランクキャップを、2番目がグレード 1 を定義します。 acquireActionRates List<EzAcquireActionRate> 0 ~ 100 items 報酬加算テーブルリストグレードに基づいて報酬量をスケーリングするための名前付き倍率テーブルのコレクションです。複数のテーブルを定義して、異なる種類の報酬（例: 経験値、通貨、アイテム）に異なるスケーリングルールを適用できます。 関連するメソッド: getGradeModel - 名前を指定して限界突破・覚醒モデルを取得する listGradeModels - 限界突破・覚醒モデルの一覧を取得する EzGradeEntryModel グレードエントリーモデル /ja/api_reference/guild/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/guild/game_engine/ モデル EzGuild ギルド ギルドは最大5個の属性を持つことができ、ギルドの検索やギルド一覧表示の際に利用できます。 ギルドには参加ポリシーを設定でき、自由参加と承認制を選択できます。 自由参加を選択した場合、ギルドへの参加リクエストを行うと即座にギルドメンバーとなります。 承認制を選択した場合、ギルドへの参加リクエストを行うとギルドマスターまたはギルドメンバーが承認するまでギルドメンバーにはなりません。 ギルドメンバーにはロールを設定でき、ギルドマスター、ギルドメンバーに加えてギルドが独自に定義した最大10個のカスタムロールを設定できます。 ギルドメンバーはギルドに参加した際にデフォルトで付与されるロールを設定できます。 型 有効化条件 必須 デフォルト 値の制限 説明 guildModelName string ✓ ~ 128文字 ギルドモデル名ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 name string ✓ UUID ~ 36文字 ギルド名ギルドの一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各ギルドを識別するために使用されます。 displayName string ✓ ~ 64文字 表示名UI でプレイヤーに表示されるギルドの人間が読める名前です。ギルド名（システム生成の UUID）とは異なり、表示名はギルド作成者が設定し、更新も可能です。ギルド検索結果、メンバーリスト、その他のプレイヤー向け表示に使用されます。 attribute1 int 0 ~ 2147483645 属性1ギルド検索でのフィルタリングやソートに使用できるギルドの数値属性です。レベル、地域、プレイスタイル、アクティビティ要件などのカスタムギルドプロパティを定義するために、最大5つの属性を開発者が利用できます。 attribute2 int 0 ~ 2147483645 属性2ギルド検索でのフィルタリングやソートに使用できるギルドの数値属性です。詳細は attribute1 を参照してください。 attribute3 int 0 ~ 2147483645 属性3ギルド検索でのフィルタリングやソートに使用できるギルドの数値属性です。詳細は attribute1 を参照してください。 attribute4 int 0 ~ 2147483645 属性4ギルド検索でのフィルタリングやソートに使用できるギルドの数値属性です。詳細は attribute1 を参照してください。 attribute5 int 0 ~ 2147483645 属性5ギルド検索でのフィルタリングやソートに使用できるギルドの数値属性です。詳細は attribute1 を参照してください。 metadata string ~ 1024文字 ギルドのメタデータGS2 の動作に影響しないギルドに関連付けられた任意のデータです。ギルドの紋章、説明、募集メッセージ、その他のカスタムデータなど、ゲーム固有の情報を保存するために使用できます。 joinPolicy 文字列列挙型 /ja/api_reference/idle/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/idle/game_engine/ モデル EzStatus ステータス 初めて GetIdleStatus を呼び出した時に作成され、その時間から放置時間のカウントが始まります。 放置時間のカウントは報酬を受け取るとリセットされます。 GS2-Schedule のイベントが関連づけられている場合、イベントの開催前には Category にアクセスできず、ステータスを作成することもできません。 イベントが関連づけられている場合、ステータス はイベントの繰り返し回数を保持します。 現在のイベントIDとステータス作成時のイベントIDが一致しない場合、現在のイベントの繰り返し回数とステータスが保持する繰り返し回数が一致しない場合、またはイベントの開始時刻より前にステータスが作成されている場合、待機時間 はリセットされます。 型 有効化条件 必須 デフォルト 値の制限 説明 categoryName string ✓ ~ 128文字 カテゴリーモデル名このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 randomSeed long 0 0 ~ 9223372036854775805 乱数シード放置報酬の計算時に決定論的な乱数生成に使用されるシード値です。報酬計算が再現可能で一貫性があることを保証し、サーバーが報酬結果を検証できるようにします。報酬を受け取るたびに更新されます。 idleMinutes int ✓ 0 ~ 2147483646 放置時間（分）最後の報酬受け取りまたはステータス作成からの累積放置時間（分）です。この値は idleStartedAt からの経過時間から計算され、maximumIdleMinutes で上限が設定されます。利用可能な報酬数はこの値をカテゴリーモデルの rewardIntervalMinutes で割ることで決定されます。 maximumIdleMinutes int 0 0 ~ 2147483646 最大放置時間（分）このステータスが蓄積できる最大放置時間（分）です。ステータス作成時にカテゴリーモデルの defaultMaximumIdleMinutes から初期化されます。入手アクションを通じてユーザーごとに増加でき、プレミアムユーザーやイベント参加者がより多くの放置報酬を蓄積できるようにします。 関連するメソッド: getStatus - 特定カテゴリーの放置報酬ステータスを取得する listStatuses - プレイヤーの放置報酬ステータスの一覧を取得する prediction - 今受け取れる放置報酬をプレビューする receive - 蓄積された放置報酬を受け取る EzCategoryModel カテゴリーモデル /ja/api_reference/inbox/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inbox/game_engine/ モデル EzMessage メッセージ ゲームプレイヤー毎に用意されるメッセージボックスに届けられたメッセージデータ。 メッセージには開封状態がある他、開封時に実行する入手アクションを設定することができます。 メッセージには有効期限を設定でき、有効期限が切れたメッセージは、未読状態、開封後の既読状態にかかわらず、自動的に削除されます。 添付された報酬を受け取っていない場合でも削除されます。 型 有効化条件 必須 デフォルト 値の制限 説明 messageId string ※ ~ 1024文字 メッセージ GRN ※ サーバーが自動で設定 name string ✓ UUID ~ 36文字 メッセージ名メッセージの一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 metadata string ✓ ~ 4096文字 メタデータメッセージのタイトル、本文、送信者情報、表示パラメータなどを含むJSON文字列など、メッセージの内容を表す任意のデータです。GS2はこの値を解釈せず、メッセージUIの描画のためにゲームクライアントにそのまま渡されます。最大4096文字です。 isRead bool false 既読状態メッセージがユーザーによって開封されたかどうかを示します。メッセージが開封されると、このフラグがtrueに設定され、readAcquireActions が実行されて添付報酬が配布され、readAt タイムスタンプが記録されます。ネームスペースで isAutomaticDeletingEnabled が設定されている場合、既読後にメッセージは削除されます。 readAcquireActions List<EzAcquireAction> [] 0 ~ 100 items 開封時入手アクションユーザーがこのメッセージを開封した際に実行される入手アクションのリストです。アイテム、通貨、リソースなどの報酬をメッセージに添付するために使用されます。複数のアクションを組み合わせて異なる種類の報酬を同時に付与できます。メッセージあたり最大100アクションです。 receivedAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 readAt long 0 開封日時UNIX 時間・ミリ秒 expiresAt long 有効期限日時UNIX 時間・ミリ秒 関連するメソッド: batchRead - 複数のメッセージを一括開封してまとめて報酬を受け取る delete - プレゼントボックスからメッセージを削除する get - 特定のメッセージの詳細を取得する list - プレイヤーのプレゼントボックスにあるメッセージの一覧を取得する read - メッセージを開封して報酬を受け取る receiveGlobalMessage - 全プレイヤー宛てのメッセージを受信する EzConfig コンフィグ設定 /ja/api_reference/inventory/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inventory/game_engine/ モデル EzInventory インベントリ インベントリは、ゲームプレイヤーが所有するアイテムを格納するためのカバンのようなものです。 カバンには容量があり、プレイヤーごとに容量を拡張することができます。 型 有効化条件 必須 デフォルト 値の制限 説明 inventoryId string ※ ~ 1024文字 インベントリ GRN ※ サーバーが自動で設定 inventoryName string ✓ ~ 128文字 インベントリモデル名このインベントリの構造と容量設定を定義するインベントリモデルの名前です。ユーザーのインベントリインスタンスをモデル定義にリンクし、使用可能なアイテムの種類と容量制限を決定します。 currentInventoryCapacityUsage int 0 0 ~ 2147483646 キャパシティ使用量アイテムセットによって現在使用されているインベントリ枠の数です。新しいアイテムスタックが追加された時（例：allowMultipleStacksで新しい枠が作成された時）にインクリメントされ、アイテムセットが完全に消費または削除された時にデクリメントされます。currentInventoryMaxCapacityを超えることはできません。 currentInventoryMaxCapacity int ✓ 1 ~ 2147483646 最大キャパシティこのユーザーが使用可能なインベントリ枠の現在の最大数です。インベントリモデルのinitialCapacityから初期化され、入手アクションまたは直接のAPI呼び出しを通じてモデルのmaxCapacityまで拡張できます。 関連するメソッド: getInventory - 特定のインベントリの詳細を取得する listInventories - プレイヤーのインベントリ一覧を取得する consume - プレイヤーのインベントリからアイテムを消費する getItem - インベントリ名とアイテム名を指定してアイテムを取得する getItemWithSignature - 所持証明の署名付きでアイテムを取得する EzItemSet アイテムセット アイテムセットはゲームプレイヤーのインベントリ内に保存されている所有物を表しています。 インベントリモデル名とアイテムモデル名、所持数量、有効期限等を保持します。 型 有効化条件 必須 デフォルト 値の制限 説明 itemSetId string ※ ~ 1024文字 アイテムセット GRN ※ サーバーが自動で設定 name string ✓ UUID ~ 36文字 アイテムセットを識別する名前アイテムセットの一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各アイテムセットを識別するために使用されます。 inventoryName string ✓ ~ 128文字 インベントリモデル名このアイテムセットを含むインベントリモデルの名前です。itemNameと組み合わせて、この所持品がどのインベントリとアイテムの種類に属するかを識別するために使用されます。 itemName string ✓ ~ 128文字 アイテムモデル名このセットに格納されているアイテムの種類を定義するアイテムモデルの名前です。inventoryNameと組み合わせて、このアイテムセットのスタック上限と複数スタック動作を決定します。 count long ✓ 1 ~ 9223372036854775805 所持数量このスタック内のアイテム数です。1からアイテムモデルのスタック上限までの範囲です。アイテムを入手するとスタック上限までカウントが増加し、消費すると減少します。カウントが0になるとアイテムセットは削除され、インベントリ枠が解放されます。 sortValue int ✓ 0 ~ 2147483646 表示順番アイテムモデルのsortValueからコピーされた数値で、インベントリ内のアイテムセットを表示用にソートするために使用されます。値が小さいほど先に表示されます。 expiresAt long 0 有効期限UNIX 時間・ミリ秒 referenceOf List<string> [] 0 ~ 24 items 参照元リストこのアイテムセットに登録された外部参照です。どのシステムがこのアイテムを使用しているか（例：武器として装備、編成に割り当て）を追跡するために使用されます。アイテムセットあたり最大24参照です。 関連するメソッド: consume - プレイヤーのインベントリからアイテムを消費する getItem - インベントリ名とアイテム名を指定してアイテムを取得する getItemWithSignature - 所持証明の署名付きでアイテムを取得する listItems - インベントリ内のプレイヤーが所持するアイテム一覧を取得する EzSimpleItem シンプルアイテム /ja/api_reference/job_queue/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/job_queue/game_engine/ モデル EzJob ジョブ ジョブキューとは直ちに処理を完了せず、処理を遅延実行するための仕組みです。 例えば、キャラクターを入手したときに直ちに実行しなければならない処理としては所持品にキャラクターを格納することです。 一方で、直ちに処理しなければならないわけではない処理として、図鑑に登録する という処理があります。 こういった直ちに処理するまでもない処理をジョブキューを経由して処理するようにすることで、障害に強い設計にすることができます。 なぜなら、図鑑サービスが何らかの障害によって止まっていたとしても、図鑑に登録されない状態でゲームを継続することができます。 ジョブキューに詰まれた処理は失敗しても、障害が解消した後でリトライすることで結果的に正しい状態にできます。 GS2 ではこのような 結果整合 処理を推奨しており、様々な場面でジョブキューを利用した遅延処理が行われます。 型 有効化条件 必須 デフォルト 値の制限 説明 jobId string ※ ~ 1024文字 ジョブ GRN ※ サーバーが自動で設定 scriptId string ✓ ~ 1024文字 スクリプト GRN args string ✓ ~ 5242880文字 引数ジョブの実行時にスクリプトに渡すJSON形式のリクエストパラメータです。アクションタイプや対象リソースなどの具体的な操作内容を含みます。最大5MBです。 currentRetryCount int 0 0 ~ 100 現在のリトライ回数失敗後にこのジョブがリトライされた回数です。リトライ可能なエラーで実行が終了するたびにインクリメントされます。このカウントがmaxTryCountに達すると、ジョブは恒久的な失敗としてマークされます。 maxTryCount int 3 1 ~ 100 最大試行回数初回の試行とリトライを含めて、このジョブを実行できる最大回数です。すべての試行が失敗した場合、ジョブは放棄されます。デフォルトは3、最大100です。 関連するメソッド: run - プレイヤーのジョブキューにある次のジョブを実行する EzJobResult ジョブ実行結果（詳細） 単一のジョブ実行試行の結果を記録します。各試行ごとに個別のJobResultが作成されるため、複数回リトライされたジョブには複数の結果が存在します。statusCodeはジョブが成功したか失敗したかを示します。 型 有効化条件 必須 デフォルト 値の制限 説明 statusCode int ✓ 0 ~ 1000 ステータスコードスクリプト実行から返されたHTTPステータスコードです。2xxコードは成功を示し、その他のコードは失敗を示します。リトライ可能なエラーの場合、maxTryCountに達していなければ自動リトライが行われることがあります。 result string ✓ ~ 5242880文字 レスポンスの内容スクリプト実行から返されたJSON形式のレスポンスボディです。成功時には結果データを、失敗時にはエラーの詳細を含みます。最大5MBです。 関連するメソッド: getResult - 完了したジョブの実行結果を取得する EzJobEntry 登録ジョブ /ja/api_reference/limit/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/limit/game_engine/ モデル EzCounter 回数制限の現在の値 各ユーザーの回数制限モデル配下の特定カウンターの現在の使用回数を追跡します。1つの回数制限モデルの下に複数のカウンターを作成できます（例：1回限りの報酬用にクエストごとに1つのカウンター）。カウント値はカウントアップ操作時に指定される最大値と比較され、回数制限モデルのリセットスケジュールに基づいて自動的にゼロにリセットされます。 型 有効化条件 必須 デフォルト 値の制限 説明 counterId string ※ ~ 1024文字 カウンター GRN ※ サーバーが自動で設定 limitName string ✓ ~ 128文字 回数制限モデル名このカウンターが属する回数制限モデルの名前です。このカウンターの値に適用されるリセットスケジュール（毎日、毎週、毎月など）を決定します。 name string ✓ ~ 128文字 カウンターの名前回数制限モデル内でこのカウンターを一意に識別する名前です。同じ回数制限モデルを異なる名前の複数のカウンターで共有でき、個別の回数制限モデルを作成せずに別々の使用回数追跡（例：クエストごとや商品ごとに1カウンター）が可能です。 count int 0 0 ~ 2147483646 カウント値このカウンターの現在の使用回数です。countUp操作でインクリメントされ、その際に指定された最大値と比較されます。回数制限モデルのリセットタイミングに達すると自動的にゼロにリセットされます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 関連するメソッド: countUp - 回数制限カウンターをカウントアップする getCounter - 特定の回数制限カウンターを取得する listCounters - プレイヤーの回数制限カウンターの一覧を取得する EzLimitModel 回数制限モデル 回数制限モデルには、使用回数をリセットするタイミングを設定できます。 リセット間隔は 「毎日」「毎週」「毎月」「リセットしない」「一定日数」の 5 種類から選択できます。 また、回数制限の最大値はマスターデータ側では固定しません。 /ja/api_reference/lock/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/lock/game_engine/ モデル EzMutex ミューテックス GS2 の提供するミューテックスは再入可能ロックの一種です。 ロックを取得する際にはトランザクションIDを指定し、同一トランザクションIDを指定した場合にのみ再度ロックを取得できます。 参照カウンタを持つため、解放するときには同回数のアンロック処理が必要です。 型 有効化条件 必須 デフォルト 値の制限 説明 mutexId string ※ ~ 1024文字 ミューテックス GRN ※ サーバーが自動で設定 propertyId string ✓ ~ 1024文字 プロパティIDロック対象のリソースを識別するためのIDで、どのリソースに対するロックであるかを決定します。複数の処理が同一リソースへの排他アクセスを必要とする場合、同じプロパティIDを指定する必要があります。 transactionId string ✓ ~ 256文字 トランザクションIDロックを取得するトランザクションの識別子。この ID は再入可能ロックの実現に使用されます。ロック要求が現在のロック保持者と同じトランザクションIDを指定した場合、ロックは再取得に成功し参照カウンタがインクリメントされます。異なるトランザクションIDでのロック要求は、ロックが保持されている間は拒否されます。 ttlAt long 現在時刻から1時間後の絶対時刻 有効期限日時UNIX 時間・ミリ秒 関連するメソッド: get - ミューテックスの状態を取得 lock - ロックを取得 unlock - ロックを解放 メソッド get ミューテックスの状態を取得 Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 propertyId string ✓ ~ 1024文字 プロパティIDロック対象のリソースを識別するためのIDで、どのリソースに対するロックであるかを決定します。複数の処理が同一リソースへの排他アクセスを必要とする場合、同じプロパティIDを指定する必要があります。 gameSession GameSession ✓ GameSession Result 型 説明 item EzMutex ミューテックス 実装例 Game Engine: Unity (UniTask) Unity (Vanilla) Unreal Engine 5 var domain = gs2. /ja/api_reference/log/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/log/game_engine/ モデル EzInGameLog インゲームログ ゲームクライアントまたはサーバーサイドスクリプトから送信されるカスタムログエントリです。GS2 API呼び出しにより自動生成されるアクセスログとは異なり、インゲームログはゲーム開発者がプレイヤーのアクション、ゲーム状態の変化、ビジネスメトリクスなどのゲーム固有のイベントを記録するために明示的に送信します。 型 有効化条件 必須 デフォルト 値の制限 説明 timestamp long ✓ 日時インゲームログが送信された日時です。 userId string ~ 128文字 ユーザーID tags List<EzInGameLogTag> [] 0 ~ 20 items タグフィルタリングと分類のためにログエントリに付与されたキーバリューペアです。タグによりインゲームログの効率的な検索と集計が可能です（例：イベントタイプ、ステージID、アイテムカテゴリ）。 payload string ✓ ~ 10485760文字 ペイロードJSON形式のカスタムログデータです。プレイヤーのアクション、ゲーム状態、ビジネスメトリクスなど、ゲーム固有の任意の情報を含めることができます。最大10MBまで。 関連するメソッド: sendInGameLog - ゲーム内ログを送信します EzInGameLogTag ゲーム内ログのタグ インゲームログエントリのフィルタリングと分類に使用されるキーバリューペアです。各タグキーは1つのログエントリ内で一意でなければなりません。 型 有効化条件 必須 デフォルト 値の制限 説明 key string ✓ ~ 64文字 タグ名このタグのキー名です。インゲームログを検索する際のフィルタ条件として使用されます。 value string ✓ ~ 128文字 タグ値このタグの値です。キーと組み合わせて、特定の条件でのログフィルタリングを可能にします（例：key=“stageId”, value=“stage-001”）。 関連するメソッド: sendInGameLog - ゲーム内ログを送信します 関連するモデル: EzInGameLog - インゲームログ メソッド sendInGameLog ゲーム内ログを送信します /ja/api_reference/login_reward/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/login_reward/game_engine/ モデル EzReceiveStatus 受け取り状態 ユーザーごと・ボーナスモデルごとのログインボーナスの受け取り状態を追跡します。 各エントリがその日の報酬を受け取り済みかどうかを示す真偽値の配列（receivedSteps）を保持します。 また、日次の受け取り資格を判定するために、最後にボーナスを受け取った時刻（lastReceivedAt）を記録します。 receivedSteps はボーナスサイクルの再開時（ストリーミングモードの繰り返し有効時など）にリセットされることがあります。 型 有効化条件 必須 デフォルト 値の制限 説明 bonusModelName string ✓ ~ 128文字 ボーナスモデル名この受け取り状態が紐づくログインボーナスモデルの名前。ユーザーの受け取り進捗を特定のボーナスモデル定義に関連づけ、どの報酬リストと配布ルールが適用されるかを決定します。 receivedSteps List<bool> [] 0 ~ 100 items 受け取りステップ報酬リストの各日に対応する順序付きの真偽値配列。true はユーザーがその日の報酬を受け取り済みであることを示し、false は取り逃がしたか未受け取りであることを示します。配列のインデックスは関連する BonusModel の rewards 配列と対応します。ストリーミングモードで繰り返しが有効な場合、サイクルの再開時にこの配列はリセットされます。 lastReceivedAt long 最終受け取り時刻ユーザーが最後にログインボーナスを受け取った時刻のタイムスタンプ。ボーナスモデルで定義されたリセット時間に基づき、ユーザーが本日のボーナスを既に受け取り済みかどうかを判定するために使用されます。受け取り状態がクリアされた際（繰り返しモードでのサイクル再開時など）に 0 にリセットされます。 関連するメソッド: missedReceive - 取り逃がしたログインボーナスを受け取る receive - 今日のログインボーナスを受け取る getReceiveStatus - 特定のボーナスの受け取り進捗を取得する listReceiveStatuss - 全ボーナスの受け取り進捗を一覧で取得する EzBonusModel ログインボーナスモデル ログインボーナスモデルにはログインボーナスの配布スケジュールを設定します。 配布スケジュールには《スケジュールモード》と《ストリーミングモード》があります。 スケジュールモードでは、GS2-Schedule のイベントの指定が必須で、そのイベントの開始日からの経過日数でボーナスの配布を行います。 途中で撮り逃しが発生した場合、その分のボーナスは配布されません。 ストリーミングモードでは、毎日ボーナスに設定された報酬を先頭から順番に配布します。 ストリーミングモードでは繰り返しの設定が可能です。その場合、ストリームの終端に達した場合、先頭から再度配布を行います。 スケジュールモード・ストリーミングモード 共に、取り逃がしの救済機能があります。 一定のコストを支払うことで、取り逃がしたボーナスを受け取ることができます。 ただし、GS2-Schedule のイベントが関連づけられている場合、イベントの開始日からの経過日数より先のボーナスは受け取ることができません。 取り逃がし機能はストリーミングモードかつ繰り返しが有効な場合は使用することができません。 スケジュールモード・ストリーミングモード 共に、設定可能なボーナスの最大日数は100日です。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 ログインボーナスモデル名ログインボーナスモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) . /ja/api_reference/lottery/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/lottery/game_engine/ モデル EzProbability 排出確率 特定の景品の算出された排出確率を表します。確率は排出確率テーブル内の全景品の重みの合計に対するこの景品の重みから計算されます。ボックスガチャの場合、景品がボックスから排出されるにつれて確率は動的に変化します。 型 有効化条件 必須 デフォルト 値の制限 説明 prize EzDrawnPrize ✓ 景品この確率が対応する景品で、IDと入手アクションを含みます。 rate float ✓ 0 ~ 1.0 排出確率 (0.0〜1.0)この景品が排出される確率で、0.0から1.0の値で表されます。この景品の重みをテーブル内の全景品の重みの合計で割って算出されます。 関連するメソッド: listProbabilities - ガチャの現在の排出確率を取得する EzDrawnPrize 排出された景品 抽選で排出された景品を表します。景品IDとユーザーに景品を付与するために実行された入手アクションを含みます。 型 有効化条件 必須 デフォルト 値の制限 説明 prizeId string ✓ ~ 36文字 景品ID排出された景品のIDで、排出確率テーブル内の景品エントリに対応します。 acquireActions List<EzAcquireAction> 0 ~ 100 items 入手アクションのリストこの景品をユーザーに付与するために実行された入手アクションのリストです。 関連するモデル: EzProbability - 排出確率 EzBoxItems ボックスアイテムリスト 特定のユーザーと排出確率テーブルに対するボックスガチャの状態を記録します。ボックス内のすべての景品とその残数・初期数量のリストを含み、どの景品が排出済みでどの景品が残っているかをユーザーが確認できます。 型 有効化条件 必須 デフォルト 値の制限 説明 boxId string ※ ~ 1024文字 ボックス GRN ※ サーバーが自動で設定 prizeTableName string ✓ ~ 128文字 排出確率テーブル名このボックスに関連付けられた排出確率テーブルの名前です。このレコードがどのボックスガチャに属するかを識別します。 items List<EzBoxItem> [] 0 ~ 1000 items アイテムリストボックス内のすべての景品とその残数・初期数量のリストです。各アイテムはその景品が最初にボックスに何個あったか、何個残っているかを示し、ボックスガチャの抽選進行状況の追跡を可能にします。 関連するメソッド: describeBoxes - プレイヤーが引いたすべてのボックスガチャの状態を取得する getBox - 特定のボックスガチャの状態を取得する resetBox - ボックスガチャを初期状態にリセットする EzLotteryModel 抽選モデル /ja/api_reference/matchmaking/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/matchmaking/game_engine/ モデル EzGathering ギャザリング マッチメイキングによって集められたゲームプレイヤーグループを表すエンティティです。 マッチメイキング用のパラメータを複数持っており、パラメータを総合的に判断してプレイヤーをグルーピングします。 プレイヤーは自身のロール・属性値・拒否リスト（一緒にプレイしたくないユーザー）を指定してギャザリングに参加します。 参加時には属性値の範囲条件、ロールの定員、ホワイトリスト制限（allowUserIds）が検証されます。 すべてのロール枠が定員に達するとギャザリングは完成状態となり、マッチメイキングが完了します。 ギャザリング名は UUID 形式で自動生成され、有効期限を設定して自動クリーンアップすることも可能です。 型 有効化条件 必須 デフォルト 値の制限 説明 gatheringId string ※ ~ 1024文字 ギャザリング GRN ※ サーバーが自動で設定 name string ✓ UUID ~ 128文字 ギャザリング名ギャザリングの一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、ギャザリングを識別するために使用されます。 attributeRanges List<EzAttributeRange> [] 0 ~ 5 items 募集条件このギャザリングに参加するためにプレイヤーが満たすべき属性範囲条件のリスト。各エントリは属性名と許容される最小値・最大値の範囲を指定します。プレイヤー自身の属性値がこの範囲内でなければ参加できません。最大5件。 capacityOfRoles List<EzCapacityOfRole> [] 1 ~ 5 items 募集枠リストこのギャザリングの募集枠を定義します。各エントリはロール名、その別名、およびそのロールに参加可能な最大人数を指定します。すべてのロール枠が定員に達するとマッチメイキングが完了となります。最小1件、最大5件。 allowUserIds List<string> [] 0 ~ 100 items 参加許可ユーザーIDリストこのギャザリングへの参加を許可されたユーザーIDのホワイトリスト。指定した場合、リストに含まれるユーザーのみがこのギャザリングのマッチメイキングに参加できます。フレンド限定マッチメイキングや招待制マッチメイキングに利用します。最大100件。 metadata string ~ 1024文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 expiresAt long ギャザリングの有効期限このギャザリングが自動的に期限切れとなり削除される時刻。この時刻までにマッチメイキングが完了しない場合、ギャザリングはクリーンアップされます。未指定の場合、マッチメイキングが完了するか手動で削除されるまでギャザリングは維持されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 関連するメソッド: cancelMatchmaking - マッチメイキングをキャンセルしてギャザリングから離脱する createGathering - マッチメイキング用の部屋（ギャザリング）を新規作成する doMatchmaking - 参加可能なギャザリングを探して参加する earlyCompleteMatchmaking - 定員に達していない状態でマッチメイキングを早期完了する getGathering - ギャザリングの現在の状態を取得する ping - マッチメイキング待機中のキープアライブを送信する updateGathering - ギャザリングの募集条件を変更する EzRating レーティング /ja/api_reference/mega_field/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/mega_field/game_engine/ モデル EzSpatial 空間情報 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID areaModelName string ✓ ~ 128文字 エリア名 layerModelName string ✓ ~ 128文字 レイヤー名 position EzPosition ✓ 座標 vector EzVector ✓ 向き 関連するメソッド: update - 座標を送信 EzAreaModel エリアは空間を分割するもので、同じ座標でもエリアが異なれば別空間として扱うことができます。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 エリアモデル名 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 layerModels List<EzLayerModel> [] 0 ~ 1000 items レイヤーモデル一覧 関連するメソッド: describeAreaModels - エリアモデル一覧を取得 getAreaModel - エリアモデルを取得 EzLayerModel レイヤーは1つの空間内で複数の論理階層を実現します。 /ja/api_reference/mission/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/mission/game_engine/ モデル EzComplete ミッションの達成状況 特定のミッショングループに対するユーザーのミッション達成状況と報酬受け取り状況を追跡します。達成済みタスク名と報酬受け取り済みタスク名を別々のリストで管理し、達成されたタスクと実際に報酬が受け取られたタスクを区別します。 型 有効化条件 必須 デフォルト 値の制限 説明 missionGroupName string ✓ ~ 128文字 ミッショングループ名この達成状況レコードが属するミッショングループの名前です。ユーザーごと・ミッショングループごとに1つの達成状況レコードが存在します。 completedMissionTaskNames List<string> [] 0 ~ 1000 items 達成済みのタスク名リストユーザーが達成した（達成条件を満たした）ミッションタスクの名前です。カウンターが目標値に達するか検証アクションが成功した時点でこのリストに追加されます。報酬の受け取りの有無は問いません。 receivedMissionTaskNames List<string> [] 0 ~ 1000 items 報酬の受け取り済みのタスク名リストユーザーが達成報酬を受け取り済みのミッションタスクの名前です。報酬を受け取るには、タスクが達成済みリストに含まれている必要があります。 関連するメソッド: evaluateComplete - ミッション達成状況を再評価する getComplete - 特定ミッショングループのプレイヤーの達成状況を取得する listCompletes - 全グループのプレイヤーのミッション達成状況を取得する EzCounter カウンター カウンターはミッションの進行状況をゲームプレイヤー毎に保持するエンティティです。 カウンターの値は関連付けられたタスクの期間ごとに集計されます。 そのため、1つのカウンターは複数の値を持ちます。 例えば、クエストのクリア回数カウンターであれば、今月のクリア回数、今週のクリア回数、今日のクリア回数、といった具合です。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 カウンターモデル名このカウンターインスタンスの基となるカウンターモデルの名前です。スコープやリセットタイミングを定義するカウンターモデル定義にリンクします。 values List<EzScopedValue> [] 0 ~ 32 items 値このカウンターのスコープ別の値のリストです。各エントリは特定のスコープ（リセットタイミングまたは検証アクション条件）のカウンター値と次回リセット時刻を保持します。1つのカウンターが複数のスコープの値を同時に保持します。 関連するメソッド: deleteCounter - カウンターを完全に削除する getCounter - 特定カウンターのプレイヤーの値を取得する listCounters - プレイヤーの現在のカウンター値を取得する resetCounter - カウンターの特定スコープをリセットする EzCounterScopeModel カウンターリセットタイミングモデル /ja/api_reference/money/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/money/game_engine/ モデル EzWallet ウォレット ウォレット内の通貨は大きく有償で購入した通貨と、無償で入手した通貨が分けて管理されます。 有償で購入した通貨は更に購入時の単価毎に管理され、サービス終了になってしまった際の返金や資金決済法に該当するだけの残高が存在するかが集計できます。 ウォレットにはスロットがあり、スロットごとに異なる残高を管理できます。 プラットフォームをまたいで残高を共有できない場合にはプラットフォーム毎に異なるスロットを利用することで分けて管理することができます。 その際に無償で入手した通貨は全てのプラットフォームで共通した値を利用することもできます。 型 有効化条件 必須 デフォルト 値の制限 説明 slot int ✓ 0 ~ 100000000 スロット番号プラットフォームやコンテキストごとにウォレット残高を分離するための識別子。異なるスロットにより、別々の有償通貨プールを管理できます（例: iOS購入はスロット0、Androidはスロット1）。無償通貨はネームスペースの shareFree 設定により、全スロット間で共有することもできます。 paid int 0 0 ~ 2147483646 有償通貨所持量このウォレットスロット内の有償（購入済み）通貨の合計量。単価が0でないすべての WalletDetail エントリの合計です。ストア購入による入金で増加し、消費優先度に従った出金で減少します。 free int 0 0 ~ 2147483646 無償通貨所持量このウォレットスロット内の無償（付与された）通貨の合計量。単価が0の WalletDetail エントリに対応します。ネームスペースで shareFree が有効な場合、この値はスロット0から全ウォレットスロットに同期されます。 shareFree bool false 無償通貨の共有このウォレットの無償通貨が全スロット間で共有されるかどうか。この値はウォレット作成時にネームスペース設定から継承されます。true の場合、無償通貨がスロット0から他のすべてのウォレットスロットに同期されます。 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 関連するメソッド: get - プレイヤーの課金通貨ウォレットの残高を取得する withdraw - プレイヤーのウォレットから課金通貨を消費する メソッド get プレイヤーの課金通貨ウォレットの残高を取得する 指定したスロットのプレイヤーのウォレットを取得し、有償通貨と無償通貨それぞれの現在の残高を確認できます。 「有償」通貨はプレイヤーがリアルマネーで購入したもの（例: 100ジェムを¥120で購入）、「無償」通貨はゲームプレイで獲得したもの（例: イベント報酬、ログインボーナス）です。 /ja/api_reference/money2/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/money2/game_engine/ モデル EzWallet ウォレット ウォレット内の通貨は大きく有償で購入した通貨と、無償で入手した通貨が分けて管理されます。 有償で購入した通貨は更に購入時の単価毎に管理され、サービス終了になってしまった際の返金や資金決済法に該当するだけの残高が存在するかが集計できます。 ウォレットにはスロットがあり、スロットごとに異なる残高を管理できます。 プラットフォームをまたいで残高を共有できない場合にはプラットフォーム毎に異なるスロットを利用することで分けて管理することができます。 その際に無償で入手した通貨は全てのプラットフォームで共通した値を利用することもできます。 型 有効化条件 必須 デフォルト 値の制限 説明 slot int ✓ 0 ~ 100000000 スロット番号ウォレットスロットを識別します。プラットフォーム間の残高共有が許可されていない場合、異なるスロットを使用してプラットフォームごとに通貨を分けて管理できます（例：iOS用とAndroid用）。 summary EzWalletSummary ✓ ウォレットの状態ウォレットの現在の残高サマリーで、有償通貨、無償通貨、合計額に分けて表示されます。入金トランザクションから算出されます。 sharedFreeCurrency bool ✓ 無償通貨を共有するかこのウォレットの無償通貨がすべてのスロット間で共有されるかどうかを示します。ウォレット作成時にネームスペースの設定から継承されます。 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 関連するメソッド: get - プレイヤーの課金通貨ウォレットの残高を取得する list - プレイヤーの課金通貨ウォレット一覧を取得する withdraw - プレイヤーのウォレットから課金通貨を消費する EzSubscribeTransaction サブスクリプションの購入情報 ストアプラットフォームからのサブスクリプション購入レコードを表します。有効、トライアル、初回割引、猶予期間、解約、期限切れ、取り消しなどのライフサイクルを通じた詳細なサブスクリプションステータスを追跡します。各トランザクションは特定のストアプラットフォームとユーザーに紐づけられます。 型 有効化条件 必須 デフォルト 値の制限 説明 contentName string ✓ ~ 128文字 ストア定期課金コンテンツモデル名 store 文字列列挙型 enum { “AppleAppStore”, “GooglePlay”, “fake” } ✓ ストア購入が行われたストアプラットフォームです。レシート検証に使用される検証方法を決定します。定義説明“AppleAppStore”Apple App Store“GooglePlay”Google Play“fake”Fake transactionId string ✓ ~ 1024文字 トランザクションIDストアプラットフォームによって割り当てられた一意のトランザクション識別子です。同一購入の重複処理を防止するために使用されます。 statusDetail 文字列列挙型 /ja/api_reference/news/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/news/game_engine/ モデル EzNews お知らせ記事 Hugo サイトデータから生成された個々のニュース記事を表します。 各記事はセクションとコンテンツパスに属し、タイトル、タイムスタンプ、Front Matter メタデータを持ちます。 GS2-Schedule のイベントとリンクして表示期間を制御することもできます。 Front Matter には JSON 形式の追加メタデータが含まれ、表示順序を制御するためのオプションの weight フィールドも含まれます。 型 有効化条件 必須 デフォルト 値の制限 説明 section string ✓ ~ 1024文字 セクション名この記事が属するセクション（カテゴリ）。Hugo のコンテンツディレクトリ構造に対応します。記事を表示用の論理グループに整理するために使用されます。 content string ✓ ~ 1024文字 コンテンツセクション内でのこの記事のコンテンツパス識別子。セクションと合わせて、Hugo コンテンツ構造内の記事の位置を一意に識別します。 title string ✓ ~ 1024文字 記事見出しニュース記事のタイトル。通常、Hugo の Front Matter で定義されます。プレイヤーへの記事一覧表示時に見出しとして表示されます。 scheduleEventId string ~ 1024文字 GS2-Schedule イベント GRN timestamp long ✓ タイムスタンプUNIX 時間・ミリ秒 frontMatter string ✓ ~ 1024文字 Front MatterJSON 形式の記事に関連付けられたメタデータ。元は Hugo マークダウンの Front Matter で定義されます。weight（表示順序の制御用）、タグ、カテゴリ、その他のカスタムプロパティなどの任意のフィールドを含むことができます。 関連するメソッド: listNewses - お知らせ記事の一覧を取得する EzSetCookieRequestEntry Cookie 設定リクエストエントリ /ja/api_reference/quest/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/quest/game_engine/ モデル EzProgress クエスト進行状況 クエストの開始時に作成され、終了時に削除されます。 インゲームの途中でアプリを終了した際にはこのデータが残った状態となり エンティティが保持する進行中のクエスト情報からゲームをリジュームすることが可能です。 型 有効化条件 必須 デフォルト 値の制限 説明 progressId string ※ ~ 1024文字 クエスト進行状況 GRN ※ サーバーが自動で設定 transactionId string ✓ UUID ~ 36文字 トランザクションIDクエストトランザクションの一意の識別子です。クエスト進行状況と報酬配布を管理するトランザクションを紐付けるために使用されます。 questModelId string ✓ ~ 1024文字 クエストモデル GRN 現在進行中のクエストモデルのGRNです。ユーザーがプレイ中のクエストを識別し、クエスト途中でアプリを終了した場合のゲームリジュームを可能にします。 randomSeed long ✓ 0 ~ 9223372036854775805 乱数シードクエスト開始時に割り当てられる乱数シードです。このクエスト試行で選択されるコンテンツバリエーション（報酬セット）の決定に使用され、再現可能な結果を保証します。 metadata string ~ 256文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 rewards List<EzReward> [] 0 ~ 1000 items クリア報酬リストクエストクリア時に付与される報酬のリストです。乱数シードで選択されたコンテンツバリエーションに基づき、クエスト開始時に決定されます。 failedRewards List<EzReward> [] 0 ~ 1000 items 失敗時報酬リストクエスト失敗時に付与される報酬のリストです。クエスト開始時に決定され、失敗時の慰労報酬やコストの一部返還として提供されます。 関連するメソッド: deleteProgress - プレイヤーの現在のクエストをキャンセルする end - クエストの完了または失敗を報告する getProgress - プレイヤーの現在のクエスト進行状況を取得する EzCompletedQuestList クリア済みクエストリスト /ja/api_reference/ranking/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ranking/game_engine/ モデル EzScore スコア ゲームプレイヤーごと・カテゴリーごとに登録されたスコアを保持するエンティティです。 各スコアエントリはユニークIDで識別され、カテゴリーとスコア登録ユーザーに関連付けられます。 合算モードでは、新しいスコアは個別のエントリを作成するのではなく、AddScore 操作で既存の合計に加算されます。 カテゴリーの最小値・最大値の範囲外のスコアは登録時に拒否されます。 型 有効化条件 必須 デフォルト 値の制限 説明 categoryName string ✓ ~ 128文字 カテゴリー名 userId string ✓ ~ 128文字 ユーザーID uniqueId string ✓ UUID ~ 36文字 ユニークIDこのスコアエントリを一意に識別する UUID。作成時に自動生成されます。uniqueByUserId が無効の場合、同一ユーザーの同一カテゴリー内の複数スコアエントリを区別するために使用されます。 scorerUserId string ✓ ~ 128文字 ユーザーID score long ✓ 0 ~ 9223372036854775805 スコアプレイヤーが登録したスコア値。カテゴリーに設定された最小値・最大値の範囲内である必要があります。合算モードでは、AddScore 操作でこの値をインクリメントできます。 metadata string ~ 512文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 関連するメソッド: putScore - ランキングにスコアを登録する getScore - プレイヤーが登録した特定のスコアを取得する listScores - 特定プレイヤーが登録したスコアの一覧を取得する EzRanking ランキング ランキングリーダーボードの1エントリを表し、ユーザーの順位、スコア、および関連メタデータを含みます。 グローバルランキング（全プレイヤーが共有ボードでバッチ集計により競争）とスコープランキング（購読したプレイヤーに基づくユーザーごとのボードでリアルタイム反映）の2種類があります。 /ja/api_reference/ranking2/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ranking2/game_engine/ モデル EzGlobalRankingData グローバルランキング 特定シーズンのグローバルランキングにおけるランキングエントリを表します。ユーザーのスコア、0始まりのインデックス（ソート位置）、1始まりの順位（同点を考慮）を含みます。順位はインデックス + 1 で計算されます。 型 有効化条件 必須 デフォルト 値の制限 説明 rankingName string ✓ ~ 128文字 グローバルランキングモデル名グローバルランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 season long ✓ 0 ~ 9223372036854775805 シーズンGS2-Schedule イベントの繰り返し回数に対応するシーズン番号です。新しいランキング期間ごとに増加します。 userId string ✓ ~ 128文字 ユーザーID index int 0 ~ 2147483646 インデックスランキング内のこのエントリの0始まりの一意のソート位置です。順位とは異なり、スコアが同点でもインデックスは常に一意です。インデックスベースの報酬計算に使用されます。 rank int 0 ~ 2147483646 順位1始まりのランキング順位です。同スコアのプレイヤーは同じ順位を共有します。インデックス + 1 で計算されます。順位ベースの報酬計算に使用されます。 score long ✓ 0 ~ 9223372036854775805 スコア metadata string ~ 512文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 関連するメソッド: getGlobalRankingRank - グローバルランキングでのプレイヤー自身の順位を取得する listGlobalRankings - グローバルランキングのリーダーボードを取得する EzGlobalRankingReceivedReward グローバルランキング報酬受け取り履歴 /ja/api_reference/realtime/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/realtime/game_engine/ モデル EzRoom ルーム マルチプレイヤー対戦でリアルタイム通信を処理するための専用ゲームサーバーインスタンスを表します。 ルーム作成は非同期で行われ、リクエスト後にシステムがサーバーをプロビジョニングし、インスタンスの準備ができるとIPアドレス、ポート、暗号鍵が割り当てられます。 クライアントは接続を試みる前に作成完了通知を待つか、ポーリングする必要があります。 暗号鍵はゲームクライアントとリレーサーバー間のセキュアな通信チャネルを確立するために使用されます。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 ルーム名ルーム固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 ipAddress string ~ 128文字 IPアドレスプロビジョニングされたゲームサーバーのIPアドレス。ルームのサーバーインスタンスの準備ができた後、システムにより自動的に割り当てられます。ルーム作成直後には利用できません。最大128文字。 port int 0 ~ 65535 待受ポートプロビジョニングされたゲームサーバーの待受ポート番号。サーバーインスタンスの準備ができた後、IPアドレスと共に自動的に割り当てられます。範囲: 0～65535。 encryptionKey string ~ 256文字 暗号鍵ゲームクライアントとリレーサーバー間の通信を暗号化するためのキー。サーバーインスタンスの準備ができた後、IPアドレスおよびポートと共に自動的に割り当てられます。クライアントはリレーサーバーを介して送受信するメッセージの暗号化・復号化にこのキーを使用する必要があります。最大256文字。 関連するメソッド: getRoom - リアルタイムゲームルームの接続情報を取得する メソッド now 現在のサーバー時刻を取得する GS2サーバーの現在時刻をUnixタイムスタンプ（ミリ秒）で返します。 ゲームクライアントの時計をサーバーと同期するために使います。たとえばカウントダウンタイマー、イベントの開始・終了時刻、クールダウン期間を正確に表示する際に便利です。 クライアント端末の時計は不正確だったり操作されたりする可能性があるため、サーバー時刻を使うことですべてのプレイヤーに一貫したタイミングを表示できます。 主な使い方: ゲーム起動時にクライアントとサーバーの時刻差を計算し、セッション中ずっとその差分を適用する 期間限定イベントやランキング期間の正確な「残り時間」を表示する タイミングに敏感なアクションをサーバーに送信する前にクライアント側で検証する Request 型 有効化条件 必須 デフォルト 値の制限 説明 Result 型 説明 timestamp long 現在時刻UNIX 時間・ミリ秒 実装例 Game Engine: Unity (UniTask) Unity (Vanilla) Unreal Engine 5 var domain = gs2. /ja/api_reference/schedule/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/schedule/game_engine/ モデル EzTrigger トリガー 相対イベントスケジューリングの起点を定義し、プレイヤーごとのイベント期間を実現します。 プレイヤーに対してトリガーが発動されると、発動時刻（triggeredAt）と有効期限（expiresAt）が記録されます。 “relative” スケジュールタイプで設定されたイベントはトリガーを名前で参照し、そのプレイヤーのイベント期間はトリガーの発動時刻から有効期限まで続きます。 トリガーは更新可能（createdAt をリセットし expiresAt を更新）で、有効期限後は TTL により自動的にクリーンアップされます。 型 有効化条件 必須 デフォルト 値の制限 説明 triggerId string ※ ~ 1024文字 トリガー GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 トリガー名トリガー固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 expiresAt long ✓ 有効期限このトリガーが期限切れとなり、相対イベント期間が終了するタイムスタンプ。この時刻以降、トリガーは期限切れと見なされ（IsExpire が true を返す）、このプレイヤーに対する関連する相対イベントは無効になります。トリガーデータは有効期限後に DynamoDB TTL により自動的にクリーンアップされます。UNIX 時間（ミリ秒）で表現されます。 関連するメソッド: getTrigger - 特定のトリガーの状態を取得する listTriggers - プレイヤーの有効なトリガー一覧を取得する EzEvent イベント イベントの期間は絶対期間と相対期間の2種類存在します。 絶対期間は 例えば YYYY年MM月DD日 00:00(UTC) ～ YYYY年MM月DD日 23:59(UTC) のような固定の期間で、 /ja/api_reference/season_rating/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/season_rating/game_engine/ モデル EzBallot 投票用紙 特定のマッチセッションに対して各プレイヤーに発行される投票チケットです。 対戦コンテキスト（シーズン、セッション、参加人数）とプレイヤーのユーザーIDを含みます。 投票用紙はサーバーによって署名されプレイヤーに返却され、プレイヤーはゲーム結果を記入して WrittenBallot として再提出します。 投票集計時、全参加者の投票用紙が多数決で比較され、結果の改ざんを防止します。 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID seasonName string ✓ ~ 128文字 シーズン名この対戦のレーティング計算に使用するシーズンモデルの名前。この対戦に適用されるティアー構造とポイント変動ルールを定義する SeasonModel を参照します。 sessionName string ✓ ~ 128文字 セッション名この投票用紙が属するマッチセッションの名前。同一セッション内の全投票用紙は投票プロセスにおいて集約されます。 numberOfPlayer int ✓ 2 ~ 10 参加人数この対戦の総参加者数。投票の完了判定に使用されます。結果確定には全投票用紙の収集（または多数決の成立）が必要です。有効範囲: 2〜10。 関連するメソッド: createVote - 対戦結果報告用の署名付き投票用紙を作成する vote - 自分の投票用紙を送信して対戦結果を投票する（個別投票） voteMultiple - 全員の投票用紙を集めて対戦結果をまとめて送信する（即時結果反映） EzSeasonModel シーズンモデル シーズン期間中に適用されるティアー構造とポイント変動ルールを定義するマスターデータです。 各ティアーごとのポイント変動範囲・参加料・ランクアップボーナスを設定し、ポイント管理に使用する Experience モデルを指定します。 実際のポイントおよびティアーのユーザーデータは GS2-Experience によって管理されます。 型 有効化条件 必須 デフォルト 値の制限 説明 seasonModelId string ※ ~ 1024文字 シーズンモデル GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 シーズンモデル名シーズンモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) . /ja/api_reference/serial_key/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/serial_key/game_engine/ モデル EzSerialKey シリアルコード 発行されたシリアルコードは1度のみ使用可能です。 シリアルコードは「RPCLP-FP7N-NCDMJ-FLVA-IRI4」のような形式で発行され、データ長を変更することはできません。 シリアルコード内にはキャンペーンの種類の情報も含まれており、シリアルコードを使用する際にはネームスペースを指定するだけで使用できます。 型 有効化条件 必須 デフォルト 値の制限 説明 campaignModelName string ✓ ~ 128文字 キャンペーン名このシリアルコードが属するキャンペーンモデルの名前です。キャンペーン情報はシリアルコード自体に埋め込まれているため、コード使用時にはネームスペースを指定するだけで利用できます。 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 code string ✓ ~ 48文字 シリアルコード「XXXXX-XXXX-XXXXX-XXXX-XXXX」形式のシリアルコード文字列です。各コードは一意で、キャンペーン識別情報が含まれています。コードの形式とデータ長は固定で変更できません。 status 文字列列挙型 enum { “ACTIVE”, “USED”, “INACTIVE” } “ACTIVE” ステータスこのシリアルコードの現在の使用状態です。ユーザーが消費すると ACTIVE から USED に遷移します。二重使用を防ぐため楽観的ロックで保護されています。INACTIVE のコードは使用できません。定義説明“ACTIVE”利用可能“USED”使用済み“INACTIVE”無効（利用不可） 関連するメソッド: get - シリアルコードの状態を確認する useSerialCode - シリアルコードを引き換える EzCampaignModel キャンペーンモデル キャンペーンモデルはキャンペーンを定義し、シリアルコードと紐づけて管理するために使用されます。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 キャンペーンモデル名 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 enableCampaignCode bool false キャンペーンコードによる引き換えを許可するか有効にすると、個別のシリアルコードではなく共通のキャンペーンコード（キャンペーン名）を使って報酬を引き換えられるようになります。これにより、1つのコードを複数のユーザーが使用できます。 関連するメソッド: getCampaignModel - 特定のシリアルコードキャンペーンの詳細を取得する get - シリアルコードの状態を確認する useSerialCode - シリアルコードを引き換える メソッド getCampaignModel 特定のシリアルコードキャンペーンの詳細を取得する /ja/api_reference/showcase/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/showcase/game_engine/ モデル EzShowcase 陳列棚 陳列棚には陳列する商品を定義できます。 また、陳列棚の商品の販売期間を設定することができます。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 陳列棚名陳列棚固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 displayItems List<EzDisplayItem> [] 1 ~ 1000 items 陳列する商品リストこの陳列棚に陳列される商品のリストです。各陳列商品は単一の商品または商品グループのいずれかです。販売期間イベントが終了または無効な商品は、陳列棚の取得時に自動的にフィルタリングされます。 salesPeriodEventId string ~ 1024文字 陳列棚の販売期間を設定した GS2-Schedule のイベント GRN この陳列棚全体の販売期間を制御します。指定した場合、関連する GS2-Schedule のイベント期間中のみ陳列棚が利用可能になります。イベントが有効でない場合、陳列棚は空で返されます。 関連するメソッド: getShowcase - ショップの陳列棚と商品を取得する EzDisplayItem 陳列する商品 陳列棚に表示される商品です。単一の商品または商品グループのいずれかを参照できます。各陳列商品には、陳列棚全体の販売期間とは独立して GS2-Schedule イベントによる個別の販売期間を設定できます。 型 有効化条件 必須 デフォルト 値の制限 説明 displayItemId string ✓ UUID ~ 128文字 陳列商品ID陳列商品の一意な名前を保持します。省略するとシステムによって UUID（Universally Unique Identifier）フォーマットで自動的に割り当てられます。 type 文字列列挙型 /ja/api_reference/skill_tree/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/skill_tree/game_engine/ モデル EzStatus スキルツリーの解放状況 特定のプレイヤーとプロパティに対するスキルツリーの解放状態を追跡するモデルです。 解放済み（アンロック済み）のノード名のリストを管理します。ノードは解放（リストに追加）、拘束（リストから削除）、リセット（全クリア）が可能です。 既に解放済みのノードを解放しようとしたり、未解放のノードを拘束しようとするとエラーになります。 ユーザーが初めてアクセスした際に自動作成されます。 型 有効化条件 必須 デフォルト 値の制限 説明 statusId string ※ ~ 1024文字 ステータス GRN ※ サーバーが自動で設定 userId string ✓ ~ 128文字 ユーザーID releasedNodeNames List<string> [] 0 ~ 1000 items 解放済みノードモデル名リストこのスキルツリーでプレイヤーがアンロックしたノードモデル名のリスト。解放（追加）、拘束（削除）、リセット（全クリア）操作により更新されます。最大1000エントリ。 関連するメソッド: getStatus - プレイヤーのスキルツリーの進行状況を取得する release - スキルツリーのノードを解放する reset - スキルツリー全体をリセットする（フルリスペック） restrain - 特定のノードをロック状態に戻す EzNodeModel ノードモデル スキルツリー内のノードを定義するモデルで、解放コスト・前提条件・返却動作を含みます。 各ノードには検証アクション（解放前の条件チェック）、消費アクション（支払うコスト）、先に解放が必要な前提ノードを設定できます。 ノードを拘束（未解放状態に戻す）すると、消費したリソースが返却率に基づいて部分的に返却されます。 返却入手アクションは消費アクションに返却率を乗じて自動的に計算されます。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 ノードモデル名ノードモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 releaseVerifyActions List<EzVerifyAction> [] 0 ~ 10 items 解放検証アクションリストこのノードを解放する前に実行され、条件が満たされているかを確認する検証アクションのリスト。例えば、プレイヤーが特定のレベルに達しているか、特定のアイテムを所持しているかを検証できます。いずれかの検証アクションが失敗すると、ノード解放は拒否されます。最大10アクション。 releaseConsumeActions List<EzConsumeAction> [] 1 ~ 10 items 解放消費アクションリストこのノードを解放する際に実行される消費アクションのリストで、解放コストを表します。これらのアクションは返却入手アクションの計算にも使用されます。ノードを拘束する際、各消費アクションが返却率に基づいて逆転されます。最低1つの消費アクションが必要です。最大10アクション。 returnAcquireActions List<EzAcquireAction> 0 ~ 10 items 返却入手アクションリストこのノードを拘束（取り消し）する際に実行される入手アクションのリストで、プレイヤーに返却されるリソースを表します。このフィールドは解放消費アクションに返却率を乗じて自動生成されます。例えば、解放コストが100ゴールドで返却率が0. /ja/api_reference/stamina/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/stamina/game_engine/ モデル EzStamina スタミナ スタミナとは現実時間の時間経過で回復するポイントです。 一般的にこのスタミナを消費してゲームをプレイできるようにすることで、プレイヤーの1日のプレイ回数を制限し、ゲームの進行速度をゲーム提供側がコントロールする目的で使用されます。 型 有効化条件 必須 デフォルト 値の制限 説明 staminaName string ✓ ~ 128文字 スタミナモデル名このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 value int ✓ 0 ~ 2147483646 スタミナ値オーバーフロー分を除く、このユーザーの現在のスタミナ量。回復間隔と回復量に基づいて時間経過で自動的に増加し、maxValue まで回復します。lastRecoveredAt からの経過時間を用いて recoverSteps = elapsedMinutes / recoverIntervalMinutes の式で計算されます。 overflowValue int ✓ 0 ~ 2147483646 オーバーフロー値通常の最大値（maxValue）を超えて格納されているスタミナ量。StaminaModel の isOverflow が有効な場合のみ使用されます。実効スタミナの合計は value + overflowValue で、maxCapacity が上限です。スタミナ消費時はオーバーフロー分が先に消費されます。 maxValue int ✓ 1 ~ 2147483646 スタミナの最大値StaminaModel から解決され、オプションでプレイヤーの GS2-Experience ランクに基づく MaxStaminaTable でオーバーライドされるユーザーごとのスタミナ最大値。オーバーフロー無効時は initialCapacity が下限となります。オーバーフロー有効時は maxCapacity が上限となります。自然回復はこの値で停止します。 recoverIntervalMinutes int 1 ~ 2147483646 スタミナの回復間隔（分）StaminaModel から解決され、オプションでプレイヤーの GS2-Experience ランクに基づく RecoverIntervalTable でオーバーライドされるユーザーごとの回復間隔（分）。テーブルが設定されていない場合、モデルのデフォルト recoverIntervalMinutes にフォールバックします。 recoverValue int 1 ~ 2147483646 スタミナの回復量StaminaModel から解決され、オプションでプレイヤーの GS2-Experience ランクに基づく RecoverValueTable でオーバーライドされるユーザーごとのティックあたりの回復量。テーブルが設定されていない場合、モデルのデフォルト recoverValue にフォールバックします。 nextRecoverAt long 次回回復時刻次のスタミナ回復ティックが発生する Unix タイムスタンプ（ミリ秒）。lastRecoveredAt + recoverIntervalMinutes（ミリ秒換算）で計算されます。スタミナが既に maxValue の場合、このフィールドは未設定になることがあります。 関連するメソッド: apply - スタミナの時間経過による自然回復を適用する consume - スタミナを使用（消費）する getStamina - 特定の種別のプレイヤーの現在スタミナを取得する listStaminas - プレイヤーのスタミナ値一覧を取得する setMaxValue - プレイヤーレベルに基づいてスタミナ上限を更新する setRecoverInterval - プレイヤーレベルに基づいてスタミナ回復間隔を更新する setRecoverValue - プレイヤーレベルに基づいてスタミナ回復量を更新する EzStaminaModel スタミナモデル /ja/api_reference/state_machine/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/state_machine/game_engine/ モデル EzStatus ステートマシンの状態 特定のユーザーに対するステートマシンの実行インスタンスを表します。変数、サブステートマシン用のコールスタック、遷移回数、乱数状態を含む現在の実行状態を追跡します。ステータスは Running、Wait、Pass（成功）、Error の状態を遷移します。 型 有効化条件 必須 デフォルト 値の制限 説明 statusId string ※ ~ 1024文字 ステートマシンの状態 GRN ※ サーバーが自動で設定 name string ✓ UUID ~ 36文字 ステータス名ステートマシンの状態の一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各ステートマシンの状態を識別するために使用されます。 enableSpeculativeExecution 文字列列挙型 enum { “enable”, “disable” } “disable” 投機的実行を有効にするか有効にすると、ステートマシン定義と乱数状態がこの Status エンティティに含まれます。これによりクライアントがサーバー確認前にローカルで遷移をシミュレーションでき、体感遅延を軽減できます。定義説明“enable”有効“disable”無効 stateMachineDefinition string {enableSpeculativeExecution} == “enable” ※ ~ 16777216文字 ステートマシン定義投機的実行のためにこのステータスに埋め込まれた GSL 定義です。enableSpeculativeExecution が有効な場合のみ存在します。通常の API レスポンスではフィルタリングされ、クライアント側シミュレーションに必要な場合のみ含まれます。 ※ enableSpeculativeExecution が “enable” であれば 有効 randomStatus EzRandomStatus {enableSpeculativeExecution} == “enable” ※ 乱数状態この実行インスタンスの乱数生成状態です。投機的実行時にクライアントとサーバーで決定論的な乱数動作を保証するために使用されます。enableSpeculativeExecution が有効な場合のみ存在します。 /ja/api_reference/version/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/version/game_engine/ モデル EzAcceptVersion 承認したバージョン アプリバージョンや、アセットバージョンのようなデータに紐づいたバージョンではなく 同意した利用規約のバージョンのようなユーザ毎にバージョン管理が必要なエンティティで使用します。 型 有効化条件 必須 デフォルト 値の制限 説明 versionName string ✓ ~ 128文字 バージョン名この承認レコードが関連付けられているバージョンモデルの名前です。ユーザーの承認を特定のバージョンモデル定義に紐付けます。 userId string ✓ ~ 128文字 ユーザーID version EzVersion ✓ バージョンユーザーが承認または拒否したバージョン番号です。「active」スコープのバージョンモデルで使用される場合、バージョンチェック時にモデルの現在のバージョンと比較されます。 関連するメソッド: accept - バージョンを承認する（利用規約に同意する） delete - バージョン承認レコードを削除する list - プレイヤーが承認または拒否したバージョンの一覧を取得する reject - バージョンを拒否する（任意の規約を辞退する） EzVersionModel バージョンモデル バージョンモデルには、ログインを受け入れるが、バージョンアップ出来ることを通知する警告バージョンと、ログインを受け入れないエラーバージョンを設定できます。 現在のバージョンをクライアントに申告させるのに、署名の有無を指定できます。 署名付きを選択した場合、クライアントは嘘のバージョン申告を出来なくなります。 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 バージョンモデル名バージョンモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 warningVersion EzVersion {type} == “simple” ✓※ バージョンアップを促すバージョンアップグレード通知を表示する最低バージョン閾値です。クライアントのバージョンがこの値を下回る場合、ログインは許可されますがユーザーにアップグレードが促されます。比較はメジャー、マイナー、マイクロの順に階層的に行われます。 /ja/get_start/tutorial/setup_sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/get_start/tutorial/setup_sdk/ このセクションでは、Game Engine 向けのSDK、GS2 SDK for Unity もしくは GS2 SDK for Unreal Engine 5 のインストール手順について詳述しています。 GS2 SDK for Unityのインストール手順 GS2 SDK for Unity Installer Version 2024.4.1 上記のリンクよりUnityPackege形式のインストーラーをダウンロードします。 新規で Unity プロジェクトを作成するか、既存の Unity プロジェクトを準備し、Unity Editor で開きます。 メニューの 『Assets > Import Package > Custum Packages…』 から gs2-unity-installer_2024.4.1.unitypackage ファイルをインポートします。 Unity Editor のメニューから 『Window > Game Server Services > SDK Installer』 を選択します。 SDK インストーラーのウィンドウが表示されます。『Install』を選択します。 インストールが完了すると、プロジェクトの『Packeges』にSDKがインストールされ、Package Managerでインストールされていることが確認できます。 GS2 SDK for Unity は GS2-CSharp-SDK と GS2 SDK for Unity で構成されています、 /ja/get_start/blueprint/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/get_start/blueprint/ 途中までは一般的なチュートリアルと同じ手順となります。 GS2のセットアップ SDKのセットアップ クレデンシャル(APIキー)の作成 ログイン処理に必要なリソースを準備 クライアントの初期化 GS2::Core::Action::Initialize ノードを作成し、clientId / clientSecret / 接続先のリージョンを設定します。 clientId / clientSecret には クレデンシャル(APIキー)の作成 で作成した値を設定します。 初期化に成功した場合は OnSuccess が呼び出され、失敗した場合は OnError が呼び出されます。 成功時は Client に GS2 のクライアントオブジェクト、失敗時は Error に失敗理由のエラーオブジェクトが返されます。 GS2-Account クライアントの生成 初期化した際に得られた Client オブジェクトを指定して GS2::Account::Service ノードを作成します。 Service に GS2-Account の機能を利用するためのサービスクライアントが返されます。 Namespace オブジェクトの生成 GS2-Account のサービスクライアントを指定して GS2::Account::Namespace ノードを作成します。 Namespace Name にはログイン処理に必要なリソースを準備 で作成したネームスペース名を指定します。 Namespace に GS2-Account の Namespace オブジェクトが返されます。 匿名アカウントの新規作成 GS2-Account の Namespace オブジェクトを指定して GS2::Account::Action::Create ノードを作成します。 アカウントの作成に成功した場合は OnSuccess が呼び出され、失敗した場合は OnError が呼び出されます。 成功時は Account に作成したアカウントオブジェクト、失敗時は Error に失敗理由のエラーオブジェクトが返されます。 /ja/get_start/tutorial/coding/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/get_start/tutorial/coding/ ここでは、GS2 SDK を使用してアカウントの作成とログインを行う最小限の実装方法を解説します。 各プラットフォームごとの完全なコードは サンプルコード全文 をご確認ください。 Unity での実装について Unity SDK では非同期処理に Coroutine を使用しています。以下のコード例は Coroutine 内（IEnumerator を返すメソッド内）で実行することを想定しています。 GS2 SDKの初期化 Game Engine: Unity Unreal Engine // Setup variables var clientId = "YourClientId"; var clientSecret = "YourClientSecret"; var accountNamespaceName = "game-0001"; // Setup general setting Gs2Domain gs2; { var future = Gs2Client.CreateFuture( new BasicGs2Credential( clientId, clientSecret ), Region.ApNortheast1 ); yield return future; if (future.Error != null) { throw future.Error; } gs2 = future.Result; } // Setup variables const auto ClientId = "