サポートされている UGS イベント
Learn about the events emitted by Unity Gaming Services that you can use to trigger Cloud Code scripts or modules.
読み終わるまでの所要時間 17 分最終更新 5ヶ月前
Unity Gaming Services は、プレイヤーのアクティビティとゲームの状態に関する情報を提供できるイベントを発行します。これらのイベントを使用して、対応するイベントタイプでトリガー設定を作成することにより、Cloud Code スクリプトまたはモジュールをトリガーします。
イベントがトリガー設定にどのように対応するかを確認するには、トリガー構造 を参照してください。
Unity Gaming Services によって発行されるイベントのリストについては、以下の表を参照してください。
サービス | イベント名 | 発行されるタイミング |
|---|---|---|
| 認証 | サインアップ | プレイヤーが Authentication サービス にサインアップしたとき。作成されたプレイヤーもサインインし、サインイン イベントを発行します。 |
| 認証 | サインイン | プレイヤーが Authentication サービスにサインインするか、トークンをリフレッシュしたとき。 |
| Leaderboards | リセット | リーダーボードをリセットしたとき。 |
| Leaderboards | スコア送信 | プレイヤーがスコアをリーダーボードに送信したとき。 |
| Cloud Save | キー保存 | プレイヤーまたはエンティティの Cloud Save キーが保存されたとき。 |
| Moderation (モデレーション) | プレイヤーアクション | プレイヤーアクションは審査されます。 |
認証
Authentication サービス は、新規プレイヤーのエンゲージメントの促進、サインインボーナスの提供、および戻ってきたプレイヤーへの報酬の授与に役立つイベントを提供します。
Unity Runtime からプレイヤーを認証している場合、プレイヤー認証フローが完了する前にイベントが発生します。
サインアップ
サインアップイベントは、プレイヤーが Authentication サービスで作成されたときに発行されます。作成されたプレイヤーもサインインし、サインイン イベントを発行します。
イベントタイプ:
com.unity.services.player-auth.signed-up.v1イベントのペイロードについては、以下の表を参照してください。
フィールド | 説明 | 型 |
|---|---|---|
| さまざまなデバイスや外部プロバイダーで、戻ってきたプレイヤーおよび新規プレイヤーを識別するために使用される英数字文字列。 | string |
| サインインに使用されたプロバイダー。 | string |
| プレイヤーアカウントが作成されたときのタイムスタンプ (RFC3339 形式)。 | string |
イベントで を使用して プレイヤーエンドポイントの取得 を呼び出すことで完全なプレイヤー情報を取得します。
playerIdユースケースサンプル: 新規にサインアップしたプレイヤーのデフォルト設定値での初期化 に示されている、このイベントの使用方法の例を参照してください。
サインイン
サインインイベントは、プレイヤーが Authentication サービスにサインインするか、トークンをリフレッシュしたときに発行されます。
イベントタイプ:
com.unity.services.player-auth.signed-in.v1イベントのペイロードについては、以下の表を参照してください。
フィールド | 説明 | 型 |
|---|---|---|
| さまざまなデバイスや外部プロバイダーで、戻ってきたプレイヤーおよび新規プレイヤーを識別するために使用される英数字文字列。 | string |
| サインインに使用されたプロバイダー。 | string |
| プレイヤーアカウントが作成されたときのタイムスタンプ (RFC3339 形式)。 | string |
| プレイヤーが最後にサインインしたときのタイムスタンプ (RFC3339 形式)。 | string |
| プレイヤーが前回サインインした日付のタイムスタンプ (RFC3339 形式)。 | string |
イベントで を使用して プレイヤーエンドポイントの取得 を呼び出すことで完全なプレイヤー情報を取得します。
playerIdLeaderboards
Leaderboard サービス は、エンゲージメントの推進に役立つイベントを提供します。
リセット
リセットイベントは、リーダーボードがリセットされたときに発行されます。
イベントタイプ:
com.unity.services.leaderboards.reset.v1イベントのペイロードについては、以下の表を参照してください。
フィールド | 説明 | 型 |
|---|---|---|
| リーダーボード ID。 | string |
| リーダーボードバージョン ID。 | string |
このイベントを使用して、リーダーボードの上位プレイヤーに報酬を与えたり、プレイヤーを別のティアにプロモートおよびデモートしたりできます。
ユースケースサンプル: シーズンの終わりにゲーム内通貨で上位プレイヤーに報酬を与える に示されている、このイベントの使用方法の例を参照してください。
スコア送信
Leaderboards サービスは、プレイヤーがスコアをリーダーボードに送信したときにスコア送信イベントを発行します。
イベントタイプ:
com.unity.services.leaderboards.score-submitted.v1イベントのペイロードについては、以下の表を参照してください。
フィールド | 説明 | 型 |
|---|---|---|
| スコアが送信されるリーダーボード ID。 | string |
| スコア送信のタイムスタンプ (RFC3339 形式)。 | string |
| プレイヤー ID。 | string |
| プレイヤー名。 | string |
| プレイヤーのランク。 | int |
| 送信されたスコア。 | double |
| プレイヤーのティア。階層化されていないリーダーボードの空の文字列。 | string |
| バケット ID。バケット化されていないリーダーボードの空の文字列。 | string |
このイベントを使用してエンゲージメントを推進できます。例えば、プレイヤーがリーダーボードで優れたパフォーマンスを達成したときに通知したり、特定のランクに達したプレイヤーに報酬を与えたりできます。
ユースケースサンプル: スコアが破られたプレイヤーにプッシュメッセージを送信する に示されている、このイベントの使用方法の例を参照してください。
Cloud Save
Cloud Save サービスは、アイテムが更新されたときにプレイヤーに通知することでエンゲージメントを推進するのに役立つイベントを送信します。
キー保存
キー保存イベントは、プレイヤーのアイテムまたは Cloud Save のエンティティが保存されたときに発行されます。
イベントタイプ:
com.unity.services.cloud-save.key-saved.v1イベントのペイロードについては、以下の表を参照してください。
フィールド | 説明 | 型 |
|---|---|---|
| イベントに関連付けられているプレイヤーまたはエンティティの ID。 | string |
| アイテムセット ID タイプ ( | string |
| Cloud Save アイテムのキー。 | string |
| Cloud Save アイテムの値がイベントに含まれるかどうか。サイズが 128b 未満の値のみが返されます。 | bool |
| Cloud Save アイテムの値。サイズが 128b 未満の値のみが返されます。 | object |
| Cloud Save アイテムの書き込みロック。 | string |
| アイテムのアクセスクラス。これは | string |
| アイテムの変更日 (RFC3339 形式)。 | string |
このイベントを使用して、アイテムが更新されたときにプレイヤーに通知することでエンゲージメントを推進できます。
Moderation (モデレーション)
Moderation サービス には、プレイヤーの行動を管理するのに役立つイベントが用意されています。Moderation サービスを通じてプレイヤーアクションが審査されるときに実行するカスタムアクションを Cloud Code で定義できます。例えば、Cloud Code でカスタムアクションを定義して、イベントが発生したときに特定のゲームモードからプレイヤーをバンできます。
プレイヤーアクション
プレイヤーアクションイベントは、プレイヤーのアクションが審査されるときに発行されます。
イベントタイプ: 。
com.unity.services.moderation.player-action-event.v1イベントのペイロードについては、以下の表を参照してください。
フィールド | 説明 | 型 |
|---|---|---|
| イベントに関連するプレイヤーアクションの UUID。 | string |
| このプレイヤーアクションが適用されたモデレーションインシデントの UUID。 | string |
| アクションに関連付けられているイベントのタイプ。値は、プレイヤーアクションが適用されている場合は | string |
| 適用されているプレイヤーアクションの種類の識別子。 | string |
| 適用されているプレイヤーアクションの種類の表示名。 | string |
| プレイヤーアクションが適用または取り消される理由。 | string |
| モデレーターがアクションを適用または取り消す理由として提供したコメント。 | string |
| このプレイヤーアクションを担当するモデレーター。 | string |
| 影響を受けるプレイヤーの uas ID。 | string |
| 影響を受けるプレイヤーのユーザー名。プレイヤー名を取得できない場合、この値には | string |
| このプレイヤーアクションが 1 回限りのアクションであるかどうかを定義します。 | bool |
| プレイヤーアクションが作成されたときのタイムスタンプ (RFC3339 形式)。 | string |
| プレイヤーアクションが失効するときのタイムスタンプ (RFC3339 形式)。プレイヤーアクションが永続的または 1 回限りのアクションである場合は null になります。 | string または null |
| プレイヤーアクションが取り消されたときのタイムスタンプ (RFC3339 形式)。プレイヤーアクションが取り消されていない場合は null になります。 | string または null |
| プレイヤーの外部 ID のマップ。キーはプロバイダー ID で、値は外部 ID です。 | object |