PowerShell からHarvest のデータに接続してデータの取得・CSV エクスポートを実行する方法
CData Cmdlets for API を使えば、PowerShell からHarvest に手軽に連携して、データのCRUD やエクスポートを実行できます。
本記事では、Harvest への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。
Harvest への接続を設定
それでは、まずはHarvest への接続設定からはじめていきましょう。接続設定にはCData Harvest Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。
インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。
Import-Module APICmdlets;
Connect-API コマンドを使ってHarvest との接続を設定します。各接続プロパティの取得方法は次に説明します。
$conn = Connect-API -Profile "$Profile" -ProfileSettings "$ProfileSettings" -AccountId "$AccountId"
まず、Profile 接続プロパティをディスク上のHarvest プロファイルの場所に設定します（例：C:\profiles\Harvest.apip）。次に、ProfileSettings 接続プロパティをHarvest の接続文字列に設定します（以下を参照）。
Harvest API プロファイル設定
Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。
トークン認証の使用
トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。
OAuth 認証の使用
まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。
以下の接続プロパティを設定すると、接続できるようになります。
- ProfileSettings：ProfileSettings でAccountId を設定します。
- AuthScheme：OAuth に設定します。
- OAuthClientId：アプリ設定で指定したclient ID に設定します。
- OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
- CallbackURL：アプリ設定で指定したRedirect URI に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。
これで接続設定は完了です。
Harvest のデータを取得してCSV にパイプライン
接続が完了したので、Invoices テーブルデータを取得して結果をCSV ファイルにエクスポートします。
Select-API -Connection $conn -Table Invoices | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myInvoicesData.csv -NoTypeInformation
このコードでは、Select-API から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。
おわりに
このように、CData Cmdlets を使えばPowerShell でのHarvest のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。