사용 사례 샘플: 시즌 종료 시 상위 플레이어에게 게임 내 재화로 보상 제공

reset

필수 조건

서비스 계정을 사용하여 인증

1. Unity Dashboard로 이동합니다.
2. Administration > Service Accounts를 선택합니다.
3. New 버튼을 선택하고 서비스 계정의 이름과 설명을 입력합니다.
4. Create를 선택합니다.

1. Manage product roles를 선택합니다.
2. 다음 역할을 서비스 계정에 추가합니다.
   
   • LiveOps 드롭다운에서 다음 역할을 선택합니다.
     • Triggers 구성 편집자
     • Triggers 구성 조회자
     • Economy 리소스 편집자
     • Economy 리소스 조회자
     • Leaderboards 관리자
     • Leaderboards 조회자
     • Cloud Code 모듈을 배포 중인 경우 다음 역할을 추가합니다.
       • Cloud Code 편집자
       • Cloud Code 조회자
     • Cloud Code 스크립트를 배포 중인 경우 다음 역할을 추가합니다.
       • Cloud Code 편집자
       • Cloud Code 조회자
       • Cloud Code 퍼블리셔
         
   • Admin 드롭다운에서 Unity Environments Viewer를 선택합니다.
     
3. Save를 선택합니다.
4. Add Key를 선택합니다.
5. base64 인코딩을 사용하여 Key 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. 앞서 인증된 서비스 계정을 사용하여 인증을 받습니다. 인증 받기를 참고하십시오.

reset 이벤트 확인

reset

{  "leaderboardId": "string",  "leaderboardVersionId": "string"}

배포 파일 생성

• COIN.ecc

  : Economy 재화 구성을 포함합니다.

• leaderboard.lb

  : Leaderboards 구성을 포함합니다.

• triggers-config.tr

  : Triggers 구성을 포함합니다.
• 리더보드가 초기화될 때 상위 플레이어에게 게임 내 재화로 보상을 지급하는 로직을 정의하는 Cloud Code 모듈이나 스크립트입니다.

reward-top-players

Economy 설정

ugs economy currency new-file COIN.ecc

COIN.ecc

{  "$schema": "https://ugs-config-schemas.unity3d.com/v1/economy/economy-currency.schema.json",  "initial": 0,  "name": "Coin"}

Coin

Leaderboards 설정

ugs leaderboards new-file leaderboard.lb

leaderboard.lb

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

Cloud Code 설정

Cloud Code C# 모듈

ugs cc m new-file RewardTopPlayers RewardTopPlayers

leaderboardId

using System;using System.Collections.Generic;using System.Threading.Tasks;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.Economy.Model;using Unity.Services.Leaderboards.Model;namespace RewardTopPlayers;public class RewardTopPlayers{    private const string CoinsKey = "COIN";    private const int Amount = 10;    private readonly ILogger<RewardTopPlayers> _logger;    public RewardTopPlayers(ILogger<RewardTopPlayers> logger)    {        _logger = logger;    }    [CloudCodeFunction("IssueReward")]    public async Task Reward(IExecutionContext ctx, IGameApiClient gameApiClient, string leaderboardId, string leaderboardVersionId)    {        var top5Players = await GetTop5(ctx, gameApiClient, leaderboardId, leaderboardVersionId);        foreach (var score in top5Players)        {            try            {                // Retrieve the player's configuration to ensure currency configuration is synced                var configResponse = await gameApiClient.EconomyConfiguration.GetPlayerConfigurationAsync(ctx, ctx.ServiceToken, ctx.ProjectId, score.PlayerId);                var res = await gameApiClient.EconomyCurrencies.IncrementPlayerCurrencyBalanceAsync(ctx, ctx.ServiceToken, ctx.ProjectId,                    score.PlayerId,                    CoinsKey, new CurrencyModifyBalanceRequest(amount: Amount), configResponse.Data.Metadata.ConfigAssignmentHash);                _logger.LogInformation("Incremented balance for playerId {playerId} by {amount}", score.PlayerId, Amount);            }            catch (ApiException e)            {                _logger.LogError(e, "Failed to increment balance for playerId {playerId}. Error: {Error}", score.PlayerId, e.Message);                throw;            }        }    }    public async Task<List<LeaderboardEntry>> GetTop5(IExecutionContext ctx, IGameApiClient gameApiClient, string leaderboardId, string leaderboardVersionId)    {        try        {            var results = await gameApiClient.Leaderboards.GetLeaderboardVersionScoresAsync(ctx, ctx.ServiceToken, new Guid(ctx.ProjectId),                leaderboardId, leaderboardVersionId, 0, 5);            return results.Data.Results;        }        catch (ApiException e)        {            _logger.LogError(e, "Failed to get top players for leaderboard: {LeaderboardId}. Error: {Error}", leaderboardId, e.Message);            throw new Exception($"Failed to get top players for leaderboard: {leaderboardId}. Error: {e.Message}");        }    }    public class ModuleConfig : ICloudCodeSetup    {        public void Setup(ICloudCodeConfig config)        {            config.Dependencies.AddSingleton(GameApiClient.Create());        }    }}

Cloud Code JavaScript 스크립트

ugs cc s new-file RewardTopPlayers.js

JavaScript

const axios = require("axios");const { CurrenciesApi, ConfigurationApi } = require("@unity-services/economy-2.4");const { LeaderboardsApi } = require("@unity-services/leaderboards-1.1");module.exports = async ({ params, context, logger }) => {  // Get top 5 players from the Leaderboard  const leaderboardsApi = new LeaderboardsApi(context);  const cointAmount = 10;  let result;  try {    result = await leaderboardsApi.getLeaderboardVersionScores(context.projectId, params.leaderboardId, params.leaderboardVersionId, 0, 5);  } catch (err) {    logger.error("Failed to retrieve players from the leaderboard", { "error.message": err.message }, { "leaderboardId": params.leaderboardId });    throw err;  }  const currencyId = "COIN";  const currenciesApi = new CurrenciesApi(context);  const configApi = new ConfigurationApi(context);  // Reward currency to every player  const promises = result.data.results.map(async (score) => {    try {      // Retrieve the player config to get the configAssignmentHash.      // This is needed to ensure the currency is synced      var config = await configApi.getPlayerConfiguration({        playerId: score.playerId,        projectId: context.projectId,      });      await currenciesApi.incrementPlayerCurrencyBalance({        currencyId,        playerId: score.playerId,        projectId: context.projectId,        configAssignmentHash: config.data.metadata.configAssignmentHash,        currencyModifyBalanceRequest: { amount: cointAmount },      });    } catch (err) {      logger.error("Failed to increment currency for player", { "error.message": err.message }, { "affectedPlayerId": score.playerId });      return;    }  });  await Promise.all(promises);};

Triggers 설정

ugs tr new-file triggers-config.tr

{  "$schema": "https://ugs-config-schemas.unity3d.com/v1/triggers.schema.json",  "Configs": [    {      "Name": "reward-leaderboard",      "EventType": "com.unity.services.leaderboards.reset.v1",      "ActionUrn": "urn:ugs:cloud-code:RewardTopPlayers/IssueReward",      "ActionType": "cloud-code"    }  ]}

{  "$schema": "https://ugs-config-schemas.unity3d.com/v1/triggers.schema.json",  "Configs": [    {      "Name": "reward-leaderboard",      "EventType": "com.unity.services.leaderboards.reset.v1",      "ActionUrn": "urn:ugs:cloud-code:RewardTopPlayers",      "ActionType": "cloud-code"    }  ]}

구성 파일 배포

reward-top-players

• COIN.ecc

  - Economy 재화 구성이 포함되어 있습니다.

• leaderboard.lb

  - Leaderboards 구성이 포함되어 있습니다.

• triggers-config.tr

  - Trigger 구성이 포함되어 있습니다.

• RewardTopPlayers.sln

  폴더 - Cloud Code 모듈이 포함되어 있습니다.

• RewardTopPlayers.js

  폴더 - Cloud Code 스크립트가 포함되어 있습니다.

ugs deploy .

선택 사항: 리더보드에 점수 추가

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

결과 확인

1. Unity Dashboard로 이동합니다.
2. Products > Leaderboards를 선택합니다.
3. Overview 섹션을 선택합니다.

4. leaderboard

   리더보드를 선택합니다.
5. Entries 탭을 선택합니다.
6. 상위 플레이어 ID 중 하나를 기록해 둡니다.

1. Unity Dashboard로 이동합니다.
2. Products > Leaderboards를 선택합니다.
3. Overview 섹션을 선택합니다.

4. leaderboard

   리더보드를 선택합니다.
5. Reset Leaderboard를 선택합니다.
6. Archive current scores를 활성화합니다.

1. Products > Player Management를 선택합니다.
2. 검색 필드에 앞서 기록해 둔 플레이어 ID를 입력하고 Find Player를 선택합니다.
3. Economy > Currencies 섹션으로 이동합니다. 플레이어가 보상으로 10코인을 받았음을 확인할 수 있으면 성공적으로 완료된 것입니다.