こんにちは、ジモティーでエンジニアをしている中村です。
以前の橋本の記事が好評だったので、今回もデータ活用周り、特に弊社でのGoogle Apps Script（以下GAS）の活用について書いていきたいと思います。
ジモティーにおけるGASの活用例
弊社ではGASを色々な用途で利用しています。ここではその一例をご紹介します。
KPIメールの送信
KPIメールとは、橋本の記事でもご紹介した通りサービスのコンディションを測るための重要指標を集計し、１日に２回全社員向けに送信しているメールのことです。 GASを使ってBigQueryやFirebase、SpreadSheetなどから各KPIを集計してそれをスプレッドシートとメールに出力しています。
リリース履歴の保存
監査のためにリリース履歴を保存する仕組みにも利用しています。 弊社ではreleaseというブランチを切っており、このブランチにマージされたものが本番にリリースされます。 リリース時はメインブランチからrelaseブランチ向けのプルリクを作ります。 このプルリクがマージされたときに、GitHubのWebhookでGASへリクエストを飛ばして、それを受け取ってリリース履歴保存用のスプレッドシートに書き出しています。
CircleCIのモニタリング
弊社ではCIツールとしてCircleCIを利用しているのですが、度々「CI遅くない？」「遅いよね」「うん遅い」みたいな会話が発生していました。 なので、本当に実行時間が伸びているのかを検証するためにGASでCircleCIのAPIを使って各ジョブの実行時間を取得し、スプレッドシートに書き出すことで平均実行時間をモニタリングできる仕組みを構築しました。
GASの導入理由
弊社ではデータ分析基盤にBigQueryやFirebase、SpreadSheetなどのGoogle系のサービスを利用しています。KPIメール配信システムの開発の際にそれらのサービスと連携がしやすかったためGASを導入しました。
GASのデメリット
ただ、GASを使い始め以下のような課題もありました。
- Webエディタでの開発がしづらい
- コードレビューがしづらい
- 問題があったときに元の状態に戻しづらい
これらを解決するために、弊社では clasp というツールを導入しました。
clasp の導入
claspとは？
clasp は Google謹製の、GASをローカルで開発出来るようにするためのツールです。
pull コマンドでリモートのGASのコードをローカルに落としたり、push コマンドで簡単にアップロードが出来ます。
また、弊社ではいまのところ利用していませんが、TypeScript や ES6 も使えるみたいです。
弊社では、clasp でローカルに落としたコードを GitHub にプッシュすることでGASのバージョン管理をしています。
claspの使い方
最後にclaspの使い方を簡単にご紹介したいと思います。
1. claspのインストール
clasp は npm を使ってインストールします。
# claspをインストール > npm i @google/clasp -g
2. clasp で Google アカウントにログイン
以下のコマンドでお使いのGoogleアカウントにログインします。
> clasp login
ブラウザが起動するので、シート作成時のアカウントを選択してclaspからのアクセスを許可してください。
3. Googleスプレッドシートの新しいシートを作成する
弊社では、GASとSpreadSheetを紐つけて管理しているので、SpreadSheetのスクリプトエディタからGASを起動していきます。
4. スプレッドシートのツールメニューから「スクリプトエディタ」を起動
GASのWebエディタが開きます。
5. GASのプロジェクト名を設定
適当な名前をつけてください。
6. 試しにスクリプトを実行してみる
↓のように関数を実装して、▶ を押して実行してみてください。
表示メニューの「ログ」、もしくは Cmd + Enter で実行結果を確認できます。
7. プロジェクトのプロパティのスクリプトIDをコピー
GASのスクリプトエディタの「ファイル」メニューの「プロジェクトのプロパティ」の、スクリプトIDをコピーしてください。
8. ローカルに適当な名前のディレクトリを作成
> mkdir clasp_sample > cd clasp_sample
9. clasp clone でローカルにGASのコードをClone
> clasp clone 【手順7でコピーしたID】 Warning: files in subfolder are not accounted for unless you set a '.claspignore' file. Cloned 2 files. └─ appsscript.json └─ コード.js Not ignored files: └─ appsscript.json └─ コード.js Ignored files: └─ .clasp.json > ls appsscript.json コード.js
10. ローカルでファイルを編集してPush
function myFunction() { Logger.log("ぼくジモティー"); }
編集してプッシュします。
> clasp push
\ Pushing files...Push failed. Errors:
{ Error: User has not enabled the Apps Script API. Enable it by visiting https://script.google.com/home/usersettings then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.
エラーがでます。
11. エラーメッセージにあるURLにアクセスして Google App Script API をONにする
12. もう一回 Push
> clasp push └─ appsscript.json └─ コード.js Pushed 2 files.
今度は成功しました。 もう一度スクリプトエディタを確認すると。
無事ローカルの修正がリモートに反映されています。
13. GitHubなどにPushしてバージョン管理
弊社ではGitHubを使ってGASのバージョン管理をしているので、最後に忘れず変更をPushします。
終わりに
最後まで読んでいただきありがとうございました。 本記事の内容が少しでもお役に立てば幸いです。
また、弊社ではジモティーを更に成長させる為に一緒に取り組んでいただけるエンジニアを募集しています。 もし少しでも気になればお気軽にご応募ください。
弊社では一緒にプロダクトを改善していただける仲間を探しています！
こちらでお気軽にお声がけください！
