【GoogleAppsScript】Spreadsheetサービスの「オブジェクト」

2020年9月28日 22:19

GASでスプレッドシートを操作していく際に知っておくべき、オブジェクトのお話

オブジェクトとはなに？

スプレッドシートをはじめ各サービスの操作対象とするモノを「オブジェクト」と呼びます

スプレッドシートを取り扱うSpreadsheetサービスでは、以下のようなオブジェクトが用意されています

スプレッドシート：Spreadsheetオブジェクト
シート：Sheetオブジェクト
セル範囲：Rangeオブジェクト

それらを操作するために、メソッドと呼ばれる命令があります

スプレッドシートをSpreadsheetオブジェクトを取得します

方法はいくつかありますが、コンテナバインドスクリプトの場合、最もかんたんなのはアクティブなスプレッドシートを取得するgetActiveSpreadsheetメソッドを使う。

アクティブなスプレッドシートというのは、スクリプトがバインドしているスプレッドシートのことです。

このメソッド1つで一意にスプレッドシートが決まるのです。

書き方は

SpreadsheetApp.getActiveSpreadsheet()

さて「SpreadsheetApp」とは？

これは、Spreadsheetサービスでいうところのトップレベルのオブジェクトと呼ばれるものです。

スクリプトからスプレッドシートサービスのなんらかのお武家ウトを操作する場合には、まずこのSpreadsheetAppオブジェクトを経由して取得しにいく必要があります。

Spreadsheetサービスの最も上位にあるオブジェクトになります。

例

function myFunciton() {
   const ss = SpreadsheetApp.getActiveSpreadsheet();
   console.log(ss.getName());
}

アクティブなスプレッドシートを取得して、それを変数ssに格納します。

その変数を使って、取得したスプレッドシート名をログ出力する。

getNameメソッドはその名の通り、スプレッドシート名を取得するメソッド。

Spreadsheetオブジェクト.getName()

実行すると、スプレッドシート名をログ出力として得られます。

スプレッドシート名が「スプレッドシート名」という名前の場合。

赤枠部分の名前を取得して出力結果に表示します。

この記事が気に入ったらサポートをしてみませんか？