はじめに

bocci bocciを運営している@shoji-kaiです。
前編ではfreee APIのセットアップと基本的な使い方を確認しました。
今回は、GAS(Google Apps Scripts)を使って商品購入メールが届いていたらfreee APIを叩くところまでをやってみたいと思います。

GAS(Google Apps Script)とは

GASは、GmailやGoogle SpreadsheetsなどGoogle Workspaceの一連のアプリケーションを操作できるスクリプトの総称になります。
GASは下記URLより誰でも使うことができます。

Google Appsの承認

GASからGoogle Apps(Gmail, Google Spreadsheetsなど)にアクセスしようとすると承認が求められます。
下記のステップで承認を許可してください。

1. 承認ダイアログが出てきたら「権限を確認」を押す

2. アカウントを選択する

3. 左下にある「詳細」を開く

4. 「無題のプロジェクト (安全ではないページ) に移動」をクリックする

5. アクセスリクエストを許可する

GASからfreee APIを叩いてみる

それでは、早速GASからfreee APIを叩いてみたいと思います。
GASでプロジェクトを新規作成し、以下のコードを貼り付けて実行します。

コード.gs

function postDeal() {
  const accessToken = '<ACCESS_TOKEN>'; // 自分のアクセストークンに置き換えてください
  const companyId = <COMPANY_ID>;       // 自分の事業所IDに置き換えてください
  const data = {
    "issue_date": "2020-11-01",
    "type": "expense",
    "company_id": companyId,
    "details": [
      {
        "tax_code": 136,
        "account_item_id": 538987945,
        "amount": 1100,
        "description": "ノートとボールペンをコンビニで購入"
      }
    ]
  };

  const url = 'https://api.freee.co.jp/api/1/deals';
  const options = {
    'method': 'post',
    'contentType': 'application/json',
    'payload': JSON.stringify(data),
    'headers': {
      'Authorization': 'Bearer ' + accessToken
    }
  };
  const res = UrlFetchApp.fetch(url, options);
  Logger.log(res.getResponseCode());
}

エラーが発生せずに正常終了していれば成功です。

GASからGmailに商品購入メールが届いているか確認する

まずはダミーの商品購入メールを自分のGmail宛てに送信します。

cat <<. | sendmail -t
Subject: 商品が購入されました。
To: <メールアドレス>

テスト
.

GASに以下のコードを追記します。

コード.gs

function checkOrderMail() {
  const query = 'subject:(商品が購入されました) in:anywhere';
  const threads = GmailApp.search(query).reverse();
  for (let i = 0; i < threads.length; i++) {
    const messages = threads[i].getMessages();
    for (let j = 0; j < messages.length; j++) {
      const date = messages[j].getDate();
      const orderedAt = date.getFullYear() + '-' + (date.getMonth() + 1) + '-' + date.getDate();
      Logger.log('ordered at ' + orderedAt);
    }
  }
}

実行する関数を checkOrderMail に変更して実行します。
実行ログに'ordered at'のログが記録されていれば成功です。

メールが届いていたら仕訳登録する

続いて、メールが届いていたらpostDeal()を呼び出して仕訳登録する処理を追加します。
ここではメール受信〜仕訳登録の一連のながれをテストしたいだけなので、先ほどのサンプル取引データをそのまま流用します。
ただし、取引発生時刻はメール受信時刻とすることにします。

コードは以下のようになります。

コード.gs

function postDeal(orderedAt) {          // <= 引数にorderedAtを受け取る
  const accessToken = '<ACCESS_TOKEN>';
  const companyId = <COMPANY_ID>;
  const data = {
    "issue_date": orderedAt,            // <= issue_dateのvalueをorderedAtに変更
  :
  (snip)
  :
}

function checkOrderMail() {
  const query = 'subject:(商品が購入されました) in:anywhere';
  const threads = GmailApp.search(query).reverse();
  for (let i = 0; i < threads.length; i++) {
    const messages = threads[i].getMessages();
    for (let j = 0; j < messages.length; j++) {
      const date = messages[j].getDate();
      const orderedAt = date.getFullYear() + '-' + (date.getMonth() + 1) + '-' + date.getDate();
      Logger.log('ordered at ' + orderedAt);

      postDeal(orderedAt);  // <= postDeal()の呼び出しを追加
    }
  }
}

以下のようにエラーがなく正常終了していたら成功です。

いちおう、freeeの画面からも確認してみます。
メール受信時刻を取引日とした仕訳が登録されていることが確認できます。

トリガーを設定する

最後にトリガーを設定して、Gmailを定期的にチェックするようにします。
トリガーは、左カラムにある時計のアイコンになります。

トリガーをクリックし、新しいトリガーを作成すると以下のようなダイアログが出てきます。
今回はテストのために分単位でチェックしますが、本番では一日単位で十分でしょう。
以下のように項目を選択してトリガーを保存します。

1分ほど待ってから、再度freeeを確認してみます。
取引データが追加されていることが分かります。

トリガーの確認ができたら、忘れずにトリガーを削除しておきます。
GASは無料で使えますが、一日あたりの実行回数に制限があります。
ref. https://developers.google.com/apps-script/guides/services/quotas

おわりに

以上でGASから購入メール確認〜仕訳登録までを定期的に実行するやり方を確認できました。
ですが、本番に実装するにはまだクリアしなければいけない項目があります。

アクセストークンの更新 (freeeのアクセストークン期限は24時間なのでリフレッシュする必要があります)
検索するメールの範囲を指定する (一日単位でトリガーを設定した場合、一日以内のメールのみを検索する)
重複取引の除外 (同じデータを取り込まないようにする)
購入メール本文から注文番号、商品名、商品価格を抽出する

などです。
次回は、このあたりの項目も実装した完成版を構築していきたいと思います。