[GAS][会計freee]事業所IDを取得しよう

どうも。つじけ（tsujikenzo）です。この連載では 「会計freeeAPIを使って残高確認表を作成しよう」 について全7回でお送りします。今日は4回目で 「事業所IDを取得しよう」 をお届けします。

前回のおさらい
事業所IDとは
リファレンスの確認
リクエストURLの作成
HTTPリクエストを送信
HTTPレスポンスの確認（閲覧）
まとめ
この連載の目次

前回のおさらい

前回は、「会計freeeAPIを操作する」 ということで、「APIとはなにか」、「HTTPリクエストとHTTPレスポンス」などをお届けしました。

[GAS][会計freee]会計freeeAPIを操作する

どうも。つじけ（tsujikenzo）です。この連載では「会計freeeAPIを使って残高確認表を作成しよう」について全7回でお送りします。今日は3回目で「会計freeeAPIを操作する」をお届けします。前回のおさらい前回は...

今回は、「事業所IDを取得しよう」 をお届けします。

事業所IDとは

会計freeeでは、1つのアカウントで複数の事業所を持てます。

第2回目の「マイアプリを作成する」のときに、事業所を切り替える作業を行いましたね。

事業所には、固有のIDが割り振られています。事業所が1つだけしかない人も、まずは事業所IDの確認が必要です。

事業所IDは、会計freeeAPIを操作して、取得できます。

リファレンスの確認

「事業所IDを取得する」ということをやりたい場合は、まずは リファレンスの確認 です。

[事業所一覧の取得]をクリックします。

Responses（レスポンス）を確認します。HTTPリクエストが成功すると、このようなJSONが返ってくるようです。

リクエストURLの作成

リクエストURLを作成します。Partners（パラメーター）の[Try it out]をクリックします。

[Excute]をクリックします。

リクエストURLが生成されました。後で必要になりますので、コピーしておきましょう。

HTTPリクエストを送信

スクリプトエディタを開きます。これからコーディングしますが、作業場として、「事業所一覧の取得」ファイルを作成した方が分かりやすいでしょう。

HTTPリクエストをリクエストURLに送信するコードはこちらです。

const response = UrlFetchApp.fetch(requestUrl, params);

引数に必要な[リクエストURL]は、さきほど確認しましたね。変数に代入しておきます。

const requestUrl = 'https://api.freee.co.jp/api/1/companies';

引数に必要なparamsを作成するコードはこちらです。

const params = {
"method" : "get",
"headers" : {"Authorization":"Bearer " + accessToken}
};

レスポンスを閲覧するコードはこちらです。普段はconsole.log()を使うと思いますが、閲覧だけならLogger.log() で構いません。

Logger.log(response);

以上を組み合わせたコードがこちらです。第2回目で登場したアクセストークンを取得するコードも使用します。

/**
* 事業所一覧を取得する関数
*
* @param none
* @return none
*/
function getMyCompanies() {

//freeeAPIのサービスからアクセストークンを取得
const accessToken = getService().getAccessToken();

//HTTPリクエストを送る時に必要なパラメーター
const params = {
"method" : "get",
"headers" : {"Authorization":"Bearer " + accessToken}
};

//事業所一覧を取得するためのリクエストURL
const requestUrl = 'https://api.freee.co.jp/api/1/companies';

//HTTPリクエストをリクエストURLに送信する
const response = UrlFetchApp.fetch(requestUrl, params);

//レスポンスの中身を閲覧する
Logger.log(response);

}