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

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

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

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

TaxJar への接続を設定

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

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

    Import-Module TaxJarCmdlets;

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

    $conn = Connect-TaxJar  -APIKey "$APIKey"

TaxJar API への認証には、まず初めにTaxJar UI からAPI キーを取得する必要があります。

NOTE：API の利用は、Professional およびPremium TaxJar プランでのみ可能です。

すでにProfessional またはPremium プランをお持ちの方は、TaxJar UI にログインして、「アカウント」->「TaxJar API」に移動するとAPI キーを確認することができます。 API キーを取得したら、APIKey 接続プロパティに設定できます。

その他の注意事項

• デフォルトでは、エンティティが日付範囲フィルタをサポートしている場合、CData コネクタは過去3か月のデータを取得します。StartDate を設定して、取得するデータの最小作成日を指定することができます。
• API キーがサンドボックスAPI アカウント用に作成されている場合は、UseSandbox をtrue に設定してください。ただし、すべてのエンドポイントが期待どおりに機能するとは限りません。詳しくは、TaxJar 開発者用ドキュメントを参照してください。

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

TaxJar データを取得してCSV にパイプライン

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

Select-TaxJar -Connection $conn -Table Orders | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

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

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

データの削除

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

Select-TaxJar -Connection $conn -Table Orders -Where "TransactionID = 123" | Remove-TaxJar

データの挿入と更新

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

Import-Csv -Path C:\MyOrdersUpdates.csv | %{
  $record = Select-TaxJar -Connection $TaxJar -Table Orders -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-TaxJar -Connection $taxjar -Table Orders -Columns ("TransactionID","UserID") -Values ($_.TransactionID, $_.UserID) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-TaxJar -Connection $taxjar -Table Orders -Columns ("TransactionID","UserID") -Values ($_.TransactionID, $_.UserID)
  }
}

おわりに

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