使用示例：向分数被超过的玩家发送推送消息

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. 按如下方式配置 Project 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 Project ID：
   1. 选择 Create a Unity Project ID（创建 Unity Project ID）> Organizations（组织），然后从下拉选单中选择一个组织。
   2. 选择 Create project ID（创建 Project ID）。
   
   如果已有 Unity Project ID：
   1. 选择 Use an existing Unity project ID（使用现有 Unity Project ID）。
   2. 从下拉选单中选择组织和项目。
   3. 选择 Link project ID（关联 Project 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"}