GASの共通処理をライブラリ化して使い回す仕組み(中級編)

GASの共通処理をライブラリ化して使い回す仕組み(中級編) GAS

こんにちは!ともです。GASのプロジェクトが増えてくると、「この日付を整形する処理、前にもどこかで書いたな」という場面が出てきます。プロジェクトごとに同じコードをコピーして持つと、直すときに全部のプロジェクトを回ることになり、直し漏れも起きます。

GASには、コードを「ライブラリ」として切り出し、他のプロジェクトから呼び出して使う仕組みがあります。この記事では、共通処理をライブラリ化する手順と、バージョン固定の考え方、開発モードとの使い分けまでを、中級編としてまとめます。

【この記事で分かること】

この記事で分かること
この記事で分かること
  • 完成品で何ができるようになるか
  • 必要なものとコスト(無料で使える範囲)
  • ライブラリ用プロジェクトの作成と、スクリプトIDの確認手順
  • ライブラリ側のコードの書き方(外から見える関数・見えない関数)
  • 利用側でライブラリを追加して呼び出す手順
  • バージョン固定と開発モードの使い分け

【完成品のイメージ:共通処理は1か所、呼ぶ側は短く】

完成品のイメージ:共通処理は1か所、呼ぶ側は短く
完成品のイメージ:共通処理は1か所、呼ぶ側は短く

完成すると、日付の整形やログの記録といった共通処理が、1つのライブラリプロジェクトにまとまります。他のプロジェクトからは、その関数を名前で呼び出すだけです。

共通処理を直したいときは、ライブラリ側を1回直すだけです。あとは利用側のバージョン指定を更新すれば、直した内容が行き渡ります。「同じコードを何か所にもコピーして持つ」状態から、「正本は1か所」に変わるのが、この作例の完成形です。

なお、ライブラリ化は「プロジェクトが複数に増えて、同じ処理の重複が目立ってきた」と感じたタイミングで検討する仕組みです。プロジェクトが1つしかない段階では、普通に関数を分けて書くだけで十分です。重複が2つ、3つと増えてきたら、その共通部分がライブラリの候補になります。この記事では、その切り替えの進め方を扱います。

【必要なものとコスト】

必要なものとコスト
必要なものとコスト

ライブラリの仕組み自体は、GASの標準機能として無料で使えます(2026年11月確認時点)。

項目内容
使うツールGoogle Apps Script(ライブラリ機能)/利用側の各プロジェクト
料金の目安無料(約0円)。Googleアカウントの範囲で利用可
前提Googleアカウント/ライブラリ化する共通処理の見当が付いていること/ライブラリのプロジェクトは、利用側から参照できる共有状態にしておくこと

コストはかかりませんが、運用の約束ごとが増えるのがこの仕組みの特徴です。ライブラリは「他のプロジェクトの土台」になるため、消したり共有を外したりすると、利用側が一斉に動かなくなります。作る前に、誰が管理するプロジェクトに置くかを決めておいてください。

【難易度と進め方の目安】

難易度と進め方の目安
難易度と進め方の目安

難易度は中くらいです。コードの書き方自体は普段のGASと変わりませんが、「バージョン」という考え方と、ライブラリ側・利用側という2つの立場を行き来する点が新しい部分です。目安の所要時間は、初期設定込みで1時間前後です。

進め方は「ライブラリ用プロジェクトの作成→共通関数の用意→バージョンを付けて保存→利用側で追加→呼び出して確認→本番はバージョン固定」の順番です。最初は、日付の整形のような小さくて独立した処理から切り出すのが安全です。

【初期設定:ライブラリ用プロジェクトの作成とスクリプトID】

初期設定:ライブラリ用プロジェクトの作成とスクリプトID
初期設定:ライブラリ用プロジェクトの作成とスクリプトID

まず、ライブラリ専用のプロジェクトを新しく作ります。script.google.com の画面から新規プロジェクトを作成し、「共通ライブラリ」のように役割の分かる名前を付けてください。特定のシートにひも付けない、独立したプロジェクトにするのが基本です。土台として長く使うものなので、作業用の使い捨てプロジェクトとは分けておきます。

次に、このプロジェクトの「スクリプトID」を確認します。スクリプトIDは、ライブラリを指し示すための住所のようなものです。確認の手順は次のとおりです。

  1. ライブラリ用プロジェクトをエディタで開く
  2. 左メニューの「プロジェクトの設定」(歯車のアイコン)を開く
  3. 「ID」の欄にある「スクリプトID」をコピーする

このIDは、利用側でライブラリを追加するときに使います。IDそのものは秘密情報ではありませんが、ライブラリとして参照されるには、利用する側のアカウントからプロジェクトへアクセスできる共有状態が必要です。自分のアカウント内だけで使う場合はそのままで構いませんが、他の人と使う場合は、ライブラリのプロジェクトを「閲覧できる」状態に共有しておいてください。編集できる権限まで渡す必要はありません。

【作り方の骨格1:ライブラリ側のコードを用意する】

作り方の骨格1:ライブラリ側のコードを用意する
作り方の骨格1:ライブラリ側のコードを用意する

ライブラリ側には、他のプロジェクトから使わせたい関数を置きます。書き方は通常のGASと同じですが、関数の「見え方」に1つ約束ごとがあります。関数名の末尾にアンダースコア(`_`)を付けた関数は、利用側から呼び出せなくなります。内部専用の下準備には `_` を付け、外に公開する関数には付けない、という使い分けです。

// 【ライブラリ側】今日の日付を「2026年11月16日」の形の文字列で返す
function todayText() {
  // 日本時間で今日の日付を取得し、年月日の形に整える
  return Utilities.formatDate(new Date(), 'Asia/Tokyo', 'yyyy年M月d日');
}

// 【ライブラリ側】処理の記録を、指定したシートの末尾へ残す
function appendLog(sheet, message) {
  // 渡されたシートの末尾へ、日時とメッセージを1行追加する
  sheet.appendRow([new Date(), message]);
}

// 【ライブラリ側】名前の末尾に _ を付けた関数は、利用側から呼び出せない(内部専用)
function buildLogLine_(message) {
  // ライブラリの中だけで使う、下準備の処理をここに書く
  return '[' + todayText() + '] ' + message;
}

`appendLog` の例では、シート自体を利用側から渡す形にしています。ライブラリの中で「今開いているスプレッドシート」を取得する書き方もできますが、利用側の文脈に依存して分かりにくくなるため、必要な材料は引数で受け取る形が基本です。「材料を渡せば結果が返る」という形の関数は、ライブラリに向いています。

用意ができたら、ライブラリとして使えるように「バージョン」を付けて保存します。エディタの「デプロイ」から「デプロイを管理」を開き、新しいデプロイとしてバージョンを付ける、というのが大まかな流れです。バージョンは、ライブラリの「確定した状態」に付ける番号だと考えてください。利用側は、この番号を指定してライブラリを使います。

【作り方の骨格2:利用側で追加して呼び出す】

作り方の骨格2:利用側で追加して呼び出す
作り方の骨格2:利用側で追加して呼び出す

次に、使う側のプロジェクトでの作業です。ライブラリの追加は、エディタの画面から行います。

  1. 利用側のプロジェクトをエディタで開く
  2. 左メニューの「ライブラリ」の横にある「+」を押す
  3. ライブラリ側のスクリプトIDを貼り付けて「検索」を押し、見つかったライブラリを選ぶ
  4. バージョンを選ぶ(検証中は「開発モード」をオンに、本番では番号の付いたバージョンを指定する)
  5. 「識別子」に短い名前を付ける(例:`CommonLib`)。この名前が、コードの中でライブラリを指す呼び名になる

追加が終わると、利用側のコードから、識別子を頭に付けてライブラリの関数を呼べるようになります。

// 【利用側】ライブラリの関数を、識別子(ここでは CommonLib)を付けて呼び出す
function runFromProjectA() {
  // ライブラリ側の todayText() を呼び出して、今日の日付の文字列を受け取る
  const today = CommonLib.todayText();

  // 受け取った値を、このプロジェクト側の処理に使う
  console.log('今日は ' + today + ' です');
}

ここで大切なのが、バージョンの扱いです。利用側で番号の付いたバージョンを指定している場合、ライブラリ側のコードを直しただけでは、利用側の動きは変わりません。直した内容を新しいバージョンとして保存し、利用側で指定するバージョンを更新して、初めて反映されます。手間がかかる分、「いつの状態のライブラリで動いているか」が常にはっきりするのが、この仕組みの良いところです。

一方の「開発モード」は、ライブラリ側の最新のコード(保存したばかりの状態)をそのまま参照します。ライブラリを作っている最中の検証には便利ですが、ライブラリ側を編集中のコードが、そのまま利用側の本番の動きに影響します。検証が終わったら、必ずバージョン指定に戻してください。

バージョンを更新するときの運用の約束も、先に決めておくと迷いません。たとえば、バージョンを付けるときの説明欄に「何を直したか」を1行で残しておくことです。あとから「あの変更はどのバージョンからか」を追えるようになります。また、利用側のバージョンを上げる前に、検証用のプロジェクトで新しいバージョンを試してから、本番のプロジェクトへ広げる順番にしておくと、土台の変更で一斉に止まる事故を避けられます。ライブラリは便利な分、更新の手順そのものも「仕組み」として扱ってください。

【ライブラリ化に向く処理・向かない処理】

ライブラリ化に向く処理・向かない処理
ライブラリ化に向く処理・向かない処理

何でもライブラリに寄せればよいわけではありません。向く処理と向かない処理の目安を押さえておくと、切り分けで迷いません。

向くのは、「材料を渡せば、同じ結果が返る」処理です。日付や文字列の整形、ログの記録、外部APIを呼ぶときの共通の下準備など、置かれた場所に依存しない処理が該当します。複数のプロジェクトで、まったく同じ形で使われている処理ほど、ライブラリ化の効果が出ます。

向かないのは、特定のプロジェクトの都合に強く結び付いた処理です。「このシートの、この列を決め打ちで読む」といった処理は、利用側ごとに事情が違うため、ライブラリに寄せると引数が増えてかえって分かりにくくなります。また、1つのプロジェクトでしか使わない処理は、そもそも切り出す理由がありません。

もう1つの判断軸は、変更の頻度です。めったに変わらない処理はバージョン固定との相性がよく、しょっちゅう直す処理は、直すたびにバージョン更新の手順が付いて回ります。育てている最中の処理は、まず利用側に置いたままにして、形が固まってからライブラリへ移す進め方が現実的です。

【つまずきやすい点】

つまずきやすい点
つまずきやすい点

よくあるつまずきは5つです。1つ目は、開発モードのまま本番で使い続けることです。ライブラリ側のちょっとした編集や、書きかけのコードが、利用側の定期実行などにそのまま影響します。本番のプロジェクトでは、バージョンを番号で固定するのが原則です。

2つ目は、直したのに反映されないことです。バージョン固定の仕組み上、ライブラリ側を直す→新しいバージョンとして保存する→利用側のバージョン指定を更新する、の3手順がそろって初めて反映されます。「直したのに変わらない」と感じたら、まず利用側がどのバージョンを指しているかを確認してください。

3つ目は、関数名の末尾のアンダースコアです。ライブラリ側で `_` を付けた関数は、利用側から見えなくなります。「ライブラリ側には確かに書いたのに、利用側で呼び出せない」という場合は、まず名前を確認してください。

4つ目は、権限(承認)です。ライブラリ側の関数がスプレッドシートの編集やメール送信などを使う場合、その許可は利用側のプロジェクトでも必要になります。ライブラリを追加しただけでは承認は終わらないため、利用側で一度実行して、承認の手順を済ませてください。

5つ目は、ライブラリ本体の管理です。ライブラリのプロジェクトを削除したり、共有を外したりすると、それを使っているすべてのプロジェクトが動かなくなります。ライブラリは土台だという意識で、置き場所と管理者を決め、むやみに触らない運用にしてください。

【まとめ】

まとめ
まとめ

GASのライブラリ化は、「共通処理を専用プロジェクトに切り出す→バージョンを付けて保存する→利用側では識別子で呼び、バージョンは番号で固定する」という流れで進めます。直す場所が1か所になる代わりに、バージョン管理という一手間が増えます。プロジェクトが3つ、4つと増えてきたら検討する価値のある仕組みです。

定期実行のトリガー登録のような「どのプロジェクトにも置く下準備」は、ライブラリ化の候補に向いています。

GASを決まった時刻に自動で動かす仕組み

Webアプリの表示・記録の下準備をライブラリへ寄せると、公開する側のコードは薄く保てます。

GASをWebアプリとして公開する仕組み

GASそのものが初めての方は、入門のレシピ集から始めるのがおすすめです。

GASレシピ一覧(ショートマスター)

なお、「自分で作るのではなく、業務の自動化そのものを相談したい」という場合は、作ってもらう選択肢もあります。

\ 業務の自動化やAI活用を、代わりに作ってほしい方はこちら /

コメント

タイトルとURLをコピーしました