はじめに
この記事は自作のGASスクリプトファイル(の関数)を、他の複数の(あるいはひとつの)GASスクリプトから利用する時の操作についてのメモ、と、その知見を社内で共有するために書いています。
手順概要
下記の手順で呼び出される側、呼び出す側両方で設定が必要になります。
- 呼び出される側のファイルでの設定
2. Webアプリケーションとして導入の設定する - 呼び出す側のファイルでの設定
3. 呼び出すファイルをライブラリとして追加する
4. プログラムを記述する
5. プログラムを実行する
6. おわり - (必要な場合)複数人(複数Googleアカウント)で利用する場合のGASスクリプトファイルの共有化方法
手順詳細
1.呼び出される側のファイルでの設定
1-1. Webアプリケーションとして導入
- Project Version:
- プロジェクトファイルを公開する時のバージョン
- Execute the app as:
- プロジェクトを実行するユーザ権限
- Me
- 利用者
- Googleにログインしなければ実行不可になる。
- プロジェクトを実行するユーザ権限
- Who has access to the app:
- 実行許可ユーザ
- Anybody(だれでもログインユーザに限らず)
- only myself(自分だけ)
- all user(すべてのGoogleログインユーザ)
- 実行許可ユーザ
1-2. プロジェクトキーをメモする
2.呼び出す側のファイルでの設定
2-1. 呼び出す側のスクリプトファイルを作成する
今回はスプレッドシートのコンテナバインドスクリプトのファイルを作成して、そこから呼び出します。
スプレッドシートを開き、スクリプトエディタを開きます。
2-2. ライブラリ設定を行う
ライブラリとして、呼び出すファイルを設定します。
1-2でコピーしたライブラリキーを張り付けて追加をクリックします。
2-3. プログラムを記述する
ここまでの操作で、呼び出す側のファイルで呼び出される側のファイルをライブラリとして使いますよ。という宣言ができた状態です。これで呼び出される側のファイルにある関数を使えるようになりました。あとは呼び出す側のファイルで好きなようにプログラムを記述するだけです。
- 例として、kabusokuというプロジェクトファイルの中にある関数を利用するには下記のように記述します。
function CallonUpdateBatchCheck() {
kabusoku.onUpdateBatchCheck()
}
//kabusokuまで入力すると入力補完も効きます。
2-4. プログラムを実行する
上記例、CallonUpdateBatchCheckを実行してみたところ、kahusokuファイルのonUpdateBatchCheckに記述されたプログラムの結果が取得できました。
2-5. おわり
注意すること と うまくいかない時に確認すること
-
ライブラリ追加時の注意点と確認すべき内容
- 呼び出される側のGASスクリプトファイルのプロジェクト名は、日本語でも問題ないが、その場合は「identifier」の部分に日本語以外の名前を付ける必要がある。「identifier」が日本語だとライブラリ追加の時点でエラーになる。
-
呼び出されるファイルを更新した時の注意点と確認すべき内容
- 呼び出されるファイルにて、1-1.の作業を再実行する。その際、必ず
Newのバージョン
として公開する。 - 呼び出すファイルにて、1-1.の作業を再実行する。その際、必ず最新バージョンを選択する。
- 呼び出されるファイルにて、1-1.の作業を再実行する。その際、必ず
-
ライブラリを呼び出すプログラムが正しく動作しない時の注意点と確認すべき内容(単体としては動作するが、ライブラリとして外部から実行するとエラーになる)
- 1-1の設定内容を見直してください。
- 複数人(複数Googleアカウント)で利用する場合は後述の「スクリプトファイルの共有化」が必要なのでそちらをチェックしてください。
3. 複数人(複数Googleアカウント)で利用する場合のGASスクリプトファイルの共有化方法
自分以外のGoogleアカウントがマクロを実行する可能性がある場合は、下記のように、呼び出される側のGASスクリプトファイルを共有化しておく必要があります。