PowerShell からfreee のデータに接続してデータの取得・CSV エクスポートを実行する方法
CData Cmdlets for API を使えば、PowerShell からfreee に手軽に連携して、データのCRUD やエクスポートを実行できます。
本記事では、freee への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。
freee への接続を設定
それでは、まずはfreee への接続設定からはじめていきましょう。接続設定にはCData freee Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。
インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。
Import-Module APICmdlets;
Connect-Freee コマンドを使ってfreee との接続を設定します。各接続プロパティの取得方法は次に説明します。
$conn = Connect-Freee -Profile "$Profile" -ProfileSettings "$ProfileSettings" -' "$'" -Authscheme "$Authscheme" -InitiateOAuth "$InitiateOAuth" -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackUrl "$CallbackUrl"
まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。
次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。
その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。
- AuthScheme：OAuth に設定します。
- OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
- OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
- CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
これで接続設定は完了です。
freee のデータを取得してCSV にパイプライン
接続が完了したので、Deals テーブルデータを取得して結果をCSV ファイルにエクスポートします。
Select-API -Connection $conn -Table Deals | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myDealsData.csv -NoTypeInformation
このコードでは、Select-API から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。
おわりに
このように、CData Cmdlets を使えばPowerShell でのfreee のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。