プッシュメッセージの送信

ユースケースと利点

モジュールの作成

• SendPlayerMessage

  : 特定の接続済みプレイヤーにメッセージを送信します。

• SendProjectMessage

  : プロジェクト内のすべての接続済みプレイヤーにメッセージをブロードキャストします。

SendProjectMessage

Unity.Services.CloudCode.Apis

PushClient

using Microsoft.Extensions.DependencyInjection;using Unity.Services.CloudCode.Core;using Unity.Services.CloudCode.Apis;namespace PushExample{    public class PushExample    {        [CloudCodeFunction("SendPlayerMessage")]        public async Task<string> SendPlayerMessage(IExecutionContext context, PushClient pushClient, string message, string messageType, string playerId)        {            var response = await pushClient.SendPlayerMessageAsync(context, message, messageType, playerId);            return "Player message sent";        }        // Recommended to use access control to limit access to this endpoint        [CloudCodeFunction("SendProjectMessage")]        public async Task<string> SendProjectMessage(IExecutionContext context, PushClient pushClient, string message, string messageType)        {            var response = await pushClient.SendProjectMessageAsync(context, message, messageType);            return "Project message sent";        }    }    public class ModuleConfig : ICloudCodeSetup    {        public void Setup(ICloudCodeConfig config)        {            config.Dependencies.AddSingleton(PushClient.Create());        }    }}

Unity エディターの設定

プロジェクトのリンク

1. Unity エディターで、Edit (編集) > Project Settings (プロジェクト設定) > Services (サービス) の順に選択します。
2. プロジェクトをリンクします。
   プロジェクトに Unity プロジェクト ID がない場合:
   1. Create a Unity Project ID (Unity プロジェクト ID の作成) > Organizations (組織) の順に選択し、ドロップダウンから組織を選択します。
   2. Create project ID (プロジェクト ID を作成) を選択します。
   
   既存の Unity プロジェクト ID がある場合:
   1. Use an existing Unity project ID (既存の Unity プロジェクト ID を使用) を選択します。
   2. ドロップダウンから組織とプロジェクトを選択します。
   3. Link project ID (プロジェクト ID をリンク) を選択します。

UnityEditor.CloudProjectSettings.projectId

SDK のインストール

1. Unity エディターで、Window (ウィンドウ) > Package Manager (パッケージマネージャー) を開きます。
2. Package Manager で、Unity Registry (Unity レジストリ) のリストビューを選択します。

3. com.unity.services.cloudcode

   を検索するか、リストから Cloud Code パッケージを探します。
4. このパッケージを選択し、Install (インストール) をクリックします。

SDK の設定

1. Cloud Code サービスダッシュボードページを介してサービスが有効になっていることを確認します。
2. Cloud Code と Authentication SDK の両方をインストールしたことを確認します。
3. Edit (編集) > Project Settings (プロジェクト設定) > Services (サービス) を選択して、Unity エディター内からクラウドプロジェクトにサインインします。
4. Unity エディターで新しい C# Monobehaviour スクリプトを作成します。Unity マニュアルの スクリプトの作成と使用 を参照してください。
5. スクリプトで、await

   UnityServices.InitializeAsync()

   を使用して Core SDK を初期化します。
6. スクリプトで、Authentication SDK を初期化します。

await AuthenticationService.Instance.SignInAnonymouslyAsync();

メッセージのサブスクライブ

MonoBehaviour

using System;using System.Threading.Tasks;using Newtonsoft.Json;using Unity.Services.Authentication;using Unity.Services.CloudCode;using Unity.Services.CloudCode.Subscriptions;using Unity.Services.Core;using UnityEngine;namespace CloudCode{	public class CloudCodePushExample : MonoBehaviour	{    	async void Start()        {            await UnityServices.InitializeAsync();            await AuthenticationService.Instance.SignInAnonymouslyAsync();            Debug.Log(AuthenticationService.Instance.PlayerId);            await SubscribeToPlayerMessages();            await SubscribeToProjectMessages();        }        // This method creates a subscription to player messages and logs out the messages received,        // the state changes of the connection, when the player is kicked and when an error occurs.        Task SubscribeToPlayerMessages()        {            // Register callbacks, which are triggered when a player message is received            var callbacks = new SubscriptionEventCallbacks();            callbacks.MessageReceived += @event =>            {                Debug.Log(DateTime.Now.ToString("yyyy-MM-dd'T'HH:mm:ss.fffK"));                Debug.Log($"Got player subscription Message: {JsonConvert.SerializeObject(@event, Formatting.Indented)}");            };            callbacks.ConnectionStateChanged += @event =>            {                Debug.Log($"Got player subscription ConnectionStateChanged: {JsonConvert.SerializeObject(@event, Formatting.Indented)}");            };            callbacks.Kicked += () =>            {                Debug.Log($"Got player subscription Kicked");            };            callbacks.Error += @event =>            {                Debug.Log($"Got player subscription Error: {JsonConvert.SerializeObject(@event, Formatting.Indented)}");            };            return CloudCodeService.Instance.SubscribeToPlayerMessagesAsync(callbacks);        }        // This method creates a subscription to project messages and logs out the messages received,        // the state changes of the connection, when the player is kicked and when an error occurs.        Task SubscribeToProjectMessages()        {            var callbacks = new SubscriptionEventCallbacks();            callbacks.MessageReceived += @event =>            {                Debug.Log(DateTime.Now.ToString("yyyy-MM-dd'T'HH:mm:ss.fffK"));                Debug.Log($"Got project subscription Message: {JsonConvert.SerializeObject(@event, Formatting.Indented)}");            };            callbacks.ConnectionStateChanged += @event =>            {                Debug.Log($"Got project subscription ConnectionStateChanged: {JsonConvert.SerializeObject(@event, Formatting.Indented)}");            };            callbacks.Kicked += () =>            {                Debug.Log($"Got project subscription Kicked");            };            callbacks.Error += @event =>            {                Debug.Log($"Got project subscription Error: {JsonConvert.SerializeObject(@event, Formatting.Indented)}");            };            return CloudCodeService.Instance.SubscribeToProjectMessagesAsync(callbacks);        }	}}

プレイヤーへのメッセージの送信

SendPlayerMessage

SendProjectMessage

Unity Runtime からの実行

CloudCodeService

CallModuleEndpointAsync

var sendPlayerMessageResult = await CloudCodeService.Instance.CallModuleEndpointAsync<string>("PushExample", "SendPlayerMessage",new Dictionary<string, object> {{"message", "hello with a player message from PushExample!"}, {"messageType", "testType"}, {"playerId", "<other-unity-player-ID>"}});

SendProjectMessage

イベント

• MessageReceived

  : プレイヤーが新しいメッセージを受信したときにトリガーします。

• ConnectionStateChanged

  : 接続の状態が変わったときにトリガーします。

• Kicked

  : サーバーがプレイヤーのメッセージのサブスクライブを強制的に解除したときにトリガーします。これにより WebSocket 接続はクローズされず、ゲームクライアントがメッセージを再びサブスクライブすることも阻止されません。

• Error

  : 接続の処理時またはプレイヤーがメッセージを受信したときにトリガーします。

メッセージエンベロープ

IMessageReceivedEvent

IMessageReceivedEvent

SpecVersion

Id

4f88f657-27da-4b1d-a013-9033dbc7b48b

Source

https://cloud-code.service.api.unity.com

Type

com.unity.services.cloud-code.push.v1

Time

2023-09-19T10:26:40.436878688Z

ProjectId

b6670776-9fd3-4d66-8bf4-63fb1112dc95

EnvironmentId

a4bc2571-d1e7-4507-9cc9-80b687d48d8f

CorrelationId

afbd7c6e-e999-4ca2-86fc-3c908ba83bf2

Message

MessageType

Type