GoogleSpreadSheetを使ってマスタデータを管理する

f:id:flat-M_M:20201205093419p:plain

ゲームのマスタデータをゲームのIDE外で管理する方法を模索している中、GoogleSpreadSheetが結構良かったので方法をまとめてみます。

マスタデータとは
目指すもの
カバーしない範囲
手順
- スプレッドシートにマスタデータを入力する
- JSON形式で返してくれるAPIを作成する
アクセス可能なAPIとして公開する
最後に

マスタデータとは

マスタデータとは、ゲーム内のアイテム名や説明文など、プレイ中に変化することのない固定のデータと定義してお話を進めていきます。

目指すもの

今回作りたいものの理想状態は、チーム開発をする際にエンジニア以外の人がパラメータをいじってそのまま実機で確認できる環境の構築を目指しました。

カバーしない範囲

下記の点については、今回は扱っていません。

複数のdev環境に合わせたマスタデータの公開
複雑な入れ子などが存在するJSONデータの作成
開発環境のみを想定し、本番環境で運用のマスタデータサーバとしての使用は想定しません

手順

スプレッドシートにマスタデータを入力する
スプレッドシートのデータをJSON形式で返してくれるAPIを作成する

スプレッドシートにマスタデータを入力する

例えば、ショップに並ぶアイテムのデータを管理するとします。

今回だと写真のようなデータを入力しておきました。

シート名は「ショップマスター」に設定してあります。

f:id:flat-M_M:20201205093828p:plain

JSON形式で返してくれるAPIを作成する

スプレッドシートの内容を読み込み、JSON形式に整形して返してくれるAPIを作成します。

まずは、スプレッドシートの「ツール」→「スクリプトエディタ」を選択します。

f:id:flat-M_M:20201205093958p:plain

すると、GoogleAppScript(GAS)を記述できる画面が表示されます。

そこに下記のコードをコピペしてください。

// エントリーポイント
function doGet(e) {
  // クエリqに該当する文字列を取得する
  var sheetName = e.parameter.q;
  var response;
  if (sheetName == "ショップマスター") {
    // 1行1列目から6列分のデータを最後まで取得する
    response = getRangeFromSheet("ショップマスター", 1, 1, 6);
  }
  // JSON形式でレスポンスを返す
  return ContentService.createTextOutput(JSON.stringify(response, null, 2)).setMimeType(ContentService.MimeType.JSON);
}

// 特定のシートからJSON形式のデータを取得する関数
function getRangeFromSheet(sheetName, start_row, start_column, end_column) {
  // 特定のシートを選択する
  var sheet = SpreadsheetApp.getActive().getSheetByName(sheetName);
  
  // 行の一覧を取得する
  var rows = sheet.getRange(start_row, start_column, sheet.getLastRow(), end_column).getValues();
  
  // 一行目はJSONのキーに設定するため取り出しておく
  var keys = rows.splice(0, 1)[0];
  
  // 取得した行一覧を一つずつ見て、JSONデータを構築していく
  var obj = rows.map(function(row) {
    var temp = {};
    row.map(function(item, index) {
      // Boolean判定
      if (String(item) == "TRUE" || String(item) == "FALSE") {
        temp[String(keys[index])] = String(item) == "TRUE";
      } 
      // isNumber判定
      else if ((typeof item === 'number') && isFinite(item)) {
        temp[String(keys[index])] = parseInt(item);
      } 
      // それ以外
      else {
        temp[String(keys[index])] = String(item);
      }
    });
    return temp;
  });
  return obj;
}

コードの解説はコメントを読んで頂けると、大体何をしているかは理解できるかと思います。

getRangeFromSheetさえ実装しておけば、あとはページが増えても柔軟にデータを取得できます。