【初心者向けGAS】チャットワークのマイチャットにメッセージを送る最も簡単な例


send-message

photo credit: marcoverch Flaschenpost am Strand via photopin (license)

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

初心者向けGoogle Apps Scriptのシリーズとして、チャットワークのBotを作成する方法をお伝えしています。

前回の記事はコチラ。

【初心者向けGAS】面倒なことはライブラリに任せよう!その概要と追加の方法
初心者向けGoogle Apps ScriptのシリーズとしてチャットワークのBotの作り方についてお伝えしています。今回はライブラリとは何か、またその追加の仕方についてお伝えしていきます。

ライブラリとは何か、またライブラリの追加の方法についてお伝えしました。

これで、チャットワークのAPIを簡単に操作できるようになるライブラリ「ChatWorkClient for Google Apps Script」が追加されましたので、あとはそれを使ってメッセージを送信してみるまでですね。

ということで、まず超簡単な例としてGoogle Apps Scriptを使ってチャットワークのマイチャットにメッセージを送ってみましょう。

また、チャットワークAPIの利用に必要なAPIトークンの取得の方法についてもお伝えしていますよ。

では、行ってみましょう!

APIトークンとは

まず、チャットワークAPIを操作するときには、「APIトークン」と呼ばれるものを準備する必要があります。

APIトークンとは、チャットワークAPIを外部から使用する際に認証に使用する文字列です。

まあ、鍵のようなものですね。

「ChatWorkClient for Google Apps Script」を使用してメッセージを送ったり、タスクを追加したりする際にも、その鍵としてAPIトークンが必要になります。

なお、APIドキュメントにも記載されている通り

APIトークンは有効期限がなく、機能にフルアクセスが可能なものになっています。第三者へ開示しないよう取り扱いには十分ご注意ください。

ということなので、取得後は取り扱いには十分に注意するようにしてくださいね。

チャットワークのAPIトークンを取得する

このAPIトークンを取得する方法ですが、契約プランによって異なります。

ビジネスプラン・エンタープライズプランの場合

ビジネスプラン・エンタープライズプランの場合は、管理者への利用申請が必要になりますので、APIの利用申請ページから申請をしてください。

詳細はこちらのページをどうぞ。

APIの利用申請を承認・却下する
組織契約をご利用の場合は、ユーザーがチャットワークAPIを利用するためには、必ず組織管理者への利用申請が必要となります。 組織管理者は、「API利用申請リスト」にて、申請の承認と却下を行うことができます。※フリープラン、パーソナルプランをご利用のお客様はAPI設定ページからすぐにご利用いただけます。   APIの利用申...

フリープラン・パーソナルプランの場合

フリープラン・パーソナルの場合は、すぐにAPIトークンを取得できます。

手順としては、まずチャットワークの右上のメニューを開いて「API設定」を選択します。

チャットワークのAPI設定画面を開く

「API Token」の画面に遷移しますので、入力欄にチャットワークのパスワードを入力し「表示」をクリックします。

チャットワークAPIトークンを表示
正しいパスワードであれば、APIトークンが表示されますので「コピー」するなどして利用しましょう。

チャットワークAPIトークンを取得

チャットワークAPIを使ってマイチャットにメッセージを送る

では、試しに「ChatWorkClient for Google Apps Script」を通してチャットワークAPIを操作してみましょう。

以下のスクリプトを組んで実行してみましょう。

なお、「’ここにAPIトークンを入力してください’」のところには、先程取得した皆さんのAPIトークンを入力してくださいね。APIトークンは文字列なのでシングル(もしくはダブル)クォーテーションで囲むのです。

初回実行時は認証が必要ですが、以下のようにチャットワークのマイチャットに「テストメッセージ」というメッセージが送信されているはずです。

GASでチャットワークのマイチャットにメッセージを送信

ChatWorkオブジェクトを生成する

「ChatWorkClient for Google Apps Script」の使い方について解説をしていきましょう。

まず、2行目。

ここでは、チャットワークのAPIトークンを渡してChatWorkオブジェクトを生成して変数cwにセットしています。

ChatWorkオブジェクト…?生成?…なんだそれ?!

という感じかも知れませんが、ひとまず、チャットワークを操作するために必要な「モノ」だと認識してください。

その、生成したChatWorkオブジェクトを通すことで、チャットワークの操作をすることができます。

その生成の書式はfactoryメソッドを使って、このように書きます。

ChatWorkClient.factory({token: チャットワークAPIトークン})

チャットワークAPIトークンは前述の通り、文字列なのでシングルまたはダブルクォーテーションで指定します。

マイチャットにメッセージを送る

続いて、4行目でマイチャットにメッセージを送信します。

sendMessageToMyChatメソッドを使いまして、書式は以下の通りです。

ChatWorkオブジェクト.sendMessageToMyChat(メッセージ)

こっちはわかりやすいですね。

これで、マイチャットにメッセージを送ることができるわけです。

まとめ

Google Apps Scriptでチャットワークのマイチャットにメッセージを送信する方法をお伝えしました。

またチャットワークのAPIトークンの取得の方法もお伝えしました。APIトークンは取り扱い注意でお願いしますね。

ライブラリ「ChatWorkClient for Google Apps Script」を使うことで、実質2行のステートメントでメッセージ送れることがわかりましたね。

これを使って、Botを作っていきますよ。

【初心者向けGAS】Google Apps Scriptで別の関数を呼び出すfunctionの書き方
Google Apps ScriptでBotを作りながらその基本を学ぶシリーズです。今回は、関数から別の関数を呼び出す方法です。functionの書き方、引数、仮引数、戻り値などについても解説します。

次回、どうぞお楽しみに!

連載目次:超初心者向けGASでBotを作りながら基礎を学ぶ

Google Apps Script(GAS)をはじめるためのメリットは山程ありますが、何を作ったらいいの?と悩んでしまうこともありますよね。そんな時に、おすすめしたいのが「Bot」の作成です。このシリーズでは、超初心者向けにGASでBotを作る方法を題材としながら、GASプログラミングの一通りの流れと書き方について学んでいきます。
  1. 【初心者向けGAS】本当の最初の一歩!スクリプトエディタでプロジェクトを開く
  2. 【初心者向けGAS】はじめてのスクリプトを作成し、保存し、実行する
  3. 【初心者向けGAS】プログラミングに必須の変数の使い方とデータ型について
  4. 【初心者向けGAS】ログを表示するLogger.logの使い方
  5. 【初心者向けGAS】スクリプト実行時の「承認」でびっくりしないために
  6. 【初心者向けGAS】Spreadsheetサービスの「オブジェクト」の基礎の基礎を知ろう
  7. 【初心者向けGAS】スプレッドシートのシートを取得する2つの方法
  8. 【初心者向けGAS】スプレッドシートのセル・セル範囲とその値を取得する方法
  9. 【初心者向けGAS】for文を使ったスプレッドシートの繰り返しの超基本
  10. 【初心者向けGAS】条件分岐をするif文の使い方の超基本
  11. 【初心者向けGAS】スプレッドシートのセルに値を入力する基礎の基礎
  12. 【初心者向けGAS】条件に応じてループを制御する2つの方法~break文とwhile文~
  13. 【初心者向けGAS】スプレッドシートのセル範囲を行数・列数を使って取得する
  14. 【初心者向けGAS】スプレッドシートのセル範囲をクリアするいくつかの方法
  15. 【初心者向けGAS】Google Apps ScriptでWeb APIを活用するための基礎知識
  16. 【初心者向けGAS】面倒なことはライブラリに任せよう!その概要と追加の方法
  17. 【初心者向けGAS】チャットワークのマイチャットにメッセージを送る最も簡単な例
  18. 【初心者向けGAS】Google Apps Scriptで別の関数を呼び出すfunctionの書き方
  19. 【初心者向けGAS】時限式のイベントトリガーを設置して決まった時刻にBotを送信する方法
  20. 【初心者向けGAS】プロパティストアの概要とスクリプトプロパティの編集方法
  21. 【初心者向けGAS】スクリプトプロパティを操作してそのデータを取り出す方法
  22. 【初心者向けGAS】スプレッドシートのセル範囲の値を二次元配列として取得して取り扱う方法
  23. 【初心者向けGAS】チャットワークのメッセージ記法でBot送信するメッセージを装飾する方法
  24. 【初心者向けGAS】Google Apps Scriptのドキュメンテーションコメントの書き方

The following two tabs change content below.
株式会社プランノーツ代表、コミュニティ「ノンプロ研」主宰。1976年こどもの日生まれ。東京板橋区在住。「ITで日本の『働く』の価値を上げる!」をテーマに、VBA&GASの開発、講師、執筆などをしております。→詳しいプロフィールはコチラ ★ご依頼・ご相談はお気軽にどうぞ!→お問い合わせはコチラ ★フォロー頂ければ嬉しいです。

コメント

  1. 武田 より:

    タイトルにある対象者そのものの超初心者なので、
    とても、丁寧な説明に感謝していますm(_ _)m

    ChatWorkで取得したトークンを入れても、以下のような表記が出て、
    うまくいきません。

    ReferenceError: 「ChatWorkClient」が定義されていません。(行 2、ファイル「CW」)

    どこが悪いのでしょうか?

    お忙しいところお手数ですが、ご返信いただけると幸いです。
    よろしくお願いいたします。