ユースケースサンプル: 参加ロビー内のすべてのプレイヤーにレベルアップをアナウンスする

key-saved

前提条件

サービスアカウントを使用した認証

1. Unity Dashboard に移動します。
2. Administration (管理) > Service Accounts (サービスアカウント) を選択します。
3. New (新規) ボタンを選択し、サービスアカウントの名前と説明を入力します。
4. Create (作成) を選択します。

1. Manage product roles (製品ロールの管理) を選択します。
2. 以下のロールをサービスアカウントに追加します。
   
   • LiveOps ドロップダウンから、Triggers Configuration Editor (Triggers 設定編集者) および Triggers Configuration Viewer (Triggers 設定閲覧者) を選択します。
     
   • Admin (管理者) ドロップダウンから Unity Environments Viewer (Unity 環境閲覧者) を選択します。
3. Save (保存) を選択します。
4. Add Key (キーの追加) を選択します。
5. base64 エンコードを使用して Key ID (キー ID) と Secret key (秘密鍵) をエンコードします。形式は "key_id:secret_key" です。この値をメモしておきます。

key-saved イベントを調べる

key-saved

{  "id": "7LpyhpsIvEczGkDI1r8J6gHhHezL",  "idType": "player",  "key": "LEVEL",  "value": 1,  "valueIncluded": true,  "writeLock": "7b8920a57912509f6b5cbb183eb7fcb0",  "accessClass": "default",  "modifiedDate": "2021-03-04T09:00:00Z"}

Cloud Code の設定

AnnounceLevelUp

using Microsoft.Extensions.DependencyInjection;using Microsoft.Extensions.Logging;using Unity.Services.CloudCode.Apis;using Unity.Services.CloudCode.Core;using Unity.Services.CloudCode.Shared;using Unity.Services.Lobby.Model;namespace AnnounceLevelUp;public class AnnounceLevelUp{    private const string ServiceId = "cloud-code";    private readonly ILogger<AnnounceLevelUp> _logger;    public AnnounceLevelUp(ILogger<AnnounceLevelUp> logger)    {        _logger = logger;    }    [CloudCodeFunction("AnnounceLevelUp")]    public async Task Announce(IExecutionContext ctx, PushClient pushClient, IGameApiClient gameApiClient,        string id)    {        try        {            var playerList = await GetPlayersFromLobbies(ctx, gameApiClient, id);            if (playerList.Count == 0)            {                _logger.LogInformation("The player {playerId} has not joined any lobbies", id);                return;            }            await SendPushMessage(ctx, pushClient, playerList);        }        catch (ApiException e)        {            _logger.LogError("Failed to announce level up for player {playerId}. Error: {Error}", id,                e.Message);            throw new Exception($"Failed to announce level up for player {id}. Error: {e.Message}");        }    }    public async Task SendPushMessage(IExecutionContext ctx,  PushClient pushClient, List<Player> lobbyPlayers)    {        foreach (var lobbyPlayer in lobbyPlayers)        {            try            {                var message = $"The player {lobbyPlayer.Id} has leveled up!";                _logger.LogInformation("Sending push notification to player {lobbyPlayer}", lobbyPlayer.Id);                await pushClient.SendPlayerMessageAsync(ctx, message, "Level up!", lobbyPlayer.Id);            }            catch (ApiException e)            {                _logger.LogError("Failed to send push notification to player {playerId}. Error: {Error}", lobbyPlayer.Id,                    e.Message);            }        }    }    public async Task<List<Player>> GetPlayersFromLobbies(IExecutionContext ctx, IGameApiClient gameApiClient, string playerId)    {        var playersToNotify = new List<Player>();        try        {            var lobbyList = await gameApiClient.Lobby.GetJoinedLobbiesAsync(ctx, ctx.ServiceToken, ServiceId,playerId );            foreach (var lobby in lobbyList.Data)            {                var players = await GetLobbyData(ctx, gameApiClient, lobby);                playersToNotify.AddRange(players);            }            return playersToNotify;        }        catch (Exception e)        {            _logger.LogError("Failed to get players from lobbies. Error: {Error}",  e.Message);            throw new Exception($"Failed to get players from lobbies. Error: {e.Message}");        }    }    public async Task<List<Player>> GetLobbyData(IExecutionContext ctx, IGameApiClient gameApiClient, string lobbyId)    {        try        {            var response = await gameApiClient.Lobby.GetLobbyAsync(ctx, ctx.ServiceToken, lobbyId, "cloud-code");            return response.Data.Players;        }        catch (Exception e)        {            _logger.LogError("Failed to get players from lobby: {lobbyId}. Error: {Error}", lobbyId, e.Message);            throw new Exception($"Failed to get players from lobby: {lobbyId}. Error: {e.Message}");        }    }    public class ModuleConfig : ICloudCodeSetup    {        public void Setup(ICloudCodeConfig config)        {            config.Dependencies.AddSingleton(GameApiClient.Create());            config.Dependencies.AddSingleton(PushClient.Create());        }    }}

Cloud Code Editor

トリガーの設定

key-saved

key_id:secret_key

curl 'https://services.api.unity.com/triggers/v1/projects/<PROJECT_ID>/environments/<ENVIRONMENT_ID>/configs' \--header 'Content-Type: application/json' \--header 'Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS_ENCODED>' \--data '{  "name": "announce-level-up",  "eventType": "com.unity.services.cloud-save.key-saved.v1",  "actionType": "cloud-code",  "actionUrn": "urn:ugs:cloud-code:AnnounceLevelUp/AnnounceLevelUp",  "filter": "data[\"idType\"] == \"player\" && data[\"key\"] == \"LEVEL\""}'

LEVEL

Lobby の設定

JavaScript

const { LobbyApi } = require("@unity-services/lobby-1.2");module.exports = async ({ params, context, logger }) => {  const lobbyApi = new LobbyApi(context);  const serviceId = "cloud-code";  try {    // Create a private lobby without any initial players.    const { data: lobby } = await lobbyApi.createLobby(serviceId, null, {      name: "sample-lobby",      maxPlayers: 4,    });    return lobby.id;  } catch (err) {    logger.error(`Error while calling out to Lobby: ${JSON.stringify(err.message)}`);    throw err;  }};

プレイヤーのロビーへの追加

lobbyId

JavaScript

const { LobbyApi } = require("@unity-services/lobby-1.2");module.exports = async ({ params, context, logger }) => {  const lobbyApi = new LobbyApi(context);  const serviceId = "cloud-code";  try {    await lobbyApi.joinLobbyById(params.lobbyId, serviceId, context.playerId);  } catch (err) {    logger.error("Failed to join lobby", { "error.message": err.message }, { lobbyId: params.lobbyId });    throw err;  }};

結果の検証

前提条件

プロジェクトのリンク

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 を選択します。

Monobehaviour スクリプトの作成

Monobehaviour

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();        }        // 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);        }    }}

Monobehaviour

ロビーへの参加

lobbyId

playerId

Cloud Save での Level キーの更新

playerId

level

level

JavaScript

const { DataApi } = require("@unity-services/cloud-save-1.4");module.exports = async ({ params, context, logger }) => {  const cloudSaveApi = new DataApi(context);  try {    await cloudSaveApi.setItem(context.projectId, params.playerId, {      key: "LEVEL",      value: params.level,    });    result = await cloudSaveApi.getItems(context.projectId, params.playerId);    return result.data;  } catch (err) {    logger.error("Error while calling out to Cloud Save", { "error.message": err.message });    throw err;  }};

結果の検証

LEVEL

Got player subscription Message:  {    "data_base64": <BASE64-ENCODED-DATA>,    "time": "2023-11-13T16:21:35.102058117Z",    "message": "The player Z96pNb4wfgdaMLqMQfWpwXEclaRZ has leveled up!",    "specversion": "1.0",    "id": <ID>,    "source": "https://cloud-code.service.api.unity.com",    "type": "com.unity.services.cloud-code.push.v1",    "projectid": <PROJECT-ID>,    "environmentid": <ENVIRONMENT-ID>,    "correlationid": <CORRELATION-ID>,    "messagetype": "Level up!",  }