自作ファイルを他の人に使ってもらうには？社内にscriptを共有した覚書_アラフィフGAS初心者が業務効率化

会社の業務を効率化したくて2021年1月からGoogle Apps Scriptを始めました。
JavaScriptも知りませんでした。そんなわたしが作業していて悩んだことを残します。
具体的なソースは業務関連なので掲載してません。

自作ファイルを同僚に渡したら面倒なことになった！

スクリプトを仕込んだシートができあがったので、同僚にも共有しようとファイルをコピーして何人かに渡しました。

しばらく経ったある日、わたしが思ってなかった使い方をした人がいてエラーが出てしまいました。
そのことでスクリプトを修正したくなったのですが・・・。

ファイルを修正するには配布した人の数だけスクリプトを更新しないといけなかったのです。

スクリプトの種類を考えてみたら当たり前なんですけどね。

基本中の基本 ｜ GASのスクリプトの種類とは？

• スタンドアロン（スクリプト）
  シートやフォームに関連付けられていないスクリプト

• バインドスクリプト
  あるシート（もしくはフォームなど）に関連づけられたスクリプト
  ファイルの中からスクリプトエディタを呼び出しコーディングできる。

わたしが作ったのはシートに関連づけられたバインドスクリプトだったので、ファイルをコピーした分だけスクリプトが作られてしまっていたわけです。

ただ幸いだったのはわたしが書いたスクリプトはAppScript（ https://script.google.com/home ）に全てまとめられていたので配布済みのファイルから辿っていく必要はなく、コードの改修でコピペする作業はそれほど大変ではなかったです。

配布する数が少ないならそのままでもいいかも

もし配布すべき人が少人数なら複数のバインドファイルをメンテナンスする方法でもいいかもしれません。

というのもわたしが選んだやり方はメンテナンス性は上がりますが、少し面倒です。
それにスクリプトの書き方もクラスやコンストラクタが必要になります。

もしも、スクリプトの内容をコピペでまかなっている場合、元のスクリプトの多くはそのように（オブジェクト指向で）は記載されていないことが多いのです。
他の人の書いたスクリプトを改変するのはスクリプトを勉強したい方は別ですが、今の仕事を楽にしたいことが主目的の方には余計な仕事だと思うのです。
素人が手軽にプログラムの恩恵を受けられるはずのGASが全然手軽じゃなくなっちゃう。
そうすると効率化が楽しくなくなっちゃう。

わたしの場合ですが、慣れてないので自作のスクリプトにもかかわらず普通にバインドスクリプトを書くより改修の方が時間がかかりました。
業務効率を上げるのが目的なら、これに時間をかけるのは本末転倒かもなぁって思います。
結果、シンプルで合理的な方を選んだ方がいいです。

モヤモヤしながら手がかりが欲しくて検索をしてみた

どんな方でも書いたスクリプトはAppScript（ https://script.google.com/home ）に全てまとめられますが、AppScriptはフォルダが作れないのでスクリプトが増えるとお目当てのスクリプトが見つけづらくなります。

GASはプログラマーなどの玄人ばかりが利用するものではないにしても、この方法では管理しづらいし、複数のシートから一つのスクリプトを参照する方法がありそうだなぁと思い

GAS シート 社内共有

で検索してみました。


するとライブラリ、デプロイといった単語が混じったページがヒットしてきました。
複数の記事を読み進めていくうちに、

後々改修が必要になるかもしれない細々とした処理を記載した関数部分はスタンドアロン（スクリプト）をライブラリに登録しておいて
シートのバインドスクリプトに単純にライブラリの関数を呼び出す記載をすれば良い

とわかりました。
書き直す可能性がある部分だけは１つのファイルにしておく方法です。

ファイルを改修してライブラリに登録する

バインドスクリプトだったファイルをライブラリ用に書き直しました。
この時感じたわたしなりのポイントをまとめました。

ライブラリ側
クラスとコンストラクタを用意して、具体的な処理はメソッドに書く
ライブラリ内で使う外から呼び出す予定がないfunctionはクラスにしなくてもよい

バインドスクリプト側
newしてメソッド呼び出すだけ
修正しないつもりで単純に書く
（ライブラリのメソッドは直接呼び出せない）

分離作業は2つを同時にひらきながら書くとやりやすいと思いました。
最初からライブラリ用のgsを書くならデバッグもあるので個々に書いた方がやりよいですね。

こうしてできたスクリプトをライブラリにします。

ライブラリにする際に地味に困ったのがIDEが新しくなっていたことです。
変わりたてだったので先人の皆様の残した書きつけがそのまま利用できなかったのです。

1.プロジェクトの共有

ライブラリにするスクリプトを共有します。共有の設定は赤く囲ったアイコンからします。



クリックすると設定画面が出てきます。
同じ会社の人だったら誰でも使ってもらっていいので、グループのメンバー全員が閲覧できますに設定しました。

2.デプロイする

デプロイって何でしょうね？
わたしは使える状態のものとして登録しておくって捉えてます。
スクリプトに改修があった場合、今後少しずつ内容が違ったものが作られていきます。どれも動く状態としてAppScriptのIDEに登録しておけるようです。

さぁ、デプロイを始めましょう。
ライブラリにするスクリプトのデプロイボタンをクリック。

新しいデプロイの設定画面が出てきますので、ライブラリを選んでください。

説明を入力してデプロイボタンをクリックします。
わたしが参考にしたサイトによると新しい説明文の欄に日本語を入力するのは厳禁のようです。

完了をクリックしてデプロイを終えましょう。
（雑談ですが、このキャプチャを作成用に何も書いてない関数を使ったのですが、無でもライブラリにできるんだなぁと驚きがありました。）

3.スクリプトIDの場所

こちらはライブラリにしたスクリプトの「プロジェクトの設定」画面です。
（IDEの左側のアイコン群の歯車をクリックすると開きます）

スクリプトIDは赤で塗りつぶしている範囲にあります。
先ほどデプロイした関数を別のファイルから呼び出すために、こちらのスクリプトIDをバインドファイルに読み込みます。

わたしはマニフェストは表示派です。実際にはチェックを入れてます。
タイムゾーンを設定したり、ライブラリを読み込む際にも役立ちました。
普段は表示しないにしろjsonの中身をみておいてよかったなぁ。
もしGUIがうまく動かないことがあってもファイルの中身を見ていたおかげで、どっかで見たことあるファイルの記述だ。あれに直接書き込めばいいのかもしれないと・・・
調べまわってもわからないことも自力で突破できる糸口が得られたからです。

バインドファイルにライブラリを読み込む

バインド側のファイルを開き、ライブラリの横の+をクリックします。
ライブラリの追加画面が出てきます。

ここに先ほどのライブラリファイルのスクリプトIDをバインドファイルに読み込みます。

先ほどのライブラリの現在呼び出せるバージョンの一覧がドロップダウンリストで出てきます。
リストの内容は、HEAD（開発モード）と先ほどデプロイした1（説明：version.1）です。

今はリリース前の想定なので、1を選択します。
（HEADでもいいです。後から変えられるので。）

赤枠で囲ったIDの欄に任意の名称をつけます。

const abc = append.createABC();

のようにIDの後にコンストラクタ名で処理を呼び出すことになりますのでaaaとか適当にしちゃうと複数のライブラリが入ると、どのライブラリか中身がわかりづらくなりますよ。

追加をクリックするとライブラリが追加されています。
ライブラリを呼び出して、ざくざく書いていきましょう。

IDが登録できなくて困った

実は何故か任意のIDが登録できなくてとても苦労したのです。
弄り回すうちにマニフェストファイルに直接書いたらいいのでは・・・とわかりました。
（マニュフェスト appsscript.json はプロジェクトの設定でチェックを入れるとエディタに表示されます）

他にそんなことで困っている人は居なさそうだったのですが、IDEの変わり目なのでお役に立てば。

appsscript.json

    "libraries": [
      {
        "userSymbol": "Id_name",
        "version": "1",
        "libraryId": "this area fill up with script id",
        "developmentMode": false
      }
    ]

改修したファイルを配布したけれど自分以外はエラーになる！

ライブラリファイルを呼び出すように改造したので、再配布しようと試しに実行してもらいました。
ところが動かないんです。
「function hogehogeは定義されてません。」ってエラーが出ます。
自分は動くのに。

自分は動くから、権限関係でしょう。
ファイルの共有もしてるし・・・ってわからなかったのですが、調べてみるとライブラリをGoogle Cloud Platform（GCP）プロジェクトにしないといけないようです。

設定ファイルの下の部分です。

Google Cloud Platformで新しいプロジェクトを作ってプロジェクト番号を設定してください。

この辺りの設定を覚えていないこととキャプチャが取れてなくて恐縮なんですが・・・実行可能APIにして読み込みしたところ無事に動くようになりました。
新しいプロジェクトを登録する際にまた更新します。

参考にした本・ページ

全体的には本で

図書館で初版に出会い今までwebで調べながらしていたのが効率悪いのに気付きました。
ひと月くらい読み耽り、会社に第2版を買ってもらいました♡
コピペしない派の方にはこの本がよいのではと思います。今では手軽に辞書っぽく使います。
操作画面は旧IDEで紹介されています。

ライブラリのことなど

ライブラリについて調べているうちに上の本の作者の方のページにたどり着きました。新IDEで紹介されています。

実行可能APIのことなど

ライブラリにしても「function hogehogeは定義されてません。」と自分以外の人の環境で出てくるので、検索してたどり着きました。操作画面は旧IDEで紹介されてます。

レファレンス

本に載ってないことがあるので・・・でも英語なのですわ。
でも日本語で読むと意味わからんくなってくることもあるのですわ。
結局、英語版に戻るのですわ。