このドキュメントでは、スクリプトのパフォーマンス向上に役立つベスト プラクティスを紹介します。
他のサービスへの呼び出しを最小限に抑える
スクリプト内で JavaScript オペレーションを使用すると、他のサービスを呼び出すよりもはるかに高速です。Google Apps Script 自体でできることは、Google のサーバーまたは外部サーバーからデータを取得する必要がある呼び出し(スプレッドシート、ドキュメント、サイト、翻訳、UrlFetch など)の実行よりもはるかに高速です。スクリプトがこれらのサービスに対して行う呼び出しを最小限に抑える方法を見つけることができれば、スクリプトの実行が速くなります。
共有ドライブを使用したコラボレーションを検討する
他のデベロッパーと共同でスクリプト プロジェクトで作業している場合は、共有ドライブを使用して Apps Script プロジェクトで共同編集できます。共有ドライブ内のファイルのオーナーは、個人ではなくグループです。これにより、プロジェクトの開発とメンテナンスが容易になります。
バッチ オペレーションを使用する
スクリプトは通常、スプレッドシートからデータを読み込んで計算し、データの結果をスプレッドシートに書き出す必要があります。Google Apps Script には、あらかじめいくつかの最適化機能が組み込まれています。たとえば、先読みキャッシュを使用してスクリプトが取得できる可能性のある内容を取得し、設定される可能性のある内容を保存するためにキャッシュに書き込みます。
スクリプトを作成すると、読み取りと書き込みの回数を最小限に抑えることで、組み込みキャッシュを最大限に活用できます。読み取りコマンドと書き込みコマンドを交互に繰り返すと遅くなります。スクリプトを高速化するには、1 つのコマンドですべてのデータを配列に読み込み、配列内のデータに対してオペレーションを実行して、1 つのコマンドでデータを書き出します。
ここで例を示します。従うべきでない例です。使用すべきではない例です。スクリプトは、次のコードを使用して、100 x 100 のスプレッドシート グリッド内のすべてのセルの背景色を設定します。getColorFromCoordinates()
という名前の関数(ここでは示していません)として使用し、各セルに使用する色を決定します。
// DO NOT USE THIS CODE. It is an example of SLOW, INEFFICIENT code.
// FOR DEMONSTRATION ONLY
var cell = sheet.getRange('a1');
for (var y = 0; y < 100; y++) {
xcoord = xmin;
for (var x = 0; x < 100; x++) {
var c = getColorFromCoordinates(xcoord, ycoord);
cell.offset(y, x).setBackgroundColor(c);
xcoord += xincrement;
}
ycoord -= yincrement;
SpreadsheetApp.flush();
}
このスクリプトは非効率的です。100 行、100 列をループして、10,000 個のセルに連続して書き込みます。Google Apps Script の書き戻しキャッシュは、すべての行の最後にフラッシュを使用して強制的に書き戻しを行うため、便利です。キャッシュ保存のため、スプレッドシートの呼び出しは 100 回しか行われません。
ただし、呼び出しをバッチ処理することで、コードをより効率的に作成できます。次の書き換えでは、セル範囲を色と呼ばれる配列に読み込み、配列内のデータに対して色割り当て操作を行い、配列内の値をスプレッドシートに書き出します。
// OKAY TO USE THIS EXAMPLE or code based on it.
var cell = sheet.getRange('a1');
var colors = new Array(100);
for (var y = 0; y < 100; y++) {
xcoord = xmin;
colors[y] = new Array(100);
for (var x = 0; x < 100; x++) {
colors[y][x] = getColorFromCoordinates(xcoord, ycoord);
xcoord += xincrement;
}
ycoord -= yincrement;
}
sheet.getRange(1, 1, 100, 100).setBackgroundColors(colors);
非効率なコードの実行には約 70 秒かかります。効率的なコードはわずか 1 秒で実行されます。
UI を多用するスクリプトでライブラリを使用しない
ライブラリはコードを再利用できる便利な方法ですが、スクリプトの起動にかかる時間が若干増えます。この遅延は、比較的長時間実行されるスクリプト(Google ドライブ内のファイルをクリーンアップするユーティリティ スクリプトなど)では顕著ではありませんが、短時間の google.script.run
呼び出しを繰り返し行うクライアント側の HTML Service ユーザー インターフェースでは、すべての呼び出しに影響します。この問題のため、アドオン内でのライブラリの使用は控えめにする必要があります。また、google.script.run
を大量に呼び出すアドオン以外のスクリプトでは、ライブラリの使用は避けることをおすすめします。
キャッシュ サービスを使用する
キャッシュ サービスを使用すると、スクリプトの実行間でリソースをキャッシュに保存できます。データをキャッシュに保存することで、データを取得する必要がある回数や頻度を減らすことができます。たとえば、example.com の RSS フィードの取得に 20 秒かかっており、リクエストの平均的なアクセスを高速化したい場合を考えてみます。次の例は、キャッシュ サービスを使用してこのデータへのアクセスを高速化する方法を示しています。
function getRssFeed() {
var cache = CacheService.getScriptCache();
var cached = cache.get("rss-feed-contents");
if (cached != null) {
return cached;
}
// This fetch takes 20 seconds:
var result = UrlFetchApp.fetch("http://example.com/my-slow-rss-feed.xml");
var contents = result.getContentText();
cache.put("rss-feed-contents", contents, 1500); // cache for 25 minutes
return contents;
}
アイテムがキャッシュにない場合は 20 秒待機する必要がありますが、それ以降のアクセスは、アイテムがキャッシュから 25 分で期限切れになるまで非常に高速になります。