ユースケースサンプル: シーズンの終わりにゲーム内通貨で上位プレイヤーに報酬を与える

reset

前提条件

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

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

1. Manage product roles (製品ロールの管理) を選択します。
2. 以下のロールをサービスアカウントに追加します。
   
   • LiveOps ドロップダウンから、以下のロールを選択します。
     • Triggers 設定編集者
     • Triggers 設定閲覧者
     • Economy Resource Editor (Economy リソース編集者)
     • Economy Resource Viewer (Economy リソース閲覧者)
     • Leaderboards Admin (Leaderboards 管理者)
     • Leaderboards Viewer (Leaderboards 閲覧者)
     • Cloud Code モジュールをデプロイしている場合は、以下のロールを追加します。
       • Cloud Code 編集者
       • Cloud Code 閲覧者
     • Cloud Code スクリプトをデプロイしている場合は、以下のロールを追加します。
       • Cloud Code 編集者
       • Cloud Code 閲覧者
       • Cloud Code パブリッシャー
         
   • 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. 以前に認証したサービスアカウントを使用して認証します。認証の取得 を参照してください。

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

  - Triggers の設定が含まれます。

• 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 つを書き留めます。

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 コインの報酬を受け取ったことが表示されます。