使い方
新規にGoogle Spreadsheetを作成する
Garoon Slack Notificatorは、Google Spreadsheetを設定の保存先として利用します。そのためまずはじめにGoogle Spreadsheetを新規に作成します。
自分のガルーンのID・パスワードを記載することになるので、公開範囲には気をつけてください。
Google Apps Scriptを作成する
Google Spreadsheetのメニュー ツール > スクリプトエディタ
からGoogle Apps Scriptのスクリプトエディタを開きます。
GitHubに公開しているコードをスクリプトエディタへコピペします。
設定
最初に作成したGoogle SpreadsheetにガルーンのIDやパスワード、SlackのWebhook URLなどの設定を記載します。
用意したスクリプトを実行することでその設定表をGoogle Spreadsheet上に作成できます。
スクリプトエディタのメニュー 実行 > 関数を実行 > setUp
を選択することで、setUp
関数を実行できます。関数を実行し、Google Spreadsheetに戻ると「設定」シートが作成されているはずです。
「設定」シートに、下記の設定項目を記入します。
項目 | 設定値 |
---|---|
ガルーン サブドメイン | ガルーンのサブドメインを記入します。例えば、ガルーンのURLが example.cybozu.com であれば、 example の部分がサブドメインとなります。 |
ガルーン ID | ガルーンのIDを記入します。 |
ガルーン パスワード | ガルーンのパスワードを記入します。念のため、白の文字色にしておりカーソルを合わせない限りはパスワードが表示されないようになっていますが、ただの目隠しですので、このSpreadsheetの公開範囲にはお気をつけください。 |
Slack WebhookURL | SlackのIncoming Webhook URLを指定します。 |
Slack Channel | 非公開予定も通知されるようになるので、自分のユーザ名を指定することをおすすめします。 |
取得間隔(分) | 何分前に通知をするかを分で指定します。(1 , 5 , 10 , 15 , 30 から選択します。) |
タイマーを設定する
スクリプトを定期的に実行するためにタイマーを設定します。
スクリプトエディタのメニュー 編集 > 現在のプロジェクトのトリガー
を選択します。
「トリガーが設定されていません。今すぐ追加するにはここをクリックしてください。」をクリックします。
「実行」は「main」を選択し、「イベント」は「時間主導型」「分タイマー」を選択します。選択する分数は前述した「取得間隔」に設定した値を設定します。
TIPS
一番右の「通知」リンクをクリックし、実行失敗時にメールで通知できるようにしておくと設定ミスなどに気付けるので設定しておくことをおすすめします。
「通知」をクリック後、通知方法を選択します(基本的に「(Google Appsのメールアドレス)メール経由」しか選択できないはずです)。通知タイミングは「今すぐ」を選択します。最後にOKをクリックし、通知の設定を完了します。
最後にタイマーの設定を保存するために、「保存」ボタンをクリックしますが、クリックするのはタイミングを見計らいます。
例えば、5分ごとの実行を8:03に設定すると、次回の実行はその5分後の8:08となってしまい、中途半端な時間に実行されることとなってしまいます。そのため、5分ごとの設定の場合は、8:00や8:05、8:10などのちょうどいいタイミングを見計らう必要があります。