Unity SDK のチュートリアル

Unity からの Cloud Save の使用

1. Unity 内で C# MonoBehaviour スクリプトを作成します。
2. Cloud Save との間でデータを保存/ロードするコードを追加します (以下の例を参照してください)。
3. 新しく作成したスクリプトをゲームオブジェクトにアタッチします。
4. Play (再生) を選択してプロジェクトを実行し、Cloud Save の動作を体験します。

SDK サンプル

CloudSaveSample

認証の例

using UnityEngine;using Unity.Services.Core;using Unity.Services.Authentication;using Unity.Services.CloudSave;using Unity.Services.CloudSave.Models;using Unity.Services.CloudSave.Models.Data.Player;using SaveOptions = Unity.Services.CloudSave.Models.Data.Player.SaveOptions;using System.Collections.Generic;public class CloudSaveSample : MonoBehaviour{    private async void Awake()    {        await UnityServices.InitializeAsync();        await AuthenticationService.Instance.SignInAnonymouslyAsync();    }    public async void SaveData()    {        var playerData = new Dictionary<string, object>{          {"firstKeyName", "a text value"},          {"secondKeyName", 123}        };        await CloudSaveService.Instance.Data.Player.SaveAsync(playerData);        Debug.Log($"Saved data {string.Join(',', playerData)}");    }    public async void LoadData()    {        var playerData = await CloudSaveService.Instance.Data.Player.LoadAsync(new HashSet<string> {          "firstKeyName", "secondKeyName"        });        if (playerData.TryGetValue("firstKeyName", out var firstKey)) {            Debug.Log($"firstKeyName value: {firstKey.Value.GetAs<string>()}");        }        if (playerData.TryGetValue("secondKeyName", out var secondKey)) {            Debug.Log($"secondKey value: {secondKey.Value.GetAs<int>()}");        }    }}

プレイヤーデータ

項目を保存する

SaveAsync

public async void SaveData(){    var data = new Dictionary<string, object>{{"keyName", "value"}};    await CloudSaveService.Instance.Data.Player.SaveAsync(data);}

public async void SavePublicData(){    var data = new Dictionary<string, object>{{"keyName", "value"}};    await CloudSaveService.Instance.Data.Player.SaveAsync(data, new SaveOptions(new PublicWriteAccessClassOptions()));}

データをフェッチする

LoadAsync

public async void LoadData(){    var playerData = await CloudSaveService.Instance.Data.Player.LoadAsync(new HashSet<string>{"keyName"});    if (playerData.TryGetValue("keyName", out var keyName)) {        Debug.Log($"keyName: {keyName.Value.GetAs<string>()}");    }}

public async void LoadPublicData(){  var playerData = await CloudSaveService.Instance.Data.Player.LoadAsync(new HashSet<string>{"keyName"}, new LoadOptions(new PublicReadAccessClassOptions()));  if (playerData.TryGetValue("keyName", out var keyName)) {      Debug.Log($"keyName: {keyName.Value.GetAs<string>()}");  }}

public async void LoadProtectedData(){  var playerData = await CloudSaveService.Instance.Data.Player.LoadAsync(new HashSet<string>{"keyName"}, new LoadOptions(new ProtectedReadAccessClassOptions()));  if (playerData.TryGetValue("keyName", out var keyName)) {      Debug.Log($"keyName: {keyName.Value.GetAs<string>()}");  }}

public async void LoadPublicDataByPlayerId(){  var playerId = "JE1unrWOOzzbIwy3Nl60fRefuiVE";  var playerData = await CloudSaveService.Instance.Data.Player.LoadAsync(new HashSet<string>{"keyName"}, new LoadOptions(new PublicReadAccessClassOptions(playerId)));  if (playerData.TryGetValue("keyName", out var keyName)) {      Debug.Log($"keyName: {keyName.Value.GetAs<string>()}");  }}

項目を削除する

DeleteAsync

public async void DeleteData(){    await CloudSaveService.Instance.Data.Player.DeleteAsync("key");}

キーのリストを取得する

ListAllKeysAsync

public async void ListKeys(){    var keys = await CloudSaveService.Instance.Data.Player.ListAllKeysAsync();    for (int i = 0; i < keys.Count; i++)    {        Debug.Log(keys[i].Key);    }}

public async void ListKeys(){    var keys = await CloudSaveService.Instance.Data.Player.ListAllKeysAsync(      new ListAllKeysOptions(new PublicReadAccessClassOptions())    );    for (int i = 0; i < keys.Count; i++)    {        Debug.Log(keys[i].Key);    }}

public async void ListKeys(){    var keys = await CloudSaveService.Instance.Data.Player.ListAllKeysAsync(      new ListAllKeysOptions(new ProtectedReadAccessClassOptions())    );    for (int i = 0; i < keys.Count; i++)    {        Debug.Log(keys[i].Key);    }}

プレイヤーデータに対してクエリを実行する

public async void QueryPlayerData(){  var query = new Query(    // The first argument to Query is a list of one or more filters, all must evaluate to true for a result to be included    new List<FieldFilter>    {        new FieldFilter("indexedKeyName", "value", FieldFilter.OpOptions.EQ, true),        new FieldFilter("anotherIndexedKeyName", "otherValue", FieldFilter.OpOptions.NE, true)    },    // The second (optional) argument is a list of keys you want to be included with their values in the response    // This may include keys which are not part of the index, and does not need to include the index keys    // If you don't specify any, you will still get back a list of IDs for Players that matched the query    new HashSet<string>    {        "indexedKeyName"    }  );  var results = await CloudSaveService.Instance.Data.Player.QueryAsync(query, new QueryOptions());  Debug.Log($"Number of results from query: {results.Count}");  results.ForEach(r =>  {      Debug.Log($"Player ID: {r.Id}");      r.Data.ForEach(d => Debug.Log($"Key: {d.Key}, Value: {d.Value.GetAsString()}"));  });}

ゲームデータ

データをフェッチする

LoadAllAsync

public async void LoadCustomItemData(){  var customItemId = 'my-custom-item';  var customItemData = await CloudSaveService.Instance.Data.Custom.LoadAllAsync(customId);  foreach (var customItem in customItemData)  {      Debug.Log($"Key: {customItem.Key}, Value: {customItem.Value.Value}");  }}

カスタム項目に対してクエリを実行する

public async void QueryCustomItems(){  var query = new Query(    // The first argument to Query is a list of one or more filters, all must evaluate to true for a result to be included    new List<FieldFilter>    {        new FieldFilter("indexedKeyName", "value", FieldFilter.OpOptions.EQ, true),        new FieldFilter("anotherIndexedKeyName", "otherValue", FieldFilter.OpOptions.NE, true)    },    // The second (optional) argument is a list of keys you want to be included with their values in the response    // This may include keys which are not part of the index, and does not need to include the index keys    // If you don't specify any, you will still get back a list of IDs for Players that matched the query    new HashSet<string>    {        "indexedKeyName"    }  );  var results = await CloudSaveService.Instance.Data.Custom.QueryAsync(query);  Debug.Log($"Number of results from query: {results.Count}");  results.ForEach(r =>  {      Debug.Log($"Custom Item ID: {r.Id}");      r.Data.ForEach(d => Debug.Log($"Key: {d.Key}, Value: {d.Value.GetAsString()}"));  });}

プレイヤーファイル

プレイヤーファイルを保存する

SaveAsync

public async void SavePlayerFile(){    byte[] file = System.IO.File.ReadAllBytes("fileName.txt");    await CloudSaveService.Instance.Files.Player.SaveAsync("fileName", file);}

プレイヤーファイルを削除する

DeleteAsync

public async void DeletePlayerFile(){    await CloudSaveService.Instance.Files.Player.DeleteAsync("fileName");}

プレイヤーファイルをリスト表示する

ListAllAsync

public async void ListPlayerFiles(){    List<FileItem> files = await CloudSaveService.Instance.Files.Player.ListAllAsync();    for (int i = 0; i < files.Count; i++)    {        Debug.Log(files[i]);    }}

プレイヤーファイルをバイト配列として取得する

LoadBytesAsync

public async void GetPlayerFileAsByteArray(){    byte[] file = await CloudSaveService.Instance.Files.Player.LoadBytesAsync("fileName");}

プレイヤーファイルをストリームとして取得する

LoadStreamAsync

public async void GetPlayerFileAsStream(){    Stream file = await CloudSaveService.Instance.Files.Player.LoadStreamAsync("fileName");}

プレイヤーファイルのメタデータを取得する

GetMetadataAsync

public async void GetPlayerFileMetadata(){    var metadata = await CloudSaveService.Instance.Files.Player.GetMetadataAsync("fileName");    Debug.Log(metadata.Key);    Debug.Log(metadata.Size);    Debug.Log(metadata.ContentType);    Debug.Log(metadata.Created);    Debug.Log(metadata.LastModified);    Debug.Log(metadata.WriteLock);}

エラー処理