푸시 메시지 전송

사용 사례 및 이점

모듈 생성

• 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 > Organizations를 선택한 다음 드롭다운에서 조직을 선택합니다.
   2. Create project ID를 선택합니다.
   
   Unity 프로젝트 ID가 있는 경우 다음 단계를 진행합니다.
   1. Use an existing Unity project ID를 선택합니다.
   2. 드롭다운에서 조직과 프로젝트를 선택합니다.
   3. Link project ID를 선택합니다.

UnityEditor.CloudProjectSettings.projectId

SDK 설치

1. Unity 에디터에서 Window > Package Manager를 엽니다.
2. Package Manager에서 Unity Registry 목록 뷰를 선택합니다.

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