（最終更新日：2023年6月）
✔以下の疑問をお持ちの方へ向けた記事です
「Google Apps Script（GAS）でのforeachループはどのように使用するのだろうか？」
「GASのforeachループの書き方を学びたい」
「GASのforeachループの具体的な使用例を見て理解したい」
✔この記事を読むことで得られる知識
- GASでのforeachループの基本的な書き方
- foreachループの応用法
- GASでのforeachループを用いた具体的な使用例
この記事では、GASでのforeachループの基本的な使い方から、その応用法まで、具体例を交えて詳しく説明します。
また、foreachループを使ったデータ処理やエラーハンドリングなど、より実践的な内容も含めて紹介します。
ぜひ最後までお読みください。
筆者プロフィール
【現職】プロダクトマネージャー
【副業】ブログ（月間20万PV）/YouTube/Web・アプリ制作
「プログラミング × ライティング × 営業」の経験を活かし、30後半からのIT系職へシフト。現在はプロダクトマネージャーとして、さまざまな関係者の間に入り奮闘してます。当サイトでは、実際に手を動かせるWebアプリの開発を通じて、プログラミングはもちろん、IT職に必要な情報を提供していきます。
【当ブログで紹介しているサイト】
✔人に見せても恥ずかしくないコードを書こう
「リーダブルコード」は、わかりやすく良いコードの定義を教えてくれる本です。
- 見るからにきれいなコードの書き方
- コードの分割方法
- 変数や関数の命名規則
エンジニアのスタンダートとすべき基準を一から解説しています。
何回も読むのに値する本なので、ぜひ手にとって読んでみてください。
GASのforEachを理解するための前提知識
この記事では、Google Apps Script（GAS）における配列操作とその中でも特に「forEach」の使用法について解説します。
これを理解することで、スクリプトの記述がスムーズになり、作業効率が向上します。
- Google Apps Script（GAS）の概要
- GASでの配列操作の重要性
- forEachの基本概念
Google Apps Script（GAS）の概要
Google Apps Script（GAS）はGoogleが提供するスクリプト言語で、JavaScriptをベースにしています。
Googleの各種サービス（Gmail, Calendar, Driveなど）と連携した処理を自動化することが可能です。
一例として、特定のメールを自動的に整理したり、スケジュールの管理、スプレッドシートのデータ操作など、幅広い活用が期待できます。
GASでの配列操作の重要性
GASにおいて、配列の操作は一般的なプログラミングと同様に重要なスキルとなります。
配列は複数のデータをまとめて扱うためのデータ型で、その操作方法を理解しておくことで、データの取り扱いが格段に便利になります。
例えば、スプレッドシートの複数の行や列を一度に操作したり、メールの一覧を整理したりする場合などに配列は大いに役立ちます。
GASの配列について詳しく知りたい方はこちら。
forEachの基本概念
「forEach」は配列の各要素に対して順に操作するためのメソッドで、その操作はコールバック関数として定義します。
当記事では、forEachの基本的な使い方から、具体的な使用例、さらには高度なテクニックまでを詳しく解説していきます。
Array.prototype.forEach()の基本
本節では、Array.prototype.forEach()メソッドの基本的な使い方について解説します。
また、伝統的なforループとの比較を行い、forEachの利点と欠点についても探っていきましょう。
- 使い方と構文
- forEachとforループの違い
- forEachの利点と欠点
使い方と構文
forEach()はJavaScriptのArrayオブジェクトのメソッドです。
基本的な構文は次のようになります。
array.forEach(function(currentValue, index, arr), thisValue)ここでは、function(currentValue, index, arr)がforEachで行う処理を定義するコールバック関数です。
- currentValue：ループされている現在の要素
- index：その要素のインデックス
- arr：メソッドが呼び出された配列
また、thisValueはコールバック関数内で使用するthisの値を指定します。
forEachとforループの違い
forループとforEachの最大の違いは、forループは条件によってループの継続・中断を制御できる点です。
対してforEach()は、配列の各要素に対して同じ操作をおこなうに限ります。
ただしforループでは手動でインデックスを管理しなければならないのに対し、forEach()は自動的に各要素に対する操作ができるので、コードがよりシンプルになるという利点があります。
forループとforEach()は同じく配列の各要素に対して操作しますが、その使い方と特性にはいくつかの違いがあるのです。
forEachの利点と欠点
forEach()の主な利点は、コードが簡潔で可読性が高い点です。
さらに、コールバック関数内で現在の要素、インデックス、配列全体へのアクセスが可能なため、高度な配列操作をおこないやすいのも特徴。
ただし、デメリットとして以下を押さえておきましょう。
- 「break」文によるループの中断ができない
- 「return」文による値の返却ができない
そのため、特定の条件でループを終了させるなどの制御が必要な場合は、forループや他の配列メソッド（every、someなど）の使用を検討すると良いでしょう。
forEachの実践的な使い方
こちらでは、Array.prototype.forEach()の実践的な使い方に焦点を当てます。
配列の要素を操作・変換する基本的な例から始め、スプレッドシートやドキュメントと連携する具体的な例、さらには例外処理とエラーハンドリングについても掘り下げましょう。
- 配列の要素を操作・変換する例（コード例＆解説）
- スプレッドシートやドキュメントと連携する例（コード例＆解説、スクリーンショット）
- 例外処理とエラーハンドリング（コード例＆解説）
配列の要素を操作・変換する例（コード例＆解説）
forEachを使って配列の要素を操作・変換する基本的な例を見てみましょう。
以下の例では、配列の全ての要素を2倍にします。
let numbers = [1, 2, 3, 4, 5];
numbers.forEach((num, index) => {
numbers[index] = num * 2;
});
console.log(numbers); // Output: [2, 4, 6, 8, 10]このように、forEachを使用すると、配列の各要素に対する操作を簡潔に記述できるのです。
スプレッドシートやドキュメントと連携する例（コード例＆解説、スクリーンショット）
Google Apps Script（GAS）でよく行われる操作の一つは、Googleスプレッドシートのデータを操作することです。
forEachを用いて、スプレッドシートの特定の列の全てのセルに対する操作を行う例を考えてみましょう。
以下の例では、特定の列の全てのセルに文字列を追加しています。
function addStringToCells() {
//Sheet1というシートを取り出す
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Sheet1');
var range = sheet.getRange('A1:A10');
var values = range.getValues();
values.forEach((row, index) => {
values[index][0] = row[0] + ' extra text';
});
range.setValues(values);
}このスクリプトを実行すると、’Sheet1’のセルA1からA10までの各セルに’ extra text’が追加されます。
例外処理とエラーハンドリング（コード例＆解説）
JavaScriptにおけるエラーハンドリングの一部として、forEach内で例外処理を行う方法について解説します。
forEachのコールバック関数内でエラーが発生した場合、それを捉えて適切に対応することが重要です。
以下にその例を示します。
let numbers = [1, 2, 3, "four", 5];
try {
numbers.forEach((num, index) => {
if (typeof num !== 'number') {
throw new Error(`Array element at index ${index} is not a number.`);
}
console.log(num * 2);
});
} catch (error) {
console.error(error.message);
}この例では、forEachのコールバック関数内で配列の要素が数値かどうかをチェックし、数値でない場合にはエラーを投げます。
エラーは外側のtry-catchブロックで捕捉され、そのメッセージがコンソールに出力されます。
forEachを使った高度なテクニック
こちらではforEachを使った高度なテクニックをご紹介します。
配列内のオブジェクトの操作、thisArgの使い方、そしてforEachと他のArrayメソッド（map, filter, reduce）の組み合わせ方について詳しくみていきましょう。
- 配列内のオブジェクトを操作する方法（コード例＆解説）
- thisArgの使い方（コード例＆解説）
- forEachと他のArrayメソッド（map, filter, reduce）を組み合わせる方法（コード例＆解説）
配列内のオブジェクトを操作する方法
JavaScriptの配列は、文字列や数値だけでなく、オブジェクトを要素として持つことが可能です。
これは非常に強力で、多次元配列やJSONデータを扱う際に便利。
以下の例は、forEachを使って配列内のオブジェクトを操作する方法を示しています。
let students = [
{ name: "Alice", score: 85 },
{ name: "Bob", score: 92 },
{ name: "Charlie", score: 88 }
];
students.forEach(student => {
student.score += 5; //スコアに5点追加
});
console.log(students);上記の例では、学生の名前とスコアを保持するオブジェクトの配列を作成し、forEachを使って各学生のスコアに5点を加算しています。
thisArgの使い方
forEachメソッドの第二引数には、コールバック関数内でthisとして参照するオブジェクトを指定できます。
これをthisArgと呼びます。以下にその使用例を示します。
let multiplier = {
factor: 2,
multiply: function(arr) {
arr.forEach(function(number) {
console.log(number * this.factor);
}, this);
}
};
multiplier.multiply([1, 2, 3]); //2, 4, 6を出力上記の例では、multiplierというオブジェクト内でforEachを使用しています。
このとき、コールバック関数内のthisをmultiplierオブジェクトにバインドするためにthisArgとしてthisを指定しています。
forEachと他のArrayメソッド（map, filter, reduce）を組み合わせる方法
forEachは単独で使うだけでなく、ほかのArrayメソッドと組み合わせることで、より強力な操作をおこなえます。
map、filter、reduceなどのメソッドと組み合わせて、配列の変換、フィルタリング、集約などが可能です
let numbers = [1, 2, 3, 4, 5];
// 偶数だけを取り出して、それぞれを2乗
let squaresOfEvens = numbers.filter(num => num % 2 === 0).map(num => num ** 2);
console.log(squaresOfEvens); // [4, 16]この例では、まずfilterメソッドを使用して偶数だけを取り出し、その結果に対してmapメソッドを適用して各数値を2乗しています。
サンプルプロジェクト＆練習問題
こちらでは、これまでに学んだforEachの概念とその実用的な使い方を実践するためのプロジェクトと練習問題を提供します。
- サンプルプロジェクトの概要と手順
- 練習問題と解答例
サンプルプロジェクトの概要と手順
サンプルプロジェクトとして、「GASを用いてスプレッドシートのデータを操作する」方法を学びましょう。
具体的には、スプレッドシートの特定の列からデータを取得し、その値を2倍にするという操作です。
まず、スプレッドシートからスクリプトエディタを開くことで、そのスプレッドシートとGASのコードを連携させられます。
function doubleValues() {
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange("A2:A6"); //値を2倍にする列を指定
var values = range.getValues();
values.forEach(function(row) {
row[0] *= 2;
});
range.setValues(values);
}上記スクリプトは、アクティブなシートの”A2:A6″の範囲の値を取得し、それぞれの値を2倍にしてスプレッドシートに戻すものです。
GASのコードとスプレッドシートが連携できていない場合は、getSheetByIdメソッドなどを使い、特定のスプレッドシートをコード内で取得する必要があります。
練習問題と解答例
以下に、forEachを使って解決できるいくつかの練習問題を提示します。
- 配列の全ての要素を3倍にするスクリプトを書いてみてください。
- 配列から偶数だけを取り出し、それぞれの数値を半分にするスクリプトを書いてみてください。
- 配列の全ての文字列を大文字にするスクリプトを書いてみてください。
これらの問題を解くためには、forEachの基本的な使い方と、配列を操作するための基本的なJavaScriptの知識が必要です。
問題に取り組んだ後は、自分の解答と解答例を比較してみてください。
異なる解答があった場合でも、それはあなたが新しい解決策を見つけ出した証拠かもしれません。
まとめと次のステップ
当記事では、基本的な使い方から高度なテクニックまで、さまざまな観点からforEachを取り上げ、実際のコード例とともに説明しました。
- GASはGoogleの各種サービスとの連携が強みなので、G Suiteの全体を最低限理解する
- GASを使ったプロジェクトでは、何を自動化するか、どのようなプロセスを効率化するかを明確に定義する
- GASのスクリプトはJavaScriptで書かれているため、基本的なJavaScriptの知識を持つことが必要
当サイトでは、具体的にGASを使用したアプリ開発にも取り組んでいます。
以下のようなものを作りながら学んでみることもおすすめです。
