GASライブラリ公開手順
GAS実践の概要
Google Apps Script(GAS)は、Google Workspace のサービスを拡張するためのスクリプト言語です。実際に業務で活用する際は、単なる自動化だけでなく、再利用可能なライブラリを作成し、チーム全体で共有することが重要です。この記事では、ライブラリ作成からデプロイ、公開設定、配布までの一連の流れを実践的に解説します。
ライブラリ作成の手順
まずは、プロジェクトを「ライブラリ」として構築します。スクリプトエディタで新規プロジェクトを作成し、必要な関数をモジュール化します。関数に /** @param {string} name */ のように JSDoc を付与すると、ドキュメンテーションが自動生成され、マニュアル作成が容易になります。
/**
* こんにちはを返す
* @param {string} name 名前
* @return {string} 返却文字列
*/
function greet(name) {
return 'こんにちは、' + name + 'さん!';
}
JSDoc を使うことで、関数の引数や戻り値の型を明示でき、他の開発者が利用しやすくなります。ライブラリ化したら、スクリプトID を取得し、次のステップへ進みます。
スクリプトIDとデプロイ
スクリプトID は、プロジェクトの「公開」メニューから確認できます。ライブラリとして利用するには、この ID を他のプロジェクトに追加します。デプロイは「公開」→「ライブラリとして公開」から行い、バージョン番号を設定します。バージョン管理は、変更点を追跡しやすくするために不可欠です。
例として、バージョン 1 を作成する手順は以下の通りです。
- 「公開」メニューから「バージョンを管理」を選択。
- 「新しいバージョンを作成」をクリックし、説明を入力。
- 「公開」を押して完了。
これで、他のプロジェクトから greet 関数を呼び出せるようになります。
公開設定と配布
ライブラリを公開する際は、アクセス権限を「全員(公開)」に設定するか、特定のユーザーに限定するかを決めます。公開設定を「全員」にすると、誰でもスクリプトID を知っていれば利用できます。配布は、GitHub などのリポジトリに README とともに JSDoc で生成したドキュメントを添付すると、ユーザーが簡単に導入できます。
配布時のマニュアル例:
## ライブラリの導入手順
1. スクリプトエディタで「リソース」→「ライブラリ」を選択。
2. スクリプトID を入力し、バージョンを選択。
3. 「追加」をクリックしてプロジェクトに組み込む。
## 使用例
```javascript
var result = greet('太郎');
Logger.log(result); // こんにちは、太郎さん!
```
このように、JSDoc とマニュアルを併用することで、配布後もユーザーがスムーズに利用できる環境を整えられます。
コメント
コメントを投稿