Google Apps Script (GAS) でこのセル範囲のセルのメモの内容を取得・設定する方法を説明します。
Rangeクラスのメソッドを利用した手順について説明します。
Google Apps Scriptの基本的な使い方については下記をご覧ください。
GASによるスプレッドシート操作の概要
GASでスプレッドシートを操作するための「SpreadSheetサービス」は、主に下記のクラスで構成されています。
| クラス | 説明 |
|---|---|
| SpreadSheetApp | SpreadSheetサービスの親クラス |
| Spreadsheet | スプレッドシートを操作するクラス |
| Sheet | シートを操作するクラス |
| Range | セル範囲を操作するクラス |
それぞれ下記のような位置付けになります。
「SpreadSheetApp」→「SpreadSheet」→「Sheet」→「Range」という順の階層構造になっています。操作対象に応じて、下の階層にたどってオブジェクトを取得して利用します。
このページでは、上記の中のRangeクラスの下記のメソッドについて説明します。
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getNote() | String | このセル範囲の左上セルのメモを取得する |
| getNotes() | String | このセル範囲のセルのメモを配列で一括取得する |
| setNote(note) | Range | このセル範囲のセルのメモを一括設定する |
| setNotes(notes) | Range | このセル範囲のセルのメモを配列で一括設定する |
このセル範囲のセルのメモを取得する
このセル範囲のセルのメモを取得するメソッドを説明します。
このセル範囲の左上セルのメモを取得する：getNote()
このセル範囲の左上セルのメモを取得する方法です。
下記のように実行します。
|
1 2 3 4 5 6 |
function myFunction() { const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); const testSheet = testSpreadSheet.getSheetByName("シート1"); const testRange = testSheet.getRange("B2:C3"); console.log(testRange.getNote()); } |
下記のファイルで実行してみます。
下記のような実行結果になります。左上セルのメモを取得できます。
|
1 |
これはB2セルのメモです。 |
このセル範囲のセルのメモを配列で一括取得する：getNotes()
このセル範囲のセルのメモを配列で一括取得する方法です。
下記のように実行します。
|
1 2 3 4 5 6 |
function myFunction() { const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); const testSheet = testSpreadSheet.getSheetByName("シート1"); const testRange = testSheet.getRange("B2:C3"); console.log(testRange.getNotes()); } |
下記のファイルで実行してみます。
下記のような実行結果になります。セルのメモを配列で一括取得できます。
|
1 2 |
[ [ 'これはB2セルのメモです。', 'これはC2セルのメモです。' ], [ 'これはB3セルのメモです。', 'これはC3セルのメモです。' ] ] |
このセル範囲のセルのメモを設定する
このセル範囲のセルのメモを設定するメソッドを説明します。
このセル範囲のセルのメモを一括設定する：setNote(note)
このセル範囲のセルのメモを一括設定する方法です。
下記のように実行します。
|
1 2 3 4 5 6 |
function myFunction() { const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); const testSheet = testSpreadSheet.getSheetByName("シート1"); const testRange = testSheet.getRange("B2:C3"); testRange.setNote(); } |
下記のファイルで実行してみます。
下記のような実行結果になります。指定したセルのメモをすべて一括設定できます。
このセル範囲のセルのメモを配列で一括設定する：setNotes(notes)
このセル範囲のセルのメモを配列で一括設定する方法です。
下記のように実行します。
|
1 2 3 4 5 6 7 |
function myFunction() { const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); const testSheet = testSpreadSheet.getSheetByName("シート1"); const testRange = testSheet.getRange("B2:C3"); testRange.setNotes([["B2セルのメモを更新しました", "C2セルのメモを更新しました"], ["B3セルのメモを更新しました", "C3セルのメモを更新しました"]]); console.log(testRange.getNotes()); } |
下記のファイルで実行してみます。
下記のような実行結果になります。指定したセルのメモを配列で一括設定できます。
実行後のgetNotesメソッドの出力結果は下記になります。
|
1 2 |
[ [ 'B2セルのメモを更新しました', 'C2セルのメモを更新しました' ], [ 'B3セルのメモを更新しました', 'C3セルのメモを更新しました' ] ] |
まとめ
Google Apps Script (GAS) でこのセル範囲のセルのメモの内容を取得・設定する方法を説明しました。
GASは無料で利用できてとても便利なツールです。
Googleスプレッドシート等のGoogleアプリケーションを利用されている方は、GASを習得することで作業を大きく効率化できます。
GASの基本構文を知りたい方は、下記もご覧ください。
