スプレッドシートのシート別の情報を異なるスクリプタブル・オブジェクトに取り込む - i-school

　Google の SpreadSheet(スプレッドシート。以下、GSS とします)のシートの情報を１シートにつき、１つのスクリプタブル・オブジェクトに取り込む方法について学習します。

　こちらの記事を参考に作成しています。ありがとうございます。

ドクロモエ様
【Unity】Google スプレッドシートから直接データを読む方法
https://dokuro.moe/unity-how-to-import-google-spre...

　非同期処理についてはコルーチンを利用していますが、UniTask(async/await)を利用した実装方法の教材もあります。
そちらを利用した実装を行いたい場合には、この教材を最後まで進めていただき、終了後に別の教材へ移行してください。(最後にリンクがあります)

事前準備

　スプレッドシートの情報を Unity 内に取り込んで利用できる状態にするため、
スプレッドシートの内容をクラスとして作成し、それをスクリプタブル・オブジェクトとして管理できるようにしておきます。

SkillData スクリプトを作成する

　これはサンプルです。ご自分のデータの内容に合わせて適宜変更をお願いします。

　クラスの名称はスプレッドシートのシート名と同じにしておきます。
宣言する変数はすべて public 修飾子とし、スプレッドシートの項目と同じ内容で設定します。

スプレッドシートのシート名

スプレッドシートの項目名

SkillData.cs

　<=　クリックすると開きます

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System;

/// <summary>
/// スキルの種類
/// </summary>
public enum SkillType {
    Fire,
    Ice,
    Thunder,
    Wind
　　// 他にもあれば追加

}

[Serializable]
public class SkillData
{
    public int id;
    public int skillNo;
    public SkillType skillType;
    public int weight;
    public int skillPower;
    public int criticalRate;
    public string skillName;


    /// <summary>
    /// コストラクタ
    /// </summary>
    /// <param name="datas"></param>
    public SkillData(string[] datas) {

        // 取得した情報の確認
        for (int i = 0; i < datas.Length; i++) {
            Debug.Log(datas[i]);
        }

        // 取得した情報をキャストして代入
        id = int.Parse(datas[0]);
        skillNo = int.Parse(datas[1]);
        skillType = (SkillType)Enum.Parse(typeof(SkillType),datas[2]);
        weight = int.Parse(datas[3]);
        skillPower = int.Parse(datas[4]);
        criticalRate = int.Parse(datas[5]);
        skillName = datas[6];
    }
}

　スプレッドシートからの情報をすべて文字列として取得して利用する形になります。
そのため、各シート用のクラスにはコンストラクタ・メソッドを用意し、string[] 配列の形で引数を受け取って
文字列以外のデータ型については、それをキャストしてから変数に代入する処理を記述します。

SkillDataSO スクリプトを作成する

　作成した SkillData クラスをスクリプタブル・オブジェクトとして活用できるようにします。

SkillDataSO.cs

　<=　クリックすると開きます

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

[CreateAssetMenu(menuName = "Create SkillDataSO", fileName ="SkillDataSO")]
public class SkillDataSO : ScriptableObject
{
    public List<SkillData> skillDatasList = new ();
}

　完成したら、スクリプタブル・オブジェクトのアセットを作成しておいてください。
Size は 0 で問題ありません。

DataBaseManager スクリプトを作成する

　作成したスクリプタブル・オブジェクト(アセット)を変数として登録し、ゲーム内で利用できる状態にするクラスをシングルトンクラスとして作成します。

DataBaseManager.cs

　<=　クリックすると開きます

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System.Linq;

public class DataBaseManager : MonoBehaviour
{
    public static DataBaseManager instance;

    public SkillDataSO skillDataSO;


    void Awake() {
        if (instance == null) {
            instance = this;
            DontDestroyOnLoad(gameObject);
        } else {
            Destroy(gameObject);
        } 
    }
}

　完成したら、空のゲームオブジェクトを作成し、名前を DataBaseManager に変更し、このスクリプトをアタッチしてください。

　インスペクターより変数にスクリプタブル・オブジェクト(アセット)をドラッグアンドドロップしてアサインして登録し、利用できる状態にしてください。

スプレッドシートを読み込んでスクリプタブル・オブジェクトに取り込むための処理を作成する

　２つのクラスを作成します。
GSSReader クラスでは、スプレッドシートのシートへアクセスして情報を取得します。
GSSReciver クラスでは GSSReacer クラスが取得した情報をスクリプタブル・オブジェクトへと取り込む処理を行います。

　参考にさせていただいている記事を元に作成していますので、処理の大筋は変わりませんが、
こちらでは、１つのスプレッドシートの複数のシートから複数のスクリプタブル・オブジェクトへの取り込み処理を行えるように修正しています。

GSSReader スクリプトを作成する

　スプレッドシートにアクセスし、シート内の情報をシートごとに取得しておくためにクラスです。
取得した情報は SheetData クラスに保持し、配列としておくことで複数のシートの情報を保持しています。

GSSReader.cs

　<=　クリックすると開きます

using System.IO;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Networking;
using UnityEngine.Events;

/// <summary>
/// シート名の登録用
/// </summary>
public enum SheetName {
    None,        // 自分の作成したスプレッドシート内のシートの名前を登録します
　　CardData,
    SkillData,
    ItemData,
    EventData

}

/// <summary>
/// 読み込むシートのデータ群。シートの情報を管理します
/// </summary>
[System.Serializable]
public class SheetData {
    public SheetName SheetName;
    public List<string[]> DatasList = new List<string[]>();
}

/// <summary>
/// スプレッドシートのデータを取得してシート別に解析します
/// 解析が終了したら、OnLoadEnd に登録したメソッドを呼び出します
/// 解析結果は SheetData クラスの DatasList 変数からシートごとに取得
/// </summary>
public class GSSReader : MonoBehaviour {

    public string SheetID = "読み込むスプレッドシートのアドレス";

    public UnityEvent OnLoadEnd;　　　// この変数にインスペクターからメソッドを登録しておくと、スプレッドシートを読み込み後にコールバックする

    [Header("読み込みたいシート名を選択")]
    public SheetData[] sheetDatas;

    public void Reload() => StartCoroutine(GetFromWeb());


    public IEnumerator GetFromWeb() {

        // 複数のシートの読み込み
        for (int i = 0; i < sheetDatas.Length; i++) {

            // シート名だけ毎回読み込み先を変更する
            string url = "https://docs.google.com/spreadsheets/d/" + SheetID + "/gviz/tq?tqx=out:csv&sheet=" + sheetDatas[i].SheetName.ToString();

            // Web の GoogleSpreadSheet を取得
            UnityWebRequest request = UnityWebRequest.Get(url);

            // 取得できるまで待機
            yield return request.SendWebRequest();
            Debug.Log(request.downloadHandler.text);

            // エラーが発生しているか確認
            bool protocol_error = request.result == UnityWebRequest.Result.ProtocolError ? true : false;
            bool connection_error = request.result == UnityWebRequest.Result.ConnectionError ? true : false;

            // エラーがある場合
            if (protocol_error || connection_error) {

　　　　　　　　// エラー表示を行い、処理を終了する
                Debug.LogError(request.error);
                yield break;
            }

            // GSS の各シートごとのデータを List<string[]> の形で取得
            sheetDatas[i].DatasList = ConvertToArrayListFromCSV(request.downloadHandler.text);
        }

        // GSSLoader のメソッドを登録しておいて実行する
        OnLoadEnd.Invoke();
    }

    /// <summary>
    /// 取得した GoogleSpreadSheet(GSS) の CSV ファイルの情報を ArrayList 形式に変換
    /// </summary>
    /// <param name="text"></param>
    /// <returns></returns>
    private List<string[]> ConvertToArrayListFromCSV(string text) {
        StringReader reader = new StringReader(text);
        reader.ReadLine();  // 1行目はヘッダー情報なので、読み込んで何もしないで読み飛ばす

        List<string[]> rows = new List<string[]>();

        while (reader.Peek() >= 0) {  // Peek メソッドを使うと戻り値の値によりファイルの末尾まで達しているか確認できる。末尾になると -1 が戻るので、そうなるまで繰り返す
            string line = reader.ReadLine();        // 一行ずつ読み込み
            string[] elements = line.Split(',');    // 行のセルは,で区切られているので、それを分割して１文字ずつの情報が入った配列にする

            for (int i = 0; i < elements.Length; i++) {　　// 1文字ずつ取り出す
                if (elements[i] == "\"\"") {
                    continue;                       // 取り出した文字が空白である場合は除去
                }
                elements[i] = elements[i].TrimStart('"').TrimEnd('"');  // 文字の最初と最後にある "" を削除する
                //Debug.Log(elements[i]);
            }
            rows.Add(elements);
        }
        return rows;
    }
}

GSSReceiver スクリプトを作成する

　スプレッドシートから取得したデータが GSSReacer クラスの SheetData 配列変数内に格納されているので、
それをシート単位で任意のスクリプタブル・オブジェクトに値として取り込むためのクラスです。

　処理の内容としては、こちらのクラスが起点となって GSSReacer クラスへ取得命令を出し、
取得した情報をこちらで受け取ってスクリプタブル・オブジェクトに代入しています。

GSSReceiver.cs

　<=　クリックすると開きます

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System.Linq;

/// <summary>
/// スプレッドシートから取得したデータをシート単位で任意のスクリプタブル・オブジェクトに値として取り込む
/// </summary>
[RequireComponent(typeof(GSSReader))]
public class GSSReceiver : MonoBehaviour
{
    public bool IsLoading { get; set; }　　//　プロパティのままですとインスペクターから確認できないため、一時的に変数にしてもいいでしょう


    private void Awake() {

        // GSS のデータ取得準備
        StartCoroutine(PrepareGSSLoadStart());
    }

    /// <summary>
    /// GSS のデータ取得準備
    /// </summary>
    /// <returns></returns>
    private IEnumerator PrepareGSSLoadStart() {

　　　　IsLoading = true;

        // GSS を取得して SO に取得する。その処理が終わるまでここで待機する
        yield return StartCoroutine(GetComponent<GSSReader>().GetFromWeb());

　　　　IsLoading = false;

        Debug.Log("GSS データを SO に取得");
    }

    /// <summary>
    /// インスペクターから GSSReader の OnLoadEnd にこのメソッドを追加することで GSS の読み込み完了時にコールバックされる
    /// </summary>
    public void OnGSSLoadEnd() {

        GSSReader reader = GetComponent<GSSReader>();

　　　　// スプレッドシートから取得した各シートの配列を List に変換
        List<SheetData> sheetDataslist = reader.sheetDatas.ToList();

　　　　// 情報が取得できた場合
        if (sheetDataslist != null) {

            // スクリプタブル・オブジェクトに代入(例１)
            DataBaseManager.instance.skillDataSO.skillDatasList = 
                new List<SkillData>(sheetDataslist.Find(x => x.SheetName == SheetName.SkillData).DatasList.Select(x => new SkillData(x)).ToList());

            // スクリプタブル・オブジェクトに代入(例２)
            DataBaseManager.instance.cardDataSO.cardDataList = 
                new List<CardData>(sheetDataslist.Find(x => x.SheetName == SheetName.CardData).DatasList.Select(x => new CardData(x)).ToList());

            // TODO 他の SO を追加する

        }
    }
}

Editor フォルダ

　今回参考にさせていただいているサイト内では Editor 拡張用のスクリプトが作成されています。
こちらの作成は任意です。作成しなくても問題ありませんので、不要な場合にはスキップしてください。
もしも Editor 拡張用のスクリプトを作成した場合には、Assets フォルダの直下に Editor フォルダを作成して、そちらに拡張用のスクリプトを配置してください。

　Editor 拡張用のスクリプトがある際にビルドを行うとエラーが発生します。
これは Editor 拡張用のスクリプトがビルド時に読み込まれることによって発生しています。

　Editor フォルダに Editor 拡張用のスクリプトを配置することにより、ビルド時に Editor フォルダ内のスクリプトは除かれるようになりますので
このエラーを回避することが出来るようになります。

スプレッドシートの用意

　SkillData スクリプトの変数をラベルとし、SkillData スクリプト内で宣言した変数と順番と同じ順番と同じ名前で項目と作り、値については自由に作成してください。
またシートの名称も SkillData としておいてください。

　すでにシートが用意してある場合には、下記の「表示形式」の設定だけ行ってください。

　スプレッドシートの作成時の注意点については、先ほどのサイトを参考にしてください。
特にシートの「表示形式」についてはすべてのセルを「書式なし」に変更してください。(シート全体を選択して設定してください）
また、利用していないセルは削除してください。

　再度、サンプルを提示します。
実際にはご自分のデータに合わせてクラスを作成してください。

シート名

セルの内容(1行目にラベル用の項目。SkillData スクリプト内の変数の並びと名称に合わせる)

スプレッドシート側の設定

　スプレッドシート側は GoogleDrive で対象のファイルを選択し、共有かリンクの取得を選択し、「リンクを知っている全員が閲覧可能な状態」に設定します。
リンクのシートのアドレスの末尾が usp=sharing であれば共有設定がされています。

　共有設定が行われていないと、読み込みに失敗します。

GSSConveter ゲームオブジェクトを作成し、GSSReader スクリプトと GSSReceiver スクリプトをアタッチして設定を行う

　ヒエラルキー内に新しいゲームオブジェクトを作成し、名前を GSSConveter に変更します。
GSSConveter ゲームオブジェクトに先ほど作成した GSSReader スクリプトと GSSReceiver スクリプトをアタッチします。
　
　GSSReader スクリプトの変数に情報を登録します。

　SheetID 変数にはスプレッドシートの中から該当する URL(アドレス)を登録します。
先ほどのサイトも参照してください。

登録する部分

　OnLoadEnd 変数にはメソッドを登録します。この部分に登録したメソッドが、スプレッドシートのデータを取得後に実行されます。
Editor And Runtime の設定に変更したうえで、同じゲームオブジェクトにアタッチされている GSSReceiver コンポーネントを登録し、その中から OnGSSLoadEnd メソッドを登録します。
なお設定が Runtime になっていると実行しても失敗しますので注意してください。

インスペクター画像

　上記画像の補足としまして、Editor 拡張用のスクリプトを作成していると「スプレッドシート読み込み」ボタンが表示されます。
作成していない場合には表示されません。

ゲームを実行して動作を確認する

　スプレッドシートの読み込みですが、ゲームを実行してから行わないと、スクリプタブル・オブジェクトのインスタンスがないために失敗します。
そのため、Editor 拡張を行った際のインスペクターのボタンからは事前に試さないようにしてください。

　ゲームを実行すると、自動的にスプレッドシートの読み込みと、読み込んだ情報をスクリプタブル・オブジェクトに取り込む処理が実行されます。

　SkillDataSO スクリプタブル・オブジェクトを確認し、Size が 0 ではなく、スプレッドシートの行の数分になっており、値が代入されているかを確認してください。

複数のシートの情報をそれぞれ異なるスクリプタブル・オブジェクトに取り込む

　新しくスクリプタブル・オブジェクト用のスクリプトを作成し、スクリプタブル・オブジェクトを作成してください。

　次に、スプレッドシートのシートを増やして、スクリプタブル・オブジェクトに取り込みたい情報を SkillData と同じように記述します。

　GSSConverter ゲームオブジェクトの GSSReader スクリプトの SheetDatas 変数の Size を変更し、シートの名称の列挙子を登録します。

　そして、GSSReceiver スクリプトの中に、スクリプタブル・オブジェクトの代入処理を作成してください。
SkillDataSO スクリプタブル・オブジェクトの代入処理が参考になります。

　あとはゲームを実行すれば、複数のスクリプタブル・オブジェクトに、それぞれの対応するシートの情報を取り込むことが出来ます。
スプレッドシートを読み込む GSSReader の方はインスペクターからシートの名前を設定するだけで済みます。

　以上になります。
色々と試してみてください。

　
　UniTask を利用した GSS のシートをスクリプタブル・オブジェクトに取り込む方法についてはこちらです。