案件ボット G Suite 版

案件ボット G Suite 版

はじめに

このドキュメントは、direct と Google Apps を連携させた案件ボット(以下、ボット)について、各種設定から実行するまでの手順書となっています。そのため、direct および Google Apps の両サービスをご契約・ご利用中のものとしています。

まだ、ご利用でない方は、direct および Google Apps のそれぞれに無料トライアルがありますので、そちらをご参照ください。

ボット用アカウントの取得

ボット用に、新しくメールアドレスを用意します。

direct

通常のユーザと同じように、ボット用アカウントを作成します。

組織の管理ツールから、ボット用メールアドレスに招待メールを送信します。 管理ツールのご利用には権限が必要です。お持ちでない方は、契約者もしくは管理者にご連絡下さい。

組織に招待されると、ボット用メールアドレスにメールが届きます。 メールに記載されているURLをクリックしてアカウント登録手続きをしてください。

ログインページからボット用メールアドレスでログインします。 招待を承認する画面が開きますので、その画面で「承認」を選択してください。 次に、設定>プロフィール編集より、表示名とプロフィール画像をボット用に変更します。

Google Apps

連携アプリケーションの作成と同じように、ボット用プロジェクトを作成します。

Google Developer Console からプロジェクトを追加します。Google Developer Consoleのご利用方法については、こちらのヘルプページをご参照ください。

メニュー「APIと認証」の API で Drive API を有効にします。API の有効方法については、こちらのヘルプページをご参照ください。

メニュー「APIと認証」の認証情報で、OAuth用に「新しいクライアントIDを作成」します。「インストールされているアプリケーション」「その他」の組み合わせで作成してください。認証情報の設定する方法については、こちらのヘルプページをご参照ください。

node のインストール

https://nodejs.org/ から最新版をインストールします。v6.2.1 で動作確認しています。

サンプルプログラムの設定

サンプルプログラムをダウンロードして展開します。以降は、この展開したディレクトリ(フォルダ)にて、コマンドライン(コマンドプロンプト)で作業することになります。

direct

direct へのアクセスには、アクセストークンが利用されます。アクセストークンの取得には、アクセストークンを環境変数に設定していない状態で、以下のコマンドを実行し、ボット用のメールアドレスとパスワードを入力します。

$ bin/hubot
Email: loginid@bot.email.com
Password: *****
0123456789ABCDEF_your_direct_access_token

以下の環境変数に、アクセストークンを設定します。

$ export HUBOT_DIRECT_TOKEN=0123456789ABCDEF_your_direct_access_token

Google Apps

Google Apps へのアクセスには、OAuth2が利用されます。

以下の環境変数に、取得したアプリケーションIDおよびシークレットを設定します。

export GAPPS_CLIENT_ID=
export GAPPS_CLIENT_SECRET=

ボットに初めて話しかけたとき、コンソールにURLが表示されて処理が停止します。

$ bin/hubot
...
https://accounts.google.com/o/oauth2/auth?....
code? 

この URL をブラウザで開き、Google Apps の案件ボット用アカウントでログインします。ログインが成功すると認可画面が表示されますので承認してください。その後、コードが表示される画面になるので、コマンドラインに戻ってそのコードを入力します。

code? 4/aBcDeF...

トークンの情報は起動したディレクトリの .gdrive ファイルに保存されます。次回起動時はこの内容が読み込まれます。

案件ファイル

案件情報は、最新のExcelファイルから検索されます。

Google drive に 案件管理.xlsx をアップロードし、Google スプレッドシートに変換します。ファイル名は拡張子を削除して案件管理に変更してください。案件ボットが読み書きできるようにアクセス権限を設定します。案件管理ファイルのサンプルは、ダウンロードページで取得できます。

案件管理ファイル名は、以下の環境変数で変更することができます。未設定の場合は以下の値になります。

export ANKEN_WORKSHEET_NAME=案件管理.xlsx

サンプルプログラムの実行

以下のコマンドを実行します。

$ bin/hubot

サンプルプログラムのダウンロード

  • daab-googleapps-anken
    • 基本セット + 案件ボットのスクリプト
    • 履歴
      • github に移行
      • 2014/12/15 初版
  • 案件管理.xlsx
    • 案件のボットスクリプトで利用する案件ファイルのサンプル