GASを使ってやってみたいことが増えてきたので、勉強していた中で、スプレッドシートを弄るときに利用するメソッドの一覧を復習も兼ねてまとめていこうかと思います。
メソッド一覧
getActiveSpreadsheet()
GASと連動しているアクティブなスプレッドシートを取得するためのメソッド。
getSheetByName()
スプレッドシートの中にある、シートというオブジェクトを取り出すためのメソッドです。(下の写真の赤い丸で囲った部分です。
getName()
シート名を取得するためのメソッド。
SpreadsheetApp.getActiveSheet()
こちらのメソッドはアクティブなシートを取得するためのメソッドです。利用するシートが一枚のみであればこちらの方法は有効。シート名自体はユーザーが自分で変えることも出来るため、getSheetByNameだと、名称変更があった際にうまく動かなくなる。
getRange()
シートの中の行数や列数を取得するためのメソッド。シートの指定の仕方は行と列を数値で指定するケースとA列○行目(E3などのように)で指定するケースがあります。
Sheetオブジェクト.getRange(行番号, 列番号, 行数, 列数)
行番号と列番号は、○行目の○列目という指定の仕方をする。例えば下記の写真の赤で塗りつぶした部分を取得するには、5行目の3列目なので、('5,3')として指定する。
行数と列数に関しては、前半で指定したセルを起点とし、左右にどれだけの範囲で取得したいのかを取得します。C5のセルから、7行目E列までを取得したい場合は、行数が3行で、列数も3列なので、('3,3')と書きます。
したがって今回の場合は下のように記載します。
Sheetオブジェクト.getRange('5, 3, 3, 3')
2つ目の足り方としては、5行目3列目を指定する場合は、C5と入れたり、範囲を入れる際は左上と右下のアドレスを下記のように入れます。
sheetオブジェクト.getRange('C5:E7')
getA1Notation()
getRangeメソッドで取得した範囲のアドレスを取得するためのメソッド。
clear()
clearメソッドは指定したRangeオブジェクトの内容をすべて削除するメソッドです。書き方は以下です。
Rangeオブジェクト.clear()
ただclearメソッドを使ってしまうと、セルの範囲内のセルのすべてをクリアしてしまいます。消したい内容が、セルの中の値だけであれば、clearContentメソッドを使います。
getValue()
セルの値を取得するメソッド。例えば5行目3列目の情報が欲しければ、sheetオブジェクト.getValue('C5')と書く。複数の値を範囲指定して出す場合は`sheetオブジェクト.getValues('C5:E7')と記載します。
getLastRow()
最後の行を検知するためのメソッド。
Sheetオブジェクト.getLastRow()
と指定すると、シートにある最終行を獲得することが出来ます。
setValue()
getValueメソッドがスプレッドシートから値を取得するメソッドで有ることに対し、setValueメソッドでは、スプレッドシートのセルに値を入力するメソッドです。書き方はいかになります。
Rangeオブジェクト.setValue()