GAS作成時に気を付けたいこと

オレンジピーチのトシです。
　前回までの記事で、GAS(Google Apps Script)を用いてスプレッドシートやGmailを操作する方法を紹介して来ました。
　生成AIを用いてGASを書くことで、プログラムの知識がない人でも、「自分にもGASが作れるのでは？」と思って頂けたら、とてもうれしいです。
　さらに、実際の業務に近い形での活用方法を紹介していく前に、GASを作成していく際に、注意して欲しい点をいくつか紹介したいと思います。

【生成AI×GAS】GAS作成の際の注意点

ＰＣ上のファイル（ローカルファイル）は処理できない

　GASは仕様上、クラウド上のファイルしか処理できません。
GoogleスプレッドシートやGoogleドキュメント、Gmailなどをイメージするとあたり前のようですが、GASは画像ファイルやテキストファイル、CSVファイルなども取り扱うことが出来ます。
　これらのファイルを取り扱うときは、Googleドライブにアップロードしておきましょう。

スプレッドシート等に名前を付ける

　スプレッドシートを新規作成すると、「無題のスプレッドシート」というファイル名で作成されます。
そのままでもデータ入力出来るのですが、ファイル名を変更することを心がけましょう。（同じ名前のファイル数が増えると、管理が難しくなります）
　ファイル名を変更するには、「無題のスプレッドシート」と書かれているファイル名の箇所をクリックすると、変更が可能です。
ドキュメントや、スライドでも同じく、分かりやすい名前に変更しましょう。

新規作成したスプレッドシート

シート名に名前を付ける

　シート名も、分かりやすい名前に変更しましょう。
GASのコードの中には、シート名を記述するものもあります。
GAS作成後にシート名を変更すると、エラーの原因となるため、早い段階でシート名を変更しておきましょう。

初期状態のシート名

GASのプロジェクトに名前を付ける

　「拡張機能」→「Apps Script」 からGASのエディタを開くと、初期状態では「無題のプロジェクト」という名前のプロジェクト名です。
このプロジェクト名を、内容を象徴するような名前に変更しておきましょう。

初期状態のプロジェクト

　また、左側の「コード.gs」は、GoogleAppsScriptのスクリプトファイルのファイル名です。
これまで紹介してきたGASは、すべて１つのスクリプトファイルでしたが、スクリプトファイルは複数持つことが出来ますので、必要に応じて名称を変えておきましょう。
変更は、スクリプト名横の、３点リーダから変更できます。

関数（function）名を変更する

　GASのエディタを立ち上げた際には、myFunction() という名前の関数が表示されます。
この関数名を、myFunction から変更しておきましょう。
1つのスクリプトの中に、複数の関数を記述することも出来ます。
それぞれの関数が何をするコードなのか、内容が分かる関数名にしましょう。（生成AIを用いて、GASを作成するときに、関数名を記述してくれる場合もあります）

初期状態の関数

１行の文末に「；」セミコロンを入れる。

　GASでは上から１行ずつ命令が実行されます。
その区切りの合図として、１行終わるごとにセミコロン（；）を記載します。（忘れても動くときもありますが、思わぬ挙動を示すときもあるので、忘れずに記載しましょう）

コメントを書く。コードの内容を説明する。

　GASでは、スラッシュを２本入力（//）以降の記載は無視されます。
それを利用して、命令文の説明をコメント入力します。
後から読んで、命令文の意味が分かるように記載しましょう。

コメント入力でGASの内容を記述する

コメント欄については、過去の記事でも触れていますので、よろしければ読んでみてください。

インデントを整える

　これまで、生成AIが生成したコードを使用してきたため、意識して来ませんでしたが、GASのコードは階層構造をしており、その階層（インデント）がGASの実行に重要な役割を担っています。
今後、より複雑なコードを書いていくために、ここでインデントの整え方を紹介します。

インデントの悪い例

　上記の「インデントの悪い例」では、すべてが同じ階層となっています。
（このようなコードでは、最悪、エラーとなってしまう場合があります。
そもそも、何を書いているか読みにくいですし。）

　インデントを整える方法は簡単です。エディタが開いている状態で、「shift + alt + f」を押すだけ。（Macの方は「shift + option + f」です。）

　それだけで、簡単にインデントを自動的に調整してくれます。

インデント調整後

まとめ

　今回は、GASを記述する際の注意点について説明しました。
これまで、「生成AI×GAS」の魅力を伝えることに注力するあまり、細かい点は割愛して紹介することも多くありました。
　今後、より現実的な指示に基づいて、より複雑なコードを書いていく前に、GASや関係するアプリを高い品質で作成する方法を知って頂けたらHappyです。

最後まで読んで頂き、ありがとうございました。