Chatwork のタスクを Google カレンダーに表示する GAS を作った

タスク管理を楽にしようと思って Trello などのツールを試してみたものの、「タスクを管理する」という新たな作業が増えてしまったことがあります。
クライアントとのやり取りには主に Chatwork を使っているので、タスク管理も Chatwork で行っています。毎日開くツールの中で完結するため、シンプルに使えるところが気に入っています。
今回は、その Chatwork のタスクを Google カレンダーでも確認できるように、Google Apps Script(GAS)で連携スクリプトを作りました。
Google Apps Script とは
Google Apps Script は、Google のサービスを操作したり、外部サービスと連携したりできるスクリプト環境です。
JavaScript を使って書けるため、Google カレンダーや Google ドライブを操作するために、新しい言語を覚えなくても済みます。
今回のスクリプトでは、Chatwork API から未完了のタスクを取得し、期限の日付に Google カレンダーの終日予定として登録します。
今回のスクリプトの動き
スクリプトは実行されるたびに、対象期間内にあるこのスクリプトが登録した予定を削除し、Chatwork のタスクから予定を作り直します。
- 未完了で、期限が設定されているタスクを対象にする
- 期限が対象期間内にあるタスクを終日予定として登録する
- 完了済みのタスクや、期限が設定されていないタスクは登録しない
- 時間主導型のトリガーで定期的に実行する
元のスクリプトでは、対象期間を過去2か月から6か月先までに設定しています。
まずは連携専用の新しいカレンダーを作成し、少ないタスクで動作を確認してください。 このスクリプトは予定の削除後に Chatwork からタスクを取得するため、途中で API の取得や予定の登録に失敗すると、一時的に予定が消えたり、一部だけ登録されたりします。
1. Google カレンダーを用意する
既存のカレンダーも指定できますが、まずは連携専用の新しいカレンダーを作成します。
- パソコンのブラウザで Google カレンダーを開きます。
- 左側の「他のカレンダー」の右にある「+」から、新しいカレンダーを作成します。
- 名前を付けて作成したら、カレンダーの「設定と共有」を開きます。
- 「カレンダーの統合」に表示される カレンダー ID を控えます。
2. Chatwork の API トークンを確認する
Chatwork の画面右上にある利用者名のメニューから「サービス連携」を開き、API トークンを確認します。
組織契約の場合、API の利用に管理者への申請が必要なことがあります。詳しい手順は公式ヘルプを確認してください。[Chatwork の API トークン発行手順]
API トークンは認証情報なので、公開するコードや Git リポジトリには記載しないようにします。
3. スクリプトを作成する
Google ドライブから Apps Script のプロジェクトを作成し、次のコードを貼り付けます。
CALENDAR_ID と CHATWORK_TOKEN を、先ほど控えた値に変更してください。
// Google カレンダー ID
const CALENDAR_ID = 'ここにGoogleカレンダーIDを記入'
// Chatwork API トークン
const CHATWORK_TOKEN = 'ここにChatworkのAPIトークンを記入'
// タイトルの最大文字数
const MAX_TITLE_LENGTH = 50
// 対象期間
const MONTH_FROM = 2
const MONTH_TO = 6
// Chatwork API のエンドポイント
const CHATWORK_API_URL = 'https://api.chatwork.com/v2/my/tasks?status=open'
// カレンダーの予定に付けるタグ
const CALENDAR_TAG_KEY = 'chatwork'
// トリガーからこの関数を実行する
function syncChatwork() {
const calendar = CalendarApp.getCalendarById(CALENDAR_ID)
const term = getTerm()
// このスクリプトが登録した予定を削除する
clearEvents(calendar, term)
// Chatwork のタスクを取得する
const tasks = getTasks()
let count = 0
tasks.forEach((task) => {
const date = getDate(task, term)
if (!date) {
return
}
const title = getTitle(task)
const description = getDescription(task)
const event = calendar.createAllDayEvent(title, date, { description })
event.setTag(CALENDAR_TAG_KEY, '1')
count += 1
})
Logger.log(`未完了タスク数: ${count}`)
}
// 対象期間を返す
const getTerm = () => {
const dateFrom = new Date()
const dateTo = new Date()
dateFrom.setMonth(dateFrom.getMonth() - MONTH_FROM)
dateTo.setMonth(dateTo.getMonth() + MONTH_TO)
return {
from: dateFrom,
to: dateTo,
}
}
// このスクリプトが登録した予定を削除する
const clearEvents = (calendar, term) => {
// 過去の予定は1日多く取得する
const dateFrom = new Date(term.from.getTime() - 24 * 60 * 60 * 1000)
const events = calendar.getEvents(dateFrom, term.to)
events.forEach((event) => {
if (!event.getTag(CALENDAR_TAG_KEY)) {
return
}
event.deleteEvent()
})
}
// Chatwork からタスクを取得する
const getTasks = () => {
const response = UrlFetchApp.fetch(CHATWORK_API_URL, {
headers: { 'X-ChatWorkToken': CHATWORK_TOKEN },
method: 'get',
})
return !response ? [] : JSON.parse(response.getContentText())
}
// 対象期間内のタスクの期限を返す
const getDate = (task, term) => {
if (!task.limit_time) {
return null
}
const date = new Date(task.limit_time * 1000)
if (date.getTime() < term.from.getTime() || term.to.getTime() < date.getTime()) {
return null
}
return date
}
// タスクのタイトルを返す
const getTitle = (task) => {
const title = task.body
.split(String.fromCharCode(10)).join(' ')
.replace(/\[/g, '<')
.replace(/\]/g, '>')
.replace(/<("[^"]*"|'[^']*'|[^'">])*>/g, '')
return title.length > MAX_TITLE_LENGTH
? `${title.substring(0, MAX_TITLE_LENGTH)}...`
: title
}
// タスクの詳細を返す
const getDescription = (task) => {
return `【${task.room.name}】by ${task.assigned_by_account.name}\n${task.body}`
}4. 手動で実行して確認する
Apps Script の編集画面で syncChatwork を選び、実行します。初回は権限の承認を求められるので、内容を確認して許可します。
処理が正常に完了すると、対象となる Chatwork のタスクが、期限の日付に終日予定として追加されます。
5. 定期実行を設定する
手動実行で問題がなければ、時間主導型のトリガーを設定します。
- Apps Script の編集画面で「トリガー」を開きます。
- 「トリガーを追加」を選びます。
- 実行する関数に
syncChatworkを指定します。 - イベントのソースに「時間主導型」を選び、実行間隔を設定して保存します。
私は1時間おきに実行する設定にしています。タスクの変更は次の実行時に反映されるため、カレンダーに即座に反映されるわけではありません。[Apps Script のトリガー設定]
使っていて気をつけたいこと
このスクリプトは差分だけを更新する仕組みではなく、実行のたびに対象期間の予定を削除して作り直します。
たとえば対象のタスクが毎回10件あり、1時間おきに実行する場合、予定の作成だけで1日あたり最大240件になります。これに加えて、既存予定の取得や削除も発生します。
Apps Script や Google カレンダーには利用上限があり、アカウントの種類によっても異なります。上限は変更されることがあるため、現在の値は公式ドキュメントを確認してください。[Apps Script の利用上限]
また、元のスクリプトでは Chatwork API の取得件数を最大100件として想定しており、ページ分割して追加取得する処理はありません。未完了タスクが多い場合は、取得できないタスクがないか確認が必要です。
タスク数が増えたり、もっと頻繁に同期したくなったりした場合は、差分だけを追加・更新・削除する方法も考えられます。差分の判定は少し面倒ですが、カレンダーの操作回数は減らせそうです。




Discussion