PowerShell からQuickBooks Online のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData Cmdlets for QuickBooksOnline を使えば、PowerShell からQuickBooks Online に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、QuickBooks Online への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

QuickBooks Online への接続を設定

それでは、まずはQuickBooks Online への接続設定からはじめていきましょう。接続設定にはCData QuickBooks Online Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module QuickBooksOnlineCmdlets;

Connect-QBOnline コマンドを使ってQuickBooks Online との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-QBOnline 

QuickBooks Online への接続にはOAuth 認証標準を使います。Embedded Credentials を使用すると、接続プロパティを設定せずに接続できます。接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えるだけです。CData 製品がOAuth プロセスを完了します。

詳細はヘルプドキュメントを参照してください。

これで接続設定は完了です。

QuickBooks Online のデータを取得してCSV にパイプライン

接続が完了したので、Customers テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-QuickBooksOnline -Connection $conn -Table Customers | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

このコードでは、Select-QuickBooksOnline から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-QuickBooksOnline -Connection $conn -Table Customers -Where "FullyQualifiedName = Cook, Brian" | Remove-QuickBooksOnline

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyCustomersUpdates.csv | %{
  $record = Select-QuickBooksOnline -Connection $QuickBooksOnline -Table Customers -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-QuickBooksOnline -Connection $quickbooksonline -Table Customers -Columns ("DisplayName","Balance") -Values ($_.DisplayName, $_.Balance) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-QuickBooksOnline -Connection $quickbooksonline -Table Customers -Columns ("DisplayName","Balance") -Values ($_.DisplayName, $_.Balance)
  }
}

おわりに

このように、CData Cmdlets を使えばPowerShell でのQuickBooks Online のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。