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

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

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

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

Avalara AvaTax への接続を設定

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

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

    Import-Module AvalaraAvataxCmdlets;

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

    $conn = Connect-AvalaraAvatax  -User "$User" -Password "$Password"

Basic 認証を実行する通常の方法は、次のログイン資格情報を提供することです。

• User：ユーザー名に設定します。
• Password：パスワードに設定します。

サンドボックス環境を使用している場合には、オプションで次を設定してください。

• UseSandbox：サンドボックスアカウントで認証する場合にはこれをtrue に設定します。

アカウント番号とライセンスキーを使用して認証する

または、アカウント番号とライセンスキーを使用して認証することもできます。次を使用してデータに接続します。

• AccountId：これをアカウントId に設定します。アカウントId は管理コンソールの右上端にリストされています。
• LicenseKey：これをAvalara Avatax のライセンスキーに設定します。ライセンスキーの生成は、Avalara Avatax アカウント管理者としてログインして Settings -> Reset License Key に移動して実行できます。

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

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

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

Select-AvalaraAvatax -Connection $conn -Table Transactions | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTransactionsData.csv -NoTypeInformation

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

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

データの削除

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

Select-AvalaraAvatax -Connection $conn -Table Transactions -Where "Code = 051349" | Remove-AvalaraAvatax

データの挿入と更新

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

Import-Csv -Path C:\MyTransactionsUpdates.csv | %{
  $record = Select-AvalaraAvatax -Connection $AvalaraAvatax -Table Transactions -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-AvalaraAvatax -Connection $avalaraavatax -Table Transactions -Columns ("Id","TotalTax") -Values ($_.Id, $_.TotalTax) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-AvalaraAvatax -Connection $avalaraavatax -Table Transactions -Columns ("Id","TotalTax") -Values ($_.Id, $_.TotalTax)
  }
}

おわりに

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