Google Apps Scriptでスプレッドシートのデータの１行分を表すクラスを作る方法

photo credit: Jonas Hellebuyck Vinyl memories via photopin (license)

みなさん、こんにちは！
タカハシ(@ntakahashi0505)です。

「初心者でもわかるGoogle Apps Scriptのクラスの作り方」をテーマにシリーズをお送りしています。

前回の記事はこちら。

Google Apps Scriptでクラスに最も簡単なメソッドを追加する方法

「初心者でもわかるGoogle Apps Scriptのクラスを作ろう！」のシリーズをお送りしています。今回はGASでクラスに最も簡単なメソッドを追加する方法です。プロトタイプについても解説していますよ。

GASのクラスにメソッドを追加する方法についてお伝えしました。

今回は、当初目標にしていたスプレッドシートのデータのクラス化を進めていきたいと思いますよ。

Google Apps Scriptでスプレッドシートのデータの１行分を表すクラスを作る方法です。

では、行ってみましょう！

前回のおさらい
スプレッドシートの一行分を表すクラスを作る
1. 見出しごとにプロパティを作る
2. コンストラクタに一行分の配列を渡す
スプレッドシートの一行分のデータをクラス化するスクリプト
まとめ
連載目次：初心者向けGoogle Apps Scriptでクラスを作ろう

前回のおさらい

まずは前回のおさらいからです。

作成したスクリプトはこちらでした。

function myFunction() {
  
  var Person = function(name){
    this.name = name;
  };
  
  Person.prototype.greet = function(){
    Browser.msgBox(this.name + "です、こんにちは！");
  };

  var p = new Person("Bob");
  Logger.log(p);
  p.greet();
  
  var q = new Person("Tom");
  Logger.log(q);
  q.greet();
 
}

function myFunction() {

var Person = function(name){

this.name = name;

};

Person.prototype.greet = function(){

Browser.msgBox(this.name + "です、こんにちは！");

};

var p = new Person("Bob");

Logger.log(p);

p.greet();

var q = new Person("Tom");

Logger.log(q);

q.greet();

}

nameプロパティと、greetメソッドを持つクラスPersonを作成しましたね。

スプレッドシートの一行分を表すクラスを作る

さて、以下のようなスプレッドシートのデータがあります。

前述のクラスPersonを拡張して、これらのデータの一行分を表すクラスを作成していきたいというのが今回のお題となります。

見出しごとにプロパティを作る

スプレッドシートの表の見出しとして、id、name、gender、birthdayとありますので、これをそのままプロパティ名として流用すれば良さそうですよね。

例えば、こんな感じでしょうか。

var Person = function(id, name, gender, birthday){
  this.id = id;
  this.name = name;
  this.gender   = gender;
  this.birthday = birthday;
};

var Person = function(id, name, gender, birthday){

this.id = id;

this.name = name;

this.gender = gender;

this.birthday = birthday;

};

すると、インスタンスの生成は…

var p = Person('a01', 'Bob', 'male', new('1993/1/1'));

1	var p = Person('a01', 'Bob', 'male', new('1993/1/1'));

うん、めんどい。

バラバラではなくて、まとめてコンストラクタにデータを渡したいですよね。

コンストラクタに一行分の配列を渡す

GASの場合は、スプレッドシートのデータをいい感じに二次元配列に取得することができます。

【初心者向けGAS】スプレッドシートのセル範囲の値を二次元配列として取得して取り扱う方法

Google Apps Script初心者向けのお題として、名言Botの作り方をお伝えしています。今回は、スプレッドシートのセル範囲の値を二次元配列としてgetValuesで取得して取り扱う方法です。

この二次元配列から、要素である一次元配列を取り出すと、それが行のデータの集合となっているわけです。

なので、コンストラクタを以下のように、行のデータの集合である配列recordを受け取るようにしてみましょう。

var Person = function(record){
  this.id = record[0];
  this.name = record[1];
  this.gender   = record[2];
  this.birthday = record[3];
};

var Person = function(record){

this.id = record[0];

this.name = record[1];

this.gender = record[2];

this.birthday = record[3];

};

すると、インスタンスの生成は

var p = Person(values[1]);

1	var p = Person(values[1]);

などと書けます。

スッキリしてて良い感じです。

たまたま、スプレッドシートのデータの列が増えても、コンストラクタさえ変更すれば、インスタンスの生成はそのままでいきそうですしね。

スプレッドシートの一行分のデータをクラス化するスクリプト

では、上記をもとにまとめと動作確認をするスクリプトです。

こちらです。

function myFunction() {  
  
  var Person = function(record){
    this.id = record[0];
    this.name = record[1];
    this.gender = record[2];
    this.birthday = record[3];
  };
  
  Person.prototype.greet = function(){
    Browser.msgBox(this.name + "です、こんにちは！");
  };
  
  Person.prototype.log = function(){
    Logger.log('%s|%s|%s|%s|', this.id, this.name, this.gender, this.birthday);
  };

  var values = SpreadsheetApp.getActiveSheet().getDataRange().getValues();
  var p = new Person(values[1]);
  p.log();
  p.greet();
  
  var q = new Person(values[2]);
  q.log()
  q.greet();
   
}

function myFunction() {

var Person = function(record){

this.id = record[0];

this.name = record[1];

this.gender = record[2];

this.birthday = record[3];

};

Person.prototype.greet = function(){

Browser.msgBox(this.name + "です、こんにちは！");

};

Person.prototype.log = function(){

Logger.log('%s|%s|%s|%s|', this.id, this.name, this.gender, this.birthday);

};

var values = SpreadsheetApp.getActiveSheet().getDataRange().getValues();

var p = new Person(values[1]);

p.log();

p.greet();

var q = new Person(values[2]);

q.log()

q.greet();

}

Personのインスタンスが持つデータを確認するためのlogメソッドも作ってみました。

実行すると、BobさんとTomさんの分について、以下のようにメッセージダイアログが表示されつつ

以下のように、インスタンスが持つデータのログを確認することができます。

まとめ

以上、Google Apps Scriptでスプレッドシートのデータの１行分を表すクラスを作る方法をお伝えしました。

GASではスプレッドシートのデータが二次元配列で取得できますので、その要素である一次元配列としてコンストラクタに渡してあげる形にすれば良いですね。

次回は、プロパティをプライベートにする方法についてお伝えしていきます。

Google Apps Scriptのクラスでプライベートプロパティを作成する方法

「初心者でもわかるGoogle Apps Scriptでクラスを作ろう！」をシリーズでお送りしております。今回は、Google Apps Scriptのクラスでプライベートプロパティを作成する方法です。

どうぞお楽しみに！

連載目次：初心者向けGoogle Apps Scriptでクラスを作ろう

使いどころやそのメリットが分かりづらいGASの「クラス」。本シリーズでは、初心者でもわかるように「これでもか！」とじっくり着実にクラスとそのメリットについて解説をしていきます。

　　投稿者プロフィール

タカハシノリアキ株式会社プランノーツ　代表取締役

株式会社プランノーツ代表、コミュニティ「ノンプロ研」主宰。1976年こどもの日生まれ。東京板橋区在住。「ITで日本の『働く』の価値を上げる！」をテーマに、VBA＆GASの開発、講師、執筆などをしております。→詳しいプロフィールはコチラ
★ご依頼・ご相談はお気軽にどうぞ！→お問い合わせはコチラ
★フォロー頂ければ嬉しいです。