FreshBooks のデータでGoogle Sheets を拡張

古川えりか
古川えりか
コンテンツスペシャリスト
API Server を介して、Google Apps Script から FreshBooks を呼び出せます。



マクロ、カスタム関数、アドオンを使用してGoogle スプレッドシートからFreshBooks のデータとやり取りします。CData API Server は、ADO.NET Provider for API（またはその他の240+ ADO.NET Providers）と組み合わせることで、Google Sheets のようなクラウドベースのモバイルアプリケーションからFreshBooks のデータに接続できるようになります。API Server は、FreshBooks およびCData ADO.NET Providers にサポートされるすべてのソースのOData サービスを生成する軽量のWeb アプリケーションです。

Google Apps Script（GAS）は、これらのOData サービスをJSON 形式で利用できます。この記事では、Google スプレッドシートにInvoices データを取り込みシンプルなアドオンを作成する方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなFreshBooks OData サービスを作成していきましょう。

FreshBooks への接続

GAS からFreshBooks のデータを操作するには、まずFreshBooks への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「FreshBooks」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、FreshBooks への接続設定を行っていきましょう！ 接続設定

  5. まず、Profile 接続プロパティをディスク上の FreshBooks プロファイルの場所に設定します（例：C:\profiles\FreshBooks.apip）。次に、ProfileSettings 接続プロパティを FreshBooks の接続文字列に設定します（以下を参照）。

    FreshBooks API プロファイル設定

    FreshBooks Developer Dashboard で OAuth アプリケーションを登録し、Client ID と Client Secret を取得します。アプリケーションのコールバック URL にリダイレクト URI を設定します。

  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

FreshBooks に接続するには、クライアントアプリケーションを登録します。アプリの登録後、以下を設定します。

  • OAuth Client Id: アプリに割り当てられた client_id。
  • OAuth Client Secret: アプリに割り当てられた client_secret。

Sign In をクリックして OAuth 認証を完了します。

API Server のユーザー設定

次に、API Server 経由でFreshBooks にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。 新しいユーザーの構成
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。 API Server のユーザー設定

FreshBooks 用のAPI エンドポイントの作成

ユーザーを作成したら、FreshBooks のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。 テーブルを追加
  2. アクセスしたい接続を選択し、次へをクリックします。 接続の選択
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。 接続からのテーブルの追加

OData のエンドポイントを取得

以上でFreshBooks への接続を設定してユーザーを作成し、API Server でFreshBooks データのAPI を追加しました。これで、OData 形式のFreshBooks データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

API エンドポイント

FreshBooks のデータを取得する

「Tools」->「Script Editor」とクリックして、スプレッドシートからScript Editor を開きます。Script Editor で次の機能を追加し、スプレッドシートにOData クエリの結果を入力します。 


function retrieve(){
  var url = "https://MyUrl/api.rsc/Invoices?select=Id,Id,InvoiceNumber,AccountId";
  var response = UrlFetchApp.fetch(url,{
    headers: {"Authorization":"Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")}
  });
  var json = response.getContentText();
  var sheet = SpreadsheetApp.getActiveSheet();
  var a1 = sheet.getRange('a1');
  var index=1;
  var invoices = JSON.parse(json).value;

  var cols = [["Id","Id","InvoiceNumber","AccountId"]];
  sheet.getRange(1,1,1,4).setValues(cols);

  row=2;
  for(var i in invoices){
    for (var j in invoices[i]) {
      switch (j) {
        case "Id":
          a1.offset(row,0).setValue(account[i][j]);
          break;
        case "Id":
          a1.offset(row,1).setValue(account[i][j]);
          break;
        case "InvoiceNumber":
          a1.offset(row,2).setValue(account[i][j]);
          break;
        case "AccountId":
          a1.offset(row,3).setValue(account[i][j]);
          break;
      }
    }
    row++;
  }
}

次のステップに従って、開いたタイミングでスプレッドシートに入力するインストール可能なトリガーを追加します。

  1. 「Resources」->「Current Project's Triggers」->「Add a New Trigger」とクリックします。
  2. 「Run」メニューで「retrieve」を選択します。
  3. 「From Spreadsheet」を選択します。
  4. 「On open」を選択します。

ダイアログを閉じると、アプリケーションへのアクセスを許可するように要求されます。

「Publish」->「Test as Add-On」とクリックすることで、スクリプトを確認できます。バージョン、インストールタイプ、およびスプレッドシートを選択し、テストの構成を作成します。作成したら、選択して実行できます。

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server

この記事の内容

関連記事