【GAS入門】スプレッドシート自動化で重要な4つのクラスを理解しよう！

記事概要

前提条件

そもそもクラスとは

スプレッドシート自動化で重要な4つのクラス

1. SpreadsheetAppクラス
スプレッドシートファイルのデータを管理するクラスです。例えば、スプレッドシートファイルの作成・取得・削除などができます。
Class SpreadsheetApp | Apps Script | Google Developers
Send feedback Access and create Google Sheets files. This class is the parent class for the Spreadsheet service. RelativeDate An enumeration of relative date options for calculating a value to be used in date-based BooleanCriteria . An enumeration of value types returned by Range.getValue() and Range.getValues() from the Range class of the Spreadsheet service.
https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet-app

2. Spreadsheetクラス
スプレッドシートのデータ（シート、スプレッドシートの名前、アクセス権限など）を管理するクラスです。例えば、スプレットシートのファイル名の変更、シートの作成・取得・削除などができます。
Class Spreadsheet | Apps Script | Google Developers
Send feedback Access and modify Google Sheets files. Common operations are adding new sheets and adding collaborators. createTextFinder(findText) Returns the active cell in this sheet. Note: It's preferrable to use getCurrentCell() , which the returns the current highlighted cell.
https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet

3. Sheetクラス
シートのデータ(シート名、セルなど)を管理するクラスです。例えば、シート名の変更、行の追加・削除、選択した範囲のセルの取得などができます。
Class Sheet | Apps Script | Google Developers
Send feedback Access and modify spreadsheet sheets. Common operations are renaming a sheet and accessing range objects from the sheet. Activates this sheet. Does not alter the sheet itself, only the parent's notion of the active sheet. // This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.activate(); Return - The newly active sheet.
https://developers.google.com/apps-script/reference/spreadsheet/sheet

4. Rangeクラス
選択した範囲のセルのデータを管理するクラスです。例えば、セルの値を取得・変更することができます。
Class Range | Apps Script | Google Developers
Send feedback Access and modify spreadsheet ranges. A range can be a single cell in a sheet or a group of adjacent cells in a sheet. var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getRange('A1:D10'); range.activate(); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D10 var activeRange = selection.getActiveRange(); Return - This range, for chaining.
https://developers.google.com/apps-script/reference/spreadsheet/range

自動化例 - 株価時系列スプレッドシートの検索

概要

1. 開始日と終了日を入力して「表示する」を実行します。

2. 「開始月-開始日_終了月-終了日」の形式で指定した日付の時系列株価シートが自動生成されます。

デモ

動作確認の方法

1. 「株価時系列データ検索」のスプレッドシートを開きます↓
株価時系列データ検索
data トヨタ自動車(株) の株価時系列 https://finance.yahoo.co.jp/quote/7203.T/history 開始日,終了日 2022-09-01,〜,2022-09-30,を 日付,始値,高値,安値,終値,出来高,調整後終値* 2022/10/6,2,000,2,012,1,996.50,2,000,26,603,000,2,000 ...
https://docs.google.com/spreadsheets/d/1c_UT7-hReK9L2FP58LWwjBex-dSm0AcxXTFJXpTr_fg/edit?usp=sharing

2. 自分のGoogleドライブにコピーする
1. メニュー > ファイル > コピーを作成

3. 「表示する」をクリックすると株価検索ができます。

GASスクリプトの確認方法

1. Google Apps Scriptのコードを確認する
1. メニュー > 拡張機能 > Apps Script

GASスクリプト

GASスクリプト解説

• SpreadsheetApp.getActiveSpreadsheet()
• 現在開いているSpreadsheetクラスを取得します。
• 戻り値：Spreadsheet - 現在開いているSpreadsheetクラスのオブジェクト。
Class SpreadsheetApp | Apps Script | Google Developers
Send feedback Access and create Google Sheets files. This class is the parent class for the Spreadsheet service. RelativeDate An enumeration of relative date options for calculating a value to be used in date-based BooleanCriteria . An enumeration of value types returned by Range.getValue() and Range.getValues() from the Range class of the Spreadsheet service.
https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet-app#getActiveSpreadsheet()

• Spreadsheet.getSheetByName(name)
• 指定された名前(name)のSheetクラスを返します。
• 戻り値：Sheet - 指定した名前のシート。
Class Spreadsheet | Apps Script | Google Developers
Send feedback Access and modify Google Sheets files. Common operations are adding new sheets and adding collaborators. createTextFinder(findText) Returns the active cell in this sheet. Note: It's preferrable to use getCurrentCell() , which the returns the current highlighted cell.
https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet#getSheetByName(String)

• 検索条件

• 株価時系列

• Sheet.getRange(a1Notation)
• A1 表記または R1C1 表記で指定された範囲を返します。
• 戻り値：Range - 指定したロケーションの範囲。
Class Sheet | Apps Script | Google Developers
Send feedback Access and modify spreadsheet sheets. Common operations are renaming a sheet and accessing range objects from the sheet. Activates this sheet. Does not alter the sheet itself, only the parent's notion of the active sheet. // This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.activate(); Return - The newly active sheet.
https://developers.google.com/apps-script/reference/spreadsheet/sheet#getRange(String)

• Range.getValues()
• この範囲の値の長方形のグリッドを返します。
• 戻り値：Object[][] - 2次元の値の配列。
Class Range | Apps Script | Google Developers
Send feedback Access and modify spreadsheet ranges. A range can be a single cell in a sheet or a group of adjacent cells in a sheet. var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getRange('A1:D10'); range.activate(); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D10 var activeRange = selection.getActiveRange(); Return - This range, for chaining.
https://developers.google.com/apps-script/reference/spreadsheet/range#getValues()

• Array.prototype.filter()
• 配列の中から、提供された関数で実装されたテストに合格した要素のみを抽出したシャローコピーを作成します。
• 戻り値：「startDate <= value[0] && value[0] <= endDate」がtrueになる配列の要素。
• 補足：今回の場合だと、「開始日と終了日の範囲に入る株価時系列データ」の配列stockValuesができます。
Array.prototype.filter() - JavaScript | MDN
filter() は、与えられた callbackFn 関数を配列の各要素に対して一度ずつ呼び出し、 callbackFn が true に評価される値を返したすべての要素からなる新しい配列を生成します。 callbackFn は値が代入されている配列の添字に対してのみ呼び出されます。つまり、すでに削除された添字や、まだ値が代入されていない添字に対しては呼び出されません。 callbackFn によるテストに合格しなかった配列要素は単純にスキップされ、新しい配列には含まれないだけです。 callbackFn は 3 つの引数と共に呼び出されます。 filter に引数 thisArg が与えられた場合、そのオブジェクトは callbackFn 関数内の this 値として使われます。そうでない場合、 undefined が this 値として使われます。 callbackFn 関数内の最終的な this 値は 関数内の this を決定する一般的ルールに従って決められます。 filter() は呼び出された配列を変化させません。 filter() によって処理される配列要素の範囲は、 callbackFn が最初に呼び出される前に設定されます。既に訪問した位置にある要素や範囲外のインデックスに割り当てられた要素に対しては、 callbackFn は実行されません。既存の配列要素が削除された場合は、同様にそれらの要素は処理されません。 警告: 前項で記述したような同時進行の変更は、理解しにくいコードになる傾向があるので、（特殊な場合を除き）一般に避けるべきです。
https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Array/filter

• 例えば、検索条件で、開始日：9月6日、終了日：9月30日の場合は「9-6_9-30」というシート名が生成されます。

• Spreadsheet.deleteSheet(sheet)
• 指定したシートを削除します。
• 戻り値：無し
Class Spreadsheet | Apps Script | Google Developers
Send feedback Access and modify Google Sheets files. Common operations are adding new sheets and adding collaborators. createTextFinder(findText) Returns the active cell in this sheet. Note: It's preferrable to use getCurrentCell() , which the returns the current highlighted cell.
https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet#deletesheetsheet

• Array.prototype.unshift()
• 配列の最初に 1 つ以上の要素を追加し、新しい配列の長さを返します。
• 戻り値：メソッドを呼び出した後のオブジェクトの新しい length プロパティの値です
Array.prototype.unshift() - JavaScript | MDN
unshift メソッドは、与えられた要素を配列風オブジェクトの一番最初に挿入します。 Array.prototype.push() は unshift() と似た動作をしますが、配列の末尾に対して行う点が異なります。 Array.prototype.unshift() は意図的に汎用化されています。このメソッドは，配列に類似したオブジェクトに対して呼び出すことができます。 length プロパティ、すなわち連続の最後を示すゼロベースの数値プロパティがないオブジェクトでは、意味のある動作ができない可能性があります。 複数の要素が引数として渡された場合、引数として渡されたものと全く同じ順番で、オブジェクトの最初のチャンクに挿入されることに注意してください。したがって、 unshift を n 個の引数で 1 回呼び出すのと、1 個の引数で n 回（例えばループを使って）呼び出すのとでは同じ結果にはなりません。 例をご覧ください。
https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Array/unshift

• Spreadsheet.insertSheet(sheetName)
• 新しいスプレッドシートを指定された名前で挿入します。新しいシートがアクティブなシートになります。
• 戻り値：Sheet - 新しいシート
Class Spreadsheet | Apps Script | Google Developers
Send feedback Access and modify Google Sheets files. Common operations are adding new sheets and adding collaborators. createTextFinder(findText) Returns the active cell in this sheet. Note: It's preferrable to use getCurrentCell() , which the returns the current highlighted cell.
https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet#insertsheetsheetname

• 「startIndex + stockValues.length - 1」で最終行を計算してます。
• 「-1」はヘッダー行の分を減らしています。

• Range.setValues(values)
• 値の四角形のグリッドを設定します（この範囲の配列とvalues配列を一致させる必要があります）
• 戻り値：Range - チェーン用の範囲。
Class Range | Apps Script | Google Developers
Send feedback Access and modify spreadsheet ranges. A range can be a single cell in a sheet or a group of adjacent cells in a sheet. var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getRange('A1:D10'); range.activate(); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D10 var activeRange = selection.getActiveRange(); Return - This range, for chaining.
https://developers.google.com/apps-script/reference/spreadsheet/range#setValues(Object)

• Spreadsheet.setActiveSheet(sheet)
• 対象のシートを、スプレッドシート内の有効なシートとして設定します。
• 戻り値：Sheet - アクティブなシート。
Class SpreadsheetApp | Apps Script | Google Developers
Send feedback Access and create Google Sheets files. This class is the parent class for the Spreadsheet service. RelativeDate An enumeration of relative date options for calculating a value to be used in date-based BooleanCriteria . An enumeration of value types returned by Range.getValue() and Range.getValues() from the Range class of the Spreadsheet service.
https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet-app#setactivesheetsheet

まとめ

• スプレッドシート自動化で重要な4つのクラス

• その4つのクラスを使ったプログラム例として「株価時系列スプレッドシートの検索」

関連ブログ