みなさん、こんにちは！
タカハシ(@ntakahashi0505)です。
Google Apps ScriptでBotを作成しながら、GASプログラミングの基礎を学ぶシリーズをお送りしています。
前回の記事はこちらです。
GASのスクリプト実行時の認証についてお伝えしました。
さて、これまでの記事では、基礎中の基礎過ぎて、Botの香りは全然なかったんですが、今回からようやくBotっぽさ出していきますよ！
今回は、GASでスプレッドシートを操作していく際に知っておくべき、オブジェクトとその基礎についてお伝えします。
また、グローバルオブジェクトSpreadsheetAppについて、そして、アクティブなスプレッドシートを取得する方法もお伝えしますよ。
では、行ってみましょう！
作成するBotの説明
まず、どんなBotを作成するのかについて説明をしておきますね。
以下のようなスプレッドシートを用意しました。
Image may be NSFW.
Clik here to view.
珠玉の名言を集めたリストです。
これらのリストの中から、何かしらかの法則で一つを選んで、チャットワークやSlackなどのチャットサービスに定期的に送信するBotツールの作成を目指したいと思います。
オブジェクトとは
GASでは、スプレッドシートをはじめ各サービスの操作対象とするモノを「オブジェクト」と言います。
スプレッドシートを取り扱うSpreadsheetサービスでは、以下のようなオブジェクトとそれを操作するための命令であるメソッドが用意されています。
- スプレッドシート：Spreadsheetオブジェクト
- シート：Sheetオブジェクト
- セル範囲：Rangeオブジェクト
Spreadsheetオブジェクト・Sheetオブジェクト・Rangeオブジェクト
例えば、3行目のアインシュタインの名言を送りたいとします。
その場合、まずスプレッドシート「名言Bot」のシート「シート1」のA3セルの値を取得するという処理をする必要があります。
オブジェクトへの操作という視点で、この操作を表現すると以下のようになります。
- スプレッドシート「名言Bot」をSpreadsheetオブジェクトとして取得する
- そのSpreadsheetオブジェクトの配下にあるシート「シート1」をSheetオブジェクトとして取得する
- そのSheetオブジェクトの配下にあるA3セルをRangeオブジェクトとして取得する
- そのRangeオブジェクトの値を取得する
アクティブなスプレッドシートを取得する
では、具体的にそれらの処理の仕方を確認していきましょう。
まず、スプレッドシートをSpreadsheetオブジェクトとして取得します。
その方法はいくつかあるのですが、コンテナバインドスクリプトの場合、最も簡単なのはアクティブなスプレッドシートを取得するgetActiveSpreadsheetメソッドを使う方法です。
アクティブなスプレッドシートというのは、スクリプトがバインドしているスプレッドシートのことです。
なので、このメソッド一つで一意にスプレッドシートが決まるのです。
書き方はこちらです。
グローバルオブジェクトSpreadsheetAppとは
さて、「SpreadsheetApp」というのが出てきますが、これは何でしょう？
これは、Spreadsheetサービスでいうところのグローバルオブジェクトと呼ばれるものです。
スクリプトからスプレッドシートサービスの何らかのオブジェクトを操作する場合には、まずこのSpreadsheetAppオブジェクトを経由して取得しにいく必要があります。
Spreadsheetサービスの最も上位にあるオブジェクト、トップレベルのオブジェクト、オブジェクトの大親玉、そんな感じです。
アクティブなスプレッドシート名をログ出力するスクリプト
では、簡単な例を紹介しましょう。
以下のようなスクリプト作成します。
function myFunction() {
var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());
}
アクティブなスプレッドシートを取得して、それを変数ssに格納します。
その変数を使って、取得したスプレッドシート名をログ出力するというものです。
getNameメソッドはその名の通り、スプレッドシート名を取得するメソッドです。
実行すると、以下のように、スプレッドシート名「名言Bot」がログ出力として得られます。
Image may be NSFW.
Clik here to view.
まとめ
以上、Google Apps Scriptでスプレッドシートを操作する際の「オブジェクト」の基礎中の基礎についてお伝えしました。
- オブジェクトとは何か
- Spreadsheetサービスで取り扱えるオブジェクト（Spreadsheetオブジェクト、Sheetオブジェクト、Rangeオブジェクト）
- グローバルオブジェクトSpreadsheetAppとは
- アクティブなスプレッドシートを取得するgetActiveSpreadsheetメソッド
などなど、いずれも超重要項目ですね…！
ぜひバッチリ押さえておいてください。
では次回、今回の続きで、シートの取得の方法についてお伝えします。
どうぞお楽しみに！