ユースケースサンプル: 新規にサインアップしたプレイヤーのデフォルト設定値での初期化

signedUp

前提条件

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

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" です。この値をメモしておきます。

UGS CLI の設定

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

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

   
   

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

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

signed-up イベントを調べる

signed-up

{  "playerId": "string",  "providerId": "string",  "createdAt": "string"}

Cloud Code の設定

Cloud Code C# モジュール

playerId

InitializeNewPlayer

using Microsoft.Extensions.DependencyInjection;using Microsoft.Extensions.Logging;using Unity.Services.CloudCode.Core;using Unity.Services.CloudCode.Apis;using Unity.Services.CloudCode.Shared;using Unity.Services.CloudSave.Model;public class ModuleSample{    private const string HealthKey = "HEALTH";    private const string StaminaKey = "STAMINA";    private const int DefaultValue = 100;    private readonly ILogger<ModuleSample> _logger;    public ModuleSample(ILogger<ModuleSample> logger)    {        _logger = logger;    }    [CloudCodeFunction("InitializeNewPlayer")]    public async Task InitializeNewPlayer(IExecutionContext ctx, IGameApiClient gameApiClient, string playerId)    {        try        {            var response = await gameApiClient.CloudSaveData.GetItemsAsync(ctx, ctx.ServiceToken, ctx.ProjectId, playerId, new List<string>() { HealthKey, StaminaKey });            if (response.Data.Results.Count == 0)            {                await gameApiClient.CloudSaveData.SetItemBatchAsync(ctx, ctx.ServiceToken, ctx.ProjectId, playerId,                    new SetItemBatchBody(new List<SetItemBody>{new (HealthKey, DefaultValue), new (StaminaKey, DefaultValue)}));                _logger.LogInformation("The player has been initialized with the {HealthKey} and {StaminaKey} keys with values of {DefaultValue}", HealthKey, StaminaKey, DefaultValue);            }        } catch (ApiException e)        {            _logger.LogError("Failed to initialize player data in Cloud Save. Error: {Error}", e.Message);            throw new Exception($"Failed to initialize {playerId} data in Cloud Save. Error: {e.Message}");        }    }    public class ModuleConfig : ICloudCodeSetup    {        public void Setup(ICloudCodeConfig config)        {            config.Dependencies.AddSingleton(GameApiClient.Create());        }    }}

Cloud Code Editor

Cloud Code JavaScript スクリプト

playerId

InitializeNewPlayer

JavaScript

const { DataApi } = require("@unity-services/cloud-save-1.4");const CLOUD_SAVE_HEALTH_KEY = "HEALTH";const CLOUD_SAVE_STAMINA_KEY = "STAMINA";const DEFAULT_VALUE = 100;module.exports = async ({ params, context, logger }) => {  const cloudSaveApi = new DataApi(context);  try {    // Check if player has been initialized yet    const cloudSaveGetResponse = await cloudSaveApi.getItems(context.projectId, params.playerId, [CLOUD_SAVE_HEALTH_KEY, CLOUD_SAVE_STAMINA_KEY]);    if (cloudSaveGetResponse.data.results.length === 0) {      // Record new values for player      await cloudSaveApi.setItemBatch(context.projectId, params.playerId, {        data: [          {            key: CLOUD_SAVE_HEALTH_KEY,            value: DEFAULT_VALUE,          },          {            key: CLOUD_SAVE_STAMINA_KEY,            value: DEFAULT_VALUE,          },        ],      });      logger.info(`The player has been initialized with the ${CLOUD_SAVE_HEALTH_KEY} and ${CLOUD_SAVE_STAMINA_KEY} keys with values of ${DEFAULT_VALUE}`, { "affectedPlayerId": params.playerId });      return;    }    logger.info("The player has already been initialized.", { affectedPlayerId: params.playerId });  } catch (err) {    logger.error("Failed to update Cloud Save data", { "error.message": err.message }, { "affectedPlayerId": params.playerId });    throw err;  }};// Uncomment the code below to enable the inline parameter definition// - Requires Cloud Code JS dev environment setup with NodeJS (https://docs.unity3d.com/Packages/com.unity.services.cloudcode@latest/index.html?subfolder=/manual/Authoring/javascript_project.html)//// module.exports.params = {//   playerId: { type: "String", required: true },// };

playerId

Cloud Code Script Publisher

Cloud Code Editor

トリガーの設定

signed-up

new-file

ugs triggers new-file triggers-config

triggers-config.tr

{  "$schema": "https://ugs-config-schemas.unity3d.com/v1/triggers.schema.json",  "Configs": [    {      "Name": "initialize-new-player",      "EventType": "com.unity.services.player-auth.signed-up.v1",      "ActionUrn": "urn:ugs:cloud-code:InitializeNewPlayer",      "ActionType": "cloud-code"    }  ]}

triggers-config.tr

{  "$schema": "https://ugs-config-schemas.unity3d.com/v1/triggers.schema.json",  "Configs": [    {      "Name": "initialize-new-player",      "EventType": "com.unity.services.player-auth.signed-up.v1",      "ActionUrn": "urn:ugs:cloud-code:ModuleSample/InitializeNewPlayer",      "ActionType": "cloud-code"    }  ]}

ugs deploy triggers-config.tr

Deployed:triggers-config.tr

結果の検証

signed-up

1. Unity Dashboard に移動します。
2. Products (製品) > Player Management (プレイヤー管理) を選択します。
3. リストからプレイヤーの 1 人を選択します。
4. Cloud Save > Data (データ) タブに移動します。

5. HEALTH

   および

   STAMINA

   キーが初期値の

   100

   とともに表示されます。