ユースケースサンプル: スコアが破られたプレイヤーにプッシュメッセージを送信する

score-submitted

前提条件

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

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 設定閲覧者)、Leaderboards Admin (Leaderboards 管理者) を選択します。
     
   • Admin (管理者) ドロップダウンから Unity Environments Viewer (Unity 環境閲覧者) を選択します。
3. Save (保存) を選択します。
4. Add Key (キーの追加) を選択します。
5. base64 エンコードを使用して Key ID (キー ID) と Secret key (秘密鍵) をエンコードします。形式は "key_id:secret_key" です。この値をメモしておきます。

UGS CLI の設定

1. UGS CLI をインストール します。
2. プロジェクト ID と環境を以下のように設定します。
   

   ugs config set project-id <your-project-id>

   
   

   ugs config set environment-name <your-environment-name>

3. 前に作成したサービスアカウントを使用して認証します。認証の取得 を参照してください。

Leaderboards の設定

leaderboard.lb

new-file

ugs leaderboards new-file leaderboard

leaderboard.lb

{  "$schema": "https://ugs-config-schemas.unity3d.com/v1/leaderboards.schema.json",  "SortOrder": "asc",  "UpdateType": "keepBest",  "Name": "leaderboard"}

ugs deploy leaderboard.lb

任意: リーダーボードへのスコアの追加

JavaScript

const { LeaderboardsApi } = require("@unity-services/leaderboards-1.1");const _ = require("lodash-4.17");module.exports = async ({ params, context, logger }) => {  const leaderboardsApi = new LeaderboardsApi({ accessToken: context.accessToken });  const leaderboardID = "leaderboard";  var randomScore = _.random(1, 100);  try {    await leaderboardsApi.addLeaderboardPlayerScore(context.projectId, leaderboardID, context.playerId, { score: randomScore });  } catch (err) {    logger.error("Failed to add score to the leaderboard", { "error.message": err.message });  }};

score-submitted イベントを調べる

score-submitted

{  "leaderboardId": "leaderboard",  "updatedTime": "2019-08-24T14:15:22Z",  "playerId": "5drhidte8XgD4658j2eHtSljIAzd",  "playerName": "Jane Doe",  "rank": 42,  "score": 120.3,  "tier": "gold"}

Cloud Code の設定

SendPushNotification

using Microsoft.Extensions.DependencyInjection;using Microsoft.Extensions.Logging;using Unity.Services.CloudCode.Apis;using Unity.Services.CloudCode.Core;using Unity.Services.CloudCode.Shared;namespace LeaderboardsNotification;public class LeaderboardsNotification{    private readonly ILogger<LeaderboardsNotification> _logger;    public LeaderboardsNotification(ILogger<LeaderboardsNotification> logger)    {        _logger = logger;    }    [CloudCodeFunction("SendPlayerMessage")]    public async Task SendPlayerMessage(IExecutionContext context, IGameApiClient gameApiClient, PushClient pushClient, string playerId, string playerName,        string leaderboardId, double score)    {        try        {            var closestPlayers = await gameApiClient.Leaderboards.GetLeaderboardScoresPlayerRangeAsync(context,                context.ServiceToken, new Guid(context.ProjectId), leaderboardId, playerId, 1);            if (closestPlayers.Data.Results.Count != 0)            {                var player = closestPlayers.Data.Results[^1];                string message =                    $"The player {playerName} has just beaten your score of {player.Score} on the {leaderboardId} leaderboard by {score-player.Score} points!";                await pushClient.SendPlayerMessageAsync(context, message, "Information", player.PlayerId);            }        }        catch (ApiException e)        {            _logger.LogError("Failed to send push notification to player {playerId}. Error: {Error}", playerId, e.Message);            throw new Exception($"Failed to send push notification to player {playerId}. Error: {e.Message}");        }    }}public class ModuleConfig : ICloudCodeSetup{    public void Setup(ICloudCodeConfig config)    {        config.Dependencies.AddSingleton(PushClient.Create());        config.Dependencies.AddSingleton(GameApiClient.Create());    }}

Cloud Code Editor

トリガーの設定

score-submitted

new-file

ugs triggers new-file triggers-config

triggers-config.tr

{  "$schema": "https://ugs-config-schemas.unity3d.com/v1/triggers.schema.json",  "Configs": [    {      "Name": "score-beaten-message",      "EventType": "com.unity.services.leaderboards.score-submitted.v1",      "ActionUrn": "urn:ugs:cloud-code:LeaderboardsNotification/SendPlayerMessage",      "ActionType": "cloud-code"    }  ]}

ugs deploy triggers-config.tr

Deployed:triggers-config.tr

結果の検証

前提条件

プロジェクトのリンク

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

Got player subscription Message: {  "data_base64": <BASE64-ENCODED-DATA>,  "time": "2023-09-19T10:26:40.436878688Z",  "message": "The player AdjacentMowingToga#7 has just beaten your score of 120.3 on the my-leaderboard leaderboard by 51.3 points!",  "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": "Information"}