Google Apps ScriptでチャットワークAPIを活用するための最初の一歩

★気に入ったらシェアをお願いします!


Tunel

みなさん、こんにちは!
タカハシ(@ntakahashi0505)です。

前回、Google Apps Scriptを使って天気予報をチャットワークに送る方法をお伝えしてきました。

【Google Apps Script】天気予報をWeb APIで取得する方法
チャットワークに天気予報を通知するを目標に、今回はWeb APIとは何か、Google Apps Scriptでlivedoor天気情報のWeb APIからJSON形式のデータを取得してくる方法です。

天気以外にも、Twitterエゴサーチ結果、今日の予定、ブログのレポート、ブログ記事更新情報など様々な情報をチャットワークに送ることができます。

しかしながら、これらは全てチャットワークにメッセージを送るという一種類の操作に集約されます。

別の操作もしたいですよね…!?

チャットワークAPIを駆使すると、チャットのメッセージをスプレッドシートに取得したり、タスクやチャットの追加削除など、その他の様々な操作を行うことができるようになります。

その手始めとして、今回はチャットワークAPIの概要と簡単な使い方についてお伝えできればと思います。

チャットワークAPIとは?

まずAPIとは何かということなのですが

あるコンピュータプログラム(ソフトウェア)の機能や管理するデータなどを、外部の他のプログラムから呼び出して利用するための手順やデータ形式などを定めた規約のこと。
引用:IT用語辞典 

を言います。

チャットワークAPIでは特定のURLにアクセスすることで、チャットワークに様々な動作をしたり情報を取得したりすることができるようになります。

チャットワークAPIでできることはこちらです。

  • 自分自身の情報を取得
  • 自分の未読数、未完了タスク数を取得
  • 自分のタスク一覧を取得
  • 自分のコンタクト一覧を取得
  • チャット一覧の取得
  • チャットの作成
  • チャット情報の取得
  • チャット情報の変更
  • チャットのメンバー一覧を取得
  • チャットのメッセージ一覧を取得
  • チャットに新しいメッセージを追加
  • メッセージ情報の取得
  • チャットのタスク一覧の取得
  • チャットに新しいタスクを追加
  • タスク情報の取得
  • チャットのファイル一覧の取得
  • ファイル情報の取得
  • コンタクト承認依頼一覧を取得
  • コンタクト承認依頼の承認
  • コンタクト承認依頼のキャンセル

たくさんありますね~。

ChatWorkClient for GASライブラリの仕組み

冒頭で紹介した記事の中でチャットワークにメッセージを送る際は「ChatWorkClient for Google Apps Script」というライブラリを活用していました。

Google Apps Scriptの第一歩、初心者でもチャットワークにメッセージを送れる
Google Apps Scriptの第一歩ですが、しょっぱなから真っ先にチャットワークを操作してしまいます。初回はGASのプロジェクトの作成、ライブラリの追加、スクリプトの記述と実行までです。

このライブラリは、ChatWork社の渋谷さんがご用意してくださったもので

といった簡単な記述でチャットワークにメッセージを送ることができるようになります。

こちらのライブラリを拝見しますと

api…ってありますね。

この「https://api.chatwork.com/v2」がチャットワークAPIへのリクエスト用URLになっています。

「ChatWorkClient for Google Apps Script」ライブラリでは

  • メッセージ送信
  • マイチャットへのメッセージ送信
  • タスク追加
  • タスク一覧の種痘

などを行うためのAPIを、より簡易的な命令で使えるようにしてくれていたパッケージだったと言えます(マイチャットへのメッセージがあったの、今…気付きました。こちらを使ったほうが良かったものが大量に…あります)。

ChatWork Client for Google Apps Script. Contribute to chatwork-client-gas development by creating an account on GitHub.

ということで、チャットワークAPIを使って、様々な便利ツールや機能を作っていきたいと思います。

チャットワークAPIにリクエストをする

リクエストに必要なパラメータ

以前の記事で紹介したようにlivedoor天気のAPIにリクエストをする際は

とUrlFetchApp.fetchメソッドにリクエストURLを指定するだけで良かったのですが、チャットワークAPIではリクエストURLだけでなくパラメータが必要になります。

その場合、UrlFetchApp.fetchメソッドは第二引数も使用して

UrlFetchApp.fetch(アドレス,パラメータ)

とします。

チャットワークAPIリクエストの際に必要なパラメータは以下二つです。

  • 「X-ChatWorkToken」というキーでAPIトークンをセットしたHTTPヘッダ
  • 目的に応じたHTTPメソッド(GET,POST,DELETE,PUT)

二つあるので、以下のようにJavaScriptでのオブジェクト表記方法つまりJSON形式で変数に格納してあげます。

他のサービスのAPIを取り扱う場合はまた別のパラメータが必要になると思います。詳しくは以下ページを参考にして頂ければと思います。

チャットワークAPIのリクエストURL

チャットワークAPIへのリクエストURLは

https://api.chatwork.com/v2

がベースになります。

これに追記する形で目的別にエンドポイントと呼ばれる文字列とそれぞれに必要なパラメータを付加します。

エンドポイントは4種類あります。

  • /me:自分自身の情報にアクセス
  • /my:自分自身が持つデータ(未読数やタスクなど)にアクセス
  • /contacts:自分のコンタクトにアクセス
  • /rooms:チャットに関連してアクセス

自分の情報を取得するスクリプト

今回は試しに、/meのエンドポイントで自分の情報のいくつかを取得してみましょう。

スクリプトはこちらになります。

実行すると以下のログ出力が得られます。

チャットワークAPIから取得したme情報

チャットワークに登録している自分のチャットワークID、社名、名前、URLが取得できました。

まとめ

チャットワークAPIの概要と簡単な使い方についてお伝えしてきました。

以下、チャットワークAPIのドキュメントはもチェック頂ければと思います。

クラウド型ビジネスチャットツール「チャットワーク」における開発者向けAPIの仕様詳細について記載しています

使いこなせたら、色々なことが実現できそうですね…!

例えば

  • チャットに投稿した内容に応じてメッセージを返す
  • チャットで投稿した内容をスプレッドシートに記録する
  • 定期的なタスクを自動で追加する

など…Googleサービスや他のAPIを使えるサービスとの連携で、やれることはほぼ無限大です。

チャットワークAPIを使ったスクリプトを今後続々と紹介していきたいと思います。

次回は「おみくじチャット」の作成を目指して、チャットワークのメッセージを取得する方法です。

Google Apps Scriptでチャットワークからのメッセージを取得する方法
チャットワークで「おみくじチャット」を作るというのを目標にチャットワークAPIの使い方を勉強していきます。今回はチャットのメッセージをGoogle Apps Scriptで取得するところまでです。

どうぞお楽しみに!

連載目次:チャットワークAPI初級編:おみくじチャットを作る

本シリーズはGoogle Apps ScriptでチャットワークAPIの様々な機能を呼び出す練習となります。メッセージの取得をして、処理をして、メッセージを返すという一連の流れの基礎を学ぶことができますよ。
  1. Google Apps ScriptでチャットワークAPIを活用するための最初の一歩
  2. Google Apps Scriptでチャットワークからのメッセージを取得する方法
  3. Google Apps Scriptで乱数を使っておみくじプログラムを作る
  4. Google Apps Scriptでチャットワーク上におみくじチャットを作る
  5. Google Apps ScriptでチャットワークにToや返信でメッセージを送る
  6. 【GAS】チャットワークのメッセージを取り出す関数とメッセージを送る関数

コメント

  1. 無名 より:

    勉強になりました!