Google Apps Script SpreadsheetApp

Google Apps ScriptのSpreadsheetAppは、GASからスプレッドシートを操作するオブジェクトです。この記事を観れば、Google Apps ScriptからGoogleスプレッドシートを操作する方法が分かります。

スプレッドシートを読み込む

Google Apps Script (GAS) からスプレッドシートを読み込むには、以下に示すメソッドを利用する。

アクティブなスプレッドシートを読み込む

スプレッドシートに連携されたコンテナバインド型の Google App Script (GAS) からアクティブなスプレッドシートを取得するには、SpreadsheetApp.getActiveSpreadsheet メソッドを使う。

SpreadsheetApp.getActiveSpreadsheet()

コンテナバインド型のGASは特定のスプレッドシートと連携しているため、スプレッドシートを特定する識別子を指定する必要はない。

スプレッドシートに連携されていないスタンドアロン型のGASでは、getActiveSpreadsheetメソッドを使えない。

GASからアクティブなスプレッドシートを取得する例を以下に示す。

const sheets = SpreadsheetApp.getActiveSpreadsheet();

URLを指定してスプレッドシートを読み込む

URL を指定してスプレッドシートを読み込むには、SpreadsheetApp.openByUrl メソッドを使う。openByUrl メソッドは、スプレッドシートに連携されたコンテナバインド型 GAS および スプレッドシートに連携されていないスタンドアロン型 GAS のどちらからでも利用できる。

SpreadsheetApp.openByUrl(url)

以下に示す引数を openByUrl メソッドに指定する。

url

読み込むスプレッドシートを特定するために、スプレッドシートのURLを引数に指定する。

GASからスプレッドシートを読み込む例を以下に示す。

const url = "https://docs.google.com/spreadsheets/d/abcdefghijklmnopqrstubwxyz012345/edit#gid=0";
const sheets = SpreadsheetApp.openByUrl(url);

IDを指定してスプレッドシートを読み込む

ID を指定してスプレッドシートを読み込むには、SpreadsheetApp.openById メソッドを使う。openById メソッドは、スプレッドシートに連携されたコンテナバインド型 GAS および スプレッドシートに連携されていないスタンドアロン型 GAS のどちらからでも利用できる。

SpreadsheetApp.openById(id)

以下に示す引数を openById メソッドに指定する。

id

読み込むスプレッドシートを特定するために、スプレッドシートのURLに含まれるIDを引数に指定する。スプレッドシートの ID は、Google スプレッドシートを開いたときの URL から知ることができる。

https://docs.google.com/spreadsheets/d/id/edit#gid=0

GASからスプレッドシートを読み込む例を以下に示す。

const sheets = SpreadsheetApp.openById("abcdefghijklmnopqrstubwxyz012345");

アクティブなシートを読み込む

Google Apps Script (GAS) からシートのオブジェクトを取得するには、次の方法がある。

• アクティブなシートを取得する
• シート名を指定してシートを取得する

現在アクティブなシートを取得するには、SpreadsheetAppオブジェクトのgetActiveSheetメソッドを使う。

var sheet = SpreadsheetApp.getActiveSheet();