【はじめてのfreeeAPI】GASでリクエストを送りfreeeの事業所一覧を取得する


こんにちは!ITライターのもり(@moripro3)です!

クラウド会計ソフトfreeeのAPIを使って経理業務を自動化する初心者向けシリーズ「はじめてのfreeeAPI」をお届けしています。

前回の記事でGASとfreeeを連携する作業をして、いよいよGASでfreeeAPIを操作できるようになりました!

【はじめてのfreeeAPI】GASとfreeeをつなぐ!連携認証の手順を一から紹介します
GoogleAppsScriptでクラウド会計ソフトfreeeのAPIを操作するシリーズ。GASでfreeeを操作するために必要な「freeeマイアプリの作成」と「連携」の手順を、画面キャプチャ盛りだくさんで丁寧に紹介しています。

今回の記事では、最も簡単なお題「事業所一覧の取得」で、これらの練習をしてみましょう。

  • GASでfreeeAPIを操作し、freeeからデータを取得する
  • freeeAPIリファレンスの読み方を理解する

GASでfreeeAPIを操作するメリットの1つが、CSVファイルを経由しなくても直接データのやりとりができることでした。
GASを使用してスプレッドシートとfreeeを連携する

引用:【freee API】GASを用いてGoogleスプレッドシートと連携する

GASでfreeeに「データをください」というリクエストを送り、直接freeeからデータをもらう一連の流れをみていきましょう!

(この記事はfreee株式会社さまとのコラボ企画です。シリーズを通して、皆さんの働くの価値を上げられるよう皆さまをサポートしていきます!)

使用するスプレッドシート

前回の記事で作成したスプレッドシートを引き続き使用します。

登録したライブラリ(OAuth2 for Apps Script)・認証コードは、今後もfreeeAPIを操作するために必要なので、シリーズを通して同じスプレッドシートを利用していきましょう。

当記事の解説ではこのような名前にします。

  • 認証コードを書いたスクリプトファイル → freeeAuth.gs
  • 今回コードを書くスクリプトファイル → Company.gs

Company取得のスクリプトファイル

事業所一覧を取得する

この記事のお題「GASでfreeeAPIを操作して事業所一覧を取得する」を進める前に、「なぜ最初に事業所一覧を取得するのか?」を紹介します。

GASでfreeeAPIを操作することで、様々な操作が自動化できることをシリーズ初回にお伝えしました。

  • 試算表の出力
  • 取引の登録・出力
  • 振替伝票の登録・出力
  • 請求書の作成・出力 など他多数

これらの処理をするためには、freeeAPIに対して「この事業所のデータを取得します(登録します)」という情報を伝える必要があります。

freeeでは、1つのアカウントで複数の「事業所」を作成することができ、事業所ごとに固有の「事業所ID」が割り振られています。(1人で複数の事業を営んでいる場合、事業ごとに会計を分けた方が管理しやすいですよね)

freeeアカウントと事業所の関係

1つのアカウントで複数の「事業所」を作成できるので、GASでfreeeAPIを操作するときには、どの事業所に対する処理かを指定する「事業所ID」が必要になります。

ただし、この「事業所ID」はfreeeの画面上では確認できません。そこで、freeeAPIを通じて事業所一覧を取得し、事業所IDを確認する必要があるのです。

リクエスト・レスポンスとは

この項では、GASでfreeeAPIを操作するために必要な2つの用語を確認しておきましょう。

  • リクエスト(要求)
  • レスポンス(応答)

人間同士のやり取りと似ています。「○○の作業をお願い」と要求し、「はい、○○の結果だよ」と応答が返ってくるイメージです。

「リクエスト」とは、freeeのデータサーバに対して「~の処理をお願いします」と要求することで、その種類は4つあります。

  1. GET「取得」
  2. POST「作成」
  3. PUT「更新」
  4. DELETE「削除」

レスポンスとは、リクエストの「結果」です。正常終了・異常終了など、何らかの結果が返ってきます。これは連載を通じて紹介していきます。

<リクエスト・レスポンスのイメージ>
HTTPリクエストとレスポンスのイメージ

GETリクエストで事業所一覧を取得するコード

処理の内容は「取得」なので、リクエストの種類は「GET」です。そのコードがこちらです。

コードは後の項で詳しく解説するので、まずは実行してみましょう。

下記のようなログが出力されれば成功です。

1つのfreeeアカウントで作成している事業所のデータがすべて出力されます。(私は2つの事業所を作成しているので、2事業所が出力されています)

出力結果“id”の値が「事業所ID」です。

freee事業所IDの確認

事業所一覧を取得するコードの解説

この項では、コードの処理内容を1行ずつ解説していきます。

アクセストークンの取得

4行目で、freeeAPIのサービスから「アクセストークン」を取得しています。

前回の連携作業で、GASとfreeeをつなぐための「freeeマイアプリ」を作成しました。

アクセストークンとは、データサーバとは別の認証サーバが発行するもので、「freeeマイアプリが、ユーザーの代わりに、freeeデータの操作を許可されていることを示す証明書」です。

この「証明書」は、悪意あるアプリの不正アクセスからAPIを守る技術であるOAuthという認証の仕組みで使われています。

「事前に身元を確認(認証)済みであり、怪しい者ではありませんよ」という証明書です。

(※説明を簡略化するために、下記イメージ図からfreeeマイアプリは省いています)

freeeアクセストークンを取得する

この「証明書」を提示することで、データサーバからデータがもらえる仕組みです。

freeeアクセストークンを提示してデータを取得する

リクエストに付与するパラメータ

7~10行目では、リクエストする際に必要な2つのパラメータを設定しています。

  • メソッド
  • ヘッダー

メソッドとは、リクエストの方法です。ここではデータの「取得」をするのでGETリクエストです。

(メソッドを省略した場合はGETリクエストになるので記述しなくてもよいですが、ここでは、GETリクエストであることを明示するために記述しています)

ヘッダーとは、APIにリクエストを送る際に必要な情報の一部です。OAuthのルールでは、Authorizationの値に、”Bearer”という文字列とアクセストークンを送ることが決められています。
(※コードでは、Bearerの後ろに半角スペースが入っているのでご注意ください)

ヘッダーについては「そういう決まりなんだな」と理解するだけで、難しく考えなくて大丈夫です。

リクエストURL

13行目で、事業所一覧を取得するための「リクエストURL」を指定しています。

リクエストURLとは、APIにアクセスするためのURLです。操作したい内容によってURLが異なります。

freeeAPIでは、https://api.freee.co.jp/api/1 が固定値となり、それに続く部分が操作内容によって異なります。

freeeAPIのリクエストURL

リクエストURLの確認方法

この項では、皆さんがリクエストURLを自分自身で確認できるよう、freeeAPIリファレンスの読み方を紹介します。

リファレンスのページを開いたら、取得したい項目を探します。「事業所一覧」を取得したいので、「Companies 事業所」という項目を見つけましょう。該当部分をクリックして展開します。

※パラメータ説明の部分で「データの取得はGET」と記述しました。ここでもメソッドの種類を確認できます。

freeeAPIリファレンスの読み方

展開すると、概要などを確認できます。

「Parameters」とは、「条件指定」のことです。たとえば、取引一覧を取得するリクエストでは「yyyy/mm/dd以降の取引を取得する」といった条件指定が可能です。その場合、その「日付」がパラメータとなり、リクエストURLに付与します。

事業所一覧の取得では、「No parameters」と表記されているので「条件指定は不要」です。

「Try it out」をクリックします。

freeeAPIリファレンス事業所一覧

「Execute」をクリックします。

freeeAPIリファレンスでExecute

下部に表示される「Request URL」が、事業所一覧を取得する際のリクエストURLです。
(その上部のCurlという項目は関係ないので無視して大丈夫です)

freeeAPIリファレンスでリクエストURLの確認

レスポンスの確認方法

Logger.logで、下記のようなログを確認できました。freeeAPIのレスポンスはJSON形式です。

それぞれのパラメータの意味は、freeeAPIリファレンスで確認できます。

freeeAPIリファレンスの「Responses Sample」の項目にサンプルが掲載されており、「パラメータ詳細」をクリックすると各項目を確認できます。

freeeAPIリファレンスのレスポンスサンプル

“id”は「事業所ID」、“name”は「事業所名」といった、パラメータの詳細が確認できます。

freeeAPIリファレンスのパラメータ詳細

リクエストを送りレスポンスが返る

15行目で「リクエスト」を送り、その結果である「レスポンス」を変数responseに格納しています。次の行でレスポンスの内容をログ出力しています。

GASで「リクエストを送る」機能が、UrlFetchサービスのfetchメソッドです。英単語のfetch(フェッチ)とは、取ってくる・呼んでくる、という意味です。

UrlFetchApp.fetch(リクエストURL, パラメータ)

以上が、GASでfreeeAPIを操作してデータを取得する一連の流れです。freeeの画面を操作せずに、GASで直接データを取得することができましたね!

まとめ

連載「はじめてのfreee API」の第3回目では、これらを紹介しました。

  • GASでfreeeAPIを操作して、freeeからデータを取得する流れ
  • 事業所IDの確認方法
  • freeeAPIリファレンスの読み方

余裕のある方は、freeeAPIリファレンスを読み進めてみて、他の項目のデータ取得もぜひチャレンジしてみてください。

今回のテーマは「freeeからデータを取得する方法」でした。次回は「freeeにデータを送る方法」をテーマにして紹介します。

【はじめてのfreeeAPI】GASでリクエストを送りfreeeの事業所情報を更新する
GoogleAppsScriptでクラウド会計ソフトfreeeのAPIを操作するシリーズ。PUTリクエストでfreeeの事業所情報を更新する方法・PUTリクエストのボディ(JSON)の作り方を紹介しています。

連載目次:【GAS初心者向け】はじめてのfreeeAPI

GoogleAppsScriptを使用して「クラウド会計ソフトfreee」のAPIを操作する初心者向けシリーズ。GAS × freee APIで何ができるのか?連携方法は?を紹介しています。実際にfreee APIを操作してデータの取得・更新をしてみましょう。

  1. 【はじめてのfreeeAPI】GAS×freeeAPIで経理業務を自動化する最初の一歩!
  2. 【はじめてのfreeeAPI】GASとfreeeをつなぐ!連携認証の手順を一から紹介します
  3. 【はじめてのfreeeAPI】GASでリクエストを送りfreeeの事業所一覧を取得する
  4. 【はじめてのfreeeAPI】GASでリクエストを送りfreeeの事業所情報を更新する

  投稿者プロフィール

もり
もりITライター
GoogleAppsScript, VBAを専門とするITライターです。

退屈なことはプログラミングで片づけよう!
自らの事務職経験を活かし、事務作業をとことんラクにできるITネタを発信していきます。

個人ブログ『もりさんのプログラミング手帳』も運営中!

お気軽にTwitterフォローしてくださいね!

タイトルとURLをコピーしました